com.amazonaws.services.cloudformation

Interface AmazonCloudFormation

All Known Subinterfaces:

AmazonCloudFormationAsync

All Known Implementing Classes:

AbstractAmazonCloudFormation, AbstractAmazonCloudFormationAsync, AmazonCloudFormationAsyncClient, AmazonCloudFormationClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCloudFormation

Interface for accessing AWS CloudFormation.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonCloudFormation instead.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CancelUpdateStackResult	cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest) Cancels an update on the specified stack.
ContinueUpdateRollbackResult	continueUpdateRollback(ContinueUpdateRollbackRequest continueUpdateRollbackRequest) 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 createChangeSetRequest) 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 createStackRequest) Creates a stack as specified in the template.
CreateStackInstancesResult	createStackInstances(CreateStackInstancesRequest createStackInstancesRequest) Creates stack instances for the specified accounts, within the specified regions.
CreateStackSetResult	createStackSet(CreateStackSetRequest createStackSetRequest) Creates a stack set.
DeleteChangeSetResult	deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest) Deletes the specified change set.
DeleteStackResult	deleteStack(DeleteStackRequest deleteStackRequest) Deletes a specified stack.
DeleteStackInstancesResult	deleteStackInstances(DeleteStackInstancesRequest deleteStackInstancesRequest) Deletes stack instances for the specified accounts, in the specified regions.
DeleteStackSetResult	deleteStackSet(DeleteStackSetRequest deleteStackSetRequest) Deletes a stack set.
DescribeAccountLimitsResult	describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
DescribeChangeSetResult	describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest) 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 describeStackEventsRequest) Returns all stack related events for a specified stack in reverse chronological order.
DescribeStackInstanceResult	describeStackInstance(DescribeStackInstanceRequest describeStackInstanceRequest) Returns the stack instance that's associated with the specified stack set, AWS account, and region.
DescribeStackResourceResult	describeStackResource(DescribeStackResourceRequest describeStackResourceRequest) Returns a description of the specified resource in the specified stack.
DescribeStackResourcesResult	describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest) Returns AWS resource descriptions for running and deleted stacks.
DescribeStacksResult	describeStacks() Simplified method form for invoking the DescribeStacks operation.
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.
DescribeStackSetResult	describeStackSet(DescribeStackSetRequest describeStackSetRequest) Returns the description of the specified stack set.
DescribeStackSetOperationResult	describeStackSetOperation(DescribeStackSetOperationRequest describeStackSetOperationRequest) Returns the description of the specified stack set operation.
EstimateTemplateCostResult	estimateTemplateCost() Simplified method form for invoking the EstimateTemplateCost operation.
EstimateTemplateCostResult	estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest) Returns the estimated monthly cost of a template.
ExecuteChangeSetResult	executeChangeSet(ExecuteChangeSetRequest executeChangeSetRequest) 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 getStackPolicyRequest) Returns the stack policy for a specified stack.
GetTemplateResult	getTemplate(GetTemplateRequest getTemplateRequest) Returns the template body for a specified stack.
GetTemplateSummaryResult	getTemplateSummary() Simplified method form for invoking the GetTemplateSummary operation.
GetTemplateSummaryResult	getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest) Returns information about a new or existing template.
ListChangeSetsResult	listChangeSets(ListChangeSetsRequest listChangeSetsRequest) Returns the ID and status of each active change set for a stack.
ListExportsResult	listExports(ListExportsRequest listExportsRequest) Lists all exported output values in the account and region in which you call this action.
ListImportsResult	listImports(ListImportsRequest listImportsRequest) Lists all stacks that are importing an exported output value.
ListStackInstancesResult	listStackInstances(ListStackInstancesRequest listStackInstancesRequest) Returns summary information about stack instances that are associated with the specified stack set.
ListStackResourcesResult	listStackResources(ListStackResourcesRequest listStackResourcesRequest) Returns descriptions of all resources of the specified stack.
ListStacksResult	listStacks() Simplified method form for invoking the ListStacks operation.
ListStacksResult	listStacks(ListStacksRequest listStacksRequest) Returns the summary information for stacks whose status matches the specified StackStatusFilter.
ListStackSetOperationResultsResult	listStackSetOperationResults(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest) Returns summary information about the results of a stack set operation.
ListStackSetOperationsResult	listStackSetOperations(ListStackSetOperationsRequest listStackSetOperationsRequest) Returns summary information about operations performed on a stack set.
ListStackSetsResult	listStackSets(ListStackSetsRequest listStackSetsRequest) Returns summary information about stack sets that are associated with the user.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
SetStackPolicyResult	setStackPolicy(SetStackPolicyRequest setStackPolicyRequest) 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 signalResourceRequest) Sends a signal to the specified resource with a success or failure status.
StopStackSetOperationResult	stopStackSetOperation(StopStackSetOperationRequest stopStackSetOperationRequest) Stops an in-progress operation on a stack set and its associated stack instances.
UpdateStackResult	updateStack(UpdateStackRequest updateStackRequest) Updates a stack as specified in the template.
UpdateStackSetResult	updateStackSet(UpdateStackSetRequest updateStackSetRequest) Updates the stack set and all associated stack instances.
UpdateTerminationProtectionResult	updateTerminationProtection(UpdateTerminationProtectionRequest updateTerminationProtectionRequest) Updates termination protection for the specified stack.
ValidateTemplateResult	validateTemplate(ValidateTemplateRequest validateTemplateRequest) Validates a specified template.
AmazonCloudFormationWaiters	waiters()

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("https://cloudformation.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "cloudformation.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://cloudformation.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "cloudformation.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://cloudformation.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

cancelUpdateStack

CancelUpdateStackResult cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest)

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.

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

ContinueUpdateRollbackResult continueUpdateRollback(ContinueUpdateRollbackRequest continueUpdateRollbackRequest)

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.

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

CreateChangeSetResult createChangeSet(CreateChangeSetRequest createChangeSetRequest)

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.

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

CreateStackResult createStack(CreateStackRequest createStackRequest)

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.

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

CreateStackInstancesResult createStackInstances(CreateStackInstancesRequest createStackInstancesRequest)

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.

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

CreateStackSetResult createStackSet(CreateStackSetRequest createStackSetRequest)

Creates a stack set.

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

DeleteChangeSetResult deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest)

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.

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

DeleteStackResult deleteStack(DeleteStackRequest deleteStackRequest)

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 - 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

DeleteStackInstancesResult deleteStackInstances(DeleteStackInstancesRequest deleteStackInstancesRequest)

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

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

DeleteStackSetResult deleteStackSet(DeleteStackSetRequest deleteStackSetRequest)

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.

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

DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)

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

Parameters:

describeAccountLimitsRequest - The input for the DescribeAccountLimits action.

Returns:

Result of the DescribeAccountLimits operation returned by the service.

See Also:

AWS API Documentation

describeChangeSet

DescribeChangeSetResult describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest)

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.

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

DescribeStackEventsResult describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest)

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).

Parameters:

describeStackEventsRequest - The input for DescribeStackEvents action.

Returns:

Result of the DescribeStackEvents operation returned by the service.

See Also:

AWS API Documentation

describeStackInstance

DescribeStackInstanceResult describeStackInstance(DescribeStackInstanceRequest describeStackInstanceRequest)

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.

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

DescribeStackResourceResult describeStackResource(DescribeStackResourceRequest describeStackResourceRequest)

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.

Parameters:

describeStackResourceRequest - The input for DescribeStackResource action.

Returns:

Result of the DescribeStackResource operation returned by the service.

See Also:

AWS API Documentation

describeStackResources

DescribeStackResourcesResult describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest)

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.

Parameters:

describeStackResourcesRequest - The input for DescribeStackResources action.

Returns:

Result of the DescribeStackResources operation returned by the service.

See Also:

AWS API Documentation

describeStackSet

DescribeStackSetResult describeStackSet(DescribeStackSetRequest describeStackSetRequest)

Returns the description of the specified stack set.

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

DescribeStackSetOperationResult describeStackSetOperation(DescribeStackSetOperationRequest describeStackSetOperationRequest)

Returns the description of the specified stack set operation.

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

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.

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

Parameters:

describeStacksRequest - The input for DescribeStacks action.

Returns:

Result of the DescribeStacks operation returned by the service.

See Also:

AWS API Documentation

describeStacks

DescribeStacksResult describeStacks()

Simplified method form for invoking the DescribeStacks operation.

See Also:

describeStacks(DescribeStacksRequest)

estimateTemplateCost

EstimateTemplateCostResult estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest)

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.

Parameters:

estimateTemplateCostRequest - The input for an EstimateTemplateCost action.

Returns:

Result of the EstimateTemplateCost operation returned by the service.

See Also:

AWS API Documentation

estimateTemplateCost

EstimateTemplateCostResult estimateTemplateCost()

Simplified method form for invoking the EstimateTemplateCost operation.

See Also:

estimateTemplateCost(EstimateTemplateCostRequest)

executeChangeSet

ExecuteChangeSetResult executeChangeSet(ExecuteChangeSetRequest executeChangeSetRequest)

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.

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

GetStackPolicyResult getStackPolicy(GetStackPolicyRequest getStackPolicyRequest)

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

Parameters:

getStackPolicyRequest - The input for the GetStackPolicy action.

Returns:

Result of the GetStackPolicy operation returned by the service.

See Also:

AWS API Documentation

getTemplate

GetTemplateResult getTemplate(GetTemplateRequest getTemplateRequest)

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.

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

GetTemplateSummaryResult getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest)

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.

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

GetTemplateSummaryResult getTemplateSummary()

Simplified method form for invoking the GetTemplateSummary operation.

See Also:

getTemplateSummary(GetTemplateSummaryRequest)

listChangeSets

ListChangeSetsResult listChangeSets(ListChangeSetsRequest listChangeSetsRequest)

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.

Parameters:

listChangeSetsRequest - The input for the ListChangeSets action.

Returns:

Result of the ListChangeSets operation returned by the service.

See Also:

AWS API Documentation

listExports

ListExportsResult listExports(ListExportsRequest listExportsRequest)

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.

Parameters:

listExportsRequest -

Returns:

Result of the ListExports operation returned by the service.

See Also:

AWS API Documentation

listImports

ListImportsResult listImports(ListImportsRequest listImportsRequest)

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.

Parameters:

listImportsRequest -

Returns:

Result of the ListImports operation returned by the service.

See Also:

AWS API Documentation

listStackInstances

ListStackInstancesResult listStackInstances(ListStackInstancesRequest listStackInstancesRequest)

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.

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

ListStackResourcesResult listStackResources(ListStackResourcesRequest listStackResourcesRequest)

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.

Parameters:

listStackResourcesRequest - The input for the ListStackResource action.

Returns:

Result of the ListStackResources operation returned by the service.

See Also:

AWS API Documentation

listStackSetOperationResults

ListStackSetOperationResultsResult listStackSetOperationResults(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest)

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

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

ListStackSetOperationsResult listStackSetOperations(ListStackSetOperationsRequest listStackSetOperationsRequest)

Returns summary information about operations performed on a stack set.

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

ListStackSetsResult listStackSets(ListStackSetsRequest listStackSetsRequest)

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

Parameters:

listStackSetsRequest -

Returns:

Result of the ListStackSets operation returned by the service.

See Also:

AWS API Documentation

listStacks

ListStacksResult listStacks(ListStacksRequest listStacksRequest)

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).

Parameters:

listStacksRequest - The input for ListStacks action.

Returns:

Result of the ListStacks operation returned by the service.

See Also:

AWS API Documentation

listStacks

ListStacksResult listStacks()

Simplified method form for invoking the ListStacks operation.

See Also:

listStacks(ListStacksRequest)

setStackPolicy

SetStackPolicyResult setStackPolicy(SetStackPolicyRequest setStackPolicyRequest)

Sets a stack policy for a specified stack.

Parameters:

setStackPolicyRequest - The input for the SetStackPolicy action.

Returns:

Result of the SetStackPolicy operation returned by the service.

See Also:

AWS API Documentation

signalResource

SignalResourceResult signalResource(SignalResourceRequest signalResourceRequest)

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.

Parameters:

signalResourceRequest - The input for the SignalResource action.

Returns:

Result of the SignalResource operation returned by the service.

See Also:

AWS API Documentation

stopStackSetOperation

StopStackSetOperationResult stopStackSetOperation(StopStackSetOperationRequest stopStackSetOperationRequest)

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

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

UpdateStackResult updateStack(UpdateStackRequest updateStackRequest)

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.

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

UpdateStackSetResult updateStackSet(UpdateStackSetRequest updateStackSetRequest)

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.

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

UpdateTerminationProtectionResult updateTerminationProtection(UpdateTerminationProtectionRequest updateTerminationProtectionRequest)

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.

Parameters:

updateTerminationProtectionRequest -

Returns:

Result of the UpdateTerminationProtection operation returned by the service.

See Also:

AWS API Documentation

validateTemplate

ValidateTemplateResult validateTemplate(ValidateTemplateRequest validateTemplateRequest)

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.

Parameters:

validateTemplateRequest - The input for ValidateTemplate action.

Returns:

Result of the ValidateTemplate operation returned by the service.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.

waiters

AmazonCloudFormationWaiters waiters()