com.amazonaws.services.cloudformation.AmazonCloudFormationAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
* Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.cloudformation;
import javax.annotation.Generated;
import com.amazonaws.services.cloudformation.model.*;
/**
* Interface for accessing AWS CloudFormation asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.cloudformation.AbstractAmazonCloudFormationAsync} instead.
*
*
* AWS CloudFormation
*
* AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can
* use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store,
* Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly
* scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.
*
*
* With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines
* a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member
* resources of the stack together and manages all dependencies between the resources for you.
*
*
* For more information about AWS CloudFormation, see the AWS
* CloudFormation Product Page.
*
*
* Amazon CloudFormation makes use of other AWS products. For additional technical information about a specific AWS
* product, see its technical documentation.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCloudFormationAsync extends AmazonCloudFormation {
/**
*
* 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.
*
*
*
* @param cancelUpdateStackRequest
* The input for the CancelUpdateStack action.
* @return A Java Future containing the result of the CancelUpdateStack operation returned by the service.
* @sample AmazonCloudFormationAsync.CancelUpdateStack
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
*
* @param cancelUpdateStackRequest
* The input for the CancelUpdateStack action.
* @param 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.
* @return A Java Future containing the result of the CancelUpdateStack operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.CancelUpdateStack
* @see AWS API Documentation
*/
java.util.concurrent.Future cancelUpdateStackAsync(CancelUpdateStackRequest cancelUpdateStackRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param continueUpdateRollbackRequest
* The input for the ContinueUpdateRollback action.
* @return A Java Future containing the result of the ContinueUpdateRollback operation returned by the service.
* @sample AmazonCloudFormationAsync.ContinueUpdateRollback
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param continueUpdateRollbackRequest
* The input for the ContinueUpdateRollback action.
* @param 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.
* @return A Java Future containing the result of the ContinueUpdateRollback operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.ContinueUpdateRollback
* @see AWS API Documentation
*/
java.util.concurrent.Future continueUpdateRollbackAsync(ContinueUpdateRollbackRequest continueUpdateRollbackRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the template'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 making a change to avoid deleting or replacing 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.
*
*
* @param createChangeSetRequest
* The input for the CreateChangeSet action.
* @return A Java Future containing the result of the CreateChangeSet operation returned by the service.
* @sample AmazonCloudFormationAsync.CreateChangeSet
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createChangeSetAsync(CreateChangeSetRequest createChangeSetRequest);
/**
*
* Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the template'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 making a change to avoid deleting or replacing 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.
*
*
* @param createChangeSetRequest
* The input for the CreateChangeSet action.
* @param 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.
* @return A Java Future containing the result of the CreateChangeSet operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.CreateChangeSet
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createChangeSetAsync(CreateChangeSetRequest createChangeSetRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param createStackRequest
* The input for CreateStack action.
* @return A Java Future containing the result of the CreateStack operation returned by the service.
* @sample AmazonCloudFormationAsync.CreateStack
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param createStackRequest
* The input for CreateStack action.
* @param 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.
* @return A Java Future containing the result of the CreateStack operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.CreateStack
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createStackAsync(CreateStackRequest createStackRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param deleteChangeSetRequest
* The input for the DeleteChangeSet action.
* @return A Java Future containing the result of the DeleteChangeSet operation returned by the service.
* @sample AmazonCloudFormationAsync.DeleteChangeSet
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param deleteChangeSetRequest
* The input for the DeleteChangeSet action.
* @param 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.
* @return A Java Future containing the result of the DeleteChangeSet operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.DeleteChangeSet
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteChangeSetAsync(DeleteChangeSetRequest deleteChangeSetRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param deleteStackRequest
* The input for DeleteStack action.
* @return A Java Future containing the result of the DeleteStack operation returned by the service.
* @sample AmazonCloudFormationAsync.DeleteStack
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param deleteStackRequest
* The input for DeleteStack action.
* @param 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.
* @return A Java Future containing the result of the DeleteStack operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.DeleteStack
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteStackAsync(DeleteStackRequest deleteStackRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in
* your account.
*
*
* @param describeAccountLimitsRequest
* The input for the DescribeAccountLimits action.
* @return A Java Future containing the result of the DescribeAccountLimits operation returned by the service.
* @sample AmazonCloudFormationAsync.DescribeAccountLimits
* @see AWS API Documentation
*/
java.util.concurrent.Future describeAccountLimitsAsync(DescribeAccountLimitsRequest describeAccountLimitsRequest);
/**
*
* Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in
* your account.
*
*
* @param describeAccountLimitsRequest
* The input for the DescribeAccountLimits action.
* @param 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.
* @return A Java Future containing the result of the DescribeAccountLimits operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.DescribeAccountLimits
* @see AWS API Documentation
*/
java.util.concurrent.Future describeAccountLimitsAsync(DescribeAccountLimitsRequest describeAccountLimitsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param describeChangeSetRequest
* The input for the DescribeChangeSet action.
* @return A Java Future containing the result of the DescribeChangeSet operation returned by the service.
* @sample AmazonCloudFormationAsync.DescribeChangeSet
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param describeChangeSetRequest
* The input for the DescribeChangeSet action.
* @param 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.
* @return A Java Future containing the result of the DescribeChangeSet operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.DescribeChangeSet
* @see AWS API Documentation
*/
java.util.concurrent.Future describeChangeSetAsync(DescribeChangeSetRequest describeChangeSetRequest,
com.amazonaws.handlers.AsyncHandler 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).
*
*
*
* @param describeStackEventsRequest
* The input for DescribeStackEvents action.
* @return A Java Future containing the result of the DescribeStackEvents operation returned by the service.
* @sample AmazonCloudFormationAsync.DescribeStackEvents
* @see AWS API Documentation
*/
java.util.concurrent.Future 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).
*
*
*
* @param describeStackEventsRequest
* The input for DescribeStackEvents action.
* @param 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.
* @return A Java Future containing the result of the DescribeStackEvents operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.DescribeStackEvents
* @see AWS API Documentation
*/
java.util.concurrent.Future describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param describeStackResourceRequest
* The input for DescribeStackResource action.
* @return A Java Future containing the result of the DescribeStackResource operation returned by the service.
* @sample AmazonCloudFormationAsync.DescribeStackResource
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param describeStackResourceRequest
* The input for DescribeStackResource action.
* @param 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.
* @return A Java Future containing the result of the DescribeStackResource operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.DescribeStackResource
* @see AWS API Documentation
*/
java.util.concurrent.Future describeStackResourceAsync(DescribeStackResourceRequest describeStackResourceRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
*
* Only the first 100 resources will be returned. If your stack has more resources than this, you should use
* ListStackResources instead.
*
*
*
* For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the
* stack has been deleted.
*
*
* You must specify either StackName or PhysicalResourceId, but not both. In addition, you
* can specify LogicalResourceId to filter the returned result. For more information about resources,
* the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.
*
*
*
* A ValidationError is returned if you specify both StackName and
* PhysicalResourceId in the same request.
*
*
*
* @param describeStackResourcesRequest
* The input for DescribeStackResources action.
* @return A Java Future containing the result of the DescribeStackResources operation returned by the service.
* @sample AmazonCloudFormationAsync.DescribeStackResources
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
*
* Only the first 100 resources will be returned. If your stack has more resources than this, you should use
* ListStackResources instead.
*
*
*
* For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the
* stack has been deleted.
*
*
* You must specify either StackName or PhysicalResourceId, but not both. In addition, you
* can specify LogicalResourceId to filter the returned result. For more information about resources,
* the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.
*
*
*
* A ValidationError is returned if you specify both StackName and
* PhysicalResourceId in the same request.
*
*
*
* @param describeStackResourcesRequest
* The input for DescribeStackResources action.
* @param 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.
* @return A Java Future containing the result of the DescribeStackResources operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.DescribeStackResources
* @see AWS API Documentation
*/
java.util.concurrent.Future describeStackResourcesAsync(DescribeStackResourcesRequest describeStackResourcesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the description for the specified stack; if no stack name was specified, then it returns the description
* for all the stacks created.
*
*
*
* If the stack does not exist, an AmazonCloudFormationException is returned.
*
*
*
* @param describeStacksRequest
* The input for DescribeStacks action.
* @return A Java Future containing the result of the DescribeStacks operation returned by the service.
* @sample AmazonCloudFormationAsync.DescribeStacks
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
*
* If the stack does not exist, an AmazonCloudFormationException is returned.
*
*
*
* @param describeStacksRequest
* The input for DescribeStacks action.
* @param 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.
* @return A Java Future containing the result of the DescribeStacks operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.DescribeStacks
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeStacksAsync(DescribeStacksRequest describeStacksRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the DescribeStacks operation.
*
* @see #describeStacksAsync(DescribeStacksRequest)
*/
java.util.concurrent.Future describeStacksAsync();
/**
* Simplified method form for invoking the DescribeStacks operation with an AsyncHandler.
*
* @see #describeStacksAsync(DescribeStacksRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future describeStacksAsync(
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param estimateTemplateCostRequest
* The input for an EstimateTemplateCost action.
* @return A Java Future containing the result of the EstimateTemplateCost operation returned by the service.
* @sample AmazonCloudFormationAsync.EstimateTemplateCost
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param estimateTemplateCostRequest
* The input for an EstimateTemplateCost action.
* @param 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.
* @return A Java Future containing the result of the EstimateTemplateCost operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.EstimateTemplateCost
* @see AWS API Documentation
*/
java.util.concurrent.Future estimateTemplateCostAsync(EstimateTemplateCostRequest estimateTemplateCostRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the EstimateTemplateCost operation.
*
* @see #estimateTemplateCostAsync(EstimateTemplateCostRequest)
*/
java.util.concurrent.Future estimateTemplateCostAsync();
/**
* Simplified method form for invoking the EstimateTemplateCost operation with an AsyncHandler.
*
* @see #estimateTemplateCostAsync(EstimateTemplateCostRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future estimateTemplateCostAsync(
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param executeChangeSetRequest
* The input for the ExecuteChangeSet action.
* @return A Java Future containing the result of the ExecuteChangeSet operation returned by the service.
* @sample AmazonCloudFormationAsync.ExecuteChangeSet
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param executeChangeSetRequest
* The input for the ExecuteChangeSet action.
* @param 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.
* @return A Java Future containing the result of the ExecuteChangeSet operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.ExecuteChangeSet
* @see AWS API Documentation
*/
java.util.concurrent.Future executeChangeSetAsync(ExecuteChangeSetRequest executeChangeSetRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
*
*
* @param getStackPolicyRequest
* The input for the GetStackPolicy action.
* @return A Java Future containing the result of the GetStackPolicy operation returned by the service.
* @sample AmazonCloudFormationAsync.GetStackPolicy
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getStackPolicyAsync(GetStackPolicyRequest getStackPolicyRequest);
/**
*
* Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
*
*
* @param getStackPolicyRequest
* The input for the GetStackPolicy action.
* @param 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.
* @return A Java Future containing the result of the GetStackPolicy operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.GetStackPolicy
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getStackPolicyAsync(GetStackPolicyRequest getStackPolicyRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
*
* @param getTemplateRequest
* The input for a GetTemplate action.
* @return A Java Future containing the result of the GetTemplate operation returned by the service.
* @sample AmazonCloudFormationAsync.GetTemplate
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
*
* If the template does not exist, a ValidationError is returned.
*
*
*
* @param getTemplateRequest
* The input for a GetTemplate action.
* @param 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.
* @return A Java Future containing the result of the GetTemplate operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.GetTemplate
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getTemplateAsync(GetTemplateRequest getTemplateRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param getTemplateSummaryRequest
* The input for the GetTemplateSummary action.
* @return A Java Future containing the result of the GetTemplateSummary operation returned by the service.
* @sample AmazonCloudFormationAsync.GetTemplateSummary
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param getTemplateSummaryRequest
* The input for the GetTemplateSummary action.
* @param 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.
* @return A Java Future containing the result of the GetTemplateSummary operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.GetTemplateSummary
* @see AWS API Documentation
*/
java.util.concurrent.Future getTemplateSummaryAsync(GetTemplateSummaryRequest getTemplateSummaryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the GetTemplateSummary operation.
*
* @see #getTemplateSummaryAsync(GetTemplateSummaryRequest)
*/
java.util.concurrent.Future getTemplateSummaryAsync();
/**
* Simplified method form for invoking the GetTemplateSummary operation with an AsyncHandler.
*
* @see #getTemplateSummaryAsync(GetTemplateSummaryRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future getTemplateSummaryAsync(
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param listChangeSetsRequest
* The input for the ListChangeSets action.
* @return A Java Future containing the result of the ListChangeSets operation returned by the service.
* @sample AmazonCloudFormationAsync.ListChangeSets
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listChangeSetsRequest
* The input for the ListChangeSets action.
* @param 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.
* @return A Java Future containing the result of the ListChangeSets operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.ListChangeSets
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listChangeSetsAsync(ListChangeSetsRequest listChangeSetsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all exported output values in the account and region in which you call this action. Use this action to see
* the exported output values that you can import into other stacks. To import values, use the
* Fn::ImportValue function.
*
*
* For more information, see AWS
* CloudFormation Export Stack Output Values.
*
*
* @param listExportsRequest
* @return A Java Future containing the result of the ListExports operation returned by the service.
* @sample AmazonCloudFormationAsync.ListExports
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listExportsAsync(ListExportsRequest listExportsRequest);
/**
*
* Lists all exported output values in the account and region in which you call this action. Use this action to see
* the exported output values that you can import into other stacks. To import values, use the
* Fn::ImportValue function.
*
*
* For more information, see AWS
* CloudFormation Export Stack Output Values.
*
*
* @param listExportsRequest
* @param 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.
* @return A Java Future containing the result of the ListExports operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.ListExports
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listExportsAsync(ListExportsRequest listExportsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first
* use this action to see which stacks are using it. To see the exported output values in your account, see
* ListExports.
*
*
* For more information about importing an exported output value, see the
* Fn::ImportValue function.
*
*
* @param listImportsRequest
* @return A Java Future containing the result of the ListImports operation returned by the service.
* @sample AmazonCloudFormationAsync.ListImports
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listImportsAsync(ListImportsRequest listImportsRequest);
/**
*
* Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first
* use this action to see which stacks are using it. To see the exported output values in your account, see
* ListExports.
*
*
* For more information about importing an exported output value, see the
* Fn::ImportValue function.
*
*
* @param listImportsRequest
* @param 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.
* @return A Java Future containing the result of the ListImports operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.ListImports
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listImportsAsync(ListImportsRequest listImportsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param listStackResourcesRequest
* The input for the ListStackResource action.
* @return A Java Future containing the result of the ListStackResources operation returned by the service.
* @sample AmazonCloudFormationAsync.ListStackResources
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listStackResourcesRequest
* The input for the ListStackResource action.
* @param 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.
* @return A Java Future containing the result of the ListStackResources operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.ListStackResources
* @see AWS API Documentation
*/
java.util.concurrent.Future listStackResourcesAsync(ListStackResourcesRequest listStackResourcesRequest,
com.amazonaws.handlers.AsyncHandler 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).
*
*
* @param listStacksRequest
* The input for ListStacks action.
* @return A Java Future containing the result of the ListStacks operation returned by the service.
* @sample AmazonCloudFormationAsync.ListStacks
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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).
*
*
* @param listStacksRequest
* The input for ListStacks action.
* @param 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.
* @return A Java Future containing the result of the ListStacks operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.ListStacks
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listStacksAsync(ListStacksRequest listStacksRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the ListStacks operation.
*
* @see #listStacksAsync(ListStacksRequest)
*/
java.util.concurrent.Future listStacksAsync();
/**
* Simplified method form for invoking the ListStacks operation with an AsyncHandler.
*
* @see #listStacksAsync(ListStacksRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future listStacksAsync(com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Sets a stack policy for a specified stack.
*
*
* @param setStackPolicyRequest
* The input for the SetStackPolicy action.
* @return A Java Future containing the result of the SetStackPolicy operation returned by the service.
* @sample AmazonCloudFormationAsync.SetStackPolicy
* @see AWS
* API Documentation
*/
java.util.concurrent.Future setStackPolicyAsync(SetStackPolicyRequest setStackPolicyRequest);
/**
*
* Sets a stack policy for a specified stack.
*
*
* @param setStackPolicyRequest
* The input for the SetStackPolicy action.
* @param 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.
* @return A Java Future containing the result of the SetStackPolicy operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.SetStackPolicy
* @see AWS
* API Documentation
*/
java.util.concurrent.Future setStackPolicyAsync(SetStackPolicyRequest setStackPolicyRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param signalResourceRequest
* The input for the SignalResource action.
* @return A Java Future containing the result of the SignalResource operation returned by the service.
* @sample AmazonCloudFormationAsync.SignalResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param signalResourceRequest
* The input for the SignalResource action.
* @param 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.
* @return A Java Future containing the result of the SignalResource operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.SignalResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future signalResourceAsync(SignalResourceRequest signalResourceRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param updateStackRequest
* The input for an UpdateStack action.
* @return A Java Future containing the result of the UpdateStack operation returned by the service.
* @sample AmazonCloudFormationAsync.UpdateStack
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param updateStackRequest
* The input for an UpdateStack action.
* @param 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.
* @return A Java Future containing the result of the UpdateStack operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.UpdateStack
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateStackAsync(UpdateStackRequest updateStackRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS
* CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a
* template validation error.
*
*
* @param validateTemplateRequest
* The input for ValidateTemplate action.
* @return A Java Future containing the result of the ValidateTemplate operation returned by the service.
* @sample AmazonCloudFormationAsync.ValidateTemplate
* @see AWS API Documentation
*/
java.util.concurrent.Future validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest);
/**
*
* Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS
* CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a
* template validation error.
*
*
* @param validateTemplateRequest
* The input for ValidateTemplate action.
* @param 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.
* @return A Java Future containing the result of the ValidateTemplate operation returned by the service.
* @sample AmazonCloudFormationAsyncHandler.ValidateTemplate
* @see AWS API Documentation
*/
java.util.concurrent.Future validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}