Package software.amazon.awssdk.services.cloudformation

Interface CloudFormationClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface CloudFormationClient
extends AutoCloseable

Service client for accessing null. This can be created using the static builder() method. 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	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static CloudFormationClientBuilder	builder()	Create a builder that can be used to configure and create a CloudFormationClient.
default CancelUpdateStackResponse	cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest)	Cancels an update on the specified stack.
default ContinueUpdateRollbackResponse	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.
static CloudFormationClient	create()	Create a CloudFormationClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateChangeSetResponse	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.
default CreateStackResponse	createStack(CreateStackRequest createStackRequest)	Creates a stack as specified in the template.
default DeleteChangeSetResponse	deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest)	Deletes the specified change set.
default DeleteStackResponse	deleteStack(DeleteStackRequest deleteStackRequest)	Deletes a specified stack.
default DescribeAccountLimitsResponse	describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)	Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
default DescribeChangeSetResponse	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.
default DescribeStackEventsResponse	describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest)	Returns all stack related events for a specified stack in reverse chronological order.
default DescribeStackResourceResponse	describeStackResource(DescribeStackResourceRequest describeStackResourceRequest)	Returns a description of the specified resource in the specified stack.
default DescribeStackResourcesResponse	describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest)	Returns AWS resource descriptions for running and deleted stacks.
default DescribeStacksResponse	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.
default EstimateTemplateCostResponse	estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest)	Returns the estimated monthly cost of a template.
default ExecuteChangeSetResponse	executeChangeSet(ExecuteChangeSetRequest executeChangeSetRequest)	Updates a stack using the input information that was provided when the specified change set was created.
default GetStackPolicyResponse	getStackPolicy(GetStackPolicyRequest getStackPolicyRequest)	Returns the stack policy for a specified stack.
default GetTemplateResponse	getTemplate(GetTemplateRequest getTemplateRequest)	Returns the template body for a specified stack.
default GetTemplateSummaryResponse	getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest)	Returns information about a new or existing template.
default ListChangeSetsResponse	listChangeSets(ListChangeSetsRequest listChangeSetsRequest)	Returns the ID and status of each active change set for a stack.
default ListExportsResponse	listExports(ListExportsRequest listExportsRequest)	Lists all exported output values in the account and region in which you call this action.
default ListImportsResponse	listImports(ListImportsRequest listImportsRequest)	Lists all stacks that are importing an exported output value.
default ListStackResourcesResponse	listStackResources(ListStackResourcesRequest listStackResourcesRequest)	Returns descriptions of all resources of the specified stack.
default ListStacksResponse	listStacks(ListStacksRequest listStacksRequest)	Returns the summary information for stacks whose status matches the specified StackStatusFilter.
static ServiceMetadata	serviceMetadata()
default SetStackPolicyResponse	setStackPolicy(SetStackPolicyRequest setStackPolicyRequest)	Sets a stack policy for a specified stack.
default SignalResourceResponse	signalResource(SignalResourceRequest signalResourceRequest)	Sends a signal to the specified resource with a success or failure status.
default UpdateStackResponse	updateStack(UpdateStackRequest updateStackRequest)	Updates a stack as specified in the template.
default ValidateTemplateResponse	validateTemplate(ValidateTemplateRequest validateTemplateRequest)	Validates a specified template.
CloudFormationClientWaiters	waiters()

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static CloudFormationClient create()

Create a CloudFormationClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CloudFormationClientBuilder builder()

Create a builder that can be used to configure and create a CloudFormationClient.

cancelUpdateStack

default CancelUpdateStackResponse cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest)
                                             throws TokenAlreadyExistsException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    CloudFormationException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudFormationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

continueUpdateRollback

default ContinueUpdateRollbackResponse continueUpdateRollback(ContinueUpdateRollbackRequest continueUpdateRollbackRequest)
                                                       throws TokenAlreadyExistsException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              CloudFormationException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudFormationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createChangeSet

default CreateChangeSetResponse createChangeSet(CreateChangeSetRequest createChangeSetRequest)
                                         throws AlreadyExistsException,
                                                InsufficientCapabilitiesException,
                                                LimitExceededException,
                                                SdkBaseException,
                                                SdkClientException,
                                                CloudFormationException

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 - Resource with the name requested already exists.

InsufficientCapabilitiesException - The template contains resources with capabilities that were not specified in the Capabilities parameter.

LimitExceededException - Quota for the resource has already been reached.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudFormationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createStack

default CreateStackResponse createStack(CreateStackRequest createStackRequest)
                                 throws LimitExceededException,
                                        AlreadyExistsException,
                                        TokenAlreadyExistsException,
                                        InsufficientCapabilitiesException,
                                        SdkBaseException,
                                        SdkClientException,
                                        CloudFormationException

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 - Quota for the resource has already been reached.

AlreadyExistsException - Resource with the name requested already exists.

TokenAlreadyExistsException - A client request token already exists.

InsufficientCapabilitiesException - The template contains resources with capabilities that were not specified in the Capabilities parameter.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudFormationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteChangeSet

default DeleteChangeSetResponse deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest)
                                         throws InvalidChangeSetStatusException,
                                                SdkBaseException,
                                                SdkClientException,
                                                CloudFormationException

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

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudFormationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteStack

default DeleteStackResponse deleteStack(DeleteStackRequest deleteStackRequest)
                                 throws TokenAlreadyExistsException,
                                        SdkBaseException,
                                        SdkClientException,
                                        CloudFormationException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudFormationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeAccountLimits

default DescribeAccountLimitsResponse describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
                                                     throws SdkBaseException,
                                                            SdkClientException,
                                                            CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

describeChangeSet

default DescribeChangeSetResponse describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest)
                                             throws ChangeSetNotFoundException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    CloudFormationException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudFormationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeStackEvents

default DescribeStackEventsResponse describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest)
                                                 throws SdkBaseException,
                                                        SdkClientException,
                                                        CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

describeStackResource

default DescribeStackResourceResponse describeStackResource(DescribeStackResourceRequest describeStackResourceRequest)
                                                     throws SdkBaseException,
                                                            SdkClientException,
                                                            CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

describeStackResources

default DescribeStackResourcesResponse describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest)
                                                       throws SdkBaseException,
                                                              SdkClientException,
                                                              CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

describeStacks

default DescribeStacksResponse describeStacks(DescribeStacksRequest describeStacksRequest)
                                       throws SdkBaseException,
                                              SdkClientException,
                                              CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

estimateTemplateCost

default EstimateTemplateCostResponse estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest)
                                                   throws SdkBaseException,
                                                          SdkClientException,
                                                          CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

executeChangeSet

default ExecuteChangeSetResponse executeChangeSet(ExecuteChangeSetRequest executeChangeSetRequest)
                                           throws InvalidChangeSetStatusException,
                                                  ChangeSetNotFoundException,
                                                  InsufficientCapabilitiesException,
                                                  TokenAlreadyExistsException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  CloudFormationException

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 cannot 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 were not specified in the Capabilities parameter.

TokenAlreadyExistsException - A client request token already exists.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudFormationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getStackPolicy

default GetStackPolicyResponse getStackPolicy(GetStackPolicyRequest getStackPolicyRequest)
                                       throws SdkBaseException,
                                              SdkClientException,
                                              CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

getTemplate

default GetTemplateResponse getTemplate(GetTemplateRequest getTemplateRequest)
                                 throws ChangeSetNotFoundException,
                                        SdkBaseException,
                                        SdkClientException,
                                        CloudFormationException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudFormationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getTemplateSummary

default GetTemplateSummaryResponse getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest)
                                               throws SdkBaseException,
                                                      SdkClientException,
                                                      CloudFormationException

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.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for 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:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

listChangeSets

default ListChangeSetsResponse listChangeSets(ListChangeSetsRequest listChangeSetsRequest)
                                       throws SdkBaseException,
                                              SdkClientException,
                                              CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

listExports

default ListExportsResponse listExports(ListExportsRequest listExportsRequest)
                                 throws SdkBaseException,
                                        SdkClientException,
                                        CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

listImports

default ListImportsResponse listImports(ListImportsRequest listImportsRequest)
                                 throws SdkBaseException,
                                        SdkClientException,
                                        CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

listStackResources

default ListStackResourcesResponse listStackResources(ListStackResourcesRequest listStackResourcesRequest)
                                               throws SdkBaseException,
                                                      SdkClientException,
                                                      CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

listStacks

default ListStacksResponse listStacks(ListStacksRequest listStacksRequest)
                               throws SdkBaseException,
                                      SdkClientException,
                                      CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

setStackPolicy

default SetStackPolicyResponse setStackPolicy(SetStackPolicyRequest setStackPolicyRequest)
                                       throws SdkBaseException,
                                              SdkClientException,
                                              CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

signalResource

default SignalResourceResponse signalResource(SignalResourceRequest signalResourceRequest)
                                       throws SdkBaseException,
                                              SdkClientException,
                                              CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

updateStack

default UpdateStackResponse updateStack(UpdateStackRequest updateStackRequest)
                                 throws InsufficientCapabilitiesException,
                                        TokenAlreadyExistsException,
                                        SdkBaseException,
                                        SdkClientException,
                                        CloudFormationException

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 were not specified in the Capabilities parameter.

TokenAlreadyExistsException - A client request token already exists.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudFormationException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

validateTemplate

default ValidateTemplateResponse validateTemplate(ValidateTemplateRequest validateTemplateRequest)
                                           throws SdkBaseException,
                                                  SdkClientException,
                                                  CloudFormationException

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.

Throws:

SdkBaseException

SdkClientException

CloudFormationException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()

waiters

CloudFormationClientWaiters waiters()