String logBucket
The Amazon S3 bucket that contains your AWS WAF logs.
String roleArn
The Amazon Resource Name (ARN) of the role the DRT will use to access your AWS 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 DDoS Response Team (DRT) can use to contact you for escalations to the DRT 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. For more information see timestamp.
Date endTime
The time the attack ended, in Unix time in seconds. For more information see timestamp.
List<E> attackCounters
List of counters that describe the attack for the specified time period.
List<E> attackProperties
The array of AttackProperty objects.
List<E> mitigations
List of mitigation actions taken for the attack.
String attackLayer
The type of distributed denial of service (DDoS) event that was observed. NETWORK indicates layer 3
and layer 4 events and APPLICATION indicates layer 7 events.
String attackPropertyIdentifier
Defines the DDoS attack property information that is provided. The WORDPRESS_PINGBACK_REFLECTOR and
WORDPRESS_PINGBACK_SOURCE values are valid only for WordPress reflective pingback DDoS attacks.
List<E> topContributors
The array of contributor objects that includes the top five contributors to an attack.
String unit
The unit of the Value of the contributions.
Long total
The total contributions made to this attack by all contributors, not just the five listed in the
TopContributors list.
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. For more information see timestamp.
Date endTime
The end time of the attack, in Unix time in seconds. For more information see timestamp.
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. This is dependent on the AttackPropertyIdentifier. 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 AWS 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 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. 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 AWS CloudFront distribution:
arn:aws:cloudfront::account-id:distribution/distribution-id
For an AWS Global Accelerator 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 that to be described.
AttackDetail attack
The attack that is described.
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 AWS 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 that is described. When submitting the
DescribeProtection request you must provide either the ResourceArn or the
ProtectionID, but not both.
String resourceArn
The ARN (Amazon Resource Name) of the AWS resource for the Protection object that is described. When
submitting the DescribeProtection request you must provide either the ResourceArn or
the ProtectionID, but not both.
Protection protection
The Protection object that is described.
Subscription subscription
The AWS Shield Advanced subscription details for an account.
String logBucket
The Amazon S3 bucket that contains your AWS WAF logs.
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 subscriptionState
The status of the subscription.
List<E> resourceArns
The ARN (Amazon Resource Name) of the resource that was attacked. If this is left 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 sample request above
indicates a number type because the default used by WAF is Unix time in seconds. However any valid
timestamp
format is allowed.
TimeRange endTime
The end of the time period for the attacks. This is a timestamp type. The sample request above
indicates a number type because the default used by WAF is Unix time in seconds. However any valid
timestamp
format is allowed.
String nextToken
The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest.
Pass null if this is the first call.
Integer maxResults
The maximum number of AttackSummary objects to return. If you leave this blank, Shield Advanced returns the first 20 results.
This is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of
objects returned could be less than MaxResults, even if there are still more objects yet to return.
If there are more objects to return, Shield Advanced returns a value in NextToken that you can use
in your next request, to get the next batch of objects.
List<E> attackSummaries
The attack information for the specified time range.
String nextToken
The token returned by a previous call to indicate that there is more data available. If not null, more results
are available. Pass this value for the NextMarker parameter in a subsequent call to
ListAttacks to retrieve the next set of items.
Shield Advanced might return the list of AttackSummary objects in batches smaller than the number
specified by MaxResults. If there are more attack summary objects to return, Shield Advanced will always also
return a NextToken.
String nextToken
The next token value from a previous call to ListProtectionGroups. Pass null if this is the first
call.
Integer maxResults
The maximum number of ProtectionGroup objects to return. If you leave this blank, Shield Advanced returns the first 20 results.
This is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of
objects returned could be less than MaxResults, even if there are still more objects yet to return.
If there are more objects to return, Shield Advanced returns a value in NextToken that you can use
in your next request, to get the next batch of objects.
String nextToken
The ListProtectionsRequest.NextToken value from a previous call to ListProtections.
Pass null if this is the first call.
Integer maxResults
The maximum number of Protection objects to return. If you leave this blank, Shield Advanced returns the first 20 results.
This is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of
objects returned could be less than MaxResults, even if there are still more objects yet to return.
If there are more objects to return, Shield Advanced returns a value in NextToken that you can use
in your next request, to get the next batch of objects.
List<E> protections
The array of enabled Protection objects.
String nextToken
If you specify a value for MaxResults and you have more Protections than the value of MaxResults,
AWS Shield Advanced returns a NextToken value in the response that allows you to list another group of
Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the
previous response to get information about another batch of Protections.
Shield Advanced might return the list of Protection objects in batches smaller than the number specified
by MaxResults. If there are more Protection objects to return, Shield Advanced will always also return a
NextToken.
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
The next token value from a previous call to ListResourcesInProtectionGroup. Pass null if this is
the first call.
Integer maxResults
The maximum number of resource ARN objects to return. If you leave this blank, Shield Advanced returns the first 20 results.
This is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of
objects returned could be less than MaxResults, even if there are still more objects yet to return.
If there are more objects to return, Shield Advanced returns a value in NextToken that you can use
in your next request, to get the next batch of objects.
List<E> resourceArns
The Amazon Resource Names (ARNs) of the resources that are included in the protection group.
String nextToken
If you specify a value for MaxResults and you have more resources in the protection group than the
value of MaxResults, AWS Shield Advanced returns this token that you can use in your next request, to get the
next batch of objects.
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 AWS 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.
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 AWS 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 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 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.
Date startTime
The start time of the subscription, in Unix time in seconds. For more information see timestamp.
Date endTime
The date and time your subscription will end.
Long timeCommitmentInSeconds
The length, in seconds, of the AWS 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 DDoS Response Team (DRT) will use email and phone to notify contacts about
escalations to the DRT 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 DRT 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.
List<E> emergencyContactList
A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT 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 AWS 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 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 © 2021. All rights reserved.