String status
Indicates whether automatic application layer DDoS mitigation is enabled for the protection.
ResponseAction action
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.
String logBucket
The Amazon S3 bucket that contains the logs that you want to share.
String roleArn
The Amazon Resource Name (ARN) of the role the SRT will use to access your Amazon Web Services account.
Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to this role. For more information see Attaching and
Detaching IAM Policies.
String protectionId
The unique identifier (ID) for the Protection object to add the health check association to.
String healthCheckArn
The Amazon Resource Name (ARN) of the health check to associate with the protection.
List<E> emergencyContactList
A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support.
To enable proactive engagement, the contact list must include at least one phone number.
The contacts that you provide here replace any contacts that were already defined. If you already have contacts
defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then
provide it here.
String attackId
The unique identifier (ID) of the attack.
String resourceArn
The ARN (Amazon Resource Name) of the resource that was attacked.
List<E> subResources
If applicable, additional detail about the resource being attacked, for example, IP address or URL.
Date startTime
The time the attack started, in Unix time in seconds.
Date endTime
The time the attack ended, in Unix time in seconds.
List<E> attackCounters
List of counters that describe the attack for the specified time period.
List<E> attackProperties
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.
List<E> mitigations
List of mitigation actions taken for the attack.
String attackLayer
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.
String attackPropertyIdentifier
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.
List<E> topContributors
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.
String unit
The unit used for the Contributor Value property.
Long total
The total contributions made to this Shield event by all contributors.
AttackVolume attackVolume
Information about the volume of attacks during the time period. If the accompanying AttackCount is
zero, this setting might be empty.
Long attackCount
The number of attacks detected during the time period. This is always present, but might be zero.
String attackId
The unique identifier (ID) of the attack.
String resourceArn
The ARN (Amazon Resource Name) of the resource that was attacked.
Date startTime
The start time of the attack, in Unix time in seconds.
Date endTime
The end time of the attack, in Unix time in seconds.
List<E> attackVectors
The list of attacks for a specified time period.
String vectorType
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
AttackVolumeStatistics bitsPerSecond
A statistics object that uses bits per second as the unit. This is included for network level attacks.
AttackVolumeStatistics packetsPerSecond
A statistics object that uses packets per second as the unit. This is included for network level attacks.
AttackVolumeStatistics requestsPerSecond
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.
Double max
The maximum attack volume observed for the given unit.
String name
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.
Long value
The contribution of this contributor expressed in Protection units. For example 10,000.
String protectionGroupId
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.
String aggregation
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 and origin resources for CloudFront distributions.
String pattern
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 Amazon Resource Names (ARNs), or include all resources of a specified resource type.
String resourceType
The resource type to include in the protection group. All protected resources of this type are included in the
protection group. Newly protected resources of this type are automatically added to the group. You must set this
when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other
Pattern setting.
List<E> members
The Amazon Resource Names (ARNs) 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.
List<E> tags
One or more tag key-value pairs for the protection group.
String name
Friendly name for the Protection you are creating.
String resourceArn
The ARN (Amazon Resource Name) of the resource to be protected.
The ARN should be in one of the following formats:
For an Application Load Balancer:
arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Elastic Load Balancer (Classic Load Balancer):
arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
For an Amazon CloudFront distribution:
arn:aws:cloudfront::account-id:distribution/distribution-id
For an Global Accelerator standard accelerator:
arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
For an Elastic IP address:
arn:aws:ec2:region:account-id:eip-allocation/allocation-id
List<E> tags
One or more tag key-value pairs for the Protection object that is created.
String protectionId
The unique identifier (ID) for the Protection object that is created.
String protectionGroupId
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.
String protectionId
The unique identifier (ID) for the Protection object to be deleted.
String attackId
The unique identifier (ID) for the attack.
AttackDetail attack
The attack that you requested.
String protectionGroupId
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.
ProtectionGroup protectionGroup
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.
String protectionId
The unique identifier (ID) for the Protection object to describe. You must provide either the
ResourceArn of the protected resource or the ProtectionID of the protection, but not
both.
String resourceArn
The ARN (Amazon Resource Name) of the protected Amazon Web Services resource. You must provide either the
ResourceArn of the protected resource or the ProtectionID of the protection, but not
both.
Protection protection
The Protection that you requested.
Subscription subscription
The Shield Advanced subscription details for an account.
String resourceArn
The ARN (Amazon Resource Name) of the protected resource.
String logBucket
The Amazon S3 bucket that contains the logs that you want to share.
String protectionId
The unique identifier (ID) for the Protection object to remove the health check association from.
String healthCheckArn
The Amazon Resource Name (ARN) of the health check that is associated with the protection.
String resourceArn
The ARN (Amazon Resource Name) of the protected resource.
ResponseAction action
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.
String subscriptionState
The status of the subscription.
List<E> resourceArns
The ARN (Amazon Resource Name) of the resource whose protection you want to retrieve.
List<E> protectionNames
The name of the protection that you want to retrieve.
List<E> resourceTypes
The type of protected resource whose protections you want to retrieve.
List<E> protectionGroupIds
The ID of the protection group that you want to retrieve.
List<E> patterns
The pattern specification of the protection groups that you want to retrieve.
List<E> resourceTypes
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.
List<E> aggregations
The aggregation setting of the protection groups that you want to retrieve.
List<E> resourceArns
The ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this blank, all applicable resources for this account will be included.
TimeRange startTime
The start of the time period for the attacks. This is a timestamp type. The request syntax listing
for this call indicates a number type, but you can provide the time in any valid timestamp format setting.
TimeRange endTime
The end of the time period for the attacks. This is a timestamp type. The request syntax listing for
this call indicates a number type, but you can provide the time in any valid timestamp format setting.
String nextToken
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining
available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the
next batch of objects by requesting the list again and providing the token that was returned by the prior call in
your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the
MaxResults setting. Shield Advanced will not return more than MaxResults objects, but
may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
NextToken value.
On your first call to a list operation, leave this setting empty.
Integer maxResults
The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might
return fewer objects than you indicate in this setting, even if more objects are available. If there are more
objects remaining, Shield Advanced will always also return a NextToken value in the response.
The default setting is 20.
List<E> attackSummaries
The attack information for the specified time range.
String nextToken
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining
available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the
next batch of objects by requesting the list again and providing the token that was returned by the prior call in
your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the
MaxResults setting. Shield Advanced will not return more than MaxResults objects, but
may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
NextToken value.
String nextToken
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining
available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the
next batch of objects by requesting the list again and providing the token that was returned by the prior call in
your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the
MaxResults setting. Shield Advanced will not return more than MaxResults objects, but
may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
NextToken value.
On your first call to a list operation, leave this setting empty.
Integer maxResults
The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might
return fewer objects than you indicate in this setting, even if more objects are available. If there are more
objects remaining, Shield Advanced will always also return a NextToken value in the response.
The default setting is 20.
InclusionProtectionGroupFilters inclusionFilters
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 specific pattern or aggregation settings. 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.
List<E> protectionGroups
String nextToken
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining
available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the
next batch of objects by requesting the list again and providing the token that was returned by the prior call in
your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the
MaxResults setting. Shield Advanced will not return more than MaxResults objects, but
may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
NextToken value.
String nextToken
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining
available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the
next batch of objects by requesting the list again and providing the token that was returned by the prior call in
your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the
MaxResults setting. Shield Advanced will not return more than MaxResults objects, but
may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
NextToken value.
On your first call to a list operation, leave this setting empty.
Integer maxResults
The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might
return fewer objects than you indicate in this setting, even if more objects are available. If there are more
objects remaining, Shield Advanced will always also return a NextToken value in the response.
The default setting is 20.
InclusionProtectionFilters inclusionFilters
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.
List<E> protections
The array of enabled Protection objects.
String nextToken
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining
available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the
next batch of objects by requesting the list again and providing the token that was returned by the prior call in
your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the
MaxResults setting. Shield Advanced will not return more than MaxResults objects, but
may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
NextToken value.
String protectionGroupId
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.
String nextToken
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining
available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the
next batch of objects by requesting the list again and providing the token that was returned by the prior call in
your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the
MaxResults setting. Shield Advanced will not return more than MaxResults objects, but
may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
NextToken value.
On your first call to a list operation, leave this setting empty.
Integer maxResults
The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might
return fewer objects than you indicate in this setting, even if more objects are available. If there are more
objects remaining, Shield Advanced will always also return a NextToken value in the response.
The default setting is 20.
List<E> resourceArns
The Amazon Resource Names (ARNs) of the resources that are included in the protection group.
String nextToken
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining
available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the
next batch of objects by requesting the list again and providing the token that was returned by the prior call in
your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the
MaxResults setting. Shield Advanced will not return more than MaxResults objects, but
may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
NextToken value.
String resourceARN
The Amazon Resource Name (ARN) of the resource to get tags for.
String mitigationName
The name of the mitigation taken for this attack.
String id
The unique identifier (ID) of the protection.
String name
The name of the protection. For example, My CloudFront distributions.
String resourceArn
The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.
List<E> healthCheckIds
The unique identifier (ID) for the Route 53 health check that's associated with the protection.
String protectionArn
The ARN (Amazon Resource Name) of the protection.
ApplicationLayerAutomaticResponseConfiguration applicationLayerAutomaticResponseConfiguration
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.
String protectionGroupId
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.
String aggregation
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.
String pattern
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.
String resourceType
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.
List<E> members
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.
String protectionGroupArn
The ARN (Amazon Resource Name) of the protection group.
Long maxMembers
The maximum number of resources you can specify for a single arbitrary pattern in a protection group.
Long maxProtectionGroups
The maximum number of protection groups that you can have at one time.
ProtectionGroupPatternTypeLimits patternTypeLimits
Limits settings by pattern type in the protection groups for your subscription.
ProtectionGroupArbitraryPatternLimits arbitraryPatternLimits
Limits settings on protection groups with arbitrary pattern type.
String resourceType
The type of resource that already exists.
String resourceType
Type of resource.
BlockAction block
Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.
You must specify exactly one action, either Block or Count.
CountAction count
Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.
You must specify exactly one action, either Block or Count.
Date startTime
The start time of the subscription, in Unix time in seconds.
Date endTime
The date and time your subscription will end.
Long timeCommitmentInSeconds
The length, in seconds, of the Shield Advanced subscription for the account.
String autoRenew
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.
List<E> limits
Specifies how many protections of a given type you can create.
String proactiveEngagementStatus
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.
SubscriptionLimits subscriptionLimits
Limits settings for your subscription.
String subscriptionArn
The ARN (Amazon Resource Name) of the subscription.
ProtectionLimits protectionLimits
Limits settings on protections for your subscription.
ProtectionGroupLimits protectionGroupLimits
Limits settings on protection groups for your subscription.
String name
The counter name.
Double max
The maximum value of the counter for a specified time period.
Double average
The average value of the counter for a specified time period.
Double sum
The total of counter values for a specified time period.
Integer n
The number of counters for a specified time period.
String unit
The unit of the counters.
String key
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.
String value
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.
String resourceArn
The ARN (Amazon Resource Name) of the resource.
ResponseAction action
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.
List<E> emergencyContactList
A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
If you have proactive engagement enabled, the contact list must include at least one phone number.
String protectionGroupId
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.
String aggregation
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.
String pattern
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 Amazon Resource Names (ARNs), or include all resources of a specified resource type.
String resourceType
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.
List<E> members
The Amazon Resource Names (ARNs) 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.
String autoRenew
When you initally create a subscription, AutoRenew is set to ENABLED. If
ENABLED, the subscription will be automatically renewed at the end of the existing subscription
period. 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.
Copyright © 2024. All rights reserved.