@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSShield extends Object implements AWSShield
AWSShield
. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateDRTLogBucketResult |
associateDRTLogBucket(AssociateDRTLogBucketRequest request)
Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as
Application Load Balancer access logs, CloudFront logs, or logs from third party sources.
|
AssociateDRTRoleResult |
associateDRTRole(AssociateDRTRoleRequest request)
Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to
assist with DDoS attack mitigation during potential attacks.
|
AssociateHealthCheckResult |
associateHealthCheck(AssociateHealthCheckRequest request)
Adds health-based detection to the Shield Advanced protection for a resource.
|
AssociateProactiveEngagementDetailsResult |
associateProactiveEngagementDetails(AssociateProactiveEngagementDetailsRequest request)
Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use.
|
CreateProtectionResult |
createProtection(CreateProtectionRequest request)
Enables Shield Advanced for a specific Amazon Web Services resource.
|
CreateProtectionGroupResult |
createProtectionGroup(CreateProtectionGroupRequest request)
Creates a grouping of protected resources so they can be handled as a collective.
|
CreateSubscriptionResult |
createSubscription(CreateSubscriptionRequest request)
Activates Shield Advanced for an account.
|
DeleteProtectionResult |
deleteProtection(DeleteProtectionRequest request)
Deletes an Shield Advanced Protection.
|
DeleteProtectionGroupResult |
deleteProtectionGroup(DeleteProtectionGroupRequest request)
Removes the specified protection group.
|
DeleteSubscriptionResult |
deleteSubscription(DeleteSubscriptionRequest request)
Deprecated.
|
DescribeAttackResult |
describeAttack(DescribeAttackRequest request)
Describes the details of a DDoS attack.
|
DescribeAttackStatisticsResult |
describeAttackStatistics(DescribeAttackStatisticsRequest request)
Provides information about the number and type of attacks Shield has detected in the last year for all resources
that belong to your account, regardless of whether you've defined Shield protections for them.
|
DescribeDRTAccessResult |
describeDRTAccess(DescribeDRTAccessRequest request)
Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your
Amazon Web Services account while assisting with attack mitigation.
|
DescribeEmergencyContactSettingsResult |
describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest request)
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.
|
DescribeProtectionResult |
describeProtection(DescribeProtectionRequest request)
Lists the details of a Protection object.
|
DescribeProtectionGroupResult |
describeProtectionGroup(DescribeProtectionGroupRequest request)
Returns the specification for the specified protection group.
|
DescribeSubscriptionResult |
describeSubscription(DescribeSubscriptionRequest request)
Provides details about the Shield Advanced subscription for an account.
|
DisableApplicationLayerAutomaticResponseResult |
disableApplicationLayerAutomaticResponse(DisableApplicationLayerAutomaticResponseRequest request)
Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource.
|
DisableProactiveEngagementResult |
disableProactiveEngagement(DisableProactiveEngagementRequest request)
Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to
initiate proactive customer support.
|
DisassociateDRTLogBucketResult |
disassociateDRTLogBucket(DisassociateDRTLogBucketRequest request)
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you
shared previously.
|
DisassociateDRTRoleResult |
disassociateDRTRole(DisassociateDRTRoleRequest request)
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
|
DisassociateHealthCheckResult |
disassociateHealthCheck(DisassociateHealthCheckRequest request)
Removes health-based detection from the Shield Advanced protection for a resource.
|
EnableApplicationLayerAutomaticResponseResult |
enableApplicationLayerAutomaticResponse(EnableApplicationLayerAutomaticResponseRequest request)
Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.
|
EnableProactiveEngagementResult |
enableProactiveEngagement(EnableProactiveEngagementRequest request)
Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT
and to initiate proactive customer support.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetSubscriptionStateResult |
getSubscriptionState(GetSubscriptionStateRequest request)
Returns the
SubscriptionState , either Active or Inactive . |
ListAttacksResult |
listAttacks(ListAttacksRequest request)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
|
ListProtectionGroupsResult |
listProtectionGroups(ListProtectionGroupsRequest request)
Retrieves ProtectionGroup objects for the account.
|
ListProtectionsResult |
listProtections(ListProtectionsRequest request)
Retrieves Protection objects for the account.
|
ListResourcesInProtectionGroupResult |
listResourcesInProtectionGroup(ListResourcesInProtectionGroupRequest request)
Retrieves the resources that are included in the protection group.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("shield.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSShield.setEndpoint(String) , sets the regional endpoint for this client's service
calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds or updates tags for a resource in Shield.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from a resource in Shield.
|
UpdateApplicationLayerAutomaticResponseResult |
updateApplicationLayerAutomaticResponse(UpdateApplicationLayerAutomaticResponseRequest request)
Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified
resource.
|
UpdateEmergencyContactSettingsResult |
updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest request)
Updates the details of the 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.
|
UpdateProtectionGroupResult |
updateProtectionGroup(UpdateProtectionGroupRequest request)
Updates an existing protection group.
|
UpdateSubscriptionResult |
updateSubscription(UpdateSubscriptionRequest request)
Updates the details of an existing subscription.
|
public void setEndpoint(String endpoint)
AWSShield
Callers can pass in just the endpoint (ex: "shield.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "shield.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSShield
endpoint
- The endpoint (ex: "shield.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"shield.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.public void setRegion(Region region)
AWSShield
AWSShield.setEndpoint(String)
, sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSShield
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AssociateDRTLogBucketResult associateDRTLogBucket(AssociateDRTLogBucketRequest request)
AWSShield
Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the SRT and make an AssociateDRTLogBucket
request, you must be subscribed to
the Business Support plan or the Enterprise Support plan.
associateDRTLogBucket
in interface AWSShield
public AssociateDRTRoleResult associateDRTRole(AssociateDRTRoleRequest request)
AWSShield
Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.
You can associate only one RoleArn
with your subscription. If you submit an
AssociateDRTRole
request for an account that already has an associated role, the new
RoleArn
will replace the existing RoleArn
.
Prior to making the AssociateDRTRole
request, you must attach the
AWSShieldDRTAccessPolicy
managed policy to the role that you'll specify in the request. You can
access this policy in the IAM console at AWSShieldDRTAccessPolicy. For more information see Adding and
removing IAM identity permissions. The role must also trust the service principal
drt.shield.amazonaws.com
. For more information, see IAM JSON
policy elements: Principal.
The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.
You must have the iam:PassRole
permission to make an AssociateDRTRole
request. For more
information, see Granting a
user permissions to pass a role to an Amazon Web Services service.
To use the services of the SRT and make an AssociateDRTRole
request, you must be subscribed to the
Business Support plan or the Enterprise Support plan.
associateDRTRole
in interface AWSShield
public AssociateHealthCheckResult associateHealthCheck(AssociateHealthCheckRequest request)
AWSShield
Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
associateHealthCheck
in interface AWSShield
public AssociateProactiveEngagementDetailsResult associateProactiveEngagementDetails(AssociateProactiveEngagementDetailsRequest request)
AWSShield
Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list.
After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use
the calls DisableProactiveEngagement
and EnableProactiveEngagement
.
This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.
The contacts that you provide in the request 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 to this call.
associateProactiveEngagementDetails
in interface AWSShield
public CreateProtectionResult createProtection(CreateProtectionRequest request)
AWSShield
Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
You can add protection to only a single resource with each CreateProtection
request. You can add
protection to multiple resources at once through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For
more information see Getting Started with
Shield Advanced and Adding Shield Advanced
protection to Amazon Web Services resources.
createProtection
in interface AWSShield
public CreateProtectionGroupResult createProtectionGroup(CreateProtectionGroupRequest request)
AWSShield
Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
createProtectionGroup
in interface AWSShield
public CreateSubscriptionResult createSubscription(CreateSubscriptionRequest request)
AWSShield
Activates Shield Advanced for an account.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
When you initially create a subscription, your subscription is set to be automatically renewed at the end of the
existing subscription period. You can change this by submitting an UpdateSubscription
request.
createSubscription
in interface AWSShield
public DeleteProtectionResult deleteProtection(DeleteProtectionRequest request)
AWSShield
Deletes an Shield Advanced Protection.
deleteProtection
in interface AWSShield
public DeleteProtectionGroupResult deleteProtectionGroup(DeleteProtectionGroupRequest request)
AWSShield
Removes the specified protection group.
deleteProtectionGroup
in interface AWSShield
@Deprecated public DeleteSubscriptionResult deleteSubscription(DeleteSubscriptionRequest request)
AWSShield
Removes Shield Advanced from an account. Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.
deleteSubscription
in interface AWSShield
public DescribeAttackResult describeAttack(DescribeAttackRequest request)
AWSShield
Describes the details of a DDoS attack.
describeAttack
in interface AWSShield
public DescribeAttackStatisticsResult describeAttackStatistics(DescribeAttackStatisticsRequest request)
AWSShield
Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.
The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example,
if the current time is 2020-10-26 15:39:32 PDT
, equal to 2020-10-26 22:39:32 UTC
, then
the time range for the attack data returned is from 2019-10-26 00:00:00 UTC
to
2020-10-26 00:00:00 UTC
.
The time range indicates the period covered by the attack statistics data items.
describeAttackStatistics
in interface AWSShield
public DescribeDRTAccessResult describeDRTAccess(DescribeDRTAccessRequest request)
AWSShield
Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation.
describeDRTAccess
in interface AWSShield
public DescribeEmergencyContactSettingsResult describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest request)
AWSShield
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.
describeEmergencyContactSettings
in interface AWSShield
public DescribeProtectionResult describeProtection(DescribeProtectionRequest request)
AWSShield
Lists the details of a Protection object.
describeProtection
in interface AWSShield
public DescribeProtectionGroupResult describeProtectionGroup(DescribeProtectionGroupRequest request)
AWSShield
Returns the specification for the specified protection group.
describeProtectionGroup
in interface AWSShield
public DescribeSubscriptionResult describeSubscription(DescribeSubscriptionRequest request)
AWSShield
Provides details about the Shield Advanced subscription for an account.
describeSubscription
in interface AWSShield
public DisableApplicationLayerAutomaticResponseResult disableApplicationLayerAutomaticResponse(DisableApplicationLayerAutomaticResponseRequest request)
AWSShield
Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource.
disableApplicationLayerAutomaticResponse
in interface AWSShield
public DisableProactiveEngagementResult disableProactiveEngagement(DisableProactiveEngagementRequest request)
AWSShield
Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
disableProactiveEngagement
in interface AWSShield
public DisassociateDRTLogBucketResult disassociateDRTLogBucket(DisassociateDRTLogBucketRequest request)
AWSShield
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
disassociateDRTLogBucket
in interface AWSShield
public DisassociateDRTRoleResult disassociateDRTRole(DisassociateDRTRoleRequest request)
AWSShield
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
disassociateDRTRole
in interface AWSShield
public DisassociateHealthCheckResult disassociateHealthCheck(DisassociateHealthCheckRequest request)
AWSShield
Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
disassociateHealthCheck
in interface AWSShield
public EnableApplicationLayerAutomaticResponseResult enableApplicationLayerAutomaticResponse(EnableApplicationLayerAutomaticResponseRequest request)
AWSShield
Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.
This feature is available for Amazon CloudFront distributions and Application Load Balancers only.
This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated with the resource. For information about how automatic mitigation works and the requirements for using it, see Shield Advanced automatic application layer DDoS mitigation.
Don't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse.
To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, see Getting Started with Shield Advanced. You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see WAF Developer Guide.
enableApplicationLayerAutomaticResponse
in interface AWSShield
public EnableProactiveEngagementResult enableProactiveEngagement(EnableProactiveEngagementRequest request)
AWSShield
Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
enableProactiveEngagement
in interface AWSShield
public GetSubscriptionStateResult getSubscriptionState(GetSubscriptionStateRequest request)
AWSShield
Returns the SubscriptionState
, either Active
or Inactive
.
getSubscriptionState
in interface AWSShield
public ListAttacksResult listAttacks(ListAttacksRequest request)
AWSShield
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
listAttacks
in interface AWSShield
public ListProtectionGroupsResult listProtectionGroups(ListProtectionGroupsRequest request)
AWSShield
Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.
listProtectionGroups
in interface AWSShield
public ListProtectionsResult listProtections(ListProtectionsRequest request)
AWSShield
Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.
listProtections
in interface AWSShield
public ListResourcesInProtectionGroupResult listResourcesInProtectionGroup(ListResourcesInProtectionGroupRequest request)
AWSShield
Retrieves the resources that are included in the protection group.
listResourcesInProtectionGroup
in interface AWSShield
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSShield
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
listTagsForResource
in interface AWSShield
public TagResourceResult tagResource(TagResourceRequest request)
AWSShield
Adds or updates tags for a resource in Shield.
tagResource
in interface AWSShield
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSShield
Removes tags from a resource in Shield.
untagResource
in interface AWSShield
public UpdateApplicationLayerAutomaticResponseResult updateApplicationLayerAutomaticResponse(UpdateApplicationLayerAutomaticResponseRequest request)
AWSShield
Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
updateApplicationLayerAutomaticResponse
in interface AWSShield
public UpdateEmergencyContactSettingsResult updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest request)
AWSShield
Updates the details of the 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.
updateEmergencyContactSettings
in interface AWSShield
public UpdateProtectionGroupResult updateProtectionGroup(UpdateProtectionGroupRequest request)
AWSShield
Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
updateProtectionGroup
in interface AWSShield
public UpdateSubscriptionResult updateSubscription(UpdateSubscriptionRequest request)
AWSShield
Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
updateSubscription
in interface AWSShield
public void shutdown()
AWSShield
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSShield
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSShield
request
- The originally executed request.