com.amazonaws.services.cloudformation
Interface AmazonCloudFormationAsync

All Superinterfaces:

AmazonCloudFormation

All Known Implementing Classes:

AmazonCloudFormationAsyncClient

public interface AmazonCloudFormationAsync
extends AmazonCloudFormation

Interface for accessing AmazonCloudFormation asynchronously, using Java Futures. 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/.

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.
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 interface com.amazonaws.services.cloudformation.AmazonCloudFormation

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

Method Detail

createStackAsync

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.

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

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

Validates a specified template.

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

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.

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

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.

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

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.

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

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.

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

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.

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.