@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 DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs.
|
AssociateDRTRoleResult |
associateDRTRole(AssociateDRTRoleRequest request)
Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS 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 DDoS Response Team (DRT) to use.
|
CreateProtectionResult |
createProtection(CreateProtectionRequest request)
Enables AWS Shield Advanced for a specific AWS resource.
|
CreateProtectionGroupResult |
createProtectionGroup(CreateProtectionGroupRequest request)
Creates a grouping of protected resources so they can be handled as a collective.
|
CreateSubscriptionResult |
createSubscription(CreateSubscriptionRequest request)
Activates AWS Shield Advanced for an account.
|
DeleteProtectionResult |
deleteProtection(DeleteProtectionRequest request)
Deletes an AWS 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 AWS 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 DDoS Response Team (DRT) to access your
AWS account while assisting with attack mitigation.
|
DescribeEmergencyContactSettingsResult |
describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest request)
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.
|
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 AWS Shield Advanced subscription for an account.
|
DisableProactiveEngagementResult |
disableProactiveEngagement(DisableProactiveEngagementRequest request)
Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to
initiate proactive customer support.
|
DisassociateDRTLogBucketResult |
disassociateDRTLogBucket(DisassociateDRTLogBucketRequest request)
Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.
|
DisassociateDRTRoleResult |
disassociateDRTRole(DisassociateDRTRoleRequest request)
Removes the DDoS Response Team's (DRT) access to your AWS account.
|
DisassociateHealthCheckResult |
disassociateHealthCheck(DisassociateHealthCheckRequest request)
Removes health-based detection from the Shield Advanced protection for a resource.
|
EnableProactiveEngagementResult |
enableProactiveEngagement(EnableProactiveEngagementRequest request)
Authorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT
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 the ProtectionGroup objects for the account.
|
ListProtectionsResult |
listProtections(ListProtectionsRequest request)
Lists all Protection objects for the account.
|
ListResourcesInProtectionGroupResult |
listResourcesInProtectionGroup(ListResourcesInProtectionGroupRequest request)
Retrieves the resources that are included in the protection group.
|
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.
|
UpdateEmergencyContactSettingsResult |
updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest request)
Updates the details of the 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.
|
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 AWSShieldendpoint - 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)
AWSShieldAWSShield.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 AWSShieldregion - 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)
AWSShieldAuthorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs. You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to
the Business Support plan or the Enterprise Support plan.
associateDRTLogBucket in interface AWSShieldpublic AssociateDRTRoleResult associateDRTRole(AssociateDRTRoleRequest request)
AWSShieldAuthorizes the DDoS Response Team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS 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 you will specify in the request. For more information
see Attaching and
Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com
. For more information, see IAM JSON
Policy Elements: Principal.
The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT 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 AWS Service.
To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the
Business Support plan or the Enterprise Support plan.
associateDRTRole in interface AWSShieldpublic AssociateHealthCheckResult associateHealthCheck(AssociateHealthCheckRequest request)
AWSShieldAdds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.
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 AWS WAF and AWS Shield Developer Guide.
associateHealthCheck in interface AWSShieldpublic AssociateProactiveEngagementDetailsResult associateProactiveEngagementDetails(AssociateProactiveEngagementDetailsRequest request)
AWSShieldInitializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) 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 DDoS Response Team (DRT) can use to contact you for escalations to the DRT 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 AWSShieldpublic CreateProtectionResult createProtection(CreateProtectionRequest request)
AWSShieldEnables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.
You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console. For more information see Getting Started with AWS Shield Advanced and Add AWS Shield Advanced Protection to more AWS Resources.
createProtection in interface AWSShieldpublic CreateProtectionGroupResult createProtectionGroup(CreateProtectionGroupRequest request)
AWSShieldCreates 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 AWSShieldpublic CreateSubscriptionResult createSubscription(CreateSubscriptionRequest request)
AWSShieldActivates AWS Shield Advanced for an account.
When you initally 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 AWSShieldpublic DeleteProtectionResult deleteProtection(DeleteProtectionRequest request)
AWSShieldDeletes an AWS Shield Advanced Protection.
deleteProtection in interface AWSShieldpublic DeleteProtectionGroupResult deleteProtectionGroup(DeleteProtectionGroupRequest request)
AWSShieldRemoves the specified protection group.
deleteProtectionGroup in interface AWSShield@Deprecated public DeleteSubscriptionResult deleteSubscription(DeleteSubscriptionRequest request)
AWSShieldRemoves AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.
deleteSubscription in interface AWSShieldpublic DescribeAttackResult describeAttack(DescribeAttackRequest request)
AWSShieldDescribes the details of a DDoS attack.
describeAttack in interface AWSShieldpublic DescribeAttackStatisticsResult describeAttackStatistics(DescribeAttackStatisticsRequest request)
AWSShieldProvides information about the number and type of attacks AWS 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 AWSShieldpublic DescribeDRTAccessResult describeDRTAccess(DescribeDRTAccessRequest request)
AWSShieldReturns the current role and list of Amazon S3 log buckets used by the DDoS Response Team (DRT) to access your AWS account while assisting with attack mitigation.
describeDRTAccess in interface AWSShieldpublic DescribeEmergencyContactSettingsResult describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest request)
AWSShieldA 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.
describeEmergencyContactSettings in interface AWSShieldpublic DescribeProtectionResult describeProtection(DescribeProtectionRequest request)
AWSShieldLists the details of a Protection object.
describeProtection in interface AWSShieldpublic DescribeProtectionGroupResult describeProtectionGroup(DescribeProtectionGroupRequest request)
AWSShieldReturns the specification for the specified protection group.
describeProtectionGroup in interface AWSShieldpublic DescribeSubscriptionResult describeSubscription(DescribeSubscriptionRequest request)
AWSShieldProvides details about the AWS Shield Advanced subscription for an account.
describeSubscription in interface AWSShieldpublic DisableProactiveEngagementResult disableProactiveEngagement(DisableProactiveEngagementRequest request)
AWSShieldRemoves authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.
disableProactiveEngagement in interface AWSShieldpublic DisassociateDRTLogBucketResult disassociateDRTLogBucket(DisassociateDRTLogBucketRequest request)
AWSShieldRemoves the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.
To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are
not subscribed to one of these support plans, but had been previously and had granted the DRT access to your
account, you can submit a DisassociateDRTLogBucket request to remove this access.
disassociateDRTLogBucket in interface AWSShieldpublic DisassociateDRTRoleResult disassociateDRTRole(DisassociateDRTRoleRequest request)
AWSShieldRemoves the DDoS Response Team's (DRT) access to your AWS account.
To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are
not subscribed to one of these support plans, but had been previously and had granted the DRT access to your
account, you can submit a DisassociateDRTRole request to remove this access.
disassociateDRTRole in interface AWSShieldpublic DisassociateHealthCheckResult disassociateHealthCheck(DisassociateHealthCheckRequest request)
AWSShieldRemoves health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.
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 AWS WAF and AWS Shield Developer Guide.
disassociateHealthCheck in interface AWSShieldpublic EnableProactiveEngagementResult enableProactiveEngagement(EnableProactiveEngagementRequest request)
AWSShieldAuthorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.
enableProactiveEngagement in interface AWSShieldpublic GetSubscriptionStateResult getSubscriptionState(GetSubscriptionStateRequest request)
AWSShield
Returns the SubscriptionState, either Active or Inactive.
getSubscriptionState in interface AWSShieldpublic ListAttacksResult listAttacks(ListAttacksRequest request)
AWSShieldReturns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
listAttacks in interface AWSShieldpublic ListProtectionGroupsResult listProtectionGroups(ListProtectionGroupsRequest request)
AWSShieldRetrieves the ProtectionGroup objects for the account.
listProtectionGroups in interface AWSShieldpublic ListProtectionsResult listProtections(ListProtectionsRequest request)
AWSShieldLists all Protection objects for the account.
listProtections in interface AWSShieldpublic ListResourcesInProtectionGroupResult listResourcesInProtectionGroup(ListResourcesInProtectionGroupRequest request)
AWSShieldRetrieves the resources that are included in the protection group.
listResourcesInProtectionGroup in interface AWSShieldpublic UpdateEmergencyContactSettingsResult updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest request)
AWSShieldUpdates the details of the 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.
updateEmergencyContactSettings in interface AWSShieldpublic UpdateProtectionGroupResult updateProtectionGroup(UpdateProtectionGroupRequest request)
AWSShieldUpdates 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 AWSShieldpublic UpdateSubscriptionResult updateSubscription(UpdateSubscriptionRequest request)
AWSShieldUpdates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
updateSubscription in interface AWSShieldpublic void shutdown()
AWSShieldpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSShieldResponse 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 AWSShieldrequest - The originally executed request.