types

package
v1.29.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 18, 2024 License: Apache-2.0 Imports: 4 Imported by: 10

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Exception that indicates the specified AttackId does not exist, or the requester does not have the appropriate permissions to access the AttackId .

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AccessDeniedForDependencyException 

type AccessDeniedForDependencyException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

In order to grant the necessary access to the Shield Response Team (SRT) the user submitting the request must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an Amazon Web Services Service.

func (*AccessDeniedForDependencyException) Error 

func (e *AccessDeniedForDependencyException) Error() string

func (*AccessDeniedForDependencyException) ErrorCode 

func (e *AccessDeniedForDependencyException) ErrorCode() string

func (*AccessDeniedForDependencyException) ErrorFault 

func (e *AccessDeniedForDependencyException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedForDependencyException) ErrorMessage 

func (e *AccessDeniedForDependencyException) ErrorMessage() string

type ApplicationLayerAutomaticResponseConfiguration added in v1.11.0 

type ApplicationLayerAutomaticResponseConfiguration struct {

	// Specifies the action setting that Shield Advanced should use in the WAF rules
	// that it creates on behalf of the protected resource in response to DDoS attacks.
	// You specify this as part of the configuration for the automatic application
	// layer DDoS mitigation feature, when you enable or update automatic mitigation.
	// Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group,
	// inside the web ACL that you have associated with the resource.
	//
	// This member is required.
	Action *ResponseAction

	// Indicates whether automatic application layer DDoS mitigation is enabled for
	// the protection.
	//
	// This member is required.
	Status ApplicationLayerAutomaticResponseStatus
	// contains filtered or unexported fields
}

The automatic application layer DDoS mitigation settings for a Protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.

type ApplicationLayerAutomaticResponseStatus added in v1.11.0 

type ApplicationLayerAutomaticResponseStatus string
const (
	ApplicationLayerAutomaticResponseStatusEnabled  ApplicationLayerAutomaticResponseStatus = "ENABLED"
	ApplicationLayerAutomaticResponseStatusDisabled ApplicationLayerAutomaticResponseStatus = "DISABLED"
)

Enum values for ApplicationLayerAutomaticResponseStatus

func (ApplicationLayerAutomaticResponseStatus) Values added in v1.11.0 

func (ApplicationLayerAutomaticResponseStatus) Values() []ApplicationLayerAutomaticResponseStatus

Values returns all known values for ApplicationLayerAutomaticResponseStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AttackDetail 

type AttackDetail struct {

	// List of counters that describe the attack for the specified time period.
	AttackCounters []SummarizedCounter

	// The unique identifier (ID) of the attack.
	AttackId *string

	// The array of objects that provide details of the Shield event.
	//
	// For infrastructure layer events (L3 and L4 events), you can view metrics for
	// top contributors in Amazon CloudWatch metrics. For more information, see [Shield metrics and alarms]in the
	// WAF Developer Guide.
	//
	// [Shield metrics and alarms]: https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms
	AttackProperties []AttackProperty

	// The time the attack ended, in Unix time in seconds.
	EndTime *time.Time

	// List of mitigation actions taken for the attack.
	Mitigations []Mitigation

	// The ARN (Amazon Resource Name) of the resource that was attacked.
	ResourceArn *string

	// The time the attack started, in Unix time in seconds.
	StartTime *time.Time

	// If applicable, additional detail about the resource being attacked, for
	// example, IP address or URL.
	SubResources []SubResourceSummary
	// contains filtered or unexported fields
}

The details of a DDoS attack.

type AttackLayer 

type AttackLayer string
const (
	AttackLayerNetwork     AttackLayer = "NETWORK"
	AttackLayerApplication AttackLayer = "APPLICATION"
)

Enum values for AttackLayer

func (AttackLayer) Values added in v0.29.0 

func (AttackLayer) Values() []AttackLayer

Values returns all known values for AttackLayer. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AttackProperty 

type AttackProperty struct {

	// The type of Shield event that was observed. NETWORK indicates layer 3 and layer
	// 4 events and APPLICATION indicates layer 7 events.
	//
	// For infrastructure layer events (L3 and L4 events), you can view metrics for
	// top contributors in Amazon CloudWatch metrics. For more information, see [Shield metrics and alarms]in the
	// WAF Developer Guide.
	//
	// [Shield metrics and alarms]: https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms
	AttackLayer AttackLayer

	// Defines the Shield event property information that is provided. The
	// WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid
	// only for WordPress reflective pingback events.
	AttackPropertyIdentifier AttackPropertyIdentifier

	// Contributor objects for the top five contributors to a Shield event. A
	// contributor is a source of traffic that Shield Advanced identifies as
	// responsible for some or all of an event.
	TopContributors []Contributor

	// The total contributions made to this Shield event by all contributors.
	Total int64

	// The unit used for the Contributor Value property.
	Unit Unit
	// contains filtered or unexported fields
}

Details of a Shield event. This is provided as part of an AttackDetail.

type AttackPropertyIdentifier 

type AttackPropertyIdentifier string
const (
	AttackPropertyIdentifierDestinationUrl             AttackPropertyIdentifier = "DESTINATION_URL"
	AttackPropertyIdentifierReferrer                   AttackPropertyIdentifier = "REFERRER"
	AttackPropertyIdentifierSourceAsn                  AttackPropertyIdentifier = "SOURCE_ASN"
	AttackPropertyIdentifierSourceCountry              AttackPropertyIdentifier = "SOURCE_COUNTRY"
	AttackPropertyIdentifierSourceIpAddress            AttackPropertyIdentifier = "SOURCE_IP_ADDRESS"
	AttackPropertyIdentifierSourceUserAgent            AttackPropertyIdentifier = "SOURCE_USER_AGENT"
	AttackPropertyIdentifierWordpressPingbackReflector AttackPropertyIdentifier = "WORDPRESS_PINGBACK_REFLECTOR"
	AttackPropertyIdentifierWordpressPingbackSource    AttackPropertyIdentifier = "WORDPRESS_PINGBACK_SOURCE"
)

Enum values for AttackPropertyIdentifier

func (AttackPropertyIdentifier) Values added in v0.29.0 

func (AttackPropertyIdentifier) Values() []AttackPropertyIdentifier

Values returns all known values for AttackPropertyIdentifier. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AttackStatisticsDataItem added in v0.30.0 

type AttackStatisticsDataItem struct {

	// The number of attacks detected during the time period. This is always present,
	// but might be zero.
	//
	// This member is required.
	AttackCount int64

	// Information about the volume of attacks during the time period. If the
	// accompanying AttackCount is zero, this setting might be empty.
	AttackVolume *AttackVolume
	// contains filtered or unexported fields
}

A single attack statistics data record. This is returned by DescribeAttackStatistics along with a time range indicating the time period that the attack statistics apply to.

type AttackSummary 

type AttackSummary struct {

	// The unique identifier (ID) of the attack.
	AttackId *string

	// The list of attacks for a specified time period.
	AttackVectors []AttackVectorDescription

	// The end time of the attack, in Unix time in seconds.
	EndTime *time.Time

	// The ARN (Amazon Resource Name) of the resource that was attacked.
	ResourceArn *string

	// The start time of the attack, in Unix time in seconds.
	StartTime *time.Time
	// contains filtered or unexported fields
}

Summarizes all DDoS attacks for a specified time period.

type AttackVectorDescription 

type AttackVectorDescription struct {

	// The attack type. Valid values:
	//
	//   - UDP_TRAFFIC
	//
	//   - UDP_FRAGMENT
	//
	//   - GENERIC_UDP_REFLECTION
	//
	//   - DNS_REFLECTION
	//
	//   - NTP_REFLECTION
	//
	//   - CHARGEN_REFLECTION
	//
	//   - SSDP_REFLECTION
	//
	//   - PORT_MAPPER
	//
	//   - RIP_REFLECTION
	//
	//   - SNMP_REFLECTION
	//
	//   - MSSQL_REFLECTION
	//
	//   - NET_BIOS_REFLECTION
	//
	//   - SYN_FLOOD
	//
	//   - ACK_FLOOD
	//
	//   - REQUEST_FLOOD
	//
	//   - HTTP_REFLECTION
	//
	//   - UDS_REFLECTION
	//
	//   - MEMCACHED_REFLECTION
	//
	// This member is required.
	VectorType *string
	// contains filtered or unexported fields
}

Describes the attack.

type AttackVolume added in v0.30.0 

type AttackVolume struct {

	// A statistics object that uses bits per second as the unit. This is included for
	// network level attacks.
	BitsPerSecond *AttackVolumeStatistics

	// A statistics object that uses packets per second as the unit. This is included
	// for network level attacks.
	PacketsPerSecond *AttackVolumeStatistics

	// A statistics object that uses requests per second as the unit. This is included
	// for application level attacks, and is only available for accounts that are
	// subscribed to Shield Advanced.
	RequestsPerSecond *AttackVolumeStatistics
	// contains filtered or unexported fields
}

Information about the volume of attacks during the time period, included in an AttackStatisticsDataItem . If the accompanying AttackCount in the statistics object is zero, this setting might be empty.

type AttackVolumeStatistics added in v0.30.0 

type AttackVolumeStatistics struct {

	// The maximum attack volume observed for the given unit.
	//
	// This member is required.
	Max float64
	// contains filtered or unexported fields
}

Statistics objects for the various data types in AttackVolume.

type AutoRenew 

type AutoRenew string
const (
	AutoRenewEnabled  AutoRenew = "ENABLED"
	AutoRenewDisabled AutoRenew = "DISABLED"
)

Enum values for AutoRenew

func (AutoRenew) Values added in v0.29.0 

func (AutoRenew) Values() []AutoRenew

Values returns all known values for AutoRenew. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BlockAction added in v1.11.0 

type BlockAction struct {
	// contains filtered or unexported fields
}

Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.

This is only used in the context of the ResponseAction setting.

JSON specification: "Block": {}

type Contributor 

type Contributor struct {

	// The name of the contributor. The type of name that you'll find here depends on
	// the AttackPropertyIdentifier setting in the AttackProperty where this
	// contributor is defined. For example, if the AttackPropertyIdentifier is
	// SOURCE_COUNTRY , the Name could be United States .
	Name *string

	// The contribution of this contributor expressed in Protection units. For example 10,000 .
	Value int64
	// contains filtered or unexported fields
}

A contributor to the attack and their contribution.

type CountAction added in v1.11.0 

type CountAction struct {
	// contains filtered or unexported fields
}

Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.

This is only used in the context of the ResponseAction setting.

JSON specification: "Count": {}

type EmergencyContact 

type EmergencyContact struct {

	// The email address for the contact.
	//
	// This member is required.
	EmailAddress *string

	// Additional notes regarding the contact.
	ContactNotes *string

	// The phone number for the contact.
	PhoneNumber *string
	// contains filtered or unexported fields
}

Contact information that the SRT can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.

type InclusionProtectionFilters added in v1.17.0 

type InclusionProtectionFilters struct {

	// The name of the protection that you want to retrieve.
	ProtectionNames []string

	// The ARN (Amazon Resource Name) of the resource whose protection you want to
	// retrieve.
	ResourceArns []string

	// The type of protected resource whose protections you want to retrieve.
	ResourceTypes []ProtectedResourceType
	// contains filtered or unexported fields
}

Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.

type InclusionProtectionGroupFilters added in v1.17.0 

type InclusionProtectionGroupFilters struct {

	// The aggregation setting of the protection groups that you want to retrieve.
	Aggregations []ProtectionGroupAggregation

	// The pattern specification of the protection groups that you want to retrieve.
	Patterns []ProtectionGroupPattern

	// The ID of the protection group that you want to retrieve.
	ProtectionGroupIds []string

	// The resource type configuration of the protection groups that you want to
	// retrieve. In the protection group configuration, you specify the resource type
	// when you set the group's Pattern to BY_RESOURCE_TYPE .
	ResourceTypes []ProtectedResourceType
	// contains filtered or unexported fields
}

Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with a specific pattern, aggregation, or resource type. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.

type InternalErrorException 

type InternalErrorException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

func (*InternalErrorException) Error 

func (e *InternalErrorException) Error() string

func (*InternalErrorException) ErrorCode 

func (e *InternalErrorException) ErrorCode() string

func (*InternalErrorException) ErrorFault 

func (e *InternalErrorException) ErrorFault() smithy.ErrorFault

func (*InternalErrorException) ErrorMessage 

func (e *InternalErrorException) ErrorMessage() string

type InvalidOperationException 

type InvalidOperationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Exception that indicates that the operation would not cause any change to occur.

func (*InvalidOperationException) Error 

func (e *InvalidOperationException) Error() string

func (*InvalidOperationException) ErrorCode 

func (e *InvalidOperationException) ErrorCode() string

func (*InvalidOperationException) ErrorFault 

func (e *InvalidOperationException) ErrorFault() smithy.ErrorFault

func (*InvalidOperationException) ErrorMessage 

func (e *InvalidOperationException) ErrorMessage() string

type InvalidPaginationTokenException 

type InvalidPaginationTokenException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Exception that indicates that the NextToken specified in the request is invalid. Submit the request using the NextToken value that was returned in the prior response.

func (*InvalidPaginationTokenException) Error 

func (e *InvalidPaginationTokenException) Error() string

func (*InvalidPaginationTokenException) ErrorCode 

func (e *InvalidPaginationTokenException) ErrorCode() string

func (*InvalidPaginationTokenException) ErrorFault 

func (e *InvalidPaginationTokenException) ErrorFault() smithy.ErrorFault

func (*InvalidPaginationTokenException) ErrorMessage 

func (e *InvalidPaginationTokenException) ErrorMessage() string

type InvalidParameterException 

type InvalidParameterException struct {
	Message *string

	ErrorCodeOverride *string

	Reason ValidationExceptionReason
	Fields []ValidationExceptionField
	// contains filtered or unexported fields
}

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

func (*InvalidParameterException) Error 

func (e *InvalidParameterException) Error() string

func (*InvalidParameterException) ErrorCode 

func (e *InvalidParameterException) ErrorCode() string

func (*InvalidParameterException) ErrorFault 

func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault

func (*InvalidParameterException) ErrorMessage 

func (e *InvalidParameterException) ErrorMessage() string

type InvalidResourceException 

type InvalidResourceException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.

func (*InvalidResourceException) Error 

func (e *InvalidResourceException) Error() string

func (*InvalidResourceException) ErrorCode 

func (e *InvalidResourceException) ErrorCode() string

func (*InvalidResourceException) ErrorFault 

func (e *InvalidResourceException) ErrorFault() smithy.ErrorFault

func (*InvalidResourceException) ErrorMessage 

func (e *InvalidResourceException) ErrorMessage() string

type Limit 

type Limit struct {

	// The maximum number of protections that can be created for the specified Type .
	Max int64

	// The type of protection.
	Type *string
	// contains filtered or unexported fields
}

Specifies how many protections of a given type you can create.

type LimitsExceededException 

type LimitsExceededException struct {
	Message *string

	ErrorCodeOverride *string

	Type  *string
	Limit int64
	// contains filtered or unexported fields
}

Exception that indicates that the operation would exceed a limit.

func (*LimitsExceededException) Error 

func (e *LimitsExceededException) Error() string

func (*LimitsExceededException) ErrorCode 

func (e *LimitsExceededException) ErrorCode() string

func (*LimitsExceededException) ErrorFault 

func (e *LimitsExceededException) ErrorFault() smithy.ErrorFault

func (*LimitsExceededException) ErrorMessage 

func (e *LimitsExceededException) ErrorMessage() string

type LockedSubscriptionException 

type LockedSubscriptionException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You are trying to update a subscription that has not yet completed the 1-year commitment. You can change the AutoRenew parameter during the last 30 days of your subscription. This exception indicates that you are attempting to change AutoRenew prior to that period.

func (*LockedSubscriptionException) Error 

func (e *LockedSubscriptionException) Error() string

func (*LockedSubscriptionException) ErrorCode 

func (e *LockedSubscriptionException) ErrorCode() string

func (*LockedSubscriptionException) ErrorFault 

func (e *LockedSubscriptionException) ErrorFault() smithy.ErrorFault

func (*LockedSubscriptionException) ErrorMessage 

func (e *LockedSubscriptionException) ErrorMessage() string

type Mitigation 

type Mitigation struct {

	// The name of the mitigation taken for this attack.
	MitigationName *string
	// contains filtered or unexported fields
}

The mitigation applied to a DDoS attack.

type NoAssociatedRoleException 

type NoAssociatedRoleException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The ARN of the role that you specified does not exist.

func (*NoAssociatedRoleException) Error 

func (e *NoAssociatedRoleException) Error() string

func (*NoAssociatedRoleException) ErrorCode 

func (e *NoAssociatedRoleException) ErrorCode() string

func (*NoAssociatedRoleException) ErrorFault 

func (e *NoAssociatedRoleException) ErrorFault() smithy.ErrorFault

func (*NoAssociatedRoleException) ErrorMessage 

func (e *NoAssociatedRoleException) ErrorMessage() string

type OptimisticLockException 

type OptimisticLockException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

func (*OptimisticLockException) Error 

func (e *OptimisticLockException) Error() string

func (*OptimisticLockException) ErrorCode 

func (e *OptimisticLockException) ErrorCode() string

func (*OptimisticLockException) ErrorFault 

func (e *OptimisticLockException) ErrorFault() smithy.ErrorFault

func (*OptimisticLockException) ErrorMessage 

func (e *OptimisticLockException) ErrorMessage() string

type ProactiveEngagementStatus 

type ProactiveEngagementStatus string
const (
	ProactiveEngagementStatusEnabled  ProactiveEngagementStatus = "ENABLED"
	ProactiveEngagementStatusDisabled ProactiveEngagementStatus = "DISABLED"
	ProactiveEngagementStatusPending  ProactiveEngagementStatus = "PENDING"
)

Enum values for ProactiveEngagementStatus

func (ProactiveEngagementStatus) Values added in v0.29.0 

func (ProactiveEngagementStatus) Values() []ProactiveEngagementStatus

Values returns all known values for ProactiveEngagementStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProtectedResourceType added in v0.30.0 

type ProtectedResourceType string
const (
	ProtectedResourceTypeCloudfrontDistribution  ProtectedResourceType = "CLOUDFRONT_DISTRIBUTION"
	ProtectedResourceTypeRoute53HostedZone       ProtectedResourceType = "ROUTE_53_HOSTED_ZONE"
	ProtectedResourceTypeElasticIpAllocation     ProtectedResourceType = "ELASTIC_IP_ALLOCATION"
	ProtectedResourceTypeClassicLoadBalancer     ProtectedResourceType = "CLASSIC_LOAD_BALANCER"
	ProtectedResourceTypeApplicationLoadBalancer ProtectedResourceType = "APPLICATION_LOAD_BALANCER"
	ProtectedResourceTypeGlobalAccelerator       ProtectedResourceType = "GLOBAL_ACCELERATOR"
)

Enum values for ProtectedResourceType

func (ProtectedResourceType) Values added in v0.30.0 

func (ProtectedResourceType) Values() []ProtectedResourceType

Values returns all known values for ProtectedResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Protection 

type Protection struct {

	// The automatic application layer DDoS mitigation settings for the protection.
	// This configuration determines whether Shield Advanced automatically manages
	// rules in the web ACL in order to respond to application layer events that Shield
	// Advanced determines to be DDoS attacks.
	ApplicationLayerAutomaticResponseConfiguration *ApplicationLayerAutomaticResponseConfiguration

	// The unique identifier (ID) for the Route 53 health check that's associated with
	// the protection.
	HealthCheckIds []string

	// The unique identifier (ID) of the protection.
	Id *string

	// The name of the protection. For example, My CloudFront distributions .
	Name *string

	// The ARN (Amazon Resource Name) of the protection.
	ProtectionArn *string

	// The ARN (Amazon Resource Name) of the Amazon Web Services resource that is
	// protected.
	ResourceArn *string
	// contains filtered or unexported fields
}

An object that represents a resource that is under DDoS protection.

type ProtectionGroup added in v0.30.0 

type ProtectionGroup struct {

	// Defines how Shield combines resource data for the group in order to detect,
	// mitigate, and report events.
	//
	//   - Sum - Use the total traffic across the group. This is a good choice for
	//   most cases. Examples include Elastic IP addresses for EC2 instances that scale
	//   manually or automatically.
	//
	//   - Mean - Use the average of the traffic across the group. This is a good
	//   choice for resources that share traffic uniformly. Examples include accelerators
	//   and load balancers.
	//
	//   - Max - Use the highest traffic from each resource. This is useful for
	//   resources that don't share traffic and for resources that share that traffic in
	//   a non-uniform way. Examples include Amazon CloudFront distributions and origin
	//   resources for CloudFront distributions.
	//
	// This member is required.
	Aggregation ProtectionGroupAggregation

	// The ARNs (Amazon Resource Names) of the resources to include in the protection
	// group. You must set this when you set Pattern to ARBITRARY and you must not set
	// it for any other Pattern setting.
	//
	// This member is required.
	Members []string

	// The criteria to use to choose the protected resources for inclusion in the
	// group. You can include all resources that have protections, provide a list of
	// resource ARNs (Amazon Resource Names), or include all resources of a specified
	// resource type.
	//
	// This member is required.
	Pattern ProtectionGroupPattern

	// The name of the protection group. You use this to identify the protection group
	// in lists and to manage the protection group, for example to update, delete, or
	// describe it.
	//
	// This member is required.
	ProtectionGroupId *string

	// The ARN (Amazon Resource Name) of the protection group.
	ProtectionGroupArn *string

	// The resource type to include in the protection group. All protected resources
	// of this type are included in the protection group. You must set this when you
	// set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern
	// setting.
	ResourceType ProtectedResourceType
	// contains filtered or unexported fields
}

A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

type ProtectionGroupAggregation added in v0.30.0 

type ProtectionGroupAggregation string
const (
	ProtectionGroupAggregationSum  ProtectionGroupAggregation = "SUM"
	ProtectionGroupAggregationMean ProtectionGroupAggregation = "MEAN"
	ProtectionGroupAggregationMax  ProtectionGroupAggregation = "MAX"
)

Enum values for ProtectionGroupAggregation

func (ProtectionGroupAggregation) Values added in v0.30.0 

func (ProtectionGroupAggregation) Values() []ProtectionGroupAggregation

Values returns all known values for ProtectionGroupAggregation. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProtectionGroupArbitraryPatternLimits added in v0.30.0 

type ProtectionGroupArbitraryPatternLimits struct {

	// The maximum number of resources you can specify for a single arbitrary pattern
	// in a protection group.
	//
	// This member is required.
	MaxMembers int64
	// contains filtered or unexported fields
}

Limits settings on protection groups with arbitrary pattern type.

type ProtectionGroupLimits added in v0.30.0 

type ProtectionGroupLimits struct {

	// The maximum number of protection groups that you can have at one time.
	//
	// This member is required.
	MaxProtectionGroups int64

	// Limits settings by pattern type in the protection groups for your subscription.
	//
	// This member is required.
	PatternTypeLimits *ProtectionGroupPatternTypeLimits
	// contains filtered or unexported fields
}

Limits settings on protection groups for your subscription.

type ProtectionGroupPattern added in v0.30.0 

type ProtectionGroupPattern string
const (
	ProtectionGroupPatternAll            ProtectionGroupPattern = "ALL"
	ProtectionGroupPatternArbitrary      ProtectionGroupPattern = "ARBITRARY"
	ProtectionGroupPatternByResourceType ProtectionGroupPattern = "BY_RESOURCE_TYPE"
)

Enum values for ProtectionGroupPattern

func (ProtectionGroupPattern) Values added in v0.30.0 

func (ProtectionGroupPattern) Values() []ProtectionGroupPattern

Values returns all known values for ProtectionGroupPattern. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProtectionGroupPatternTypeLimits added in v0.30.0 

type ProtectionGroupPatternTypeLimits struct {

	// Limits settings on protection groups with arbitrary pattern type.
	//
	// This member is required.
	ArbitraryPatternLimits *ProtectionGroupArbitraryPatternLimits
	// contains filtered or unexported fields
}

Limits settings by pattern type in the protection groups for your subscription.

type ProtectionLimits added in v0.30.0 

type ProtectionLimits struct {

	// The maximum number of resource types that you can specify in a protection.
	//
	// This member is required.
	ProtectedResourceTypeLimits []Limit
	// contains filtered or unexported fields
}

Limits settings on protections for your subscription.

type ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceType *string
	// contains filtered or unexported fields
}

Exception indicating the specified resource already exists. If available, this exception includes details in additional properties.

func (*ResourceAlreadyExistsException) Error 

func (e *ResourceAlreadyExistsException) Error() string

func (*ResourceAlreadyExistsException) ErrorCode 

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault 

func (e *ResourceAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*ResourceAlreadyExistsException) ErrorMessage 

func (e *ResourceAlreadyExistsException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceType *string
	// contains filtered or unexported fields
}

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResponseAction added in v1.11.0 

type ResponseAction struct {

	// Specifies that Shield Advanced should configure its WAF rules with the WAF Block
	// action.
	//
	// You must specify exactly one action, either Block or Count .
	Block *BlockAction

	// Specifies that Shield Advanced should configure its WAF rules with the WAF Count
	// action.
	//
	// You must specify exactly one action, either Block or Count .
	Count *CountAction
	// contains filtered or unexported fields
}

Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.

type SubResourceSummary 

type SubResourceSummary struct {

	// The list of attack types and associated counters.
	AttackVectors []SummarizedAttackVector

	// The counters that describe the details of the attack.
	Counters []SummarizedCounter

	// The unique identifier (ID) of the SubResource .
	Id *string

	// The SubResource type.
	Type SubResourceType
	// contains filtered or unexported fields
}

The attack information for the specified SubResource.

type SubResourceType 

type SubResourceType string
const (
	SubResourceTypeIp  SubResourceType = "IP"
	SubResourceTypeUrl SubResourceType = "URL"
)

Enum values for SubResourceType

func (SubResourceType) Values added in v0.29.0 

func (SubResourceType) Values() []SubResourceType

Values returns all known values for SubResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Subscription 

type Subscription struct {

	// Limits settings for your subscription.
	//
	// This member is required.
	SubscriptionLimits *SubscriptionLimits

	// If ENABLED , the subscription will be automatically renewed at the end of the
	// existing subscription period.
	//
	// When you initally create a subscription, AutoRenew is set to ENABLED . You can
	// change this by submitting an UpdateSubscription request. If the
	// UpdateSubscription request does not included a value for AutoRenew , the
	// existing value for AutoRenew remains unchanged.
	AutoRenew AutoRenew

	// The date and time your subscription will end.
	EndTime *time.Time

	// Specifies how many protections of a given type you can create.
	Limits []Limit

	// If ENABLED , the Shield Response Team (SRT) will use email and phone to notify
	// contacts about escalations to the SRT and to initiate proactive customer
	// support.
	//
	// If PENDING , you have requested proactive engagement and the request is pending.
	// The status changes to ENABLED when your request is fully processed.
	//
	// If DISABLED , the SRT will not proactively notify contacts about escalations or
	// to initiate proactive customer support.
	ProactiveEngagementStatus ProactiveEngagementStatus

	// The start time of the subscription, in Unix time in seconds.
	StartTime *time.Time

	// The ARN (Amazon Resource Name) of the subscription.
	SubscriptionArn *string

	// The length, in seconds, of the Shield Advanced subscription for the account.
	TimeCommitmentInSeconds int64
	// contains filtered or unexported fields
}

Information about the Shield Advanced subscription for an account.

type SubscriptionLimits added in v0.30.0 

type SubscriptionLimits struct {

	// Limits settings on protection groups for your subscription.
	//
	// This member is required.
	ProtectionGroupLimits *ProtectionGroupLimits

	// Limits settings on protections for your subscription.
	//
	// This member is required.
	ProtectionLimits *ProtectionLimits
	// contains filtered or unexported fields
}

Limits settings for your subscription.

type SubscriptionState 

type SubscriptionState string
const (
	SubscriptionStateActive   SubscriptionState = "ACTIVE"
	SubscriptionStateInactive SubscriptionState = "INACTIVE"
)

Enum values for SubscriptionState

func (SubscriptionState) Values added in v0.29.0 

func (SubscriptionState) Values() []SubscriptionState

Values returns all known values for SubscriptionState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SummarizedAttackVector 

type SummarizedAttackVector struct {

	// The attack type, for example, SNMP reflection or SYN flood.
	//
	// This member is required.
	VectorType *string

	// The list of counters that describe the details of the attack.
	VectorCounters []SummarizedCounter
	// contains filtered or unexported fields
}

A summary of information about the attack.

type SummarizedCounter 

type SummarizedCounter struct {

	// The average value of the counter for a specified time period.
	Average float64

	// The maximum value of the counter for a specified time period.
	Max float64

	// The number of counters for a specified time period.
	N int32

	// The counter name.
	Name *string

	// The total of counter values for a specified time period.
	Sum float64

	// The unit of the counters.
	Unit *string
	// contains filtered or unexported fields
}

The counter that describes a DDoS attack.

type Tag added in v1.2.0 

type Tag struct {

	// Part of the key:value pair that defines a tag. You can use a tag key to
	// describe a category of information, such as "customer." Tag keys are
	// case-sensitive.
	Key *string

	// Part of the key:value pair that defines a tag. You can use a tag value to
	// describe a specific value within a category, such as "companyA" or "companyB."
	// Tag values are case-sensitive.
	Value *string
	// contains filtered or unexported fields
}

A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

type TimeRange 

type TimeRange struct {

	// The start time, in Unix time in seconds.
	FromInclusive *time.Time

	// The end time, in Unix time in seconds.
	ToExclusive *time.Time
	// contains filtered or unexported fields
}

The time range.

type Unit 

type Unit string
const (
	UnitBits     Unit = "BITS"
	UnitBytes    Unit = "BYTES"
	UnitPackets  Unit = "PACKETS"
	UnitRequests Unit = "REQUESTS"
)

Enum values for Unit

func (Unit) Values added in v0.29.0 

func (Unit) Values() []Unit

Values returns all known values for Unit. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ValidationExceptionField added in v0.30.0 

type ValidationExceptionField struct {

	// The message describing why the parameter failed validation.
	//
	// This member is required.
	Message *string

	// The name of the parameter that failed validation.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Provides information about a particular parameter passed inside a request that resulted in an exception.

type ValidationExceptionReason added in v0.30.0 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "OTHER"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values added in v0.30.0 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.