com.amazonaws.services.cloudformation

Class AmazonCloudFormationClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cloudformation.AmazonCloudFormationClient

All Implemented Interfaces:

AmazonCloudFormation

Direct Known Subclasses:

AmazonCloudFormationAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonCloudFormationClient
extends AmazonWebServiceClient
implements AmazonCloudFormation

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

AWS CloudFormation

AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.

With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources 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 AWS CloudFormation, see the AWS 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 docs.aws.amazon.com.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonCloudFormationClient() Deprecated. use AmazonCloudFormationClientBuilder.defaultClient()
AmazonCloudFormationClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonCloudFormationClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AmazonCloudFormationClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AmazonCloudFormationClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AmazonCloudFormationClientBuilder	builder()
CancelUpdateStackResult	cancelUpdateStack(CancelUpdateStackRequest request) Cancels an update on the specified stack.
ContinueUpdateRollbackResult	continueUpdateRollback(ContinueUpdateRollbackRequest request) For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state.
CreateChangeSetResult	createChangeSet(CreateChangeSetRequest request) Creates a list of changes that will be applied to a stack so that you can review the changes before executing them.
CreateStackResult	createStack(CreateStackRequest request) Creates a stack as specified in the template.
CreateStackInstancesResult	createStackInstances(CreateStackInstancesRequest request) Creates stack instances for the specified accounts, within the specified regions.
CreateStackSetResult	createStackSet(CreateStackSetRequest request) Creates a stack set.
DeleteChangeSetResult	deleteChangeSet(DeleteChangeSetRequest request) Deletes the specified change set.
DeleteStackResult	deleteStack(DeleteStackRequest request) Deletes a specified stack.
DeleteStackInstancesResult	deleteStackInstances(DeleteStackInstancesRequest request) Deletes stack instances for the specified accounts, in the specified regions.
DeleteStackSetResult	deleteStackSet(DeleteStackSetRequest request) Deletes a stack set.
DescribeAccountLimitsResult	describeAccountLimits(DescribeAccountLimitsRequest request) Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
DescribeChangeSetResult	describeChangeSet(DescribeChangeSetRequest request) Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set.
DescribeStackEventsResult	describeStackEvents(DescribeStackEventsRequest request) Returns all stack related events for a specified stack in reverse chronological order.
DescribeStackInstanceResult	describeStackInstance(DescribeStackInstanceRequest request) Returns the stack instance that's associated with the specified stack set, AWS account, and region.
DescribeStackResourceResult	describeStackResource(DescribeStackResourceRequest request) Returns a description of the specified resource in the specified stack.
DescribeStackResourcesResult	describeStackResources(DescribeStackResourcesRequest request) Returns AWS resource descriptions for running and deleted stacks.
DescribeStacksResult	describeStacks() Simplified method form for invoking the DescribeStacks operation.
DescribeStacksResult	describeStacks(DescribeStacksRequest request) Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
DescribeStackSetResult	describeStackSet(DescribeStackSetRequest request) Returns the description of the specified stack set.
DescribeStackSetOperationResult	describeStackSetOperation(DescribeStackSetOperationRequest request) Returns the description of the specified stack set operation.
EstimateTemplateCostResult	estimateTemplateCost() Simplified method form for invoking the EstimateTemplateCost operation.
EstimateTemplateCostResult	estimateTemplateCost(EstimateTemplateCostRequest request) Returns the estimated monthly cost of a template.
ExecuteChangeSetResult	executeChangeSet(ExecuteChangeSetRequest request) Updates a stack using the input information that was provided when the specified change set was created.
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.
GetStackPolicyResult	getStackPolicy(GetStackPolicyRequest request) Returns the stack policy for a specified stack.
GetTemplateResult	getTemplate(GetTemplateRequest request) Returns the template body for a specified stack.
GetTemplateSummaryResult	getTemplateSummary() Simplified method form for invoking the GetTemplateSummary operation.
GetTemplateSummaryResult	getTemplateSummary(GetTemplateSummaryRequest request) Returns information about a new or existing template.
ListChangeSetsResult	listChangeSets(ListChangeSetsRequest request) Returns the ID and status of each active change set for a stack.
ListExportsResult	listExports(ListExportsRequest request) Lists all exported output values in the account and region in which you call this action.
ListImportsResult	listImports(ListImportsRequest request) Lists all stacks that are importing an exported output value.
ListStackInstancesResult	listStackInstances(ListStackInstancesRequest request) Returns summary information about stack instances that are associated with the specified stack set.
ListStackResourcesResult	listStackResources(ListStackResourcesRequest request) Returns descriptions of all resources of the specified stack.
ListStacksResult	listStacks() Simplified method form for invoking the ListStacks operation.
ListStacksResult	listStacks(ListStacksRequest request) Returns the summary information for stacks whose status matches the specified StackStatusFilter.
ListStackSetOperationResultsResult	listStackSetOperationResults(ListStackSetOperationResultsRequest request) Returns summary information about the results of a stack set operation.
ListStackSetOperationsResult	listStackSetOperations(ListStackSetOperationsRequest request) Returns summary information about operations performed on a stack set.
ListStackSetsResult	listStackSets(ListStackSetsRequest request) Returns summary information about stack sets that are associated with the user.
SetStackPolicyResult	setStackPolicy(SetStackPolicyRequest request) Sets a stack policy for a specified stack.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
SignalResourceResult	signalResource(SignalResourceRequest request) Sends a signal to the specified resource with a success or failure status.
StopStackSetOperationResult	stopStackSetOperation(StopStackSetOperationRequest request) Stops an in-progress operation on a stack set and its associated stack instances.
UpdateStackResult	updateStack(UpdateStackRequest request) Updates a stack as specified in the template.
UpdateStackSetResult	updateStackSet(UpdateStackSetRequest request) Updates the stack set and all associated stack instances.
UpdateTerminationProtectionResult	updateTerminationProtection(UpdateTerminationProtectionRequest request) Updates termination protection for the specified stack.
ValidateTemplateResult	validateTemplate(ValidateTemplateRequest request) Validates a specified template.
AmazonCloudFormationWaiters	waiters()

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, 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.cloudformation.AmazonCloudFormation

setEndpoint, setRegion

Constructor Detail

AmazonCloudFormationClient

@Deprecated
public AmazonCloudFormationClient()

Deprecated. use AmazonCloudFormationClientBuilder.defaultClient()

Constructs a new client to invoke service methods on AWS CloudFormation. 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
• Instance profile credentials delivered through the Amazon EC2 metadata service

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

See Also:

DefaultAWSCredentialsProviderChain

AmazonCloudFormationClient

@Deprecated
public AmazonCloudFormationClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS CloudFormation. 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
• Instance profile credentials delivered through the Amazon EC2 metadata service

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

Parameters:

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

See Also:

DefaultAWSCredentialsProviderChain

AmazonCloudFormationClient

@Deprecated
public AmazonCloudFormationClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonCloudFormationClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on AWS CloudFormation 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

@Deprecated
public AmazonCloudFormationClient(AWSCredentials awsCredentials,
                                              ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS CloudFormation 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 AWS CloudFormation (ex: proxy settings, retry counts, etc.).

AmazonCloudFormationClient

@Deprecated
public AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on AWS CloudFormation 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

@Deprecated
public AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider,
                                              ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS CloudFormation 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 AWS CloudFormation (ex: proxy settings, retry counts, etc.).

AmazonCloudFormationClient

@Deprecated
public AmazonCloudFormationClient(AWSCredentialsProvider awsCredentialsProvider,
                                              ClientConfiguration clientConfiguration,
                                              RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on AWS CloudFormation using the specified AWS account credentials provider, client configuration options, and request metric collector.

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 AWS CloudFormation (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AmazonCloudFormationClientBuilder builder()

cancelUpdateStack

public CancelUpdateStackResult cancelUpdateStack(CancelUpdateStackRequest request)

Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

Specified by:

cancelUpdateStack in interface AmazonCloudFormation

Parameters:

cancelUpdateStackRequest - The input for the CancelUpdateStack action.

Returns:

Result of the CancelUpdateStack operation returned by the service.

Throws:

TokenAlreadyExistsException - A client request token already exists.

See Also:

AWS API Documentation

continueUpdateRollback

public ContinueUpdateRollbackResult continueUpdateRollback(ContinueUpdateRollbackRequest request)

For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.

A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.

Specified by:

continueUpdateRollback in interface AmazonCloudFormation

Parameters:

continueUpdateRollbackRequest - The input for the ContinueUpdateRollback action.

Returns:

Result of the ContinueUpdateRollback operation returned by the service.

Throws:

TokenAlreadyExistsException - A client request token already exists.

See Also:

AWS API Documentation

createChangeSet

public CreateChangeSetResult createChangeSet(CreateChangeSetRequest request)

Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.

To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.

When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes until you execute the change set.

Specified by:

createChangeSet in interface AmazonCloudFormation

Parameters:

createChangeSetRequest - The input for the CreateChangeSet action.

Returns:

Result of the CreateChangeSet operation returned by the service.

Throws:

AlreadyExistsException - The resource with the name requested already exists.

InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.

LimitExceededException - The quota for the resource has already been reached.

For information on stack set limitations, see Limitations of StackSets.

See Also:

AWS API Documentation

createStack

public CreateStackResult createStack(CreateStackRequest request)

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.

Specified by:

createStack in interface AmazonCloudFormation

Parameters:

createStackRequest - The input for CreateStack action.

Returns:

Result of the CreateStack operation returned by the service.

Throws:

LimitExceededException - The quota for the resource has already been reached.

For information on stack set limitations, see Limitations of StackSets.

AlreadyExistsException - The resource with the name requested already exists.

TokenAlreadyExistsException - A client request token already exists.

InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.

See Also:

AWS API Documentation

createStackInstances

public CreateStackInstancesResult createStackInstances(CreateStackInstancesRequest request)

Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. Accounts and Regions are required parameters—you must specify at least one account and one region.

Specified by:

createStackInstances in interface AmazonCloudFormation

Parameters:

createStackInstancesRequest -

Returns:

Result of the CreateStackInstances operation returned by the service.

Throws:

StackSetNotFoundException - The specified stack set doesn't exist.

OperationInProgressException - Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time.

OperationIdAlreadyExistsException - The specified operation ID already exists.

StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.

InvalidOperationException - The specified operation isn't valid.

LimitExceededException - The quota for the resource has already been reached.

For information on stack set limitations, see Limitations of StackSets.

See Also:

AWS API Documentation

createStackSet

public CreateStackSetResult createStackSet(CreateStackSetRequest request)

Creates a stack set.

Specified by:

createStackSet in interface AmazonCloudFormation

Parameters:

createStackSetRequest -

Returns:

Result of the CreateStackSet operation returned by the service.

Throws:

NameAlreadyExistsException - The specified name is already in use.

CreatedButModifiedException - The specified resource exists, but has been changed.

LimitExceededException - The quota for the resource has already been reached.

For information on stack set limitations, see Limitations of StackSets.

See Also:

AWS API Documentation

deleteChangeSet

public DeleteChangeSetResult deleteChangeSet(DeleteChangeSetRequest request)

Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.

If the call successfully completes, AWS CloudFormation successfully deleted the change set.

Specified by:

deleteChangeSet in interface AmazonCloudFormation

Parameters:

deleteChangeSetRequest - The input for the DeleteChangeSet action.

Returns:

Result of the DeleteChangeSet operation returned by the service.

Throws:

InvalidChangeSetStatusException - The specified change set can't be used to update the stack. For example, the change set status might be CREATE_IN_PROGRESS, or the stack status might be UPDATE_IN_PROGRESS.

See Also:

AWS API Documentation

deleteStack

public DeleteStackResult deleteStack(DeleteStackRequest request)

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 - The input for DeleteStack action.

Returns:

Result of the DeleteStack operation returned by the service.

Throws:

TokenAlreadyExistsException - A client request token already exists.

See Also:

AWS API Documentation

deleteStackInstances

public DeleteStackInstancesResult deleteStackInstances(DeleteStackInstancesRequest request)

Deletes stack instances for the specified accounts, in the specified regions.

Specified by:

deleteStackInstances in interface AmazonCloudFormation

Parameters:

deleteStackInstancesRequest -

Returns:

Result of the DeleteStackInstances operation returned by the service.

Throws:

StackSetNotFoundException - The specified stack set doesn't exist.

OperationInProgressException - Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time.

OperationIdAlreadyExistsException - The specified operation ID already exists.

StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.

InvalidOperationException - The specified operation isn't valid.

See Also:

AWS API Documentation

deleteStackSet

public DeleteStackSetResult deleteStackSet(DeleteStackSetRequest request)

Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances.

Specified by:

deleteStackSet in interface AmazonCloudFormation

Parameters:

deleteStackSetRequest -

Returns:

Result of the DeleteStackSet operation returned by the service.

Throws:

StackSetNotEmptyException - You can't yet delete this stack set, because it still contains one or more stack instances. Delete all stack instances from the stack set before deleting the stack set.

OperationInProgressException - Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time.

See Also:

AWS API Documentation

describeAccountLimits

public DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest request)

Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.

Specified by:

describeAccountLimits in interface AmazonCloudFormation

Parameters:

describeAccountLimitsRequest - The input for the DescribeAccountLimits action.

Returns:

Result of the DescribeAccountLimits operation returned by the service.

See Also:

AWS API Documentation

describeChangeSet

public DescribeChangeSetResult describeChangeSet(DescribeChangeSetRequest request)

Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.

Specified by:

describeChangeSet in interface AmazonCloudFormation

Parameters:

describeChangeSetRequest - The input for the DescribeChangeSet action.

Returns:

Result of the DescribeChangeSet operation returned by the service.

Throws:

ChangeSetNotFoundException - The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets action.

See Also:

AWS API Documentation

describeStackEvents

public DescribeStackEventsResult describeStackEvents(DescribeStackEventsRequest request)

Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).

Specified by:

describeStackEvents in interface AmazonCloudFormation

Parameters:

describeStackEventsRequest - The input for DescribeStackEvents action.

Returns:

Result of the DescribeStackEvents operation returned by the service.

See Also:

AWS API Documentation

describeStackInstance

public DescribeStackInstanceResult describeStackInstance(DescribeStackInstanceRequest request)

Returns the stack instance that's associated with the specified stack set, AWS account, and region.

For a list of stack instances that are associated with a specific stack set, use ListStackInstances.

Specified by:

describeStackInstance in interface AmazonCloudFormation

Parameters:

describeStackInstanceRequest -

Returns:

Result of the DescribeStackInstance operation returned by the service.

Throws:

StackSetNotFoundException - The specified stack set doesn't exist.

StackInstanceNotFoundException - The specified stack instance doesn't exist.

See Also:

AWS API Documentation

describeStackResource

public DescribeStackResourceResult describeStackResource(DescribeStackResourceRequest request)

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 - The input for DescribeStackResource action.

Returns:

Result of the DescribeStackResource operation returned by the service.

See Also:

AWS API Documentation

describeStackResources

public DescribeStackResourcesResult describeStackResources(DescribeStackResourcesRequest request)

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, the associated resources of the stack that the resource belongs to are returned.

Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.

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

You must specify either StackName or PhysicalResourceId, but not both. 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.

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

Specified by:

describeStackResources in interface AmazonCloudFormation

Parameters:

describeStackResourcesRequest - The input for DescribeStackResources action.

Returns:

Result of the DescribeStackResources operation returned by the service.

See Also:

AWS API Documentation

describeStackSet

public DescribeStackSetResult describeStackSet(DescribeStackSetRequest request)

Returns the description of the specified stack set.

Specified by:

describeStackSet in interface AmazonCloudFormation

Parameters:

describeStackSetRequest -

Returns:

Result of the DescribeStackSet operation returned by the service.

Throws:

StackSetNotFoundException - The specified stack set doesn't exist.

See Also:

AWS API Documentation

describeStackSetOperation

public DescribeStackSetOperationResult describeStackSetOperation(DescribeStackSetOperationRequest request)

Returns the description of the specified stack set operation.

Specified by:

describeStackSetOperation in interface AmazonCloudFormation

Parameters:

describeStackSetOperationRequest -

Returns:

Result of the DescribeStackSetOperation operation returned by the service.

Throws:

StackSetNotFoundException - The specified stack set doesn't exist.

OperationNotFoundException - The specified ID refers to an operation that doesn't exist.

See Also:

AWS API Documentation

describeStacks

public DescribeStacksResult describeStacks(DescribeStacksRequest request)

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

If the stack does not exist, an AmazonCloudFormationException is returned.

Specified by:

describeStacks in interface AmazonCloudFormation

Parameters:

describeStacksRequest - The input for DescribeStacks action.

Returns:

Result of the DescribeStacks operation returned by the service.

See Also:

AWS API Documentation

describeStacks

public DescribeStacksResult describeStacks()

Description copied from interface: AmazonCloudFormation

Simplified method form for invoking the DescribeStacks operation.

Specified by:

describeStacks in interface AmazonCloudFormation

See Also:

AmazonCloudFormation.describeStacks(DescribeStacksRequest)

estimateTemplateCost

public EstimateTemplateCostResult estimateTemplateCost(EstimateTemplateCostRequest request)

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

Specified by:

estimateTemplateCost in interface AmazonCloudFormation

Parameters:

estimateTemplateCostRequest - The input for an EstimateTemplateCost action.

Returns:

Result of the EstimateTemplateCost operation returned by the service.

See Also:

AWS API Documentation

estimateTemplateCost

public EstimateTemplateCostResult estimateTemplateCost()

Description copied from interface: AmazonCloudFormation

Simplified method form for invoking the EstimateTemplateCost operation.

Specified by:

estimateTemplateCost in interface AmazonCloudFormation

See Also:

AmazonCloudFormation.estimateTemplateCost(EstimateTemplateCostRequest)

executeChangeSet

public ExecuteChangeSetResult executeChangeSet(ExecuteChangeSetRequest request)

Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.

When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.

If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.

Specified by:

executeChangeSet in interface AmazonCloudFormation

Parameters:

executeChangeSetRequest - The input for the ExecuteChangeSet action.

Returns:

Result of the ExecuteChangeSet operation returned by the service.

Throws:

InvalidChangeSetStatusException - The specified change set can't be used to update the stack. For example, the change set status might be CREATE_IN_PROGRESS, or the stack status might be UPDATE_IN_PROGRESS.

ChangeSetNotFoundException - The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets action.

InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.

TokenAlreadyExistsException - A client request token already exists.

See Also:

AWS API Documentation

getStackPolicy

public GetStackPolicyResult getStackPolicy(GetStackPolicyRequest request)

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.

Specified by:

getStackPolicy in interface AmazonCloudFormation

Parameters:

getStackPolicyRequest - The input for the GetStackPolicy action.

Returns:

Result of the GetStackPolicy operation returned by the service.

See Also:

AWS API Documentation

getTemplate

public GetTemplateResult getTemplate(GetTemplateRequest request)

Returns the template body for a specified stack. 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.

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

Specified by:

getTemplate in interface AmazonCloudFormation

Parameters:

getTemplateRequest - The input for a GetTemplate action.

Returns:

Result of the GetTemplate operation returned by the service.

Throws:

ChangeSetNotFoundException - The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets action.

See Also:

AWS API Documentation

getTemplateSummary

public GetTemplateSummaryResult getTemplateSummary(GetTemplateSummaryRequest request)

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.

Specified by:

getTemplateSummary in interface AmazonCloudFormation

Parameters:

getTemplateSummaryRequest - The input for the GetTemplateSummary action.

Returns:

Result of the GetTemplateSummary operation returned by the service.

Throws:

StackSetNotFoundException - The specified stack set doesn't exist.

See Also:

AWS API Documentation

getTemplateSummary

public GetTemplateSummaryResult getTemplateSummary()

Description copied from interface: AmazonCloudFormation

Simplified method form for invoking the GetTemplateSummary operation.

Specified by:

getTemplateSummary in interface AmazonCloudFormation

See Also:

AmazonCloudFormation.getTemplateSummary(GetTemplateSummaryRequest)

listChangeSets

public ListChangeSetsResult listChangeSets(ListChangeSetsRequest request)

Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.

Specified by:

listChangeSets in interface AmazonCloudFormation

Parameters:

listChangeSetsRequest - The input for the ListChangeSets action.

Returns:

Result of the ListChangeSets operation returned by the service.

See Also:

AWS API Documentation

listExports

public ListExportsResult listExports(ListExportsRequest request)

Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.

For more information, see AWS CloudFormation Export Stack Output Values.

Specified by:

listExports in interface AmazonCloudFormation

Parameters:

listExportsRequest -

Returns:

Result of the ListExports operation returned by the service.

See Also:

AWS API Documentation

listImports

public ListImportsResult listImports(ListImportsRequest request)

Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.

For more information about importing an exported output value, see the Fn::ImportValue function.

Specified by:

listImports in interface AmazonCloudFormation

Parameters:

listImportsRequest -

Returns:

Result of the ListImports operation returned by the service.

See Also:

AWS API Documentation

listStackInstances

public ListStackInstancesResult listStackInstances(ListStackInstancesRequest request)

Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region.

Specified by:

listStackInstances in interface AmazonCloudFormation

Parameters:

listStackInstancesRequest -

Returns:

Result of the ListStackInstances operation returned by the service.

Throws:

StackSetNotFoundException - The specified stack set doesn't exist.

See Also:

AWS API Documentation

listStackResources

public ListStackResourcesResult listStackResources(ListStackResourcesRequest request)

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 - The input for the ListStackResource action.

Returns:

Result of the ListStackResources operation returned by the service.

See Also:

AWS API Documentation

listStackSetOperationResults

public ListStackSetOperationResultsResult listStackSetOperationResults(ListStackSetOperationResultsRequest request)

Returns summary information about the results of a stack set operation.

Specified by:

listStackSetOperationResults in interface AmazonCloudFormation

Parameters:

listStackSetOperationResultsRequest -

Returns:

Result of the ListStackSetOperationResults operation returned by the service.

Throws:

StackSetNotFoundException - The specified stack set doesn't exist.

OperationNotFoundException - The specified ID refers to an operation that doesn't exist.

See Also:

AWS API Documentation

listStackSetOperations

public ListStackSetOperationsResult listStackSetOperations(ListStackSetOperationsRequest request)

Returns summary information about operations performed on a stack set.

Specified by:

listStackSetOperations in interface AmazonCloudFormation

Parameters:

listStackSetOperationsRequest -

Returns:

Result of the ListStackSetOperations operation returned by the service.

Throws:

StackSetNotFoundException - The specified stack set doesn't exist.

See Also:

AWS API Documentation

listStackSets

public ListStackSetsResult listStackSets(ListStackSetsRequest request)

Returns summary information about stack sets that are associated with the user.

Specified by:

listStackSets in interface AmazonCloudFormation

Parameters:

listStackSetsRequest -

Returns:

Result of the ListStackSets operation returned by the service.

See Also:

AWS API Documentation

listStacks

public ListStacksResult listStacks(ListStacksRequest request)

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 - The input for ListStacks action.

Returns:

Result of the ListStacks operation returned by the service.

See Also:

AWS API Documentation

listStacks

public ListStacksResult listStacks()

Description copied from interface: AmazonCloudFormation

Simplified method form for invoking the ListStacks operation.

Specified by:

listStacks in interface AmazonCloudFormation

See Also:

AmazonCloudFormation.listStacks(ListStacksRequest)

setStackPolicy

public SetStackPolicyResult setStackPolicy(SetStackPolicyRequest request)

Sets a stack policy for a specified stack.

Specified by:

setStackPolicy in interface AmazonCloudFormation

Parameters:

setStackPolicyRequest - The input for the SetStackPolicy action.

Returns:

Result of the SetStackPolicy operation returned by the service.

See Also:

AWS API Documentation

signalResource

public SignalResourceResult signalResource(SignalResourceRequest request)

Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.

Specified by:

signalResource in interface AmazonCloudFormation

Parameters:

signalResourceRequest - The input for the SignalResource action.

Returns:

Result of the SignalResource operation returned by the service.

See Also:

AWS API Documentation

stopStackSetOperation

public StopStackSetOperationResult stopStackSetOperation(StopStackSetOperationRequest request)

Stops an in-progress operation on a stack set and its associated stack instances.

Specified by:

stopStackSetOperation in interface AmazonCloudFormation

Parameters:

stopStackSetOperationRequest -

Returns:

Result of the StopStackSetOperation operation returned by the service.

Throws:

StackSetNotFoundException - The specified stack set doesn't exist.

OperationNotFoundException - The specified ID refers to an operation that doesn't exist.

InvalidOperationException - The specified operation isn't valid.

See Also:

AWS API Documentation

updateStack

public UpdateStackResult updateStack(UpdateStackRequest request)

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 - The input for an UpdateStack action.

Returns:

Result of the UpdateStack operation returned by the service.

Throws:

InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.

TokenAlreadyExistsException - A client request token already exists.

See Also:

AWS API Documentation

updateStackSet

public UpdateStackSetResult updateStackSet(UpdateStackSetRequest request)

Updates the stack set and all associated stack instances.

Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.

Specified by:

updateStackSet in interface AmazonCloudFormation

Parameters:

updateStackSetRequest -

Returns:

Result of the UpdateStackSet operation returned by the service.

Throws:

StackSetNotFoundException - The specified stack set doesn't exist.

OperationInProgressException - Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time.

OperationIdAlreadyExistsException - The specified operation ID already exists.

StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.

InvalidOperationException - The specified operation isn't valid.

See Also:

AWS API Documentation

updateTerminationProtection

public UpdateTerminationProtectionResult updateTerminationProtection(UpdateTerminationProtectionRequest request)

Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.

For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.

Specified by:

updateTerminationProtection in interface AmazonCloudFormation

Parameters:

updateTerminationProtectionRequest -

Returns:

Result of the UpdateTerminationProtection operation returned by the service.

See Also:

AWS API Documentation

validateTemplate

public ValidateTemplateResult validateTemplate(ValidateTemplateRequest request)

Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.

Specified by:

validateTemplate in interface AmazonCloudFormation

Parameters:

validateTemplateRequest - The input for ValidateTemplate action.

Returns:

Result of the ValidateTemplate operation returned by the service.

See Also:

AWS API Documentation

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.

waiters

public AmazonCloudFormationWaiters waiters()

Specified by:

waiters in interface AmazonCloudFormation

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonCloudFormation

Overrides:

shutdown in class AmazonWebServiceClient