Interface AmazonCloudFormationAsync
- All Superinterfaces:
AmazonCloudFormation
- All Known Implementing Classes:
AbstractAmazonCloudFormationAsync
,AmazonCloudFormationAsyncClient
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/.
-
Method Summary
Modifier and TypeMethodDescriptioncancelUpdateStackAsync
(CancelUpdateStackRequest cancelUpdateStackRequest) Cancels an update on the specified stack.cancelUpdateStackAsync
(CancelUpdateStackRequest cancelUpdateStackRequest, AsyncHandler<CancelUpdateStackRequest, CancelUpdateStackResult> asyncHandler) Cancels an update on the specified stack.continueUpdateRollbackAsync
(ContinueUpdateRollbackRequest continueUpdateRollbackRequest) For a specified stack that is in theUPDATE_ROLLBACK_FAILED
state, continues rolling it back to theUPDATE_ROLLBACK_COMPLETE
state.continueUpdateRollbackAsync
(ContinueUpdateRollbackRequest continueUpdateRollbackRequest, AsyncHandler<ContinueUpdateRollbackRequest, ContinueUpdateRollbackResult> asyncHandler) For a specified stack that is in theUPDATE_ROLLBACK_FAILED
state, continues rolling it back to theUPDATE_ROLLBACK_COMPLETE
state.createChangeSetAsync
(CreateChangeSetRequest createChangeSetRequest) Creates a list of changes for a stack.createChangeSetAsync
(CreateChangeSetRequest createChangeSetRequest, AsyncHandler<CreateChangeSetRequest, CreateChangeSetResult> asyncHandler) Creates a list of changes for a stack.createStackAsync
(CreateStackRequest createStackRequest) Creates a stack as specified in the template.createStackAsync
(CreateStackRequest createStackRequest, AsyncHandler<CreateStackRequest, CreateStackResult> asyncHandler) Creates a stack as specified in the template.deleteChangeSetAsync
(DeleteChangeSetRequest deleteChangeSetRequest) Deletes the specified change set.deleteChangeSetAsync
(DeleteChangeSetRequest deleteChangeSetRequest, AsyncHandler<DeleteChangeSetRequest, DeleteChangeSetResult> asyncHandler) Deletes the specified change set.deleteStackAsync
(DeleteStackRequest deleteStackRequest) Deletes a specified stack.deleteStackAsync
(DeleteStackRequest deleteStackRequest, AsyncHandler<DeleteStackRequest, DeleteStackResult> asyncHandler) Deletes a specified stack.describeAccountLimitsAsync
(DescribeAccountLimitsRequest describeAccountLimitsRequest) Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.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.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.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.describeStackEventsAsync
(DescribeStackEventsRequest describeStackEventsRequest) Returns all stack related events for a specified stack in reverse chronological order.describeStackEventsAsync
(DescribeStackEventsRequest describeStackEventsRequest, AsyncHandler<DescribeStackEventsRequest, DescribeStackEventsResult> asyncHandler) Returns all stack related events for a specified stack in reverse chronological order.describeStackResourceAsync
(DescribeStackResourceRequest describeStackResourceRequest) Returns a description of the specified resource in the specified stack.describeStackResourceAsync
(DescribeStackResourceRequest describeStackResourceRequest, AsyncHandler<DescribeStackResourceRequest, DescribeStackResourceResult> asyncHandler) Returns a description of the specified resource in the specified stack.describeStackResourcesAsync
(DescribeStackResourcesRequest describeStackResourcesRequest) Returns AWS resource descriptions for running and deleted stacks.describeStackResourcesAsync
(DescribeStackResourcesRequest describeStackResourcesRequest, AsyncHandler<DescribeStackResourcesRequest, DescribeStackResourcesResult> asyncHandler) Returns AWS resource descriptions for running and deleted stacks.Simplified method form for invoking the DescribeStacks operation.describeStacksAsync
(AsyncHandler<DescribeStacksRequest, DescribeStacksResult> asyncHandler) Simplified method form for invoking the DescribeStacks operation with an AsyncHandler.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.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.Simplified method form for invoking the EstimateTemplateCost operation.estimateTemplateCostAsync
(AsyncHandler<EstimateTemplateCostRequest, EstimateTemplateCostResult> asyncHandler) Simplified method form for invoking the EstimateTemplateCost operation with an AsyncHandler.estimateTemplateCostAsync
(EstimateTemplateCostRequest estimateTemplateCostRequest) Returns the estimated monthly cost of a template.estimateTemplateCostAsync
(EstimateTemplateCostRequest estimateTemplateCostRequest, AsyncHandler<EstimateTemplateCostRequest, EstimateTemplateCostResult> asyncHandler) Returns the estimated monthly cost of a template.executeChangeSetAsync
(ExecuteChangeSetRequest executeChangeSetRequest) Updates a stack using the input information that was provided when the specified change set was created.executeChangeSetAsync
(ExecuteChangeSetRequest executeChangeSetRequest, AsyncHandler<ExecuteChangeSetRequest, ExecuteChangeSetResult> asyncHandler) Updates a stack using the input information that was provided when the specified change set was created.getStackPolicyAsync
(GetStackPolicyRequest getStackPolicyRequest) Returns the stack policy for a specified stack.getStackPolicyAsync
(GetStackPolicyRequest getStackPolicyRequest, AsyncHandler<GetStackPolicyRequest, GetStackPolicyResult> asyncHandler) Returns the stack policy for a specified stack.getTemplateAsync
(GetTemplateRequest getTemplateRequest) Returns the template body for a specified stack.getTemplateAsync
(GetTemplateRequest getTemplateRequest, AsyncHandler<GetTemplateRequest, GetTemplateResult> asyncHandler) Returns the template body for a specified stack.Simplified method form for invoking the GetTemplateSummary operation.getTemplateSummaryAsync
(AsyncHandler<GetTemplateSummaryRequest, GetTemplateSummaryResult> asyncHandler) Simplified method form for invoking the GetTemplateSummary operation with an AsyncHandler.getTemplateSummaryAsync
(GetTemplateSummaryRequest getTemplateSummaryRequest) Returns information about a new or existing template.getTemplateSummaryAsync
(GetTemplateSummaryRequest getTemplateSummaryRequest, AsyncHandler<GetTemplateSummaryRequest, GetTemplateSummaryResult> asyncHandler) Returns information about a new or existing template.listChangeSetsAsync
(ListChangeSetsRequest listChangeSetsRequest) Returns the ID and status of each active change set for a stack.listChangeSetsAsync
(ListChangeSetsRequest listChangeSetsRequest, AsyncHandler<ListChangeSetsRequest, ListChangeSetsResult> asyncHandler) Returns the ID and status of each active change set for a stack.listStackResourcesAsync
(ListStackResourcesRequest listStackResourcesRequest) Returns descriptions of all resources of the specified stack.listStackResourcesAsync
(ListStackResourcesRequest listStackResourcesRequest, AsyncHandler<ListStackResourcesRequest, ListStackResourcesResult> asyncHandler) Returns descriptions of all resources of the specified stack.Simplified method form for invoking the ListStacks operation.listStacksAsync
(AsyncHandler<ListStacksRequest, ListStacksResult> asyncHandler) Simplified method form for invoking the ListStacks operation with an AsyncHandler.listStacksAsync
(ListStacksRequest listStacksRequest) Returns the summary information for stacks whose status matches the specified StackStatusFilter.listStacksAsync
(ListStacksRequest listStacksRequest, AsyncHandler<ListStacksRequest, ListStacksResult> asyncHandler) Returns the summary information for stacks whose status matches the specified StackStatusFilter.setStackPolicyAsync
(SetStackPolicyRequest setStackPolicyRequest) Sets a stack policy for a specified stack.setStackPolicyAsync
(SetStackPolicyRequest setStackPolicyRequest, AsyncHandler<SetStackPolicyRequest, SetStackPolicyResult> asyncHandler) Sets a stack policy for a specified stack.signalResourceAsync
(SignalResourceRequest signalResourceRequest) Sends a signal to the specified resource with a success or failure status.signalResourceAsync
(SignalResourceRequest signalResourceRequest, AsyncHandler<SignalResourceRequest, SignalResourceResult> asyncHandler) Sends a signal to the specified resource with a success or failure status.updateStackAsync
(UpdateStackRequest updateStackRequest) Updates a stack as specified in the template.updateStackAsync
(UpdateStackRequest updateStackRequest, AsyncHandler<UpdateStackRequest, UpdateStackResult> asyncHandler) Updates a stack as specified in the template.validateTemplateAsync
(ValidateTemplateRequest validateTemplateRequest) Validates a specified template.validateTemplateAsync
(ValidateTemplateRequest validateTemplateRequest, AsyncHandler<ValidateTemplateRequest, ValidateTemplateResult> asyncHandler) Validates a specified template.Methods inherited from interface com.amazonaws.services.cloudformation.AmazonCloudFormation
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, validateTemplate
-
Method Details
-
cancelUpdateStackAsync
Future<CancelUpdateStackResult> 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.
You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
- Parameters:
cancelUpdateStackRequest
- The input for the CancelUpdateStack action.- Returns:
- A Java Future containing the result of the CancelUpdateStack operation returned by the service.
-
cancelUpdateStackAsync
Future<CancelUpdateStackResult> cancelUpdateStackAsync(CancelUpdateStackRequest cancelUpdateStackRequest, AsyncHandler<CancelUpdateStackRequest, CancelUpdateStackResult> 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.
You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
- Parameters:
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.- Returns:
- A Java Future containing the result of the CancelUpdateStack operation returned by the service.
-
continueUpdateRollbackAsync
Future<ContinueUpdateRollbackResult> continueUpdateRollbackAsync(ContinueUpdateRollbackRequest continueUpdateRollbackRequest) For a specified stack that is in the
UPDATE_ROLLBACK_FAILED
state, continues rolling it back to theUPDATE_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 (theUPDATE_ROLLBACK_COMPLETE
state), and then try to update the stack again.A stack goes into the
UPDATE_ROLLBACK_FAILED
state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.- Parameters:
continueUpdateRollbackRequest
- The input for the ContinueUpdateRollback action.- Returns:
- A Java Future containing the result of the ContinueUpdateRollback operation returned by the service.
-
continueUpdateRollbackAsync
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 theUPDATE_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 (theUPDATE_ROLLBACK_COMPLETE
state), and then try to update the stack again.A stack goes into the
UPDATE_ROLLBACK_FAILED
state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.- Parameters:
continueUpdateRollbackRequest
- The input for the ContinueUpdateRollback action.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.- Returns:
- A Java Future containing the result of the ContinueUpdateRollback operation returned by the service.
-
createChangeSetAsync
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.
- Parameters:
createChangeSetRequest
- The input for the CreateChangeSet action.- Returns:
- A Java Future containing the result of the CreateChangeSet operation returned by the service.
-
createChangeSetAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the CreateChangeSet operation returned by the service.
-
createStackAsync
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.
- Parameters:
createStackRequest
- The input for CreateStack action.- Returns:
- A Java Future containing the result of the CreateStack operation returned by the service.
-
createStackAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the CreateStack operation returned by the service.
-
deleteChangeSetAsync
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, AWS CloudFormation successfully deleted the change set.
- Parameters:
deleteChangeSetRequest
- The input for the DeleteChangeSet action.- Returns:
- A Java Future containing the result of the DeleteChangeSet operation returned by the service.
-
deleteChangeSetAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the DeleteChangeSet operation returned by the service.
-
deleteStackAsync
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
- Parameters:
deleteStackRequest
- The input for DeleteStack action.- Returns:
- A Java Future containing the result of the DeleteStack operation returned by the service.
-
deleteStackAsync
Future<DeleteStackResult> deleteStackAsync(DeleteStackRequest deleteStackRequest, AsyncHandler<DeleteStackRequest, DeleteStackResult> 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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the DeleteStack operation returned by the service.
-
describeAccountLimitsAsync
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.
- Parameters:
describeAccountLimitsRequest
- The input for the DescribeAccountLimits action.- Returns:
- A Java Future containing the result of the DescribeAccountLimits operation returned by the service.
-
describeAccountLimitsAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the DescribeAccountLimits operation returned by the service.
-
describeChangeSetAsync
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.
- Parameters:
describeChangeSetRequest
- The input for the DescribeChangeSet action.- Returns:
- A Java Future containing the result of the DescribeChangeSet operation returned by the service.
-
describeChangeSetAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the DescribeChangeSet operation returned by the service.
-
describeStackEventsAsync
Future<DescribeStackEventsResult> describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest) Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
- Parameters:
describeStackEventsRequest
- The input for DescribeStackEvents action.- Returns:
- A Java Future containing the result of the DescribeStackEvents operation returned by the service.
-
describeStackEventsAsync
Future<DescribeStackEventsResult> describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest, AsyncHandler<DescribeStackEventsRequest, DescribeStackEventsResult> asyncHandler) Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
- Parameters:
describeStackEventsRequest
- The input for DescribeStackEvents action.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.- Returns:
- A Java Future containing the result of the DescribeStackEvents operation returned by the service.
-
describeStackResourceAsync
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.
- Parameters:
describeStackResourceRequest
- The input for DescribeStackResource action.- Returns:
- A Java Future containing the result of the DescribeStackResource operation returned by the service.
-
describeStackResourceAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the DescribeStackResource operation returned by the service.
-
describeStackResourcesAsync
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. IfPhysicalResourceId
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
orPhysicalResourceId
, but not both. In addition, you can specifyLogicalResourceId
to filter the returned result. For more information about resources, theLogicalResourceId
andPhysicalResourceId
, go to the AWS CloudFormation User Guide.A
ValidationError
is returned if you specify bothStackName
andPhysicalResourceId
in the same request.- Parameters:
describeStackResourcesRequest
- The input for DescribeStackResources action.- Returns:
- A Java Future containing the result of the DescribeStackResources operation returned by the service.
-
describeStackResourcesAsync
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. IfPhysicalResourceId
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
orPhysicalResourceId
, but not both. In addition, you can specifyLogicalResourceId
to filter the returned result. For more information about resources, theLogicalResourceId
andPhysicalResourceId
, go to the AWS CloudFormation User Guide.A
ValidationError
is returned if you specify bothStackName
andPhysicalResourceId
in the same request.- Parameters:
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.- Returns:
- A Java Future containing the result of the DescribeStackResources operation returned by the service.
-
describeStacksAsync
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
- Parameters:
describeStacksRequest
- The input for DescribeStacks action.- Returns:
- A Java Future containing the result of the DescribeStacks operation returned by the service.
-
describeStacksAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the DescribeStacks operation returned by the service.
-
describeStacksAsync
Future<DescribeStacksResult> describeStacksAsync()Simplified method form for invoking the DescribeStacks operation. -
describeStacksAsync
Future<DescribeStacksResult> describeStacksAsync(AsyncHandler<DescribeStacksRequest, DescribeStacksResult> asyncHandler) Simplified method form for invoking the DescribeStacks operation with an AsyncHandler. -
estimateTemplateCostAsync
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.
- Parameters:
estimateTemplateCostRequest
- The input for an EstimateTemplateCost action.- Returns:
- A Java Future containing the result of the EstimateTemplateCost operation returned by the service.
-
estimateTemplateCostAsync
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.
- Parameters:
estimateTemplateCostRequest
- The input for an EstimateTemplateCost 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.- Returns:
- A Java Future containing the result of the EstimateTemplateCost operation returned by the service.
-
estimateTemplateCostAsync
Future<EstimateTemplateCostResult> estimateTemplateCostAsync()Simplified method form for invoking the EstimateTemplateCost operation. -
estimateTemplateCostAsync
Future<EstimateTemplateCostResult> estimateTemplateCostAsync(AsyncHandler<EstimateTemplateCostRequest, EstimateTemplateCostResult> asyncHandler) Simplified method form for invoking the EstimateTemplateCost operation with an AsyncHandler. -
executeChangeSetAsync
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.
- Parameters:
executeChangeSetRequest
- The input for the ExecuteChangeSet action.- Returns:
- A Java Future containing the result of the ExecuteChangeSet operation returned by the service.
-
executeChangeSetAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the ExecuteChangeSet operation returned by the service.
-
getStackPolicyAsync
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
- Parameters:
getStackPolicyRequest
- The input for the GetStackPolicy action.- Returns:
- A Java Future containing the result of the GetStackPolicy operation returned by the service.
-
getStackPolicyAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the GetStackPolicy operation returned by the service.
-
getTemplateAsync
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.
If the template does not exist, a
ValidationError
is returned.- Parameters:
getTemplateRequest
- The input for a GetTemplate action.- Returns:
- A Java Future containing the result of the GetTemplate operation returned by the service.
-
getTemplateAsync
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.
If the template does not exist, a
ValidationError
is returned.- Parameters:
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.- Returns:
- A Java Future containing the result of the GetTemplate operation returned by the service.
-
getTemplateSummaryAsync
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, aValidationError
is returned.- Parameters:
getTemplateSummaryRequest
- The input for the GetTemplateSummary action.- Returns:
- A Java Future containing the result of the GetTemplateSummary operation returned by the service.
-
getTemplateSummaryAsync
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, aValidationError
is returned.- Parameters:
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.- Returns:
- A Java Future containing the result of the GetTemplateSummary operation returned by the service.
-
getTemplateSummaryAsync
Future<GetTemplateSummaryResult> getTemplateSummaryAsync()Simplified method form for invoking the GetTemplateSummary operation. -
getTemplateSummaryAsync
Future<GetTemplateSummaryResult> getTemplateSummaryAsync(AsyncHandler<GetTemplateSummaryRequest, GetTemplateSummaryResult> asyncHandler) Simplified method form for invoking the GetTemplateSummary operation with an AsyncHandler. -
listChangeSetsAsync
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
orCREATE_PENDING
state.- Parameters:
listChangeSetsRequest
- The input for the ListChangeSets action.- Returns:
- A Java Future containing the result of the ListChangeSets operation returned by the service.
-
listChangeSetsAsync
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
orCREATE_PENDING
state.- Parameters:
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.- Returns:
- A Java Future containing the result of the ListChangeSets operation returned by the service.
-
listStackResourcesAsync
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.
- Parameters:
listStackResourcesRequest
- The input for the ListStackResource action.- Returns:
- A Java Future containing the result of the ListStackResources operation returned by the service.
-
listStackResourcesAsync
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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the ListStackResources operation returned by the service.
-
listStacksAsync
Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
- Parameters:
listStacksRequest
- The input for ListStacks action.- Returns:
- A Java Future containing the result of the ListStacks operation returned by the service.
-
listStacksAsync
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).
- Parameters:
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.- Returns:
- A Java Future containing the result of the ListStacks operation returned by the service.
-
listStacksAsync
Future<ListStacksResult> listStacksAsync()Simplified method form for invoking the ListStacks operation.- See Also:
-
listStacksAsync
Future<ListStacksResult> listStacksAsync(AsyncHandler<ListStacksRequest, ListStacksResult> asyncHandler) Simplified method form for invoking the ListStacks operation with an AsyncHandler. -
setStackPolicyAsync
Sets a stack policy for a specified stack.
- Parameters:
setStackPolicyRequest
- The input for the SetStackPolicy action.- Returns:
- A Java Future containing the result of the SetStackPolicy operation returned by the service.
-
setStackPolicyAsync
Future<SetStackPolicyResult> setStackPolicyAsync(SetStackPolicyRequest setStackPolicyRequest, AsyncHandler<SetStackPolicyRequest, SetStackPolicyResult> asyncHandler) Sets a stack policy for a specified stack.
- Parameters:
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.- Returns:
- A Java Future containing the result of the SetStackPolicy operation returned by the service.
-
signalResourceAsync
Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
- Parameters:
signalResourceRequest
- The input for the SignalResource action.- Returns:
- A Java Future containing the result of the SignalResource operation returned by the service.
-
signalResourceAsync
Future<SignalResourceResult> signalResourceAsync(SignalResourceRequest signalResourceRequest, AsyncHandler<SignalResourceRequest, SignalResourceResult> 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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the SignalResource operation returned by the service.
-
updateStackAsync
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
- Parameters:
updateStackRequest
- The input for an UpdateStack action.- Returns:
- A Java Future containing the result of the UpdateStack operation returned by the service.
-
updateStackAsync
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.
- Parameters:
updateStackRequest
- The input for an 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.- Returns:
- A Java Future containing the result of the UpdateStack operation returned by the service.
-
validateTemplateAsync
Future<ValidateTemplateResult> validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest) Validates a specified template.
- Parameters:
validateTemplateRequest
- The input for ValidateTemplate action.- Returns:
- A Java Future containing the result of the ValidateTemplate operation returned by the service.
-
validateTemplateAsync
Future<ValidateTemplateResult> validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest, AsyncHandler<ValidateTemplateRequest, ValidateTemplateResult> asyncHandler) Validates a specified template.
- Parameters:
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.- Returns:
- A Java Future containing the result of the ValidateTemplate operation returned by the service.
-