Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.cloudformation
Class AmazonCloudFormationClient

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceClient
      extended by com.amazonaws.services.cloudformation.AmazonCloudFormationClient
All Implemented Interfaces:
AmazonCloudFormation
Direct Known Subclasses:
AmazonCloudFormationAsyncClient
public class AmazonCloudFormationClient
extends AmazonWebServiceClient
implements AmazonCloudFormation

Client for accessing AmazonCloudFormation. All service calls made using this client are blocking, and will not return until the service call completes.

AWS CloudFormation

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

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
AmazonCloudFormationClient(AWSCredentials awsCredentials)
          Constructs a new client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials.
AmazonCloudFormationClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
          Constructs a new client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials and client configuration options.
AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider)
          Constructs a new client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials provider.
AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
          Constructs a new client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials provider and client configuration options.
 
Method Summary
 CreateStackResult createStack(CreateStackRequest createStackRequest)
           Creates a stack as specified in the template.
 void deleteStack(DeleteStackRequest deleteStackRequest)
           Deletes a specified stack.
 DescribeStackEventsResult describeStackEvents()
           Returns all the stack related events for the AWS account.
 DescribeStackEventsResult describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest)
           Returns all the stack related events for the AWS account.
 DescribeStackResourceResult describeStackResource(DescribeStackResourceRequest describeStackResourceRequest)
           Returns a description of the specified resource in the specified stack.
 DescribeStackResourcesResult describeStackResources()
           Returns AWS resource descriptions for running and deleted stacks.
 DescribeStackResourcesResult describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest)
           Returns AWS resource descriptions for running and deleted stacks.
 DescribeStacksResult describeStacks()
           Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
 DescribeStacksResult describeStacks(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.
 EstimateTemplateCostResult estimateTemplateCost()
           Returns the estimated monthly cost of a template.
 EstimateTemplateCostResult estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest)
           Returns the estimated monthly cost of a template.
 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.
 GetTemplateResult getTemplate(GetTemplateRequest getTemplateRequest)
           Returns the template body for a specified stack name.
 ListStackResourcesResult listStackResources(ListStackResourcesRequest listStackResourcesRequest)
           Returns descriptions of all resources of the specified stack.
 ListStacksResult listStacks()
           Returns the summary information for stacks whose status matches the specified StackStatusFilter.
 ListStacksResult listStacks(ListStacksRequest listStacksRequest)
           Returns the summary information for stacks whose status matches the specified StackStatusFilter.
 UpdateStackResult updateStack(UpdateStackRequest updateStackRequest)
           Updates a stack as specified in the template.
 ValidateTemplateResult validateTemplate(ValidateTemplateRequest validateTemplateRequest)
           Validates a specified template.
 
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, removeRequestHandler, setConfiguration, 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
setEndpoint, shutdown
 

Constructor Detail

AmazonCloudFormationClient

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

All service calls made using this new client object are blocking, and will not return until the service call completes.

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

AmazonCloudFormationClient

public AmazonCloudFormationClient(AWSCredentials awsCredentials,
                                  ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
clientConfiguration - The client configuration options controlling how this client connects to AmazonCloudFormation (ex: proxy settings, retry counts, etc.).

AmazonCloudFormationClient

public AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

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

AmazonCloudFormationClient

public AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider,
                                  ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonCloudFormation using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
clientConfiguration - The client configuration options controlling how this client connects to AmazonCloudFormation (ex: proxy settings, retry counts, etc.).
Method Detail

listStacks

public ListStacksResult listStacks(ListStacksRequest listStacksRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).

Specified by:
listStacks in interface AmazonCloudFormation
Parameters:
listStacksRequest - Container for the necessary parameters to execute the ListStacks service method on AmazonCloudFormation.
Returns:
The response from the ListStacks 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.

createStack

public CreateStackResult createStack(CreateStackRequest createStackRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Creates a stack as specified in the template. After 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:
createStack in interface AmazonCloudFormation
Parameters:
createStackRequest - Container for the necessary parameters to execute the CreateStack service method on AmazonCloudFormation.
Returns:
The response from the CreateStack service method, as returned by AmazonCloudFormation.
Throws:
AlreadyExistsException
LimitExceededException
InsufficientCapabilitiesException
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.

validateTemplate

public ValidateTemplateResult validateTemplate(ValidateTemplateRequest validateTemplateRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Validates a specified template.

Specified by:
validateTemplate in interface AmazonCloudFormation
Parameters:
validateTemplateRequest - Container for the necessary parameters to execute the ValidateTemplate service method on AmazonCloudFormation.
Returns:
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.

estimateTemplateCost

public EstimateTemplateCostResult estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Returns the estimated monthly cost of a template. The return value is an AWS Simply Monthly Calculator URL with a query string that describes the resources required to run the template.

Specified by:
estimateTemplateCost in interface AmazonCloudFormation
Parameters:
estimateTemplateCostRequest - Container for the necessary parameters to execute the EstimateTemplateCost service method on AmazonCloudFormation.
Returns:
The response from the EstimateTemplateCost 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.

describeStacks

public DescribeStacksResult describeStacks(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:
describeStacks in interface AmazonCloudFormation
Parameters:
describeStacksRequest - Container for the necessary parameters to execute the DescribeStacks service method on AmazonCloudFormation.
Returns:
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.

describeStackEvents

public DescribeStackEventsResult describeStackEvents(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:
describeStackEvents in interface AmazonCloudFormation
Parameters:
describeStackEventsRequest - Container for the necessary parameters to execute the DescribeStackEvents service method on AmazonCloudFormation.
Returns:
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.

getTemplate

public GetTemplateResult getTemplate(GetTemplateRequest getTemplateRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Returns the template body for a specified stack name. You can get the template for running or deleted stacks.

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

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

Specified by:
getTemplate in interface AmazonCloudFormation
Parameters:
getTemplateRequest - Container for the necessary parameters to execute the GetTemplate service method on AmazonCloudFormation.
Returns:
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.

describeStackResource

public DescribeStackResourceResult describeStackResource(DescribeStackResourceRequest describeStackResourceRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.

Specified by:
describeStackResource in interface AmazonCloudFormation
Parameters:
describeStackResourceRequest - Container for the necessary parameters to execute the DescribeStackResource service method on AmazonCloudFormation.
Returns:
The response from the DescribeStackResource 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.

deleteStack

public void deleteStack(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:
deleteStack in interface AmazonCloudFormation
Parameters:
deleteStackRequest - Container for the necessary parameters to execute the DeleteStack service method on 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.

listStackResources

public ListStackResourcesResult listStackResources(ListStackResourcesRequest listStackResourcesRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Returns descriptions of all resources of the specified stack.

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.

Specified by:
listStackResources in interface AmazonCloudFormation
Parameters:
listStackResourcesRequest - Container for the necessary parameters to execute the ListStackResources service method on AmazonCloudFormation.
Returns:
The response from the ListStackResources 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.

describeStackResources

public DescribeStackResourcesResult describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Returns AWS resource descriptions for running and deleted stacks. 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.

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.

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:
describeStackResources in interface AmazonCloudFormation
Parameters:
describeStackResourcesRequest - Container for the necessary parameters to execute the DescribeStackResources service method on AmazonCloudFormation.
Returns:
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.

updateStack

public UpdateStackResult updateStack(UpdateStackRequest updateStackRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.

To get a copy of the template for an existing stack, you can use the GetTemplate action.

For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack .

Specified by:
updateStack in interface AmazonCloudFormation
Parameters:
updateStackRequest - Container for the necessary parameters to execute the UpdateStack service method on AmazonCloudFormation.
Returns:
The response from the UpdateStack service method, as returned by AmazonCloudFormation.
Throws:
InsufficientCapabilitiesException
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.

listStacks

public ListStacksResult listStacks()
                            throws AmazonServiceException,
                                   AmazonClientException

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).

Specified by:
listStacks in interface AmazonCloudFormation
Returns:
The response from the ListStacks 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.

estimateTemplateCost

public EstimateTemplateCostResult estimateTemplateCost()
                                                throws AmazonServiceException,
                                                       AmazonClientException

Returns the estimated monthly cost of a template. The return value is an AWS Simply Monthly Calculator URL with a query string that describes the resources required to run the template.

Specified by:
estimateTemplateCost in interface AmazonCloudFormation
Returns:
The response from the EstimateTemplateCost 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.

describeStacks

public DescribeStacksResult describeStacks()
                                    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:
describeStacks in interface AmazonCloudFormation
Returns:
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.

describeStackEvents

public DescribeStackEventsResult describeStackEvents()
                                              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:
describeStackEvents in interface AmazonCloudFormation
Returns:
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.

describeStackResources

public DescribeStackResourcesResult describeStackResources()
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Returns AWS resource descriptions for running and deleted stacks. 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.

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.

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:
describeStackResources in interface AmazonCloudFormation
Returns:
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.

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 the request.

Specified by:
getCachedResponseMetadata in interface AmazonCloudFormation
Parameters:
request - The originally executed request
Returns:
The response metadata for the specified request, or null if none is available.
Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.