com.amazonaws.services.shield

Class AWSShieldAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.shield.AWSShieldClient

com.amazonaws.services.shield.AWSShieldAsyncClient

All Implemented Interfaces:

AWSShield, AWSShieldAsync

@ThreadSafe
public class AWSShieldAsyncClient
extends AWSShieldClient
implements AWSShieldAsync

Client for accessing AWS Shield asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

AWS Shield Advanced

This is the AWS Shield Advanced API Reference. This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.shield.AWSShield

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSShieldAsyncClient() Constructs a new asynchronous client to invoke service methods on AWS Shield.
AWSShieldAsyncClient(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on AWS Shield using the specified AWS account credentials.
AWSShieldAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AWS Shield using the specified AWS account credentials, executor service, and client configuration options.
AWSShieldAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AWS Shield using the specified AWS account credentials and executor service.
AWSShieldAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on AWS Shield using the specified AWS account credentials provider.
AWSShieldAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AWS Shield using the provided AWS account credentials provider and client configuration options.
AWSShieldAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AWS Shield using the specified AWS account credentials provider, executor service, and client configuration options.
AWSShieldAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AWS Shield using the specified AWS account credentials provider and executor service.
AWSShieldAsyncClient(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AWS Shield.

Method Summary

Modifier and Type	Method and Description
Future<CreateProtectionResult>	createProtectionAsync(CreateProtectionRequest request) Enables AWS Shield Advanced for a specific AWS resource.
Future<CreateProtectionResult>	createProtectionAsync(CreateProtectionRequest request, AsyncHandler<CreateProtectionRequest,CreateProtectionResult> asyncHandler) Enables AWS Shield Advanced for a specific AWS resource.
Future<CreateSubscriptionResult>	createSubscriptionAsync(CreateSubscriptionRequest request) Activates AWS Shield Advanced for an account.
Future<CreateSubscriptionResult>	createSubscriptionAsync(CreateSubscriptionRequest request, AsyncHandler<CreateSubscriptionRequest,CreateSubscriptionResult> asyncHandler) Activates AWS Shield Advanced for an account.
Future<DeleteProtectionResult>	deleteProtectionAsync(DeleteProtectionRequest request) Deletes an AWS Shield Advanced Protection.
Future<DeleteProtectionResult>	deleteProtectionAsync(DeleteProtectionRequest request, AsyncHandler<DeleteProtectionRequest,DeleteProtectionResult> asyncHandler) Deletes an AWS Shield Advanced Protection.
Future<DeleteSubscriptionResult>	deleteSubscriptionAsync(DeleteSubscriptionRequest request) Removes AWS Shield Advanced from an account.
Future<DeleteSubscriptionResult>	deleteSubscriptionAsync(DeleteSubscriptionRequest request, AsyncHandler<DeleteSubscriptionRequest,DeleteSubscriptionResult> asyncHandler) Removes AWS Shield Advanced from an account.
Future<DescribeAttackResult>	describeAttackAsync(DescribeAttackRequest request) Describes the details of a DDoS attack.
Future<DescribeAttackResult>	describeAttackAsync(DescribeAttackRequest request, AsyncHandler<DescribeAttackRequest,DescribeAttackResult> asyncHandler) Describes the details of a DDoS attack.
Future<DescribeProtectionResult>	describeProtectionAsync(DescribeProtectionRequest request) Lists the details of a Protection object.
Future<DescribeProtectionResult>	describeProtectionAsync(DescribeProtectionRequest request, AsyncHandler<DescribeProtectionRequest,DescribeProtectionResult> asyncHandler) Lists the details of a Protection object.
Future<DescribeSubscriptionResult>	describeSubscriptionAsync(DescribeSubscriptionRequest request) Provides details about the AWS Shield Advanced subscription for an account.
Future<DescribeSubscriptionResult>	describeSubscriptionAsync(DescribeSubscriptionRequest request, AsyncHandler<DescribeSubscriptionRequest,DescribeSubscriptionResult> asyncHandler) Provides details about the AWS Shield Advanced subscription for an account.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ListAttacksResult>	listAttacksAsync(ListAttacksRequest request) Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
Future<ListAttacksResult>	listAttacksAsync(ListAttacksRequest request, AsyncHandler<ListAttacksRequest,ListAttacksResult> asyncHandler) Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
Future<ListProtectionsResult>	listProtectionsAsync(ListProtectionsRequest request) Lists all Protection objects for the account.
Future<ListProtectionsResult>	listProtectionsAsync(ListProtectionsRequest request, AsyncHandler<ListProtectionsRequest,ListProtectionsResult> asyncHandler) Lists all Protection objects for the account.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.shield.AWSShieldClient

createProtection, createSubscription, deleteProtection, deleteSubscription, describeAttack, describeProtection, describeSubscription, getCachedResponseMetadata, listAttacks, listProtections

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.shield.AWSShield

createProtection, createSubscription, deleteProtection, deleteSubscription, describeAttack, describeProtection, describeSubscription, getCachedResponseMetadata, listAttacks, listProtections, setEndpoint, setRegion

Constructor Detail

AWSShieldAsyncClient

public AWSShieldAsyncClient()

Constructs a new asynchronous client to invoke service methods on AWS Shield. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AWSShieldAsyncClient

public AWSShieldAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AWS Shield. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWS Shield (ex: proxy settings, retry counts, etc).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AWSShieldAsyncClient

public AWSShieldAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on AWS Shield using the specified AWS account credentials.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

See Also:

Executors.newFixedThreadPool(int)

AWSShieldAsyncClient

public AWSShieldAsyncClient(AWSCredentials awsCredentials,
                            ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AWS Shield using the specified AWS account credentials and executor service. Default client settings will be used.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AWSShieldAsyncClient

public AWSShieldAsyncClient(AWSCredentials awsCredentials,
                            ClientConfiguration clientConfiguration,
                            ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AWS Shield using the specified AWS account credentials, executor service, and client configuration options.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AWSShieldAsyncClient

public AWSShieldAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AWS Shield using the specified AWS account credentials provider. Default client settings will be used.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

See Also:

Executors.newFixedThreadPool(int)

AWSShieldAsyncClient

public AWSShieldAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AWS Shield using the provided AWS account credentials provider and client configuration options.

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AWSShieldAsyncClient

public AWSShieldAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                            ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AWS Shield using the specified AWS account credentials provider and executor service. Default client settings will be used.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AWSShieldAsyncClient

public AWSShieldAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration,
                            ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AWS Shield using the specified AWS account credentials provider, executor service, and client configuration options.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

createProtectionAsync

public Future<CreateProtectionResult> createProtectionAsync(CreateProtectionRequest request)

Description copied from interface: AWSShieldAsync

Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, or an Amazon Route 53 hosted zone.

Specified by:

createProtectionAsync in interface AWSShieldAsync

Returns:

A Java Future containing the result of the CreateProtection operation returned by the service.

See Also:

AWS API Documentation

createProtectionAsync

public Future<CreateProtectionResult> createProtectionAsync(CreateProtectionRequest request,
                                                            AsyncHandler<CreateProtectionRequest,CreateProtectionResult> asyncHandler)

Description copied from interface: AWSShieldAsync

Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, or an Amazon Route 53 hosted zone.

Specified by:

createProtectionAsync in interface AWSShieldAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateProtection operation returned by the service.

See Also:

AWS API Documentation

createSubscriptionAsync

public Future<CreateSubscriptionResult> createSubscriptionAsync(CreateSubscriptionRequest request)

Description copied from interface: AWSShieldAsync

Activates AWS Shield Advanced for an account.

Specified by:

createSubscriptionAsync in interface AWSShieldAsync

Returns:

A Java Future containing the result of the CreateSubscription operation returned by the service.

See Also:

AWS API Documentation

createSubscriptionAsync

public Future<CreateSubscriptionResult> createSubscriptionAsync(CreateSubscriptionRequest request,
                                                                AsyncHandler<CreateSubscriptionRequest,CreateSubscriptionResult> asyncHandler)

Description copied from interface: AWSShieldAsync

Activates AWS Shield Advanced for an account.

Specified by:

createSubscriptionAsync in interface AWSShieldAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateSubscription operation returned by the service.

See Also:

AWS API Documentation

deleteProtectionAsync

public Future<DeleteProtectionResult> deleteProtectionAsync(DeleteProtectionRequest request)

Description copied from interface: AWSShieldAsync

Deletes an AWS Shield Advanced Protection.

Specified by:

deleteProtectionAsync in interface AWSShieldAsync

Returns:

A Java Future containing the result of the DeleteProtection operation returned by the service.

See Also:

AWS API Documentation

deleteProtectionAsync

public Future<DeleteProtectionResult> deleteProtectionAsync(DeleteProtectionRequest request,
                                                            AsyncHandler<DeleteProtectionRequest,DeleteProtectionResult> asyncHandler)

Description copied from interface: AWSShieldAsync

Deletes an AWS Shield Advanced Protection.

Specified by:

deleteProtectionAsync in interface AWSShieldAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteProtection operation returned by the service.

See Also:

AWS API Documentation

deleteSubscriptionAsync

public Future<DeleteSubscriptionResult> deleteSubscriptionAsync(DeleteSubscriptionRequest request)

Description copied from interface: AWSShieldAsync

Removes AWS Shield Advanced from an account.

Specified by:

deleteSubscriptionAsync in interface AWSShieldAsync

Returns:

A Java Future containing the result of the DeleteSubscription operation returned by the service.

See Also:

AWS API Documentation

deleteSubscriptionAsync

public Future<DeleteSubscriptionResult> deleteSubscriptionAsync(DeleteSubscriptionRequest request,
                                                                AsyncHandler<DeleteSubscriptionRequest,DeleteSubscriptionResult> asyncHandler)

Description copied from interface: AWSShieldAsync

Removes AWS Shield Advanced from an account.

Specified by:

deleteSubscriptionAsync in interface AWSShieldAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteSubscription operation returned by the service.

See Also:

AWS API Documentation

describeAttackAsync

public Future<DescribeAttackResult> describeAttackAsync(DescribeAttackRequest request)

Description copied from interface: AWSShieldAsync

Describes the details of a DDoS attack.

Specified by:

describeAttackAsync in interface AWSShieldAsync

Returns:

A Java Future containing the result of the DescribeAttack operation returned by the service.

See Also:

AWS API Documentation

describeAttackAsync

public Future<DescribeAttackResult> describeAttackAsync(DescribeAttackRequest request,
                                                        AsyncHandler<DescribeAttackRequest,DescribeAttackResult> asyncHandler)

Description copied from interface: AWSShieldAsync

Describes the details of a DDoS attack.

Specified by:

describeAttackAsync in interface AWSShieldAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeAttack operation returned by the service.

See Also:

AWS API Documentation

describeProtectionAsync

public Future<DescribeProtectionResult> describeProtectionAsync(DescribeProtectionRequest request)

Description copied from interface: AWSShieldAsync

Lists the details of a Protection object.

Specified by:

describeProtectionAsync in interface AWSShieldAsync

Returns:

A Java Future containing the result of the DescribeProtection operation returned by the service.

See Also:

AWS API Documentation

describeProtectionAsync

public Future<DescribeProtectionResult> describeProtectionAsync(DescribeProtectionRequest request,
                                                                AsyncHandler<DescribeProtectionRequest,DescribeProtectionResult> asyncHandler)

Description copied from interface: AWSShieldAsync

Lists the details of a Protection object.

Specified by:

describeProtectionAsync in interface AWSShieldAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeProtection operation returned by the service.

See Also:

AWS API Documentation

describeSubscriptionAsync

public Future<DescribeSubscriptionResult> describeSubscriptionAsync(DescribeSubscriptionRequest request)

Description copied from interface: AWSShieldAsync

Provides details about the AWS Shield Advanced subscription for an account.

Specified by:

describeSubscriptionAsync in interface AWSShieldAsync

Returns:

A Java Future containing the result of the DescribeSubscription operation returned by the service.

See Also:

AWS API Documentation

describeSubscriptionAsync

public Future<DescribeSubscriptionResult> describeSubscriptionAsync(DescribeSubscriptionRequest request,
                                                                    AsyncHandler<DescribeSubscriptionRequest,DescribeSubscriptionResult> asyncHandler)

Description copied from interface: AWSShieldAsync

Provides details about the AWS Shield Advanced subscription for an account.

Specified by:

describeSubscriptionAsync in interface AWSShieldAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeSubscription operation returned by the service.

See Also:

AWS API Documentation

listAttacksAsync

public Future<ListAttacksResult> listAttacksAsync(ListAttacksRequest request)

Description copied from interface: AWSShieldAsync

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

Specified by:

listAttacksAsync in interface AWSShieldAsync

Returns:

A Java Future containing the result of the ListAttacks operation returned by the service.

See Also:

AWS API Documentation

listAttacksAsync

public Future<ListAttacksResult> listAttacksAsync(ListAttacksRequest request,
                                                  AsyncHandler<ListAttacksRequest,ListAttacksResult> asyncHandler)

Description copied from interface: AWSShieldAsync

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

Specified by:

listAttacksAsync in interface AWSShieldAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListAttacks operation returned by the service.

See Also:

AWS API Documentation

listProtectionsAsync

public Future<ListProtectionsResult> listProtectionsAsync(ListProtectionsRequest request)

Description copied from interface: AWSShieldAsync

Lists all Protection objects for the account.

Specified by:

listProtectionsAsync in interface AWSShieldAsync

Returns:

A Java Future containing the result of the ListProtections operation returned by the service.

See Also:

AWS API Documentation

listProtectionsAsync

public Future<ListProtectionsResult> listProtectionsAsync(ListProtectionsRequest request,
                                                          AsyncHandler<ListProtectionsRequest,ListProtectionsResult> asyncHandler)

Description copied from interface: AWSShieldAsync

Lists all Protection objects for the account.

Specified by:

listProtectionsAsync in interface AWSShieldAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListProtections operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSShield

Overrides:

shutdown in class AmazonWebServiceClient