com.amazonaws.services.cloudformation
Class AmazonCloudFormationAsyncClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.cloudformation.AmazonCloudFormationClient
          com.amazonaws.services.cloudformation.AmazonCloudFormationAsyncClient

All Implemented Interfaces:

AmazonCloudFormation, AmazonCloudFormationAsync

public class AmazonCloudFormationAsyncClient
extends AmazonCloudFormationClient
implements AmazonCloudFormationAsync

Client for accessing AmazonCloudFormation. All calls made using this client are non-blocking and will immediately return a Java Future. Callers must use the Future object to determine when the service call has actually completed. AWS CloudFormation

This is the AWS CloudFormation API Reference. The major sections of this guide are described in the following table.

Actions Alphabetical list of CloudFormation actions Data Types Alphabetical list of CloudFormation data types Common Parameters Parameters that all Query actions can use Common Errors Client and server errors that all actions can return

This guide is for programmers who need detailed information about the CloudFormation APIs. You use AWS CloudFormation to create and manage AWS infrastructure deployments predictably and repeatedly. CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applications without worrying about creating and configuring the underlying the AWS infrastructure.

Through the use of a template file you write, and a few AWS CloudFormation commands or API actions, AWS CloudFormation enables you to manage a collection of resources together as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.

For more information about this product, go to the CloudFormation Product Page .

Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.

Constructor Summary

AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials.

AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials, executor service, and client configuration options.

AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials and executor service.

Method Summary

Future<CreateStackResult>	createStackAsync(CreateStackRequest createStackRequest) Creates a stack as specified in the template.
Future<Void>	deleteStackAsync(DeleteStackRequest deleteStackRequest) Deletes a specified stack.
Future<DescribeStackEventsResult>	describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest) Returns all the stack related events for the AWS account.
Future<DescribeStackResourcesResult>	describeStackResourcesAsync(DescribeStackResourcesRequest describeStackResourcesRequest) Returns AWS resource descriptions.
Future<DescribeStacksResult>	describeStacksAsync(DescribeStacksRequest describeStacksRequest) Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
Future<GetTemplateResult>	getTemplateAsync(GetTemplateRequest getTemplateRequest) Returns the template body for a specified stack name.
Future<ValidateTemplateResult>	validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest) Validates a specified template.

Methods inherited from class com.amazonaws.services.cloudformation.AmazonCloudFormationClient

addRequestHandler, createStack, deleteStack, describeStackEvents, describeStackEvents, describeStackResources, describeStackResources, describeStacks, describeStacks, getCachedResponseMetadata, getTemplate, validateTemplate, validateTemplate

Methods inherited from class com.amazonaws.AmazonWebServiceClient

setEndpoint, shutdown

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.cloudformation.AmazonCloudFormation

createStack, deleteStack, describeStackEvents, describeStackEvents, describeStackResources, describeStackResources, describeStacks, describeStacks, getCachedResponseMetadata, getTemplate, setEndpoint, shutdown, validateTemplate, validateTemplate

Constructor Detail

AmazonCloudFormationAsyncClient

public AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials. Default client settings will be used, and a default cached thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

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

AmazonCloudFormationAsyncClient

public AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials,
                                       ExecutorService executorService)

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

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

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.

AmazonCloudFormationAsyncClient

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

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

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

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.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

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

Returns:

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

createStackAsync

public Future<CreateStackResult> createStackAsync(CreateStackRequest createStackRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

Creates a stack as specified in the template. Once the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.

NOTE: Currently, the limit for stacks is 20 stacks per account per region.

Specified by:

createStackAsync in interface AmazonCloudFormationAsync

Parameters:

createStackRequest - Container for the necessary parameters to execute the CreateStack operation on AmazonCloudFormation.

Returns:

A Java Future object containing the response from the CreateStack service method, as returned by AmazonCloudFormation.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudFormation indicating either a problem with the data in the request, or a server side issue.

validateTemplateAsync

public Future<ValidateTemplateResult> validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest)
                                                     throws AmazonServiceException,
                                                            AmazonClientException

Validates a specified template.

Specified by:

validateTemplateAsync in interface AmazonCloudFormationAsync

Parameters:

validateTemplateRequest - Container for the necessary parameters to execute the ValidateTemplate operation on AmazonCloudFormation.

Returns:

A Java Future object containing the response from the ValidateTemplate service method, as returned by AmazonCloudFormation.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudFormation indicating either a problem with the data in the request, or a server side issue.

describeStacksAsync

public Future<DescribeStacksResult> describeStacksAsync(DescribeStacksRequest describeStacksRequest)
                                                 throws AmazonServiceException,
                                                        AmazonClientException

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

Specified by:

describeStacksAsync in interface AmazonCloudFormationAsync

Parameters:

describeStacksRequest - Container for the necessary parameters to execute the DescribeStacks operation on AmazonCloudFormation.

Returns:

A Java Future object containing the response from the DescribeStacks service method, as returned by AmazonCloudFormation.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudFormation indicating either a problem with the data in the request, or a server side issue.

describeStackEventsAsync

public Future<DescribeStackEventsResult> describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest)
                                                           throws AmazonServiceException,
                                                                  AmazonClientException

Returns all the stack related events for the AWS account. If StackName is specified, returns events related to all the stacks with the given name. If StackName is not specified, returns all the events for the account. For more information about a stack's event history, go to the AWS CloudFormation User Guide .

NOTE:Events are returned, even if the stack never existed or has been successfully deleted.

Specified by:

describeStackEventsAsync in interface AmazonCloudFormationAsync

Parameters:

describeStackEventsRequest - Container for the necessary parameters to execute the DescribeStackEvents operation on AmazonCloudFormation.

Returns:

A Java Future object containing the response from the DescribeStackEvents service method, as returned by AmazonCloudFormation.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudFormation indicating either a problem with the data in the request, or a server side issue.

getTemplateAsync

public Future<GetTemplateResult> getTemplateAsync(GetTemplateRequest getTemplateRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

Returns the template body for a specified stack name.

NOTE: If the template does not exist, a ValidationError is returned.

Specified by:

getTemplateAsync in interface AmazonCloudFormationAsync

Parameters:

getTemplateRequest - Container for the necessary parameters to execute the GetTemplate operation on AmazonCloudFormation.

Returns:

A Java Future object containing the response from the GetTemplate service method, as returned by AmazonCloudFormation.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudFormation indicating either a problem with the data in the request, or a server side issue.

deleteStackAsync

public Future<Void> deleteStackAsync(DeleteStackRequest deleteStackRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.

Specified by:

deleteStackAsync in interface AmazonCloudFormationAsync

Parameters:

deleteStackRequest - Container for the necessary parameters to execute the DeleteStack operation on AmazonCloudFormation.

Returns:

A Java Future object containing the response from the DeleteStack service method, as returned by AmazonCloudFormation.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudFormation indicating either a problem with the data in the request, or a server side issue.

describeStackResourcesAsync

public Future<DescribeStackResourcesResult> describeStackResourcesAsync(DescribeStackResourcesRequest describeStackResourcesRequest)
                                                                 throws AmazonServiceException,
                                                                        AmazonClientException

Returns AWS resource descriptions. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, all the associated resources of the stack the resource belongs to are returned.

You must specify StackName or PhysicalResourceId. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId , go to the AWS CloudFormation User Guide .

NOTE: A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.

Specified by:

describeStackResourcesAsync in interface AmazonCloudFormationAsync

Parameters:

describeStackResourcesRequest - Container for the necessary parameters to execute the DescribeStackResources operation on AmazonCloudFormation.

Returns:

A Java Future object containing the response from the DescribeStackResources service method, as returned by AmazonCloudFormation.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudFormation indicating either a problem with the data in the request, or a server side issue.