@Generated(value="software.amazon.awssdk:codegen") public interface CloudFormationClient extends SdkClient, SdkAutoCloseable
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and 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 CancelUpdateStackResponse |
cancelUpdateStack(Consumer<CancelUpdateStackRequest.Builder> cancelUpdateStackRequest)
Cancels an update on the specified stack.
|
default ContinueUpdateRollbackResponse |
continueUpdateRollback(Consumer<ContinueUpdateRollbackRequest.Builder> continueUpdateRollbackRequest)
For a specified stack that is in the
UPDATE_ROLLBACK_FAILED state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE state. |
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(Consumer<CreateChangeSetRequest.Builder> createChangeSetRequest)
Creates a list of changes that will be applied to a stack so that you can review the changes before executing
them.
|
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(Consumer<CreateStackRequest.Builder> createStackRequest)
Creates a stack as specified in the template.
|
default CreateStackResponse |
createStack(CreateStackRequest createStackRequest)
Creates a stack as specified in the template.
|
default CreateStackInstancesResponse |
createStackInstances(Consumer<CreateStackInstancesRequest.Builder> createStackInstancesRequest)
Creates stack instances for the specified accounts, within the specified regions.
|
default CreateStackInstancesResponse |
createStackInstances(CreateStackInstancesRequest createStackInstancesRequest)
Creates stack instances for the specified accounts, within the specified regions.
|
default CreateStackSetResponse |
createStackSet(Consumer<CreateStackSetRequest.Builder> createStackSetRequest)
Creates a stack set.
|
default CreateStackSetResponse |
createStackSet(CreateStackSetRequest createStackSetRequest)
Creates a stack set.
|
default DeleteChangeSetResponse |
deleteChangeSet(Consumer<DeleteChangeSetRequest.Builder> deleteChangeSetRequest)
Deletes the specified change set.
|
default DeleteChangeSetResponse |
deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest)
Deletes the specified change set.
|
default DeleteStackResponse |
deleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest)
Deletes a specified stack.
|
default DeleteStackResponse |
deleteStack(DeleteStackRequest deleteStackRequest)
Deletes a specified stack.
|
default DeleteStackInstancesResponse |
deleteStackInstances(Consumer<DeleteStackInstancesRequest.Builder> deleteStackInstancesRequest)
Deletes stack instances for the specified accounts, in the specified regions.
|
default DeleteStackInstancesResponse |
deleteStackInstances(DeleteStackInstancesRequest deleteStackInstancesRequest)
Deletes stack instances for the specified accounts, in the specified regions.
|
default DeleteStackSetResponse |
deleteStackSet(Consumer<DeleteStackSetRequest.Builder> deleteStackSetRequest)
Deletes a stack set.
|
default DeleteStackSetResponse |
deleteStackSet(DeleteStackSetRequest deleteStackSetRequest)
Deletes a stack set.
|
default DescribeAccountLimitsResponse |
describeAccountLimits()
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in
your account.
|
default DescribeAccountLimitsResponse |
describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest)
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in
your account.
|
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(Consumer<DescribeChangeSetRequest.Builder> 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 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(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order.
|
default DescribeStackEventsResponse |
describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order.
|
default DescribeStackEventsIterable |
describeStackEventsPaginator(DescribeStackEventsRequest describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order.
|
default DescribeStackInstanceResponse |
describeStackInstance(Consumer<DescribeStackInstanceRequest.Builder> describeStackInstanceRequest)
Returns the stack instance that's associated with the specified stack set, AWS account, and region.
|
default DescribeStackInstanceResponse |
describeStackInstance(DescribeStackInstanceRequest describeStackInstanceRequest)
Returns the stack instance that's associated with the specified stack set, AWS account, and region.
|
default DescribeStackResourceResponse |
describeStackResource(Consumer<DescribeStackResourceRequest.Builder> describeStackResourceRequest)
Returns a description of the specified resource in the specified stack.
|
default DescribeStackResourceResponse |
describeStackResource(DescribeStackResourceRequest describeStackResourceRequest)
Returns a description of the specified resource in the specified stack.
|
default DescribeStackResourcesResponse |
describeStackResources(Consumer<DescribeStackResourcesRequest.Builder> describeStackResourcesRequest)
Returns AWS resource descriptions for running and deleted stacks.
|
default DescribeStackResourcesResponse |
describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest)
Returns AWS resource descriptions for running and deleted stacks.
|
default DescribeStacksResponse |
describeStacks()
Returns the description for the specified stack; if no stack name was specified, then it returns the description
for all the stacks created.
|
default DescribeStacksResponse |
describeStacks(Consumer<DescribeStacksRequest.Builder> 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 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 DescribeStackSetResponse |
describeStackSet(Consumer<DescribeStackSetRequest.Builder> describeStackSetRequest)
Returns the description of the specified stack set.
|
default DescribeStackSetResponse |
describeStackSet(DescribeStackSetRequest describeStackSetRequest)
Returns the description of the specified stack set.
|
default DescribeStackSetOperationResponse |
describeStackSetOperation(Consumer<DescribeStackSetOperationRequest.Builder> describeStackSetOperationRequest)
Returns the description of the specified stack set operation.
|
default DescribeStackSetOperationResponse |
describeStackSetOperation(DescribeStackSetOperationRequest describeStackSetOperationRequest)
Returns the description of the specified stack set operation.
|
default DescribeStacksIterable |
describeStacksPaginator()
Returns the description for the specified stack; if no stack name was specified, then it returns the description
for all the stacks created.
|
default DescribeStacksIterable |
describeStacksPaginator(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(Consumer<EstimateTemplateCostRequest.Builder> estimateTemplateCostRequest)
Returns the estimated monthly cost of a template.
|
default EstimateTemplateCostResponse |
estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest)
Returns the estimated monthly cost of a template.
|
default ExecuteChangeSetResponse |
executeChangeSet(Consumer<ExecuteChangeSetRequest.Builder> executeChangeSetRequest)
Updates a stack using the input information that was provided when the specified change set was created.
|
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(Consumer<GetStackPolicyRequest.Builder> getStackPolicyRequest)
Returns the stack policy for a specified stack.
|
default GetStackPolicyResponse |
getStackPolicy(GetStackPolicyRequest getStackPolicyRequest)
Returns the stack policy for a specified stack.
|
default GetTemplateResponse |
getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest)
Returns the template body for a specified stack.
|
default GetTemplateResponse |
getTemplate(GetTemplateRequest getTemplateRequest)
Returns the template body for a specified stack.
|
default GetTemplateSummaryResponse |
getTemplateSummary(Consumer<GetTemplateSummaryRequest.Builder> getTemplateSummaryRequest)
Returns information about a new or existing template.
|
default GetTemplateSummaryResponse |
getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest)
Returns information about a new or existing template.
|
default ListChangeSetsResponse |
listChangeSets(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest)
Returns the ID and status of each active change set for a stack.
|
default ListChangeSetsResponse |
listChangeSets(ListChangeSetsRequest listChangeSetsRequest)
Returns the ID and status of each active change set for a stack.
|
default ListExportsResponse |
listExports()
Lists all exported output values in the account and region in which you call this action.
|
default ListExportsResponse |
listExports(Consumer<ListExportsRequest.Builder> listExportsRequest)
Lists all exported output values in the account and region in which you call this action.
|
default ListExportsResponse |
listExports(ListExportsRequest listExportsRequest)
Lists all exported output values in the account and region in which you call this action.
|
default ListExportsIterable |
listExportsPaginator()
Lists all exported output values in the account and region in which you call this action.
|
default ListExportsIterable |
listExportsPaginator(ListExportsRequest listExportsRequest)
Lists all exported output values in the account and region in which you call this action.
|
default ListImportsResponse |
listImports(Consumer<ListImportsRequest.Builder> listImportsRequest)
Lists all stacks that are importing an exported output value.
|
default ListImportsResponse |
listImports(ListImportsRequest listImportsRequest)
Lists all stacks that are importing an exported output value.
|
default ListImportsIterable |
listImportsPaginator(ListImportsRequest listImportsRequest)
Lists all stacks that are importing an exported output value.
|
default ListStackInstancesResponse |
listStackInstances(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest)
Returns summary information about stack instances that are associated with the specified stack set.
|
default ListStackInstancesResponse |
listStackInstances(ListStackInstancesRequest listStackInstancesRequest)
Returns summary information about stack instances that are associated with the specified stack set.
|
default ListStackResourcesResponse |
listStackResources(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
default ListStackResourcesResponse |
listStackResources(ListStackResourcesRequest listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
default ListStackResourcesIterable |
listStackResourcesPaginator(ListStackResourcesRequest listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
default ListStacksResponse |
listStacks()
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default ListStacksResponse |
listStacks(Consumer<ListStacksRequest.Builder> listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default ListStacksResponse |
listStacks(ListStacksRequest listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default ListStackSetOperationResultsResponse |
listStackSetOperationResults(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest)
Returns summary information about the results of a stack set operation.
|
default ListStackSetOperationResultsResponse |
listStackSetOperationResults(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest)
Returns summary information about the results of a stack set operation.
|
default ListStackSetOperationsResponse |
listStackSetOperations(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest)
Returns summary information about operations performed on a stack set.
|
default ListStackSetOperationsResponse |
listStackSetOperations(ListStackSetOperationsRequest listStackSetOperationsRequest)
Returns summary information about operations performed on a stack set.
|
default ListStackSetsResponse |
listStackSets()
Returns summary information about stack sets that are associated with the user.
|
default ListStackSetsResponse |
listStackSets(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest)
Returns summary information about stack sets that are associated with the user.
|
default ListStackSetsResponse |
listStackSets(ListStackSetsRequest listStackSetsRequest)
Returns summary information about stack sets that are associated with the user.
|
default ListStacksIterable |
listStacksPaginator()
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default ListStacksIterable |
listStacksPaginator(ListStacksRequest listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
static ServiceMetadata |
serviceMetadata() |
default SetStackPolicyResponse |
setStackPolicy(Consumer<SetStackPolicyRequest.Builder> setStackPolicyRequest)
Sets a stack policy for a specified stack.
|
default SetStackPolicyResponse |
setStackPolicy(SetStackPolicyRequest setStackPolicyRequest)
Sets a stack policy for a specified stack.
|
default SignalResourceResponse |
signalResource(Consumer<SignalResourceRequest.Builder> signalResourceRequest)
Sends a signal to the specified resource with a success or failure status.
|
default SignalResourceResponse |
signalResource(SignalResourceRequest signalResourceRequest)
Sends a signal to the specified resource with a success or failure status.
|
default StopStackSetOperationResponse |
stopStackSetOperation(Consumer<StopStackSetOperationRequest.Builder> stopStackSetOperationRequest)
Stops an in-progress operation on a stack set and its associated stack instances.
|
default StopStackSetOperationResponse |
stopStackSetOperation(StopStackSetOperationRequest stopStackSetOperationRequest)
Stops an in-progress operation on a stack set and its associated stack instances.
|
default UpdateStackResponse |
updateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest)
Updates a stack as specified in the template.
|
default UpdateStackResponse |
updateStack(UpdateStackRequest updateStackRequest)
Updates a stack as specified in the template.
|
default UpdateStackSetResponse |
updateStackSet(Consumer<UpdateStackSetRequest.Builder> updateStackSetRequest)
Updates the stack set and all associated stack instances.
|
default UpdateStackSetResponse |
updateStackSet(UpdateStackSetRequest updateStackSetRequest)
Updates the stack set and all associated stack instances.
|
default UpdateTerminationProtectionResponse |
updateTerminationProtection(Consumer<UpdateTerminationProtectionRequest.Builder> updateTerminationProtectionRequest)
Updates termination protection for the specified stack.
|
default UpdateTerminationProtectionResponse |
updateTerminationProtection(UpdateTerminationProtectionRequest updateTerminationProtectionRequest)
Updates termination protection for the specified stack.
|
default ValidateTemplateResponse |
validateTemplate(Consumer<ValidateTemplateRequest.Builder> validateTemplateRequest)
Validates a specified template.
|
default ValidateTemplateResponse |
validateTemplate(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template.
|
serviceName
close
static final String SERVICE_NAME
static CloudFormationClient create()
CloudFormationClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static CloudFormationClientBuilder builder()
CloudFormationClient
.default CancelUpdateStackResponse cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest) throws TokenAlreadyExistsException, SdkServiceException, 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.
cancelUpdateStackRequest
- The input for the CancelUpdateStack action.TokenAlreadyExistsException
- A client request token already exists.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CancelUpdateStackResponse cancelUpdateStack(Consumer<CancelUpdateStackRequest.Builder> cancelUpdateStackRequest) throws TokenAlreadyExistsException, SdkServiceException, 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.
cancelUpdateStackRequest
- The input for the CancelUpdateStack action.TokenAlreadyExistsException
- A client request token already exists.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ContinueUpdateRollbackResponse continueUpdateRollback(ContinueUpdateRollbackRequest continueUpdateRollbackRequest) throws TokenAlreadyExistsException, SdkServiceException, 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.
continueUpdateRollbackRequest
- The input for the ContinueUpdateRollback action.TokenAlreadyExistsException
- A client request token already exists.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ContinueUpdateRollbackResponse continueUpdateRollback(Consumer<ContinueUpdateRollbackRequest.Builder> continueUpdateRollbackRequest) throws TokenAlreadyExistsException, SdkServiceException, 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.
continueUpdateRollbackRequest
- The input for the ContinueUpdateRollback action.TokenAlreadyExistsException
- A client request token already exists.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateChangeSetResponse createChangeSet(CreateChangeSetRequest createChangeSetRequest) throws AlreadyExistsException, InsufficientCapabilitiesException, LimitExceededException, SdkServiceException, 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.
createChangeSetRequest
- The input for the CreateChangeSet action.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.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateChangeSetResponse createChangeSet(Consumer<CreateChangeSetRequest.Builder> createChangeSetRequest) throws AlreadyExistsException, InsufficientCapabilitiesException, LimitExceededException, SdkServiceException, 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.
createChangeSetRequest
- The input for the CreateChangeSet action.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.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateStackResponse createStack(CreateStackRequest createStackRequest) throws LimitExceededException, AlreadyExistsException, TokenAlreadyExistsException, InsufficientCapabilitiesException, SdkServiceException, 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.
createStackRequest
- The input for CreateStack action.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateStackResponse createStack(Consumer<CreateStackRequest.Builder> createStackRequest) throws LimitExceededException, AlreadyExistsException, TokenAlreadyExistsException, InsufficientCapabilitiesException, SdkServiceException, 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.
createStackRequest
- The input for CreateStack action.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateStackInstancesResponse createStackInstances(CreateStackInstancesRequest createStackInstancesRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, LimitExceededException, SdkServiceException, SdkClientException, CloudFormationException
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.
createStackInstancesRequest
- 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.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateStackInstancesResponse createStackInstances(Consumer<CreateStackInstancesRequest.Builder> createStackInstancesRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, LimitExceededException, SdkServiceException, SdkClientException, CloudFormationException
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.
createStackInstancesRequest
- 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.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateStackSetResponse createStackSet(CreateStackSetRequest createStackSetRequest) throws NameAlreadyExistsException, CreatedButModifiedException, LimitExceededException, SdkServiceException, SdkClientException, CloudFormationException
Creates a stack set.
createStackSetRequest
- 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.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateStackSetResponse createStackSet(Consumer<CreateStackSetRequest.Builder> createStackSetRequest) throws NameAlreadyExistsException, CreatedButModifiedException, LimitExceededException, SdkServiceException, SdkClientException, CloudFormationException
Creates a stack set.
createStackSetRequest
- 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.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteChangeSetResponse deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest) throws InvalidChangeSetStatusException, SdkServiceException, 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.
deleteChangeSetRequest
- The input for the DeleteChangeSet action.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
.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteChangeSetResponse deleteChangeSet(Consumer<DeleteChangeSetRequest.Builder> deleteChangeSetRequest) throws InvalidChangeSetStatusException, SdkServiceException, 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.
deleteChangeSetRequest
- The input for the DeleteChangeSet action.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
.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteStackResponse deleteStack(DeleteStackRequest deleteStackRequest) throws TokenAlreadyExistsException, SdkServiceException, 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.
deleteStackRequest
- The input for DeleteStack action.TokenAlreadyExistsException
- A client request token already exists.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteStackResponse deleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest) throws TokenAlreadyExistsException, SdkServiceException, 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.
deleteStackRequest
- The input for DeleteStack action.TokenAlreadyExistsException
- A client request token already exists.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteStackInstancesResponse deleteStackInstances(DeleteStackInstancesRequest deleteStackInstancesRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, SdkServiceException, SdkClientException, CloudFormationException
Deletes stack instances for the specified accounts, in the specified regions.
deleteStackInstancesRequest
- 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteStackInstancesResponse deleteStackInstances(Consumer<DeleteStackInstancesRequest.Builder> deleteStackInstancesRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, SdkServiceException, SdkClientException, CloudFormationException
Deletes stack instances for the specified accounts, in the specified regions.
deleteStackInstancesRequest
- 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteStackSetResponse deleteStackSet(DeleteStackSetRequest deleteStackSetRequest) throws StackSetNotEmptyException, OperationInProgressException, SdkServiceException, SdkClientException, CloudFormationException
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.
deleteStackSetRequest
- 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteStackSetResponse deleteStackSet(Consumer<DeleteStackSetRequest.Builder> deleteStackSetRequest) throws StackSetNotEmptyException, OperationInProgressException, SdkServiceException, SdkClientException, CloudFormationException
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.
deleteStackSetRequest
- 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeAccountLimitsResponse describeAccountLimits() throws SdkServiceException, SdkClientException, CloudFormationException
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
describeAccountLimits(DescribeAccountLimitsRequest)
,
AWS API Documentationdefault DescribeAccountLimitsResponse describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) throws SdkServiceException, SdkClientException, CloudFormationException
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
describeAccountLimitsRequest
- The input for the DescribeAccountLimits action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeAccountLimitsResponse describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) throws SdkServiceException, SdkClientException, CloudFormationException
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
describeAccountLimitsRequest
- The input for the DescribeAccountLimits action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeChangeSetResponse describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest) throws ChangeSetNotFoundException, SdkServiceException, 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.
describeChangeSetRequest
- The input for the DescribeChangeSet action.ChangeSetNotFoundException
- The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSets
action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeChangeSetResponse describeChangeSet(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest) throws ChangeSetNotFoundException, SdkServiceException, 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.
describeChangeSetRequest
- The input for the DescribeChangeSet action.ChangeSetNotFoundException
- The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSets
action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStackEventsResponse describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest) throws SdkServiceException, 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).
describeStackEventsRequest
- The input for DescribeStackEvents action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStackEventsResponse describeStackEvents(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest) throws SdkServiceException, 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).
describeStackEventsRequest
- The input for DescribeStackEvents action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStackEventsIterable describeStackEventsPaginator(DescribeStackEventsRequest describeStackEventsRequest) throws SdkServiceException, 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).
This is a variant of
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client.describeStackEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client .describeStackEventsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client.describeStackEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)
operation.
describeStackEventsRequest
- The input for DescribeStackEvents action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStackInstanceResponse describeStackInstance(DescribeStackInstanceRequest describeStackInstanceRequest) throws StackSetNotFoundException, StackInstanceNotFoundException, SdkServiceException, SdkClientException, CloudFormationException
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.
describeStackInstanceRequest
- StackSetNotFoundException
- The specified stack set doesn't exist.StackInstanceNotFoundException
- The specified stack instance doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStackInstanceResponse describeStackInstance(Consumer<DescribeStackInstanceRequest.Builder> describeStackInstanceRequest) throws StackSetNotFoundException, StackInstanceNotFoundException, SdkServiceException, SdkClientException, CloudFormationException
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.
describeStackInstanceRequest
- StackSetNotFoundException
- The specified stack set doesn't exist.StackInstanceNotFoundException
- The specified stack instance doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStackResourceResponse describeStackResource(DescribeStackResourceRequest describeStackResourceRequest) throws SdkServiceException, 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.
describeStackResourceRequest
- The input for DescribeStackResource action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStackResourceResponse describeStackResource(Consumer<DescribeStackResourceRequest.Builder> describeStackResourceRequest) throws SdkServiceException, 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.
describeStackResourceRequest
- The input for DescribeStackResource action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStackResourcesResponse describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest) throws SdkServiceException, 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.
describeStackResourcesRequest
- The input for DescribeStackResources action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStackResourcesResponse describeStackResources(Consumer<DescribeStackResourcesRequest.Builder> describeStackResourcesRequest) throws SdkServiceException, 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.
describeStackResourcesRequest
- The input for DescribeStackResources action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStackSetResponse describeStackSet(DescribeStackSetRequest describeStackSetRequest) throws StackSetNotFoundException, SdkServiceException, SdkClientException, CloudFormationException
Returns the description of the specified stack set.
describeStackSetRequest
- StackSetNotFoundException
- The specified stack set doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStackSetResponse describeStackSet(Consumer<DescribeStackSetRequest.Builder> describeStackSetRequest) throws StackSetNotFoundException, SdkServiceException, SdkClientException, CloudFormationException
Returns the description of the specified stack set.
describeStackSetRequest
- StackSetNotFoundException
- The specified stack set doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStackSetOperationResponse describeStackSetOperation(DescribeStackSetOperationRequest describeStackSetOperationRequest) throws StackSetNotFoundException, OperationNotFoundException, SdkServiceException, SdkClientException, CloudFormationException
Returns the description of the specified stack set operation.
describeStackSetOperationRequest
- StackSetNotFoundException
- The specified stack set doesn't exist.OperationNotFoundException
- The specified ID refers to an operation that doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStackSetOperationResponse describeStackSetOperation(Consumer<DescribeStackSetOperationRequest.Builder> describeStackSetOperationRequest) throws StackSetNotFoundException, OperationNotFoundException, SdkServiceException, SdkClientException, CloudFormationException
Returns the description of the specified stack set operation.
describeStackSetOperationRequest
- StackSetNotFoundException
- The specified stack set doesn't exist.OperationNotFoundException
- The specified ID refers to an operation that doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStacksResponse describeStacks() throws SdkServiceException, 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.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
describeStacks(DescribeStacksRequest)
,
AWS
API Documentationdefault DescribeStacksResponse describeStacks(DescribeStacksRequest describeStacksRequest) throws SdkServiceException, 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.
describeStacksRequest
- The input for DescribeStacks action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStacksResponse describeStacks(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) throws SdkServiceException, 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.
describeStacksRequest
- The input for DescribeStacks action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeStacksIterable describeStacksPaginator() throws SdkServiceException, 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.
This is a variant of
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client .describeStacksPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
describeStacksPaginator(DescribeStacksRequest)
,
AWS
API Documentationdefault DescribeStacksIterable describeStacksPaginator(DescribeStacksRequest describeStacksRequest) throws SdkServiceException, 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.
This is a variant of
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client .describeStacksPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation.
describeStacksRequest
- The input for DescribeStacks action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default EstimateTemplateCostResponse estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest) throws SdkServiceException, 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.
estimateTemplateCostRequest
- The input for an EstimateTemplateCost action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default EstimateTemplateCostResponse estimateTemplateCost(Consumer<EstimateTemplateCostRequest.Builder> estimateTemplateCostRequest) throws SdkServiceException, 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.
estimateTemplateCostRequest
- The input for an EstimateTemplateCost action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ExecuteChangeSetResponse executeChangeSet(ExecuteChangeSetRequest executeChangeSetRequest) throws InvalidChangeSetStatusException, ChangeSetNotFoundException, InsufficientCapabilitiesException, TokenAlreadyExistsException, SdkServiceException, 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.
executeChangeSetRequest
- The input for the ExecuteChangeSet action.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ExecuteChangeSetResponse executeChangeSet(Consumer<ExecuteChangeSetRequest.Builder> executeChangeSetRequest) throws InvalidChangeSetStatusException, ChangeSetNotFoundException, InsufficientCapabilitiesException, TokenAlreadyExistsException, SdkServiceException, 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.
executeChangeSetRequest
- The input for the ExecuteChangeSet action.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetStackPolicyResponse getStackPolicy(GetStackPolicyRequest getStackPolicyRequest) throws SdkServiceException, SdkClientException, CloudFormationException
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
getStackPolicyRequest
- The input for the GetStackPolicy action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetStackPolicyResponse getStackPolicy(Consumer<GetStackPolicyRequest.Builder> getStackPolicyRequest) throws SdkServiceException, SdkClientException, CloudFormationException
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
getStackPolicyRequest
- The input for the GetStackPolicy action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetTemplateResponse getTemplate(GetTemplateRequest getTemplateRequest) throws ChangeSetNotFoundException, SdkServiceException, 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.
getTemplateRequest
- The input for a GetTemplate action.ChangeSetNotFoundException
- The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSets
action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetTemplateResponse getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest) throws ChangeSetNotFoundException, SdkServiceException, 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.
getTemplateRequest
- The input for a GetTemplate action.ChangeSetNotFoundException
- The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSets
action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetTemplateSummaryResponse getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest) throws StackSetNotFoundException, SdkServiceException, 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 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.
getTemplateSummaryRequest
- The input for the GetTemplateSummary action.StackSetNotFoundException
- The specified stack set doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetTemplateSummaryResponse getTemplateSummary(Consumer<GetTemplateSummaryRequest.Builder> getTemplateSummaryRequest) throws StackSetNotFoundException, SdkServiceException, 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 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.
getTemplateSummaryRequest
- The input for the GetTemplateSummary action.StackSetNotFoundException
- The specified stack set doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListChangeSetsResponse listChangeSets(ListChangeSetsRequest listChangeSetsRequest) throws SdkServiceException, 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.
listChangeSetsRequest
- The input for the ListChangeSets action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListChangeSetsResponse listChangeSets(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) throws SdkServiceException, 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.
listChangeSetsRequest
- The input for the ListChangeSets action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListExportsResponse listExports() throws SdkServiceException, 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.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
listExports(ListExportsRequest)
,
AWS API
Documentationdefault ListExportsResponse listExports(ListExportsRequest listExportsRequest) throws SdkServiceException, 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.
listExportsRequest
- SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListExportsResponse listExports(Consumer<ListExportsRequest.Builder> listExportsRequest) throws SdkServiceException, 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.
listExportsRequest
- SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListExportsIterable listExportsPaginator() throws SdkServiceException, 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.
This is a variant of
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client .listExportsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)
operation.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
listExportsPaginator(ListExportsRequest)
,
AWS API
Documentationdefault ListExportsIterable listExportsPaginator(ListExportsRequest listExportsRequest) throws SdkServiceException, 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.
This is a variant of
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client .listExportsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)
operation.
listExportsRequest
- SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListImportsResponse listImports(ListImportsRequest listImportsRequest) throws SdkServiceException, 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.
listImportsRequest
- SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListImportsResponse listImports(Consumer<ListImportsRequest.Builder> listImportsRequest) throws SdkServiceException, 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.
listImportsRequest
- SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListImportsIterable listImportsPaginator(ListImportsRequest listImportsRequest) throws SdkServiceException, 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.
This is a variant of
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client .listImportsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListImportsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest)
operation.
listImportsRequest
- SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListStackInstancesResponse listStackInstances(ListStackInstancesRequest listStackInstancesRequest) throws StackSetNotFoundException, SdkServiceException, SdkClientException, CloudFormationException
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.
listStackInstancesRequest
- StackSetNotFoundException
- The specified stack set doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListStackInstancesResponse listStackInstances(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest) throws StackSetNotFoundException, SdkServiceException, SdkClientException, CloudFormationException
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.
listStackInstancesRequest
- StackSetNotFoundException
- The specified stack set doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListStackResourcesResponse listStackResources(ListStackResourcesRequest listStackResourcesRequest) throws SdkServiceException, 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.
listStackResourcesRequest
- The input for the ListStackResource action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListStackResourcesResponse listStackResources(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest) throws SdkServiceException, 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.
listStackResourcesRequest
- The input for the ListStackResource action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListStackResourcesIterable listStackResourcesPaginator(ListStackResourcesRequest listStackResourcesRequest) throws SdkServiceException, 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.
This is a variant of
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client.listStackResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client .listStackResourcesPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client.listStackResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)
operation.
listStackResourcesRequest
- The input for the ListStackResource action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListStackSetOperationResultsResponse listStackSetOperationResults(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest) throws StackSetNotFoundException, OperationNotFoundException, SdkServiceException, SdkClientException, CloudFormationException
Returns summary information about the results of a stack set operation.
listStackSetOperationResultsRequest
- StackSetNotFoundException
- The specified stack set doesn't exist.OperationNotFoundException
- The specified ID refers to an operation that doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListStackSetOperationResultsResponse listStackSetOperationResults(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest) throws StackSetNotFoundException, OperationNotFoundException, SdkServiceException, SdkClientException, CloudFormationException
Returns summary information about the results of a stack set operation.
listStackSetOperationResultsRequest
- StackSetNotFoundException
- The specified stack set doesn't exist.OperationNotFoundException
- The specified ID refers to an operation that doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListStackSetOperationsResponse listStackSetOperations(ListStackSetOperationsRequest listStackSetOperationsRequest) throws StackSetNotFoundException, SdkServiceException, SdkClientException, CloudFormationException
Returns summary information about operations performed on a stack set.
listStackSetOperationsRequest
- StackSetNotFoundException
- The specified stack set doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListStackSetOperationsResponse listStackSetOperations(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest) throws StackSetNotFoundException, SdkServiceException, SdkClientException, CloudFormationException
Returns summary information about operations performed on a stack set.
listStackSetOperationsRequest
- StackSetNotFoundException
- The specified stack set doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListStackSetsResponse listStackSets() throws SdkServiceException, SdkClientException, CloudFormationException
Returns summary information about stack sets that are associated with the user.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
listStackSets(ListStackSetsRequest)
,
AWS
API Documentationdefault ListStackSetsResponse listStackSets(ListStackSetsRequest listStackSetsRequest) throws SdkServiceException, SdkClientException, CloudFormationException
Returns summary information about stack sets that are associated with the user.
listStackSetsRequest
- SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListStackSetsResponse listStackSets(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest) throws SdkServiceException, SdkClientException, CloudFormationException
Returns summary information about stack sets that are associated with the user.
listStackSetsRequest
- SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListStacksResponse listStacks() throws SdkServiceException, 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).
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
listStacks(ListStacksRequest)
,
AWS API
Documentationdefault ListStacksResponse listStacks(ListStacksRequest listStacksRequest) throws SdkServiceException, 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).
listStacksRequest
- The input for ListStacks action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListStacksResponse listStacks(Consumer<ListStacksRequest.Builder> listStacksRequest) throws SdkServiceException, 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).
listStacksRequest
- The input for ListStacks action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListStacksIterable listStacksPaginator() throws SdkServiceException, 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).
This is a variant of listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
listStacksPaginator(ListStacksRequest)
,
AWS API
Documentationdefault ListStacksIterable listStacksPaginator(ListStacksRequest listStacksRequest) throws SdkServiceException, 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).
This is a variant of listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation.
listStacksRequest
- The input for ListStacks action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SetStackPolicyResponse setStackPolicy(SetStackPolicyRequest setStackPolicyRequest) throws SdkServiceException, SdkClientException, CloudFormationException
Sets a stack policy for a specified stack.
setStackPolicyRequest
- The input for the SetStackPolicy action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SetStackPolicyResponse setStackPolicy(Consumer<SetStackPolicyRequest.Builder> setStackPolicyRequest) throws SdkServiceException, SdkClientException, CloudFormationException
Sets a stack policy for a specified stack.
setStackPolicyRequest
- The input for the SetStackPolicy action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SignalResourceResponse signalResource(SignalResourceRequest signalResourceRequest) throws SdkServiceException, 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.
signalResourceRequest
- The input for the SignalResource action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SignalResourceResponse signalResource(Consumer<SignalResourceRequest.Builder> signalResourceRequest) throws SdkServiceException, 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.
signalResourceRequest
- The input for the SignalResource action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default StopStackSetOperationResponse stopStackSetOperation(StopStackSetOperationRequest stopStackSetOperationRequest) throws StackSetNotFoundException, OperationNotFoundException, InvalidOperationException, SdkServiceException, SdkClientException, CloudFormationException
Stops an in-progress operation on a stack set and its associated stack instances.
stopStackSetOperationRequest
- 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default StopStackSetOperationResponse stopStackSetOperation(Consumer<StopStackSetOperationRequest.Builder> stopStackSetOperationRequest) throws StackSetNotFoundException, OperationNotFoundException, InvalidOperationException, SdkServiceException, SdkClientException, CloudFormationException
Stops an in-progress operation on a stack set and its associated stack instances.
stopStackSetOperationRequest
- 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default UpdateStackResponse updateStack(UpdateStackRequest updateStackRequest) throws InsufficientCapabilitiesException, TokenAlreadyExistsException, SdkServiceException, 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.
updateStackRequest
- The input for an UpdateStack action.InsufficientCapabilitiesException
- The template contains resources with capabilities that weren't specified in the Capabilities parameter.TokenAlreadyExistsException
- A client request token already exists.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default UpdateStackResponse updateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest) throws InsufficientCapabilitiesException, TokenAlreadyExistsException, SdkServiceException, 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.
updateStackRequest
- The input for an UpdateStack action.InsufficientCapabilitiesException
- The template contains resources with capabilities that weren't specified in the Capabilities parameter.TokenAlreadyExistsException
- A client request token already exists.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default UpdateStackSetResponse updateStackSet(UpdateStackSetRequest updateStackSetRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, SdkServiceException, SdkClientException, CloudFormationException
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.
updateStackSetRequest
- 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default UpdateStackSetResponse updateStackSet(Consumer<UpdateStackSetRequest.Builder> updateStackSetRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, SdkServiceException, SdkClientException, CloudFormationException
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.
updateStackSetRequest
- 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default UpdateTerminationProtectionResponse updateTerminationProtection(UpdateTerminationProtectionRequest updateTerminationProtectionRequest) throws SdkServiceException, SdkClientException, CloudFormationException
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.
updateTerminationProtectionRequest
- SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default UpdateTerminationProtectionResponse updateTerminationProtection(Consumer<UpdateTerminationProtectionRequest.Builder> updateTerminationProtectionRequest) throws SdkServiceException, SdkClientException, CloudFormationException
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.
updateTerminationProtectionRequest
- SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ValidateTemplateResponse validateTemplate(ValidateTemplateRequest validateTemplateRequest) throws SdkServiceException, 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.
validateTemplateRequest
- The input for ValidateTemplate action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ValidateTemplateResponse validateTemplate(Consumer<ValidateTemplateRequest.Builder> validateTemplateRequest) throws SdkServiceException, 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.
validateTemplateRequest
- The input for ValidateTemplate action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.