public interface AmazonCloudFormationAsync extends AmazonCloudFormation
AsyncHandler can be used to
receive notification when an asynchronous operation completes.
AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applications without worrying about creating and configuring the underlying 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 this product, go to the CloudFormation Product Page.
Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at http://docs.aws.amazon.com/documentation/.
| Modifier and Type | Method and Description |
|---|---|
Future<Void> |
cancelUpdateStackAsync(CancelUpdateStackRequest cancelUpdateStackRequest)
Cancels an update on the specified stack.
|
Future<Void> |
cancelUpdateStackAsync(CancelUpdateStackRequest cancelUpdateStackRequest,
AsyncHandler<CancelUpdateStackRequest,Void> asyncHandler)
Cancels an update on the specified stack.
|
Future<ContinueUpdateRollbackResult> |
continueUpdateRollbackAsync(ContinueUpdateRollbackRequest continueUpdateRollbackRequest)
For a specified stack that is in the
UPDATE_ROLLBACK_FAILED
state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE state. |
Future<ContinueUpdateRollbackResult> |
continueUpdateRollbackAsync(ContinueUpdateRollbackRequest continueUpdateRollbackRequest,
AsyncHandler<ContinueUpdateRollbackRequest,ContinueUpdateRollbackResult> asyncHandler)
For a specified stack that is in the
UPDATE_ROLLBACK_FAILED
state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE state. |
Future<CreateChangeSetResult> |
createChangeSetAsync(CreateChangeSetRequest createChangeSetRequest)
Creates a list of changes for a stack.
|
Future<CreateChangeSetResult> |
createChangeSetAsync(CreateChangeSetRequest createChangeSetRequest,
AsyncHandler<CreateChangeSetRequest,CreateChangeSetResult> asyncHandler)
Creates a list of changes for a stack.
|
Future<CreateStackResult> |
createStackAsync(CreateStackRequest createStackRequest)
Creates a stack as specified in the template.
|
Future<CreateStackResult> |
createStackAsync(CreateStackRequest createStackRequest,
AsyncHandler<CreateStackRequest,CreateStackResult> asyncHandler)
Creates a stack as specified in the template.
|
Future<DeleteChangeSetResult> |
deleteChangeSetAsync(DeleteChangeSetRequest deleteChangeSetRequest)
Deletes the specified change set.
|
Future<DeleteChangeSetResult> |
deleteChangeSetAsync(DeleteChangeSetRequest deleteChangeSetRequest,
AsyncHandler<DeleteChangeSetRequest,DeleteChangeSetResult> asyncHandler)
Deletes the specified change set.
|
Future<Void> |
deleteStackAsync(DeleteStackRequest deleteStackRequest)
Deletes a specified stack.
|
Future<Void> |
deleteStackAsync(DeleteStackRequest deleteStackRequest,
AsyncHandler<DeleteStackRequest,Void> asyncHandler)
Deletes a specified stack.
|
Future<DescribeAccountLimitsResult> |
describeAccountLimitsAsync(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Retrieves your account's AWS CloudFormation limits, such as the maximum
number of stacks that you can create in your account.
|
Future<DescribeAccountLimitsResult> |
describeAccountLimitsAsync(DescribeAccountLimitsRequest describeAccountLimitsRequest,
AsyncHandler<DescribeAccountLimitsRequest,DescribeAccountLimitsResult> asyncHandler)
Retrieves your account's AWS CloudFormation limits, such as the maximum
number of stacks that you can create in your account.
|
Future<DescribeChangeSetResult> |
describeChangeSetAsync(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.
|
Future<DescribeChangeSetResult> |
describeChangeSetAsync(DescribeChangeSetRequest describeChangeSetRequest,
AsyncHandler<DescribeChangeSetRequest,DescribeChangeSetResult> asyncHandler)
Returns the inputs for the change set and a list of changes that AWS
CloudFormation will make if you execute the change set.
|
Future<DescribeStackEventsResult> |
describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest)
Returns all stack related events for a specified stack.
|
Future<DescribeStackEventsResult> |
describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest,
AsyncHandler<DescribeStackEventsRequest,DescribeStackEventsResult> asyncHandler)
Returns all stack related events for a specified stack.
|
Future<DescribeStackResourceResult> |
describeStackResourceAsync(DescribeStackResourceRequest describeStackResourceRequest)
Returns a description of the specified resource in the specified stack.
|
Future<DescribeStackResourceResult> |
describeStackResourceAsync(DescribeStackResourceRequest describeStackResourceRequest,
AsyncHandler<DescribeStackResourceRequest,DescribeStackResourceResult> asyncHandler)
Returns a description of the specified resource in the specified stack.
|
Future<DescribeStackResourcesResult> |
describeStackResourcesAsync(DescribeStackResourcesRequest describeStackResourcesRequest)
Returns AWS resource descriptions for running and deleted stacks.
|
Future<DescribeStackResourcesResult> |
describeStackResourcesAsync(DescribeStackResourcesRequest describeStackResourcesRequest,
AsyncHandler<DescribeStackResourcesRequest,DescribeStackResourcesResult> asyncHandler)
Returns AWS resource descriptions for running and deleted stacks.
|
Future<DescribeStacksResult> |
describeStacksAsync()
Simplified method form for invoking the DescribeStacks operation.
|
Future<DescribeStacksResult> |
describeStacksAsync(AsyncHandler<DescribeStacksRequest,DescribeStacksResult> asyncHandler)
Simplified method form for invoking the DescribeStacks operation with an
AsyncHandler.
|
Future<DescribeStacksResult> |
describeStacksAsync(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.
|
Future<DescribeStacksResult> |
describeStacksAsync(DescribeStacksRequest describeStacksRequest,
AsyncHandler<DescribeStacksRequest,DescribeStacksResult> asyncHandler)
Returns the description for the specified stack; if no stack name was
specified, then it returns the description for all the stacks created.
|
Future<EstimateTemplateCostResult> |
estimateTemplateCostAsync()
Simplified method form for invoking the EstimateTemplateCost operation.
|
Future<EstimateTemplateCostResult> |
estimateTemplateCostAsync(AsyncHandler<EstimateTemplateCostRequest,EstimateTemplateCostResult> asyncHandler)
Simplified method form for invoking the EstimateTemplateCost operation
with an AsyncHandler.
|
Future<EstimateTemplateCostResult> |
estimateTemplateCostAsync(EstimateTemplateCostRequest estimateTemplateCostRequest)
Returns the estimated monthly cost of a template.
|
Future<EstimateTemplateCostResult> |
estimateTemplateCostAsync(EstimateTemplateCostRequest estimateTemplateCostRequest,
AsyncHandler<EstimateTemplateCostRequest,EstimateTemplateCostResult> asyncHandler)
Returns the estimated monthly cost of a template.
|
Future<ExecuteChangeSetResult> |
executeChangeSetAsync(ExecuteChangeSetRequest executeChangeSetRequest)
Updates a stack using the input information that was provided when the
specified change set was created.
|
Future<ExecuteChangeSetResult> |
executeChangeSetAsync(ExecuteChangeSetRequest executeChangeSetRequest,
AsyncHandler<ExecuteChangeSetRequest,ExecuteChangeSetResult> asyncHandler)
Updates a stack using the input information that was provided when the
specified change set was created.
|
Future<GetStackPolicyResult> |
getStackPolicyAsync(GetStackPolicyRequest getStackPolicyRequest)
Returns the stack policy for a specified stack.
|
Future<GetStackPolicyResult> |
getStackPolicyAsync(GetStackPolicyRequest getStackPolicyRequest,
AsyncHandler<GetStackPolicyRequest,GetStackPolicyResult> asyncHandler)
Returns the stack policy for a specified stack.
|
Future<GetTemplateResult> |
getTemplateAsync(GetTemplateRequest getTemplateRequest)
Returns the template body for a specified stack.
|
Future<GetTemplateResult> |
getTemplateAsync(GetTemplateRequest getTemplateRequest,
AsyncHandler<GetTemplateRequest,GetTemplateResult> asyncHandler)
Returns the template body for a specified stack.
|
Future<GetTemplateSummaryResult> |
getTemplateSummaryAsync()
Simplified method form for invoking the GetTemplateSummary operation.
|
Future<GetTemplateSummaryResult> |
getTemplateSummaryAsync(AsyncHandler<GetTemplateSummaryRequest,GetTemplateSummaryResult> asyncHandler)
Simplified method form for invoking the GetTemplateSummary operation with
an AsyncHandler.
|
Future<GetTemplateSummaryResult> |
getTemplateSummaryAsync(GetTemplateSummaryRequest getTemplateSummaryRequest)
Returns information about a new or existing template.
|
Future<GetTemplateSummaryResult> |
getTemplateSummaryAsync(GetTemplateSummaryRequest getTemplateSummaryRequest,
AsyncHandler<GetTemplateSummaryRequest,GetTemplateSummaryResult> asyncHandler)
Returns information about a new or existing template.
|
Future<ListChangeSetsResult> |
listChangeSetsAsync(ListChangeSetsRequest listChangeSetsRequest)
Returns the ID and status of each active change set for a stack.
|
Future<ListChangeSetsResult> |
listChangeSetsAsync(ListChangeSetsRequest listChangeSetsRequest,
AsyncHandler<ListChangeSetsRequest,ListChangeSetsResult> asyncHandler)
Returns the ID and status of each active change set for a stack.
|
Future<ListStackResourcesResult> |
listStackResourcesAsync(ListStackResourcesRequest listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
Future<ListStackResourcesResult> |
listStackResourcesAsync(ListStackResourcesRequest listStackResourcesRequest,
AsyncHandler<ListStackResourcesRequest,ListStackResourcesResult> asyncHandler)
Returns descriptions of all resources of the specified stack.
|
Future<ListStacksResult> |
listStacksAsync()
Simplified method form for invoking the ListStacks operation.
|
Future<ListStacksResult> |
listStacksAsync(AsyncHandler<ListStacksRequest,ListStacksResult> asyncHandler)
Simplified method form for invoking the ListStacks operation with an
AsyncHandler.
|
Future<ListStacksResult> |
listStacksAsync(ListStacksRequest listStacksRequest)
Returns the summary information for stacks whose status matches the
specified StackStatusFilter.
|
Future<ListStacksResult> |
listStacksAsync(ListStacksRequest listStacksRequest,
AsyncHandler<ListStacksRequest,ListStacksResult> asyncHandler)
Returns the summary information for stacks whose status matches the
specified StackStatusFilter.
|
Future<Void> |
setStackPolicyAsync(SetStackPolicyRequest setStackPolicyRequest)
Sets a stack policy for a specified stack.
|
Future<Void> |
setStackPolicyAsync(SetStackPolicyRequest setStackPolicyRequest,
AsyncHandler<SetStackPolicyRequest,Void> asyncHandler)
Sets a stack policy for a specified stack.
|
Future<Void> |
signalResourceAsync(SignalResourceRequest signalResourceRequest)
Sends a signal to the specified resource with a success or failure
status.
|
Future<Void> |
signalResourceAsync(SignalResourceRequest signalResourceRequest,
AsyncHandler<SignalResourceRequest,Void> asyncHandler)
Sends a signal to the specified resource with a success or failure
status.
|
Future<UpdateStackResult> |
updateStackAsync(UpdateStackRequest updateStackRequest)
Updates a stack as specified in the template.
|
Future<UpdateStackResult> |
updateStackAsync(UpdateStackRequest updateStackRequest,
AsyncHandler<UpdateStackRequest,UpdateStackResult> asyncHandler)
Updates a stack as specified in the template.
|
Future<ValidateTemplateResult> |
validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template.
|
Future<ValidateTemplateResult> |
validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest,
AsyncHandler<ValidateTemplateRequest,ValidateTemplateResult> asyncHandler)
Validates a specified template.
|
cancelUpdateStack, continueUpdateRollback, createChangeSet, createStack, deleteChangeSet, deleteStack, describeAccountLimits, describeChangeSet, describeStackEvents, describeStackResource, describeStackResources, describeStacks, describeStacks, estimateTemplateCost, estimateTemplateCost, executeChangeSet, getCachedResponseMetadata, getStackPolicy, getTemplate, getTemplateSummary, getTemplateSummary, listChangeSets, listStackResources, listStacks, listStacks, setEndpoint, setRegion, setStackPolicy, shutdown, signalResource, updateStack, validateTemplateFuture<Void> cancelUpdateStackAsync(CancelUpdateStackRequest cancelUpdateStackRequest)
Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.
cancelUpdateStackRequest - The input for the CancelUpdateStack action.Future<Void> cancelUpdateStackAsync(CancelUpdateStackRequest cancelUpdateStackRequest, AsyncHandler<CancelUpdateStackRequest,Void> asyncHandler)
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.
cancelUpdateStackRequest - The input for the CancelUpdateStack action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ContinueUpdateRollbackResult> continueUpdateRollbackAsync(ContinueUpdateRollbackRequest continueUpdateRollbackRequest)
For a specified stack that is in the UPDATE_ROLLBACK_FAILED
state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of
the failure, you can manually fix the error and continue the rollback. By continuing the
rollback, you can return your stack to a working state (the
UPDATE_ROLLBACK_COMPLETE state), and then try to update the
stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS
CloudFormation cannot roll back all changes after a failed stack update.
For example, you might have a stack that is rolling back to an old
database instance that was deleted outside of AWS CloudFormation. Because
AWS CloudFormation doesn't know the database was deleted, it assumes that
the database instance still exists and attempts to roll back to it,
causing the update rollback to fail.
continueUpdateRollbackRequest - The input for the ContinueUpdateRollback action.Future<ContinueUpdateRollbackResult> continueUpdateRollbackAsync(ContinueUpdateRollbackRequest continueUpdateRollbackRequest, AsyncHandler<ContinueUpdateRollbackRequest,ContinueUpdateRollbackResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateChangeSetResult> createChangeSetAsync(CreateChangeSetRequest createChangeSetRequest)
Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the stack's information with the information that you submit. A change set can help you understand which resources AWS CloudFormation will change and how it will change them before you update your stack. Change sets allow you to check before you make a change so that you don't delete or replace critical resources.
AWS CloudFormation doesn't make any changes to the stack when you create a change set. To make the specified changes, you must execute the change set by using the ExecuteChangeSet action.
After the call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set, use the DescribeChangeSet action.
createChangeSetRequest - The input for the CreateChangeSet action.Future<CreateChangeSetResult> createChangeSetAsync(CreateChangeSetRequest createChangeSetRequest, AsyncHandler<CreateChangeSetRequest,CreateChangeSetResult> asyncHandler)
Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the stack's information with the information that you submit. A change set can help you understand which resources AWS CloudFormation will change and how it will change them before you update your stack. Change sets allow you to check before you make a change so that you don't delete or replace critical resources.
AWS CloudFormation doesn't make any changes to the stack when you create a change set. To make the specified changes, you must execute the change set by using the ExecuteChangeSet action.
After the call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set, use the DescribeChangeSet action.
createChangeSetRequest - The input for the CreateChangeSet action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateStackResult> createStackAsync(CreateStackRequest createStackRequest)
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.
createStackRequest - The input for CreateStack action.Future<CreateStackResult> createStackAsync(CreateStackRequest createStackRequest, AsyncHandler<CreateStackRequest,CreateStackResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteChangeSetResult> deleteChangeSetAsync(DeleteChangeSetRequest deleteChangeSetRequest)
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, AWS CloudFormation successfully deleted the change set.
deleteChangeSetRequest - The input for the DeleteChangeSet action.Future<DeleteChangeSetResult> deleteChangeSetAsync(DeleteChangeSetRequest deleteChangeSetRequest, AsyncHandler<DeleteChangeSetRequest,DeleteChangeSetResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<Void> deleteStackAsync(DeleteStackRequest deleteStackRequest)
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
deleteStackRequest - The input for DeleteStack action.Future<Void> deleteStackAsync(DeleteStackRequest deleteStackRequest, AsyncHandler<DeleteStackRequest,Void> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAccountLimitsResult> describeAccountLimitsAsync(DescribeAccountLimitsRequest describeAccountLimitsRequest)
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.Future<DescribeAccountLimitsResult> describeAccountLimitsAsync(DescribeAccountLimitsRequest describeAccountLimitsRequest, AsyncHandler<DescribeAccountLimitsRequest,DescribeAccountLimitsResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeChangeSetResult> describeChangeSetAsync(DescribeChangeSetRequest describeChangeSetRequest)
Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.
describeChangeSetRequest - The input for the DescribeChangeSet action.Future<DescribeChangeSetResult> describeChangeSetAsync(DescribeChangeSetRequest describeChangeSetRequest, AsyncHandler<DescribeChangeSetRequest,DescribeChangeSetResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStackEventsResult> describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest)
Returns all stack related events for a specified stack. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.
describeStackEventsRequest - The input for DescribeStackEvents action.Future<DescribeStackEventsResult> describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest, AsyncHandler<DescribeStackEventsRequest,DescribeStackEventsResult> asyncHandler)
Returns all stack related events for a specified stack. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.
describeStackEventsRequest - The input for DescribeStackEvents action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStackResourceResult> describeStackResourceAsync(DescribeStackResourceRequest describeStackResourceRequest)
Returns a description of the specified resource in the specified stack.
For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
describeStackResourceRequest - The input for DescribeStackResource action.Future<DescribeStackResourceResult> describeStackResourceAsync(DescribeStackResourceRequest describeStackResourceRequest, AsyncHandler<DescribeStackResourceRequest,DescribeStackResourceResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStackResourcesResult> describeStackResourcesAsync(DescribeStackResourcesRequest describeStackResourcesRequest)
Returns AWS resource descriptions for running and deleted stacks. If
StackName is specified, all the associated resources that
are part of the stack are returned. If PhysicalResourceId is
specified, the associated resources of the stack that the resource
belongs to are returned.
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.
ValidationError is returned if you specify both
StackName and PhysicalResourceId in the same
request.describeStackResourcesRequest - The input for DescribeStackResources action.Future<DescribeStackResourcesResult> describeStackResourcesAsync(DescribeStackResourcesRequest describeStackResourcesRequest, AsyncHandler<DescribeStackResourcesRequest,DescribeStackResourcesResult> asyncHandler)
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.
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.
ValidationError is returned if you specify both
StackName and PhysicalResourceId in the same
request.describeStackResourcesRequest - The input for DescribeStackResources action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStacksResult> describeStacksAsync(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.
describeStacksRequest - The input for DescribeStacks action.Future<DescribeStacksResult> describeStacksAsync(DescribeStacksRequest describeStacksRequest, AsyncHandler<DescribeStacksRequest,DescribeStacksResult> asyncHandler)
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
describeStacksRequest - The input for DescribeStacks action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStacksResult> describeStacksAsync()
Future<DescribeStacksResult> describeStacksAsync(AsyncHandler<DescribeStacksRequest,DescribeStacksResult> asyncHandler)
Future<EstimateTemplateCostResult> estimateTemplateCostAsync(EstimateTemplateCostRequest estimateTemplateCostRequest)
Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
estimateTemplateCostRequest - Future<EstimateTemplateCostResult> estimateTemplateCostAsync(EstimateTemplateCostRequest estimateTemplateCostRequest, AsyncHandler<EstimateTemplateCostRequest,EstimateTemplateCostResult> asyncHandler)
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 - asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EstimateTemplateCostResult> estimateTemplateCostAsync()
Future<EstimateTemplateCostResult> estimateTemplateCostAsync(AsyncHandler<EstimateTemplateCostRequest,EstimateTemplateCostResult> asyncHandler)
Future<ExecuteChangeSetResult> executeChangeSetAsync(ExecuteChangeSetRequest executeChangeSetRequest)
Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.
If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
executeChangeSetRequest - The input for the ExecuteChangeSet action.Future<ExecuteChangeSetResult> executeChangeSetAsync(ExecuteChangeSetRequest executeChangeSetRequest, AsyncHandler<ExecuteChangeSetRequest,ExecuteChangeSetResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetStackPolicyResult> getStackPolicyAsync(GetStackPolicyRequest getStackPolicyRequest)
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.Future<GetStackPolicyResult> getStackPolicyAsync(GetStackPolicyRequest getStackPolicyRequest, AsyncHandler<GetStackPolicyRequest,GetStackPolicyResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTemplateResult> getTemplateAsync(GetTemplateRequest getTemplateRequest)
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.
ValidationError is
returned. getTemplateRequest - The input for a GetTemplate action.Future<GetTemplateResult> getTemplateAsync(GetTemplateRequest getTemplateRequest, AsyncHandler<GetTemplateRequest,GetTemplateResult> asyncHandler)
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.
ValidationError is
returned. getTemplateRequest - The input for a GetTemplate action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTemplateSummaryResult> getTemplateSummaryAsync(GetTemplateSummaryRequest getTemplateSummaryRequest)
Returns information about a new or existing template. The
GetTemplateSummary action is useful for viewing parameter
information, such as default parameter values and parameter types, before
you create or update a stack.
You can use the GetTemplateSummary action when you submit a
template, or you can get template information for a running or deleted
stack.
For deleted stacks, GetTemplateSummary returns the template
information for up to 90 days after the stack has been deleted. If the
template does not exist, a ValidationError is returned.
getTemplateSummaryRequest - The input for the GetTemplateSummary action.Future<GetTemplateSummaryResult> getTemplateSummaryAsync(GetTemplateSummaryRequest getTemplateSummaryRequest, AsyncHandler<GetTemplateSummaryRequest,GetTemplateSummaryResult> asyncHandler)
Returns information about a new or existing template. The
GetTemplateSummary action is useful for viewing parameter
information, such as default parameter values and parameter types, before
you create or update a stack.
You can use the GetTemplateSummary action when you submit a
template, or you can get template information for a running or deleted
stack.
For deleted stacks, GetTemplateSummary returns the template
information for up to 90 days after the stack has been deleted. If the
template does not exist, a ValidationError is returned.
getTemplateSummaryRequest - The input for the GetTemplateSummary action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTemplateSummaryResult> getTemplateSummaryAsync()
Future<GetTemplateSummaryResult> getTemplateSummaryAsync(AsyncHandler<GetTemplateSummaryRequest,GetTemplateSummaryResult> asyncHandler)
Future<ListChangeSetsResult> listChangeSetsAsync(ListChangeSetsRequest listChangeSetsRequest)
Returns the ID and status of each active change set for a stack. For
example, AWS CloudFormation lists change sets that are in the
CREATE_IN_PROGRESS or CREATE_PENDING state.
listChangeSetsRequest - The input for the ListChangeSets action.Future<ListChangeSetsResult> listChangeSetsAsync(ListChangeSetsRequest listChangeSetsRequest, AsyncHandler<ListChangeSetsRequest,ListChangeSetsResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListStackResourcesResult> listStackResourcesAsync(ListStackResourcesRequest listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
listStackResourcesRequest - The input for the ListStackResource action.Future<ListStackResourcesResult> listStackResourcesAsync(ListStackResourcesRequest listStackResourcesRequest, AsyncHandler<ListStackResourcesRequest,ListStackResourcesResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListStacksResult> listStacksAsync(ListStacksRequest listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
listStacksRequest - The input for ListStacks action.Future<ListStacksResult> listStacksAsync(ListStacksRequest listStacksRequest, AsyncHandler<ListStacksRequest,ListStacksResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListStacksResult> listStacksAsync()
listStacksAsync(ListStacksRequest)Future<ListStacksResult> listStacksAsync(AsyncHandler<ListStacksRequest,ListStacksResult> asyncHandler)
Future<Void> setStackPolicyAsync(SetStackPolicyRequest setStackPolicyRequest)
Sets a stack policy for a specified stack.
setStackPolicyRequest - The input for the SetStackPolicy action.Future<Void> setStackPolicyAsync(SetStackPolicyRequest setStackPolicyRequest, AsyncHandler<SetStackPolicyRequest,Void> asyncHandler)
Sets a stack policy for a specified stack.
setStackPolicyRequest - The input for the SetStackPolicy action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<Void> signalResourceAsync(SignalResourceRequest signalResourceRequest)
Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
signalResourceRequest - The input for the SignalResource action.Future<Void> signalResourceAsync(SignalResourceRequest signalResourceRequest, AsyncHandler<SignalResourceRequest,Void> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateStackResult> updateStackAsync(UpdateStackRequest updateStackRequest)
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
updateStackRequest - The input for UpdateStack action.Future<UpdateStackResult> updateStackAsync(UpdateStackRequest updateStackRequest, AsyncHandler<UpdateStackRequest,UpdateStackResult> asyncHandler)
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 UpdateStack action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ValidateTemplateResult> validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template.
validateTemplateRequest - The input for ValidateTemplate action.Future<ValidateTemplateResult> validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest, AsyncHandler<ValidateTemplateRequest,ValidateTemplateResult> asyncHandler)
Validates a specified template.
validateTemplateRequest - The input for ValidateTemplate action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2016. All rights reserved.