@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonCloudFormationAsyncClient extends AmazonCloudFormationClient implements AmazonCloudFormationAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services 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 Amazon Web Services infrastructure.
With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about CloudFormation, see the CloudFormation product page.
CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonCloudFormationAsyncClient()
Deprecated.
|
AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AmazonCloudFormationAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonCloudFormationAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonCloudFormationAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonCloudFormationAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AmazonCloudFormationAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
activateOrganizationsAccess, activateType, batchDescribeTypeConfigurations, builder, cancelUpdateStack, continueUpdateRollback, createChangeSet, createGeneratedTemplate, createStack, createStackInstances, createStackSet, deactivateOrganizationsAccess, deactivateType, deleteChangeSet, deleteGeneratedTemplate, deleteStack, deleteStackInstances, deleteStackSet, deregisterType, describeAccountLimits, describeChangeSet, describeChangeSetHooks, describeGeneratedTemplate, describeOrganizationsAccess, describePublisher, describeResourceScan, describeStackDriftDetectionStatus, describeStackEvents, describeStackInstance, describeStackResource, describeStackResourceDrifts, describeStackResources, describeStacks, describeStacks, describeStackSet, describeStackSetOperation, describeType, describeTypeRegistration, detectStackDrift, detectStackResourceDrift, detectStackSetDrift, estimateTemplateCost, estimateTemplateCost, executeChangeSet, getCachedResponseMetadata, getGeneratedTemplate, getStackPolicy, getTemplate, getTemplateSummary, getTemplateSummary, importStacksToStackSet, listChangeSets, listExports, listGeneratedTemplates, listImports, listResourceScanRelatedResources, listResourceScanResources, listResourceScans, listStackInstanceResourceDrifts, listStackInstances, listStackResources, listStacks, listStacks, listStackSetAutoDeploymentTargets, listStackSetOperationResults, listStackSetOperations, listStackSets, listTypeRegistrations, listTypes, listTypeVersions, publishType, recordHandlerProgress, registerPublisher, registerType, rollbackStack, setStackPolicy, setTypeConfiguration, setTypeDefaultVersion, signalResource, startResourceScan, stopStackSetOperation, testType, updateGeneratedTemplate, updateStack, updateStackInstances, updateStackSet, updateTerminationProtection, validateTemplate, waitersaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitactivateOrganizationsAccess, activateType, batchDescribeTypeConfigurations, cancelUpdateStack, continueUpdateRollback, createChangeSet, createGeneratedTemplate, createStack, createStackInstances, createStackSet, deactivateOrganizationsAccess, deactivateType, deleteChangeSet, deleteGeneratedTemplate, deleteStack, deleteStackInstances, deleteStackSet, deregisterType, describeAccountLimits, describeChangeSet, describeChangeSetHooks, describeGeneratedTemplate, describeOrganizationsAccess, describePublisher, describeResourceScan, describeStackDriftDetectionStatus, describeStackEvents, describeStackInstance, describeStackResource, describeStackResourceDrifts, describeStackResources, describeStacks, describeStacks, describeStackSet, describeStackSetOperation, describeType, describeTypeRegistration, detectStackDrift, detectStackResourceDrift, detectStackSetDrift, estimateTemplateCost, estimateTemplateCost, executeChangeSet, getCachedResponseMetadata, getGeneratedTemplate, getStackPolicy, getTemplate, getTemplateSummary, getTemplateSummary, importStacksToStackSet, listChangeSets, listExports, listGeneratedTemplates, listImports, listResourceScanRelatedResources, listResourceScanResources, listResourceScans, listStackInstanceResourceDrifts, listStackInstances, listStackResources, listStacks, listStacks, listStackSetAutoDeploymentTargets, listStackSetOperationResults, listStackSetOperations, listStackSets, listTypeRegistrations, listTypes, listTypeVersions, publishType, recordHandlerProgress, registerPublisher, registerType, rollbackStack, setEndpoint, setRegion, setStackPolicy, setTypeConfiguration, setTypeDefaultVersion, signalResource, startResourceScan, stopStackSetOperation, testType, updateGeneratedTemplate, updateStack, updateStackInstances, updateStackSet, updateTerminationProtection, validateTemplate, waiters@Deprecated public AmazonCloudFormationAsyncClient()
AmazonCloudFormationAsyncClientBuilder.defaultClient()Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AmazonCloudFormationAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client connects to AWS CloudFormation (ex: proxy
settings, retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonCloudFormationAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonCloudFormationAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonCloudFormationAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonCloudFormationAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonCloudFormationAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public static AmazonCloudFormationAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<ActivateOrganizationsAccessResult> activateOrganizationsAccessAsync(ActivateOrganizationsAccessRequest request)
AmazonCloudFormationAsyncActivate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.
activateOrganizationsAccessAsync in interface AmazonCloudFormationAsyncpublic Future<ActivateOrganizationsAccessResult> activateOrganizationsAccessAsync(ActivateOrganizationsAccessRequest request, AsyncHandler<ActivateOrganizationsAccessRequest,ActivateOrganizationsAccessResult> asyncHandler)
AmazonCloudFormationAsyncActivate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.
activateOrganizationsAccessAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ActivateTypeResult> activateTypeAsync(ActivateTypeRequest request)
AmazonCloudFormationAsyncActivates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.
Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
activateTypeAsync in interface AmazonCloudFormationAsyncpublic Future<ActivateTypeResult> activateTypeAsync(ActivateTypeRequest request, AsyncHandler<ActivateTypeRequest,ActivateTypeResult> asyncHandler)
AmazonCloudFormationAsyncActivates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.
Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
activateTypeAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<BatchDescribeTypeConfigurationsResult> batchDescribeTypeConfigurationsAsync(BatchDescribeTypeConfigurationsRequest request)
AmazonCloudFormationAsyncReturns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
batchDescribeTypeConfigurationsAsync in interface AmazonCloudFormationAsyncpublic Future<BatchDescribeTypeConfigurationsResult> batchDescribeTypeConfigurationsAsync(BatchDescribeTypeConfigurationsRequest request, AsyncHandler<BatchDescribeTypeConfigurationsRequest,BatchDescribeTypeConfigurationsResult> asyncHandler)
AmazonCloudFormationAsyncReturns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
batchDescribeTypeConfigurationsAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<CancelUpdateStackResult> cancelUpdateStackAsync(CancelUpdateStackRequest request)
AmazonCloudFormationAsyncCancels 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.
cancelUpdateStackAsync in interface AmazonCloudFormationAsyncrequest - The input for the CancelUpdateStack action.public Future<CancelUpdateStackResult> cancelUpdateStackAsync(CancelUpdateStackRequest request, AsyncHandler<CancelUpdateStackRequest,CancelUpdateStackResult> asyncHandler)
AmazonCloudFormationAsyncCancels 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.
cancelUpdateStackAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<ContinueUpdateRollbackResult> continueUpdateRollbackAsync(ContinueUpdateRollbackRequest request)
AmazonCloudFormationAsync
For a specified stack that's 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 CloudFormation can't roll back all changes
after a failed stack update. For example, you might have a stack that's rolling back to an old database instance
that was deleted outside of CloudFormation. Because 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.
continueUpdateRollbackAsync in interface AmazonCloudFormationAsyncrequest - The input for the ContinueUpdateRollback action.public Future<ContinueUpdateRollbackResult> continueUpdateRollbackAsync(ContinueUpdateRollbackRequest request, AsyncHandler<ContinueUpdateRollbackRequest,ContinueUpdateRollbackResult> asyncHandler)
AmazonCloudFormationAsync
For a specified stack that's 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 CloudFormation can't roll back all changes
after a failed stack update. For example, you might have a stack that's rolling back to an old database instance
that was deleted outside of CloudFormation. Because 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.
continueUpdateRollbackAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<CreateChangeSetResult> createChangeSetAsync(CreateChangeSetRequest request)
AmazonCloudFormationAsyncCreates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.
To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify
CREATE. To create a change set for an existing stack, specify UPDATE for the
ChangeSetType parameter. To create a change set for an import operation, specify IMPORT
for the ChangeSetType parameter. After the CreateChangeSet call successfully completes,
CloudFormation starts creating the change set. To check the status of the change set or to review it, use the
DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.
To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True.
createChangeSetAsync in interface AmazonCloudFormationAsyncrequest - The input for the CreateChangeSet action.public Future<CreateChangeSetResult> createChangeSetAsync(CreateChangeSetRequest request, AsyncHandler<CreateChangeSetRequest,CreateChangeSetResult> asyncHandler)
AmazonCloudFormationAsyncCreates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.
To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify
CREATE. To create a change set for an existing stack, specify UPDATE for the
ChangeSetType parameter. To create a change set for an import operation, specify IMPORT
for the ChangeSetType parameter. After the CreateChangeSet call successfully completes,
CloudFormation starts creating the change set. To check the status of the change set or to review it, use the
DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.
To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True.
createChangeSetAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<CreateGeneratedTemplateResult> createGeneratedTemplateAsync(CreateGeneratedTemplateRequest request)
AmazonCloudFormationAsync
Creates a template from existing resources that are not already managed with CloudFormation. You can check the
status of the template generation using the DescribeGeneratedTemplate API action.
createGeneratedTemplateAsync in interface AmazonCloudFormationAsyncpublic Future<CreateGeneratedTemplateResult> createGeneratedTemplateAsync(CreateGeneratedTemplateRequest request, AsyncHandler<CreateGeneratedTemplateRequest,CreateGeneratedTemplateResult> asyncHandler)
AmazonCloudFormationAsync
Creates a template from existing resources that are not already managed with CloudFormation. You can check the
status of the template generation using the DescribeGeneratedTemplate API action.
createGeneratedTemplateAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<CreateStackResult> createStackAsync(CreateStackRequest request)
AmazonCloudFormationAsyncCreates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.
createStackAsync in interface AmazonCloudFormationAsyncrequest - The input for CreateStack action.public Future<CreateStackResult> createStackAsync(CreateStackRequest request, AsyncHandler<CreateStackRequest,CreateStackResult> asyncHandler)
AmazonCloudFormationAsyncCreates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.
createStackAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<CreateStackInstancesResult> createStackInstancesAsync(CreateStackInstancesRequest request)
AmazonCloudFormationAsync
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack
instance refers to a stack in a specific account and Region. You must specify at least one value for either
Accounts or DeploymentTargets, and you must specify at least one value for
Regions.
createStackInstancesAsync in interface AmazonCloudFormationAsyncpublic Future<CreateStackInstancesResult> createStackInstancesAsync(CreateStackInstancesRequest request, AsyncHandler<CreateStackInstancesRequest,CreateStackInstancesResult> asyncHandler)
AmazonCloudFormationAsync
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack
instance refers to a stack in a specific account and Region. You must specify at least one value for either
Accounts or DeploymentTargets, and you must specify at least one value for
Regions.
createStackInstancesAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<CreateStackSetResult> createStackSetAsync(CreateStackSetRequest request)
AmazonCloudFormationAsyncCreates a stack set.
createStackSetAsync in interface AmazonCloudFormationAsyncpublic Future<CreateStackSetResult> createStackSetAsync(CreateStackSetRequest request, AsyncHandler<CreateStackSetRequest,CreateStackSetResult> asyncHandler)
AmazonCloudFormationAsyncCreates a stack set.
createStackSetAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DeactivateOrganizationsAccessResult> deactivateOrganizationsAccessAsync(DeactivateOrganizationsAccessRequest request)
AmazonCloudFormationAsyncDeactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.
deactivateOrganizationsAccessAsync in interface AmazonCloudFormationAsyncpublic Future<DeactivateOrganizationsAccessResult> deactivateOrganizationsAccessAsync(DeactivateOrganizationsAccessRequest request, AsyncHandler<DeactivateOrganizationsAccessRequest,DeactivateOrganizationsAccessResult> asyncHandler)
AmazonCloudFormationAsyncDeactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.
deactivateOrganizationsAccessAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DeactivateTypeResult> deactivateTypeAsync(DeactivateTypeRequest request)
AmazonCloudFormationAsyncDeactivates a public extension that was previously activated in this account and Region.
Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.
deactivateTypeAsync in interface AmazonCloudFormationAsyncpublic Future<DeactivateTypeResult> deactivateTypeAsync(DeactivateTypeRequest request, AsyncHandler<DeactivateTypeRequest,DeactivateTypeResult> asyncHandler)
AmazonCloudFormationAsyncDeactivates a public extension that was previously activated in this account and Region.
Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.
deactivateTypeAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DeleteChangeSetResult> deleteChangeSetAsync(DeleteChangeSetRequest request)
AmazonCloudFormationAsyncDeletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, CloudFormation successfully deleted the change set.
If IncludeNestedStacks specifies True during the creation of the nested change set,
then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also
delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.
deleteChangeSetAsync in interface AmazonCloudFormationAsyncrequest - The input for the DeleteChangeSet action.public Future<DeleteChangeSetResult> deleteChangeSetAsync(DeleteChangeSetRequest request, AsyncHandler<DeleteChangeSetRequest,DeleteChangeSetResult> asyncHandler)
AmazonCloudFormationAsyncDeletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, CloudFormation successfully deleted the change set.
If IncludeNestedStacks specifies True during the creation of the nested change set,
then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also
delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.
deleteChangeSetAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<DeleteGeneratedTemplateResult> deleteGeneratedTemplateAsync(DeleteGeneratedTemplateRequest request)
AmazonCloudFormationAsyncDeleted a generated template.
deleteGeneratedTemplateAsync in interface AmazonCloudFormationAsyncpublic Future<DeleteGeneratedTemplateResult> deleteGeneratedTemplateAsync(DeleteGeneratedTemplateRequest request, AsyncHandler<DeleteGeneratedTemplateRequest,DeleteGeneratedTemplateResult> asyncHandler)
AmazonCloudFormationAsyncDeleted a generated template.
deleteGeneratedTemplateAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DeleteStackResult> deleteStackAsync(DeleteStackRequest request)
AmazonCloudFormationAsyncDeletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the deletion has been completed successfully.
deleteStackAsync in interface AmazonCloudFormationAsyncrequest - The input for DeleteStack action.public Future<DeleteStackResult> deleteStackAsync(DeleteStackRequest request, AsyncHandler<DeleteStackRequest,DeleteStackResult> asyncHandler)
AmazonCloudFormationAsyncDeletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the deletion has been completed successfully.
deleteStackAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<DeleteStackInstancesResult> deleteStackInstancesAsync(DeleteStackInstancesRequest request)
AmazonCloudFormationAsyncDeletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
deleteStackInstancesAsync in interface AmazonCloudFormationAsyncpublic Future<DeleteStackInstancesResult> deleteStackInstancesAsync(DeleteStackInstancesRequest request, AsyncHandler<DeleteStackInstancesRequest,DeleteStackInstancesResult> asyncHandler)
AmazonCloudFormationAsyncDeletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
deleteStackInstancesAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DeleteStackSetResult> deleteStackSetAsync(DeleteStackSetRequest request)
AmazonCloudFormationAsyncDeletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.
deleteStackSetAsync in interface AmazonCloudFormationAsyncpublic Future<DeleteStackSetResult> deleteStackSetAsync(DeleteStackSetRequest request, AsyncHandler<DeleteStackSetRequest,DeleteStackSetResult> asyncHandler)
AmazonCloudFormationAsyncDeletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.
deleteStackSetAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DeregisterTypeResult> deregisterTypeAsync(DeregisterTypeRequest request)
AmazonCloudFormationAsync
Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it
from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.
You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.
To view the deprecation status of an extension or extension version, use DescribeType.
deregisterTypeAsync in interface AmazonCloudFormationAsyncpublic Future<DeregisterTypeResult> deregisterTypeAsync(DeregisterTypeRequest request, AsyncHandler<DeregisterTypeRequest,DeregisterTypeResult> asyncHandler)
AmazonCloudFormationAsync
Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it
from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.
You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.
To view the deprecation status of an extension or extension version, use DescribeType.
deregisterTypeAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DescribeAccountLimitsResult> describeAccountLimitsAsync(DescribeAccountLimitsRequest request)
AmazonCloudFormationAsyncRetrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see CloudFormation Quotas in the CloudFormation User Guide.
describeAccountLimitsAsync in interface AmazonCloudFormationAsyncrequest - The input for the DescribeAccountLimits action.public Future<DescribeAccountLimitsResult> describeAccountLimitsAsync(DescribeAccountLimitsRequest request, AsyncHandler<DescribeAccountLimitsRequest,DescribeAccountLimitsResult> asyncHandler)
AmazonCloudFormationAsyncRetrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see CloudFormation Quotas in the CloudFormation User Guide.
describeAccountLimitsAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<DescribeChangeSetResult> describeChangeSetAsync(DescribeChangeSetRequest request)
AmazonCloudFormationAsyncReturns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the CloudFormation User Guide.
describeChangeSetAsync in interface AmazonCloudFormationAsyncrequest - The input for the DescribeChangeSet action.public Future<DescribeChangeSetResult> describeChangeSetAsync(DescribeChangeSetRequest request, AsyncHandler<DescribeChangeSetRequest,DescribeChangeSetResult> asyncHandler)
AmazonCloudFormationAsyncReturns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the CloudFormation User Guide.
describeChangeSetAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<DescribeChangeSetHooksResult> describeChangeSetHooksAsync(DescribeChangeSetHooksRequest request)
AmazonCloudFormationAsyncReturns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
describeChangeSetHooksAsync in interface AmazonCloudFormationAsyncpublic Future<DescribeChangeSetHooksResult> describeChangeSetHooksAsync(DescribeChangeSetHooksRequest request, AsyncHandler<DescribeChangeSetHooksRequest,DescribeChangeSetHooksResult> asyncHandler)
AmazonCloudFormationAsyncReturns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
describeChangeSetHooksAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DescribeGeneratedTemplateResult> describeGeneratedTemplateAsync(DescribeGeneratedTemplateRequest request)
AmazonCloudFormationAsync
Describes a generated template. The output includes details about the progress of the creation of a generated
template started by a CreateGeneratedTemplate API action or the update of a generated template
started with an UpdateGeneratedTemplate API action.
describeGeneratedTemplateAsync in interface AmazonCloudFormationAsyncpublic Future<DescribeGeneratedTemplateResult> describeGeneratedTemplateAsync(DescribeGeneratedTemplateRequest request, AsyncHandler<DescribeGeneratedTemplateRequest,DescribeGeneratedTemplateResult> asyncHandler)
AmazonCloudFormationAsync
Describes a generated template. The output includes details about the progress of the creation of a generated
template started by a CreateGeneratedTemplate API action or the update of a generated template
started with an UpdateGeneratedTemplate API action.
describeGeneratedTemplateAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DescribeOrganizationsAccessResult> describeOrganizationsAccessAsync(DescribeOrganizationsAccessRequest request)
AmazonCloudFormationAsync
Retrieves information about the account's OrganizationAccess status. This API can be called either
by the management account or the delegated administrator by using the CallAs parameter. This API can
also be called without the CallAs parameter by the management account.
describeOrganizationsAccessAsync in interface AmazonCloudFormationAsyncpublic Future<DescribeOrganizationsAccessResult> describeOrganizationsAccessAsync(DescribeOrganizationsAccessRequest request, AsyncHandler<DescribeOrganizationsAccessRequest,DescribeOrganizationsAccessResult> asyncHandler)
AmazonCloudFormationAsync
Retrieves information about the account's OrganizationAccess status. This API can be called either
by the management account or the delegated administrator by using the CallAs parameter. This API can
also be called without the CallAs parameter by the management account.
describeOrganizationsAccessAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DescribePublisherResult> describePublisherAsync(DescribePublisherRequest request)
AmazonCloudFormationAsyncReturns information about a CloudFormation extension publisher.
If you don't supply a PublisherId, and you have registered as an extension publisher,
DescribePublisher returns information about your own publisher account.
For more information about registering as a publisher, see:
Publishing extensions to make them available for public use in the CloudFormation CLI User Guide
describePublisherAsync in interface AmazonCloudFormationAsyncpublic Future<DescribePublisherResult> describePublisherAsync(DescribePublisherRequest request, AsyncHandler<DescribePublisherRequest,DescribePublisherResult> asyncHandler)
AmazonCloudFormationAsyncReturns information about a CloudFormation extension publisher.
If you don't supply a PublisherId, and you have registered as an extension publisher,
DescribePublisher returns information about your own publisher account.
For more information about registering as a publisher, see:
Publishing extensions to make them available for public use in the CloudFormation CLI User Guide
describePublisherAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DescribeResourceScanResult> describeResourceScanAsync(DescribeResourceScanRequest request)
AmazonCloudFormationAsyncDescribes details of a resource scan.
describeResourceScanAsync in interface AmazonCloudFormationAsyncpublic Future<DescribeResourceScanResult> describeResourceScanAsync(DescribeResourceScanRequest request, AsyncHandler<DescribeResourceScanRequest,DescribeResourceScanResult> asyncHandler)
AmazonCloudFormationAsyncDescribes details of a resource scan.
describeResourceScanAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DescribeStackDriftDetectionStatusResult> describeStackDriftDetectionStatusAsync(DescribeStackDriftDetectionStatusRequest request)
AmazonCloudFormationAsyncReturns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns
a StackDriftDetectionId you can use to monitor the progress of the operation using
DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use
DescribeStackResourceDrifts to return drift information about the stack and its resources.
describeStackDriftDetectionStatusAsync in interface AmazonCloudFormationAsyncpublic Future<DescribeStackDriftDetectionStatusResult> describeStackDriftDetectionStatusAsync(DescribeStackDriftDetectionStatusRequest request, AsyncHandler<DescribeStackDriftDetectionStatusRequest,DescribeStackDriftDetectionStatusResult> asyncHandler)
AmazonCloudFormationAsyncReturns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns
a StackDriftDetectionId you can use to monitor the progress of the operation using
DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use
DescribeStackResourceDrifts to return drift information about the stack and its resources.
describeStackDriftDetectionStatusAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DescribeStackEventsResult> describeStackEventsAsync(DescribeStackEventsRequest request)
AmazonCloudFormationAsyncReturns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see CloudFormation stack creation events in the 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).
describeStackEventsAsync in interface AmazonCloudFormationAsyncrequest - The input for DescribeStackEvents action.public Future<DescribeStackEventsResult> describeStackEventsAsync(DescribeStackEventsRequest request, AsyncHandler<DescribeStackEventsRequest,DescribeStackEventsResult> asyncHandler)
AmazonCloudFormationAsyncReturns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see CloudFormation stack creation events in the 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).
describeStackEventsAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<DescribeStackInstanceResult> describeStackInstanceAsync(DescribeStackInstanceRequest request)
AmazonCloudFormationAsyncReturns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.
For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
describeStackInstanceAsync in interface AmazonCloudFormationAsyncpublic Future<DescribeStackInstanceResult> describeStackInstanceAsync(DescribeStackInstanceRequest request, AsyncHandler<DescribeStackInstanceRequest,DescribeStackInstanceResult> asyncHandler)
AmazonCloudFormationAsyncReturns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.
For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
describeStackInstanceAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DescribeStackResourceResult> describeStackResourceAsync(DescribeStackResourceRequest request)
AmazonCloudFormationAsyncReturns 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.
describeStackResourceAsync in interface AmazonCloudFormationAsyncrequest - The input for DescribeStackResource action.public Future<DescribeStackResourceResult> describeStackResourceAsync(DescribeStackResourceRequest request, AsyncHandler<DescribeStackResourceRequest,DescribeStackResourceResult> asyncHandler)
AmazonCloudFormationAsyncReturns 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.
describeStackResourceAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<DescribeStackResourceDriftsResult> describeStackResourceDriftsAsync(DescribeStackResourceDriftsRequest request)
AmazonCloudFormationAsyncReturns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.
For a given stack, there will be one StackResourceDrift for each stack resource that has been
checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't
currently support drift detection aren't checked, and so not included. For a list of resources that support drift
detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
describeStackResourceDriftsAsync in interface AmazonCloudFormationAsyncpublic Future<DescribeStackResourceDriftsResult> describeStackResourceDriftsAsync(DescribeStackResourceDriftsRequest request, AsyncHandler<DescribeStackResourceDriftsRequest,DescribeStackResourceDriftsResult> asyncHandler)
AmazonCloudFormationAsyncReturns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.
For a given stack, there will be one StackResourceDrift for each stack resource that has been
checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't
currently support drift detection aren't checked, and so not included. For a list of resources that support drift
detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
describeStackResourceDriftsAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DescribeStackResourcesResult> describeStackResourcesAsync(DescribeStackResourcesRequest request)
AmazonCloudFormationAsync
Returns Amazon Web Services 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 CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and
PhysicalResourceId in the same request.
describeStackResourcesAsync in interface AmazonCloudFormationAsyncrequest - The input for DescribeStackResources action.public Future<DescribeStackResourcesResult> describeStackResourcesAsync(DescribeStackResourcesRequest request, AsyncHandler<DescribeStackResourcesRequest,DescribeStackResourcesResult> asyncHandler)
AmazonCloudFormationAsync
Returns Amazon Web Services 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 CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and
PhysicalResourceId in the same request.
describeStackResourcesAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<DescribeStackSetResult> describeStackSetAsync(DescribeStackSetRequest request)
AmazonCloudFormationAsyncReturns the description of the specified StackSet.
describeStackSetAsync in interface AmazonCloudFormationAsyncpublic Future<DescribeStackSetResult> describeStackSetAsync(DescribeStackSetRequest request, AsyncHandler<DescribeStackSetRequest,DescribeStackSetResult> asyncHandler)
AmazonCloudFormationAsyncReturns the description of the specified StackSet.
describeStackSetAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DescribeStackSetOperationResult> describeStackSetOperationAsync(DescribeStackSetOperationRequest request)
AmazonCloudFormationAsyncReturns the description of the specified StackSet operation.
describeStackSetOperationAsync in interface AmazonCloudFormationAsyncpublic Future<DescribeStackSetOperationResult> describeStackSetOperationAsync(DescribeStackSetOperationRequest request, AsyncHandler<DescribeStackSetOperationRequest,DescribeStackSetOperationResult> asyncHandler)
AmazonCloudFormationAsyncReturns the description of the specified StackSet operation.
describeStackSetOperationAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DescribeStacksResult> describeStacksAsync(DescribeStacksRequest request)
AmazonCloudFormationAsyncReturns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see CloudFormation stack creation events in the CloudFormation User Guide.
If the stack doesn't exist, a ValidationError is returned.
describeStacksAsync in interface AmazonCloudFormationAsyncrequest - The input for DescribeStacks action.public Future<DescribeStacksResult> describeStacksAsync(DescribeStacksRequest request, AsyncHandler<DescribeStacksRequest,DescribeStacksResult> asyncHandler)
AmazonCloudFormationAsyncReturns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see CloudFormation stack creation events in the CloudFormation User Guide.
If the stack doesn't exist, a ValidationError is returned.
describeStacksAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<DescribeStacksResult> describeStacksAsync()
describeStacksAsync in interface AmazonCloudFormationAsyncdescribeStacksAsync(DescribeStacksRequest)public Future<DescribeStacksResult> describeStacksAsync(AsyncHandler<DescribeStacksRequest,DescribeStacksResult> asyncHandler)
describeStacksAsync in interface AmazonCloudFormationAsyncdescribeStacksAsync(DescribeStacksRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeTypeResult> describeTypeAsync(DescribeTypeRequest request)
AmazonCloudFormationAsyncReturns detailed information about an extension that has been registered.
If you specify a VersionId, DescribeType returns information about that specific
extension version. Otherwise, it returns information about the default extension version.
describeTypeAsync in interface AmazonCloudFormationAsyncpublic Future<DescribeTypeResult> describeTypeAsync(DescribeTypeRequest request, AsyncHandler<DescribeTypeRequest,DescribeTypeResult> asyncHandler)
AmazonCloudFormationAsyncReturns detailed information about an extension that has been registered.
If you specify a VersionId, DescribeType returns information about that specific
extension version. Otherwise, it returns information about the default extension version.
describeTypeAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DescribeTypeRegistrationResult> describeTypeRegistrationAsync(DescribeTypeRegistrationRequest request)
AmazonCloudFormationAsyncReturns information about an extension's registration, including its current status and type and version identifiers.
When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.
Once the registration request has completed, use DescribeType to return detailed information about an extension.
describeTypeRegistrationAsync in interface AmazonCloudFormationAsyncpublic Future<DescribeTypeRegistrationResult> describeTypeRegistrationAsync(DescribeTypeRegistrationRequest request, AsyncHandler<DescribeTypeRegistrationRequest,DescribeTypeRegistrationResult> asyncHandler)
AmazonCloudFormationAsyncReturns information about an extension's registration, including its current status and type and version identifiers.
When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.
Once the registration request has completed, use DescribeType to return detailed information about an extension.
describeTypeRegistrationAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DetectStackDriftResult> detectStackDriftAsync(DetectStackDriftRequest request)
AmazonCloudFormationAsyncDetects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift to detect drift on all supported resources for a given stack, or
DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection.
DetectStackDrift can take up to several minutes, depending on the number of resources contained
within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift
operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return
drift information about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that
stack. Perform DetectStackDrift directly on the nested stack itself.
detectStackDriftAsync in interface AmazonCloudFormationAsyncpublic Future<DetectStackDriftResult> detectStackDriftAsync(DetectStackDriftRequest request, AsyncHandler<DetectStackDriftRequest,DetectStackDriftResult> asyncHandler)
AmazonCloudFormationAsyncDetects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift to detect drift on all supported resources for a given stack, or
DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection.
DetectStackDrift can take up to several minutes, depending on the number of resources contained
within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift
operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return
drift information about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that
stack. Perform DetectStackDrift directly on the nested stack itself.
detectStackDriftAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DetectStackResourceDriftResult> detectStackResourceDriftAsync(DetectStackResourceDriftRequest request)
AmazonCloudFormationAsyncReturns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to
detect drift on all resources in a given stack that support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
detectStackResourceDriftAsync in interface AmazonCloudFormationAsyncpublic Future<DetectStackResourceDriftResult> detectStackResourceDriftAsync(DetectStackResourceDriftRequest request, AsyncHandler<DetectStackResourceDriftRequest,DetectStackResourceDriftResult> asyncHandler)
AmazonCloudFormationAsyncReturns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to
detect drift on all resources in a given stack that support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
detectStackResourceDriftAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<DetectStackSetDriftResult> detectStackSetDriftAsync(DetectStackSetDriftRequest request)
AmazonCloudFormationAsyncDetect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift detection on a stack set.
DetectStackSetDrift returns the OperationId of the stack set drift detection operation.
Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection
operation. The drift detection operation may take some time, depending on the number of stack instances included
in the stack set, in addition to the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)
Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.
Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.
For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in stack sets.
You can only run a single drift detection operation on a given stack set at one time.
To stop a drift detection stack set operation, use StopStackSetOperation.
detectStackSetDriftAsync in interface AmazonCloudFormationAsyncpublic Future<DetectStackSetDriftResult> detectStackSetDriftAsync(DetectStackSetDriftRequest request, AsyncHandler<DetectStackSetDriftRequest,DetectStackSetDriftResult> asyncHandler)
AmazonCloudFormationAsyncDetect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift detection on a stack set.
DetectStackSetDrift returns the OperationId of the stack set drift detection operation.
Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection
operation. The drift detection operation may take some time, depending on the number of stack instances included
in the stack set, in addition to the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)
Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.
Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.
For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in stack sets.
You can only run a single drift detection operation on a given stack set at one time.
To stop a drift detection stack set operation, use StopStackSetOperation.
detectStackSetDriftAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<EstimateTemplateCostResult> estimateTemplateCostAsync(EstimateTemplateCostRequest request)
AmazonCloudFormationAsyncReturns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
estimateTemplateCostAsync in interface AmazonCloudFormationAsyncrequest - The input for an EstimateTemplateCost action.public Future<EstimateTemplateCostResult> estimateTemplateCostAsync(EstimateTemplateCostRequest request, AsyncHandler<EstimateTemplateCostRequest,EstimateTemplateCostResult> asyncHandler)
AmazonCloudFormationAsyncReturns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
estimateTemplateCostAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<EstimateTemplateCostResult> estimateTemplateCostAsync()
estimateTemplateCostAsync in interface AmazonCloudFormationAsyncestimateTemplateCostAsync(EstimateTemplateCostRequest)public Future<EstimateTemplateCostResult> estimateTemplateCostAsync(AsyncHandler<EstimateTemplateCostRequest,EstimateTemplateCostResult> asyncHandler)
estimateTemplateCostAsync in interface AmazonCloudFormationAsyncestimateTemplateCostAsync(EstimateTemplateCostRequest, com.amazonaws.handlers.AsyncHandler)public Future<ExecuteChangeSetResult> executeChangeSetAsync(ExecuteChangeSetRequest request)
AmazonCloudFormationAsyncUpdates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
When you execute a change set, 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, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
To create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to
True.
executeChangeSetAsync in interface AmazonCloudFormationAsyncrequest - The input for the ExecuteChangeSet action.public Future<ExecuteChangeSetResult> executeChangeSetAsync(ExecuteChangeSetRequest request, AsyncHandler<ExecuteChangeSetRequest,ExecuteChangeSetResult> asyncHandler)
AmazonCloudFormationAsyncUpdates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
When you execute a change set, 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, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
To create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to
True.
executeChangeSetAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<GetGeneratedTemplateResult> getGeneratedTemplateAsync(GetGeneratedTemplateRequest request)
AmazonCloudFormationAsync
Retrieves a generated template. If the template is in an InProgress or Pending status
then the template returned will be the template when the template was last in a Complete status. If
the template has not yet been in a Complete status then an empty template will be returned.
getGeneratedTemplateAsync in interface AmazonCloudFormationAsyncpublic Future<GetGeneratedTemplateResult> getGeneratedTemplateAsync(GetGeneratedTemplateRequest request, AsyncHandler<GetGeneratedTemplateRequest,GetGeneratedTemplateResult> asyncHandler)
AmazonCloudFormationAsync
Retrieves a generated template. If the template is in an InProgress or Pending status
then the template returned will be the template when the template was last in a Complete status. If
the template has not yet been in a Complete status then an empty template will be returned.
getGeneratedTemplateAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<GetStackPolicyResult> getStackPolicyAsync(GetStackPolicyRequest request)
AmazonCloudFormationAsyncReturns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
getStackPolicyAsync in interface AmazonCloudFormationAsyncrequest - The input for the GetStackPolicy action.public Future<GetStackPolicyResult> getStackPolicyAsync(GetStackPolicyRequest request, AsyncHandler<GetStackPolicyRequest,GetStackPolicyResult> asyncHandler)
AmazonCloudFormationAsyncReturns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
getStackPolicyAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<GetTemplateResult> getTemplateAsync(GetTemplateRequest request)
AmazonCloudFormationAsyncReturns 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 doesn't exist, a ValidationError is returned.
getTemplateAsync in interface AmazonCloudFormationAsyncrequest - The input for a GetTemplate action.public Future<GetTemplateResult> getTemplateAsync(GetTemplateRequest request, AsyncHandler<GetTemplateRequest,GetTemplateResult> asyncHandler)
AmazonCloudFormationAsyncReturns 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 doesn't exist, a ValidationError is returned.
getTemplateAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<GetTemplateSummaryResult> getTemplateSummaryAsync(GetTemplateSummaryRequest request)
AmazonCloudFormationAsync
Returns information about a new or existing template. The GetTemplateSummary action is useful for
viewing parameter information, such as default parameter values and parameter types, before you create or update
a stack or stack set.
You can use the GetTemplateSummary action when you submit a template, or you can get template
information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the
stack has been deleted. If the template doesn't exist, a ValidationError is returned.
getTemplateSummaryAsync in interface AmazonCloudFormationAsyncrequest - The input for the GetTemplateSummary action.public Future<GetTemplateSummaryResult> getTemplateSummaryAsync(GetTemplateSummaryRequest request, AsyncHandler<GetTemplateSummaryRequest,GetTemplateSummaryResult> asyncHandler)
AmazonCloudFormationAsync
Returns information about a new or existing template. The GetTemplateSummary action is useful for
viewing parameter information, such as default parameter values and parameter types, before you create or update
a stack or stack set.
You can use the GetTemplateSummary action when you submit a template, or you can get template
information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the
stack has been deleted. If the template doesn't exist, a ValidationError is returned.
getTemplateSummaryAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<GetTemplateSummaryResult> getTemplateSummaryAsync()
getTemplateSummaryAsync in interface AmazonCloudFormationAsyncgetTemplateSummaryAsync(GetTemplateSummaryRequest)public Future<GetTemplateSummaryResult> getTemplateSummaryAsync(AsyncHandler<GetTemplateSummaryRequest,GetTemplateSummaryResult> asyncHandler)
getTemplateSummaryAsync in interface AmazonCloudFormationAsyncgetTemplateSummaryAsync(GetTemplateSummaryRequest, com.amazonaws.handlers.AsyncHandler)public Future<ImportStacksToStackSetResult> importStacksToStackSetAsync(ImportStacksToStackSetRequest request)
AmazonCloudFormationAsyncImport existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.
importStacksToStackSetAsync in interface AmazonCloudFormationAsyncpublic Future<ImportStacksToStackSetResult> importStacksToStackSetAsync(ImportStacksToStackSetRequest request, AsyncHandler<ImportStacksToStackSetRequest,ImportStacksToStackSetResult> asyncHandler)
AmazonCloudFormationAsyncImport existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.
importStacksToStackSetAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListChangeSetsResult> listChangeSetsAsync(ListChangeSetsRequest request)
AmazonCloudFormationAsync
Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets
that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
listChangeSetsAsync in interface AmazonCloudFormationAsyncrequest - The input for the ListChangeSets action.public Future<ListChangeSetsResult> listChangeSetsAsync(ListChangeSetsRequest request, AsyncHandler<ListChangeSetsRequest,ListChangeSetsResult> asyncHandler)
AmazonCloudFormationAsync
Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets
that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
listChangeSetsAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<ListExportsResult> listExportsAsync(ListExportsRequest request)
AmazonCloudFormationAsyncLists 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 CloudFormation export stack output values.
listExportsAsync in interface AmazonCloudFormationAsyncpublic Future<ListExportsResult> listExportsAsync(ListExportsRequest request, AsyncHandler<ListExportsRequest,ListExportsResult> asyncHandler)
AmazonCloudFormationAsyncLists 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 CloudFormation export stack output values.
listExportsAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListGeneratedTemplatesResult> listGeneratedTemplatesAsync(ListGeneratedTemplatesRequest request)
AmazonCloudFormationAsyncLists your generated templates in this Region.
listGeneratedTemplatesAsync in interface AmazonCloudFormationAsyncpublic Future<ListGeneratedTemplatesResult> listGeneratedTemplatesAsync(ListGeneratedTemplatesRequest request, AsyncHandler<ListGeneratedTemplatesRequest,ListGeneratedTemplatesResult> asyncHandler)
AmazonCloudFormationAsyncLists your generated templates in this Region.
listGeneratedTemplatesAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListImportsResult> listImportsAsync(ListImportsRequest request)
AmazonCloudFormationAsyncLists 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.
listImportsAsync in interface AmazonCloudFormationAsyncpublic Future<ListImportsResult> listImportsAsync(ListImportsRequest request, AsyncHandler<ListImportsRequest,ListImportsResult> asyncHandler)
AmazonCloudFormationAsyncLists 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.
listImportsAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListResourceScanRelatedResourcesResult> listResourceScanRelatedResourcesAsync(ListResourceScanRelatedResourcesRequest request)
AmazonCloudFormationAsyncLists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.
listResourceScanRelatedResourcesAsync in interface AmazonCloudFormationAsyncpublic Future<ListResourceScanRelatedResourcesResult> listResourceScanRelatedResourcesAsync(ListResourceScanRelatedResourcesRequest request, AsyncHandler<ListResourceScanRelatedResourcesRequest,ListResourceScanRelatedResourcesResult> asyncHandler)
AmazonCloudFormationAsyncLists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.
listResourceScanRelatedResourcesAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListResourceScanResourcesResult> listResourceScanResourcesAsync(ListResourceScanResourcesRequest request)
AmazonCloudFormationAsyncLists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.
listResourceScanResourcesAsync in interface AmazonCloudFormationAsyncpublic Future<ListResourceScanResourcesResult> listResourceScanResourcesAsync(ListResourceScanResourcesRequest request, AsyncHandler<ListResourceScanResourcesRequest,ListResourceScanResourcesResult> asyncHandler)
AmazonCloudFormationAsyncLists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.
listResourceScanResourcesAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListResourceScansResult> listResourceScansAsync(ListResourceScansRequest request)
AmazonCloudFormationAsyncList the resource scans from newest to oldest. By default it will return up to 10 resource scans.
listResourceScansAsync in interface AmazonCloudFormationAsyncpublic Future<ListResourceScansResult> listResourceScansAsync(ListResourceScansRequest request, AsyncHandler<ListResourceScansRequest,ListResourceScansResult> asyncHandler)
AmazonCloudFormationAsyncList the resource scans from newest to oldest. By default it will return up to 10 resource scans.
listResourceScansAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListStackInstanceResourceDriftsResult> listStackInstanceResourceDriftsAsync(ListStackInstanceResourceDriftsRequest request)
AmazonCloudFormationAsyncReturns drift information for resources in a stack instance.
ListStackInstanceResourceDrifts returns drift information for the most recent drift detection
operation. If an operation is in progress, it may only return partial results.
listStackInstanceResourceDriftsAsync in interface AmazonCloudFormationAsyncpublic Future<ListStackInstanceResourceDriftsResult> listStackInstanceResourceDriftsAsync(ListStackInstanceResourceDriftsRequest request, AsyncHandler<ListStackInstanceResourceDriftsRequest,ListStackInstanceResourceDriftsResult> asyncHandler)
AmazonCloudFormationAsyncReturns drift information for resources in a stack instance.
ListStackInstanceResourceDrifts returns drift information for the most recent drift detection
operation. If an operation is in progress, it may only return partial results.
listStackInstanceResourceDriftsAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListStackInstancesResult> listStackInstancesAsync(ListStackInstancesRequest request)
AmazonCloudFormationAsyncReturns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.
listStackInstancesAsync in interface AmazonCloudFormationAsyncpublic Future<ListStackInstancesResult> listStackInstancesAsync(ListStackInstancesRequest request, AsyncHandler<ListStackInstancesRequest,ListStackInstancesResult> asyncHandler)
AmazonCloudFormationAsyncReturns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.
listStackInstancesAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListStackResourcesResult> listStackResourcesAsync(ListStackResourcesRequest request)
AmazonCloudFormationAsyncReturns 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.
listStackResourcesAsync in interface AmazonCloudFormationAsyncrequest - The input for the ListStackResource action.public Future<ListStackResourcesResult> listStackResourcesAsync(ListStackResourcesRequest request, AsyncHandler<ListStackResourcesRequest,ListStackResourcesResult> asyncHandler)
AmazonCloudFormationAsyncReturns 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.
listStackResourcesAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<ListStackSetAutoDeploymentTargetsResult> listStackSetAutoDeploymentTargetsAsync(ListStackSetAutoDeploymentTargetsRequest request)
AmazonCloudFormationAsyncReturns summary information about deployment targets for a stack set.
listStackSetAutoDeploymentTargetsAsync in interface AmazonCloudFormationAsyncpublic Future<ListStackSetAutoDeploymentTargetsResult> listStackSetAutoDeploymentTargetsAsync(ListStackSetAutoDeploymentTargetsRequest request, AsyncHandler<ListStackSetAutoDeploymentTargetsRequest,ListStackSetAutoDeploymentTargetsResult> asyncHandler)
AmazonCloudFormationAsyncReturns summary information about deployment targets for a stack set.
listStackSetAutoDeploymentTargetsAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListStackSetOperationResultsResult> listStackSetOperationResultsAsync(ListStackSetOperationResultsRequest request)
AmazonCloudFormationAsyncReturns summary information about the results of a stack set operation.
listStackSetOperationResultsAsync in interface AmazonCloudFormationAsyncpublic Future<ListStackSetOperationResultsResult> listStackSetOperationResultsAsync(ListStackSetOperationResultsRequest request, AsyncHandler<ListStackSetOperationResultsRequest,ListStackSetOperationResultsResult> asyncHandler)
AmazonCloudFormationAsyncReturns summary information about the results of a stack set operation.
listStackSetOperationResultsAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListStackSetOperationsResult> listStackSetOperationsAsync(ListStackSetOperationsRequest request)
AmazonCloudFormationAsyncReturns summary information about operations performed on a stack set.
listStackSetOperationsAsync in interface AmazonCloudFormationAsyncpublic Future<ListStackSetOperationsResult> listStackSetOperationsAsync(ListStackSetOperationsRequest request, AsyncHandler<ListStackSetOperationsRequest,ListStackSetOperationsResult> asyncHandler)
AmazonCloudFormationAsyncReturns summary information about operations performed on a stack set.
listStackSetOperationsAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListStackSetsResult> listStackSetsAsync(ListStackSetsRequest request)
AmazonCloudFormationAsyncReturns summary information about stack sets that are associated with the user.
[Self-managed permissions] If you set the CallAs parameter to SELF while signed in to
your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon
Web Services account.
[Service-managed permissions] If you set the CallAs parameter to SELF while signed in
to the organization's management account, ListStackSets returns all stack sets in the management
account.
[Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while
signed in to your member account, ListStackSets returns all stack sets with service-managed
permissions in the management account.
listStackSetsAsync in interface AmazonCloudFormationAsyncpublic Future<ListStackSetsResult> listStackSetsAsync(ListStackSetsRequest request, AsyncHandler<ListStackSetsRequest,ListStackSetsResult> asyncHandler)
AmazonCloudFormationAsyncReturns summary information about stack sets that are associated with the user.
[Self-managed permissions] If you set the CallAs parameter to SELF while signed in to
your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon
Web Services account.
[Service-managed permissions] If you set the CallAs parameter to SELF while signed in
to the organization's management account, ListStackSets returns all stack sets in the management
account.
[Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while
signed in to your member account, ListStackSets returns all stack sets with service-managed
permissions in the management account.
listStackSetsAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListStacksResult> listStacksAsync(ListStacksRequest request)
AmazonCloudFormationAsyncReturns 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).
listStacksAsync in interface AmazonCloudFormationAsyncrequest - The input for ListStacks action.public Future<ListStacksResult> listStacksAsync(ListStacksRequest request, AsyncHandler<ListStacksRequest,ListStacksResult> asyncHandler)
AmazonCloudFormationAsyncReturns 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).
listStacksAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<ListStacksResult> listStacksAsync()
listStacksAsync in interface AmazonCloudFormationAsynclistStacksAsync(ListStacksRequest)public Future<ListStacksResult> listStacksAsync(AsyncHandler<ListStacksRequest,ListStacksResult> asyncHandler)
listStacksAsync in interface AmazonCloudFormationAsynclistStacksAsync(ListStacksRequest, com.amazonaws.handlers.AsyncHandler)public Future<ListTypeRegistrationsResult> listTypeRegistrationsAsync(ListTypeRegistrationsRequest request)
AmazonCloudFormationAsyncReturns a list of registration tokens for the specified extension(s).
listTypeRegistrationsAsync in interface AmazonCloudFormationAsyncpublic Future<ListTypeRegistrationsResult> listTypeRegistrationsAsync(ListTypeRegistrationsRequest request, AsyncHandler<ListTypeRegistrationsRequest,ListTypeRegistrationsResult> asyncHandler)
AmazonCloudFormationAsyncReturns a list of registration tokens for the specified extension(s).
listTypeRegistrationsAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListTypeVersionsResult> listTypeVersionsAsync(ListTypeVersionsRequest request)
AmazonCloudFormationAsyncReturns summary information about the versions of an extension.
listTypeVersionsAsync in interface AmazonCloudFormationAsyncpublic Future<ListTypeVersionsResult> listTypeVersionsAsync(ListTypeVersionsRequest request, AsyncHandler<ListTypeVersionsRequest,ListTypeVersionsResult> asyncHandler)
AmazonCloudFormationAsyncReturns summary information about the versions of an extension.
listTypeVersionsAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ListTypesResult> listTypesAsync(ListTypesRequest request)
AmazonCloudFormationAsyncReturns summary information about extension that have been registered with CloudFormation.
listTypesAsync in interface AmazonCloudFormationAsyncpublic Future<ListTypesResult> listTypesAsync(ListTypesRequest request, AsyncHandler<ListTypesRequest,ListTypesResult> asyncHandler)
AmazonCloudFormationAsyncReturns summary information about extension that have been registered with CloudFormation.
listTypesAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<PublishTypeResult> publishTypeAsync(PublishTypeRequest request)
AmazonCloudFormationAsyncPublishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
publishTypeAsync in interface AmazonCloudFormationAsyncpublic Future<PublishTypeResult> publishTypeAsync(PublishTypeRequest request, AsyncHandler<PublishTypeRequest,PublishTypeResult> asyncHandler)
AmazonCloudFormationAsyncPublishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
publishTypeAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<RecordHandlerProgressResult> recordHandlerProgressAsync(RecordHandlerProgressRequest request)
AmazonCloudFormationAsyncReports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Don't use this API in your code.
recordHandlerProgressAsync in interface AmazonCloudFormationAsyncpublic Future<RecordHandlerProgressResult> recordHandlerProgressAsync(RecordHandlerProgressRequest request, AsyncHandler<RecordHandlerProgressRequest,RecordHandlerProgressResult> asyncHandler)
AmazonCloudFormationAsyncReports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Don't use this API in your code.
recordHandlerProgressAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<RegisterPublisherResult> registerPublisherAsync(RegisterPublisherRequest request)
AmazonCloudFormationAsyncRegisters your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.
For information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
registerPublisherAsync in interface AmazonCloudFormationAsyncpublic Future<RegisterPublisherResult> registerPublisherAsync(RegisterPublisherRequest request, AsyncHandler<RegisterPublisherRequest,RegisterPublisherResult> asyncHandler)
AmazonCloudFormationAsyncRegisters your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.
For information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
registerPublisherAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<RegisterTypeResult> registerTypeAsync(RegisterTypeRequest request)
AmazonCloudFormationAsyncRegisters an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
Validating the extension schema.
Determining which handlers, if any, have been specified for the extension.
Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see Creating Resource Providers in the CloudFormation CLI User Guide.
You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per Region. Use DeregisterType to deregister specific extension versions if necessary.
Once you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
Once you have registered a private extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
registerTypeAsync in interface AmazonCloudFormationAsyncpublic Future<RegisterTypeResult> registerTypeAsync(RegisterTypeRequest request, AsyncHandler<RegisterTypeRequest,RegisterTypeResult> asyncHandler)
AmazonCloudFormationAsyncRegisters an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
Validating the extension schema.
Determining which handlers, if any, have been specified for the extension.
Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see Creating Resource Providers in the CloudFormation CLI User Guide.
You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per Region. Use DeregisterType to deregister specific extension versions if necessary.
Once you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
Once you have registered a private extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
registerTypeAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<RollbackStackResult> rollbackStackAsync(RollbackStackRequest request)
AmazonCloudFormationAsync
When specifying RollbackStack, you preserve the state of previously provisioned resources when an
operation fails. You can check the status of the stack through the DescribeStacks operation.
Rolls back the specified stack to the last known stable state from CREATE_FAILED or
UPDATE_FAILED stack statuses.
This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state
includes any status in a *_COMPLETE. This includes the following stack statuses.
CREATE_COMPLETE
UPDATE_COMPLETE
UPDATE_ROLLBACK_COMPLETE
IMPORT_COMPLETE
IMPORT_ROLLBACK_COMPLETE
rollbackStackAsync in interface AmazonCloudFormationAsyncpublic Future<RollbackStackResult> rollbackStackAsync(RollbackStackRequest request, AsyncHandler<RollbackStackRequest,RollbackStackResult> asyncHandler)
AmazonCloudFormationAsync
When specifying RollbackStack, you preserve the state of previously provisioned resources when an
operation fails. You can check the status of the stack through the DescribeStacks operation.
Rolls back the specified stack to the last known stable state from CREATE_FAILED or
UPDATE_FAILED stack statuses.
This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state
includes any status in a *_COMPLETE. This includes the following stack statuses.
CREATE_COMPLETE
UPDATE_COMPLETE
UPDATE_ROLLBACK_COMPLETE
IMPORT_COMPLETE
IMPORT_ROLLBACK_COMPLETE
rollbackStackAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<SetStackPolicyResult> setStackPolicyAsync(SetStackPolicyRequest request)
AmazonCloudFormationAsyncSets a stack policy for a specified stack.
setStackPolicyAsync in interface AmazonCloudFormationAsyncrequest - The input for the SetStackPolicy action.public Future<SetStackPolicyResult> setStackPolicyAsync(SetStackPolicyRequest request, AsyncHandler<SetStackPolicyRequest,SetStackPolicyResult> asyncHandler)
AmazonCloudFormationAsyncSets a stack policy for a specified stack.
setStackPolicyAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<SetTypeConfigurationResult> setTypeConfigurationAsync(SetTypeConfigurationRequest request)
AmazonCloudFormationAsyncSpecifies the configuration data for a registered CloudFormation extension, in the given account and Region.
To view the current configuration data for an extension, refer to the ConfigurationSchema element of
DescribeType.
For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.
setTypeConfigurationAsync in interface AmazonCloudFormationAsyncpublic Future<SetTypeConfigurationResult> setTypeConfigurationAsync(SetTypeConfigurationRequest request, AsyncHandler<SetTypeConfigurationRequest,SetTypeConfigurationResult> asyncHandler)
AmazonCloudFormationAsyncSpecifies the configuration data for a registered CloudFormation extension, in the given account and Region.
To view the current configuration data for an extension, refer to the ConfigurationSchema element of
DescribeType.
For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.
setTypeConfigurationAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<SetTypeDefaultVersionResult> setTypeDefaultVersionAsync(SetTypeDefaultVersionRequest request)
AmazonCloudFormationAsyncSpecify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
setTypeDefaultVersionAsync in interface AmazonCloudFormationAsyncpublic Future<SetTypeDefaultVersionResult> setTypeDefaultVersionAsync(SetTypeDefaultVersionRequest request, AsyncHandler<SetTypeDefaultVersionRequest,SetTypeDefaultVersionResult> asyncHandler)
AmazonCloudFormationAsyncSpecify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
setTypeDefaultVersionAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<SignalResourceResult> signalResourceAsync(SignalResourceRequest request)
AmazonCloudFormationAsync
Sends a signal to the specified resource with a success or failure status. You can use the
SignalResource operation in conjunction with a creation policy or update policy. 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 operation is useful in cases where you want to send
signals from anywhere other than an Amazon EC2 instance.
signalResourceAsync in interface AmazonCloudFormationAsyncrequest - The input for the SignalResource action.public Future<SignalResourceResult> signalResourceAsync(SignalResourceRequest request, AsyncHandler<SignalResourceRequest,SignalResourceResult> asyncHandler)
AmazonCloudFormationAsync
Sends a signal to the specified resource with a success or failure status. You can use the
SignalResource operation in conjunction with a creation policy or update policy. 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 operation is useful in cases where you want to send
signals from anywhere other than an Amazon EC2 instance.
signalResourceAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<StartResourceScanResult> startResourceScanAsync(StartResourceScanRequest request)
AmazonCloudFormationAsync
Starts a scan of the resources in this account in this Region. You can the status of a scan using the
ListResourceScans API action.
startResourceScanAsync in interface AmazonCloudFormationAsyncpublic Future<StartResourceScanResult> startResourceScanAsync(StartResourceScanRequest request, AsyncHandler<StartResourceScanRequest,StartResourceScanResult> asyncHandler)
AmazonCloudFormationAsync
Starts a scan of the resources in this account in this Region. You can the status of a scan using the
ListResourceScans API action.
startResourceScanAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<StopStackSetOperationResult> stopStackSetOperationAsync(StopStackSetOperationRequest request)
AmazonCloudFormationAsyncStops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.
stopStackSetOperationAsync in interface AmazonCloudFormationAsyncpublic Future<StopStackSetOperationResult> stopStackSetOperationAsync(StopStackSetOperationRequest request, AsyncHandler<StopStackSetOperationRequest,StopStackSetOperationResult> asyncHandler)
AmazonCloudFormationAsyncStops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.
stopStackSetOperationAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<TestTypeResult> testTypeAsync(TestTypeRequest request)
AmazonCloudFormationAsyncTests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
For resource types, this includes passing all contracts tests defined for the type.
For modules, this includes determining if the module's model meets all necessary requirements.
For more information, see Testing your public extension prior to publishing in the CloudFormation CLI User Guide.
If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.
Once you've initiated testing on an extension using TestType, you can pass the returned
TypeVersionArn into DescribeType
to monitor the current test status and test status description for the extension.
An extension must have a test status of PASSED before it can be published. For more information, see
Publishing
extensions to make them available for public use in the CloudFormation CLI User Guide.
testTypeAsync in interface AmazonCloudFormationAsyncpublic Future<TestTypeResult> testTypeAsync(TestTypeRequest request, AsyncHandler<TestTypeRequest,TestTypeResult> asyncHandler)
AmazonCloudFormationAsyncTests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
For resource types, this includes passing all contracts tests defined for the type.
For modules, this includes determining if the module's model meets all necessary requirements.
For more information, see Testing your public extension prior to publishing in the CloudFormation CLI User Guide.
If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.
Once you've initiated testing on an extension using TestType, you can pass the returned
TypeVersionArn into DescribeType
to monitor the current test status and test status description for the extension.
An extension must have a test status of PASSED before it can be published. For more information, see
Publishing
extensions to make them available for public use in the CloudFormation CLI User Guide.
testTypeAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<UpdateGeneratedTemplateResult> updateGeneratedTemplateAsync(UpdateGeneratedTemplateRequest request)
AmazonCloudFormationAsync
Updates a generated template. This can be used to change the name, add and remove resources, refresh resources,
and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the
status of the update to the generated template using the DescribeGeneratedTemplate API action.
updateGeneratedTemplateAsync in interface AmazonCloudFormationAsyncpublic Future<UpdateGeneratedTemplateResult> updateGeneratedTemplateAsync(UpdateGeneratedTemplateRequest request, AsyncHandler<UpdateGeneratedTemplateRequest,UpdateGeneratedTemplateResult> asyncHandler)
AmazonCloudFormationAsync
Updates a generated template. This can be used to change the name, add and remove resources, refresh resources,
and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the
status of the update to the generated template using the DescribeGeneratedTemplate API action.
updateGeneratedTemplateAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<UpdateStackResult> updateStackAsync(UpdateStackRequest request)
AmazonCloudFormationAsyncUpdates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through 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.
updateStackAsync in interface AmazonCloudFormationAsyncrequest - The input for an UpdateStack action.public Future<UpdateStackResult> updateStackAsync(UpdateStackRequest request, AsyncHandler<UpdateStackRequest,UpdateStackResult> asyncHandler)
AmazonCloudFormationAsyncUpdates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through 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.
updateStackAsync in interface AmazonCloudFormationAsyncrequest - 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.public Future<UpdateStackInstancesResult> updateStackInstancesAsync(UpdateStackInstancesRequest request)
AmazonCloudFormationAsyncUpdates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter
itself, use UpdateStackSet
to update the stack set template. If you add a parameter to a template, before you can override the
parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the
stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter
value using UpdateStackInstances.
updateStackInstancesAsync in interface AmazonCloudFormationAsyncpublic Future<UpdateStackInstancesResult> updateStackInstancesAsync(UpdateStackInstancesRequest request, AsyncHandler<UpdateStackInstancesRequest,UpdateStackInstancesResult> asyncHandler)
AmazonCloudFormationAsyncUpdates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter
itself, use UpdateStackSet
to update the stack set template. If you add a parameter to a template, before you can override the
parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the
stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter
value using UpdateStackInstances.
updateStackInstancesAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<UpdateStackSetResult> updateStackSetAsync(UpdateStackSetRequest request)
AmazonCloudFormationAsyncUpdates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
updateStackSetAsync in interface AmazonCloudFormationAsyncpublic Future<UpdateStackSetResult> updateStackSetAsync(UpdateStackSetRequest request, AsyncHandler<UpdateStackSetRequest,UpdateStackSetResult> asyncHandler)
AmazonCloudFormationAsyncUpdates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
updateStackSetAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<UpdateTerminationProtectionResult> updateTerminationProtectionAsync(UpdateTerminationProtectionRequest request)
AmazonCloudFormationAsyncUpdates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
updateTerminationProtectionAsync in interface AmazonCloudFormationAsyncpublic Future<UpdateTerminationProtectionResult> updateTerminationProtectionAsync(UpdateTerminationProtectionRequest request, AsyncHandler<UpdateTerminationProtectionRequest,UpdateTerminationProtectionResult> asyncHandler)
AmazonCloudFormationAsyncUpdates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
updateTerminationProtectionAsync in interface AmazonCloudFormationAsyncasyncHandler - 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.public Future<ValidateTemplateResult> validateTemplateAsync(ValidateTemplateRequest request)
AmazonCloudFormationAsyncValidates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error.
validateTemplateAsync in interface AmazonCloudFormationAsyncrequest - The input for ValidateTemplate action.public Future<ValidateTemplateResult> validateTemplateAsync(ValidateTemplateRequest request, AsyncHandler<ValidateTemplateRequest,ValidateTemplateResult> asyncHandler)
AmazonCloudFormationAsyncValidates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error.
validateTemplateAsync in interface AmazonCloudFormationAsyncrequest - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonCloudFormationshutdown in class AmazonCloudFormationClient