@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCloudFormationAsync extends AmazonCloudFormation
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonCloudFormationAsync
instead.
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.
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<ActivateOrganizationsAccessResult> |
activateOrganizationsAccessAsync(ActivateOrganizationsAccessRequest activateOrganizationsAccessRequest)
Activate trusted access with Organizations.
|
Future<ActivateOrganizationsAccessResult> |
activateOrganizationsAccessAsync(ActivateOrganizationsAccessRequest activateOrganizationsAccessRequest,
AsyncHandler<ActivateOrganizationsAccessRequest,ActivateOrganizationsAccessResult> asyncHandler)
Activate trusted access with Organizations.
|
Future<ActivateTypeResult> |
activateTypeAsync(ActivateTypeRequest activateTypeRequest)
Activates a public third-party extension, making it available for use in stack templates.
|
Future<ActivateTypeResult> |
activateTypeAsync(ActivateTypeRequest activateTypeRequest,
AsyncHandler<ActivateTypeRequest,ActivateTypeResult> asyncHandler)
Activates a public third-party extension, making it available for use in stack templates.
|
Future<BatchDescribeTypeConfigurationsResult> |
batchDescribeTypeConfigurationsAsync(BatchDescribeTypeConfigurationsRequest batchDescribeTypeConfigurationsRequest)
Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the
account and Region.
|
Future<BatchDescribeTypeConfigurationsResult> |
batchDescribeTypeConfigurationsAsync(BatchDescribeTypeConfigurationsRequest batchDescribeTypeConfigurationsRequest,
AsyncHandler<BatchDescribeTypeConfigurationsRequest,BatchDescribeTypeConfigurationsResult> asyncHandler)
Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the
account and Region.
|
Future<CancelUpdateStackResult> |
cancelUpdateStackAsync(CancelUpdateStackRequest cancelUpdateStackRequest)
Cancels an update on the specified stack.
|
Future<CancelUpdateStackResult> |
cancelUpdateStackAsync(CancelUpdateStackRequest cancelUpdateStackRequest,
AsyncHandler<CancelUpdateStackRequest,CancelUpdateStackResult> asyncHandler)
Cancels an update on the specified stack.
|
Future<ContinueUpdateRollbackResult> |
continueUpdateRollbackAsync(ContinueUpdateRollbackRequest continueUpdateRollbackRequest)
For a specified stack that's in the
UPDATE_ROLLBACK_FAILED state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE state. |
Future<ContinueUpdateRollbackResult> |
continueUpdateRollbackAsync(ContinueUpdateRollbackRequest continueUpdateRollbackRequest,
AsyncHandler<ContinueUpdateRollbackRequest,ContinueUpdateRollbackResult> asyncHandler)
For a specified stack that's in the
UPDATE_ROLLBACK_FAILED state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE state. |
Future<CreateChangeSetResult> |
createChangeSetAsync(CreateChangeSetRequest createChangeSetRequest)
Creates a list of changes that will be applied to a stack so that you can review the changes before executing
them.
|
Future<CreateChangeSetResult> |
createChangeSetAsync(CreateChangeSetRequest createChangeSetRequest,
AsyncHandler<CreateChangeSetRequest,CreateChangeSetResult> asyncHandler)
Creates a list of changes that will be applied to a stack so that you can review the changes before executing
them.
|
Future<CreateGeneratedTemplateResult> |
createGeneratedTemplateAsync(CreateGeneratedTemplateRequest createGeneratedTemplateRequest)
Creates a template from existing resources that are not already managed with CloudFormation.
|
Future<CreateGeneratedTemplateResult> |
createGeneratedTemplateAsync(CreateGeneratedTemplateRequest createGeneratedTemplateRequest,
AsyncHandler<CreateGeneratedTemplateRequest,CreateGeneratedTemplateResult> asyncHandler)
Creates a template from existing resources that are not already managed with CloudFormation.
|
Future<CreateStackResult> |
createStackAsync(CreateStackRequest createStackRequest)
Creates a stack as specified in the template.
|
Future<CreateStackResult> |
createStackAsync(CreateStackRequest createStackRequest,
AsyncHandler<CreateStackRequest,CreateStackResult> asyncHandler)
Creates a stack as specified in the template.
|
Future<CreateStackInstancesResult> |
createStackInstancesAsync(CreateStackInstancesRequest createStackInstancesRequest)
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions.
|
Future<CreateStackInstancesResult> |
createStackInstancesAsync(CreateStackInstancesRequest createStackInstancesRequest,
AsyncHandler<CreateStackInstancesRequest,CreateStackInstancesResult> asyncHandler)
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions.
|
Future<CreateStackSetResult> |
createStackSetAsync(CreateStackSetRequest createStackSetRequest)
Creates a stack set.
|
Future<CreateStackSetResult> |
createStackSetAsync(CreateStackSetRequest createStackSetRequest,
AsyncHandler<CreateStackSetRequest,CreateStackSetResult> asyncHandler)
Creates a stack set.
|
Future<DeactivateOrganizationsAccessResult> |
deactivateOrganizationsAccessAsync(DeactivateOrganizationsAccessRequest deactivateOrganizationsAccessRequest)
Deactivates trusted access with Organizations.
|
Future<DeactivateOrganizationsAccessResult> |
deactivateOrganizationsAccessAsync(DeactivateOrganizationsAccessRequest deactivateOrganizationsAccessRequest,
AsyncHandler<DeactivateOrganizationsAccessRequest,DeactivateOrganizationsAccessResult> asyncHandler)
Deactivates trusted access with Organizations.
|
Future<DeactivateTypeResult> |
deactivateTypeAsync(DeactivateTypeRequest deactivateTypeRequest)
Deactivates a public extension that was previously activated in this account and Region.
|
Future<DeactivateTypeResult> |
deactivateTypeAsync(DeactivateTypeRequest deactivateTypeRequest,
AsyncHandler<DeactivateTypeRequest,DeactivateTypeResult> asyncHandler)
Deactivates a public extension that was previously activated in this account and Region.
|
Future<DeleteChangeSetResult> |
deleteChangeSetAsync(DeleteChangeSetRequest deleteChangeSetRequest)
Deletes the specified change set.
|
Future<DeleteChangeSetResult> |
deleteChangeSetAsync(DeleteChangeSetRequest deleteChangeSetRequest,
AsyncHandler<DeleteChangeSetRequest,DeleteChangeSetResult> asyncHandler)
Deletes the specified change set.
|
Future<DeleteGeneratedTemplateResult> |
deleteGeneratedTemplateAsync(DeleteGeneratedTemplateRequest deleteGeneratedTemplateRequest)
Deleted a generated template.
|
Future<DeleteGeneratedTemplateResult> |
deleteGeneratedTemplateAsync(DeleteGeneratedTemplateRequest deleteGeneratedTemplateRequest,
AsyncHandler<DeleteGeneratedTemplateRequest,DeleteGeneratedTemplateResult> asyncHandler)
Deleted a generated template.
|
Future<DeleteStackResult> |
deleteStackAsync(DeleteStackRequest deleteStackRequest)
Deletes a specified stack.
|
Future<DeleteStackResult> |
deleteStackAsync(DeleteStackRequest deleteStackRequest,
AsyncHandler<DeleteStackRequest,DeleteStackResult> asyncHandler)
Deletes a specified stack.
|
Future<DeleteStackInstancesResult> |
deleteStackInstancesAsync(DeleteStackInstancesRequest deleteStackInstancesRequest)
Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
|
Future<DeleteStackInstancesResult> |
deleteStackInstancesAsync(DeleteStackInstancesRequest deleteStackInstancesRequest,
AsyncHandler<DeleteStackInstancesRequest,DeleteStackInstancesResult> asyncHandler)
Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
|
Future<DeleteStackSetResult> |
deleteStackSetAsync(DeleteStackSetRequest deleteStackSetRequest)
Deletes a stack set.
|
Future<DeleteStackSetResult> |
deleteStackSetAsync(DeleteStackSetRequest deleteStackSetRequest,
AsyncHandler<DeleteStackSetRequest,DeleteStackSetResult> asyncHandler)
Deletes a stack set.
|
Future<DeregisterTypeResult> |
deregisterTypeAsync(DeregisterTypeRequest deregisterTypeRequest)
Marks an extension or extension version as
DEPRECATED in the CloudFormation registry, removing it
from active use. |
Future<DeregisterTypeResult> |
deregisterTypeAsync(DeregisterTypeRequest deregisterTypeRequest,
AsyncHandler<DeregisterTypeRequest,DeregisterTypeResult> asyncHandler)
Marks an extension or extension version as
DEPRECATED in the CloudFormation registry, removing it
from active use. |
Future<DescribeAccountLimitsResult> |
describeAccountLimitsAsync(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your
account.
|
Future<DescribeAccountLimitsResult> |
describeAccountLimitsAsync(DescribeAccountLimitsRequest describeAccountLimitsRequest,
AsyncHandler<DescribeAccountLimitsRequest,DescribeAccountLimitsResult> asyncHandler)
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your
account.
|
Future<DescribeChangeSetResult> |
describeChangeSetAsync(DescribeChangeSetRequest describeChangeSetRequest)
Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the
change set.
|
Future<DescribeChangeSetResult> |
describeChangeSetAsync(DescribeChangeSetRequest describeChangeSetRequest,
AsyncHandler<DescribeChangeSetRequest,DescribeChangeSetResult> asyncHandler)
Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the
change set.
|
Future<DescribeChangeSetHooksResult> |
describeChangeSetHooksAsync(DescribeChangeSetHooksRequest describeChangeSetHooksRequest)
Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run
the change set.
|
Future<DescribeChangeSetHooksResult> |
describeChangeSetHooksAsync(DescribeChangeSetHooksRequest describeChangeSetHooksRequest,
AsyncHandler<DescribeChangeSetHooksRequest,DescribeChangeSetHooksResult> asyncHandler)
Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run
the change set.
|
Future<DescribeGeneratedTemplateResult> |
describeGeneratedTemplateAsync(DescribeGeneratedTemplateRequest describeGeneratedTemplateRequest)
Describes a generated template.
|
Future<DescribeGeneratedTemplateResult> |
describeGeneratedTemplateAsync(DescribeGeneratedTemplateRequest describeGeneratedTemplateRequest,
AsyncHandler<DescribeGeneratedTemplateRequest,DescribeGeneratedTemplateResult> asyncHandler)
Describes a generated template.
|
Future<DescribeOrganizationsAccessResult> |
describeOrganizationsAccessAsync(DescribeOrganizationsAccessRequest describeOrganizationsAccessRequest)
Retrieves information about the account's
OrganizationAccess status. |
Future<DescribeOrganizationsAccessResult> |
describeOrganizationsAccessAsync(DescribeOrganizationsAccessRequest describeOrganizationsAccessRequest,
AsyncHandler<DescribeOrganizationsAccessRequest,DescribeOrganizationsAccessResult> asyncHandler)
Retrieves information about the account's
OrganizationAccess status. |
Future<DescribePublisherResult> |
describePublisherAsync(DescribePublisherRequest describePublisherRequest)
Returns information about a CloudFormation extension publisher.
|
Future<DescribePublisherResult> |
describePublisherAsync(DescribePublisherRequest describePublisherRequest,
AsyncHandler<DescribePublisherRequest,DescribePublisherResult> asyncHandler)
Returns information about a CloudFormation extension publisher.
|
Future<DescribeResourceScanResult> |
describeResourceScanAsync(DescribeResourceScanRequest describeResourceScanRequest)
Describes details of a resource scan.
|
Future<DescribeResourceScanResult> |
describeResourceScanAsync(DescribeResourceScanRequest describeResourceScanRequest,
AsyncHandler<DescribeResourceScanRequest,DescribeResourceScanResult> asyncHandler)
Describes details of a resource scan.
|
Future<DescribeStackDriftDetectionStatusResult> |
describeStackDriftDetectionStatusAsync(DescribeStackDriftDetectionStatusRequest describeStackDriftDetectionStatusRequest)
Returns information about a stack drift detection operation.
|
Future<DescribeStackDriftDetectionStatusResult> |
describeStackDriftDetectionStatusAsync(DescribeStackDriftDetectionStatusRequest describeStackDriftDetectionStatusRequest,
AsyncHandler<DescribeStackDriftDetectionStatusRequest,DescribeStackDriftDetectionStatusResult> asyncHandler)
Returns information about a stack drift detection operation.
|
Future<DescribeStackEventsResult> |
describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order.
|
Future<DescribeStackEventsResult> |
describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest,
AsyncHandler<DescribeStackEventsRequest,DescribeStackEventsResult> asyncHandler)
Returns all stack related events for a specified stack in reverse chronological order.
|
Future<DescribeStackInstanceResult> |
describeStackInstanceAsync(DescribeStackInstanceRequest describeStackInstanceRequest)
Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon
Web Services Region.
|
Future<DescribeStackInstanceResult> |
describeStackInstanceAsync(DescribeStackInstanceRequest describeStackInstanceRequest,
AsyncHandler<DescribeStackInstanceRequest,DescribeStackInstanceResult> asyncHandler)
Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon
Web Services Region.
|
Future<DescribeStackResourceResult> |
describeStackResourceAsync(DescribeStackResourceRequest describeStackResourceRequest)
Returns a description of the specified resource in the specified stack.
|
Future<DescribeStackResourceResult> |
describeStackResourceAsync(DescribeStackResourceRequest describeStackResourceRequest,
AsyncHandler<DescribeStackResourceRequest,DescribeStackResourceResult> asyncHandler)
Returns a description of the specified resource in the specified stack.
|
Future<DescribeStackResourceDriftsResult> |
describeStackResourceDriftsAsync(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest)
Returns drift information for the resources that have been checked for drift in the specified stack.
|
Future<DescribeStackResourceDriftsResult> |
describeStackResourceDriftsAsync(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest,
AsyncHandler<DescribeStackResourceDriftsRequest,DescribeStackResourceDriftsResult> asyncHandler)
Returns drift information for the resources that have been checked for drift in the specified stack.
|
Future<DescribeStackResourcesResult> |
describeStackResourcesAsync(DescribeStackResourcesRequest describeStackResourcesRequest)
Returns Amazon Web Services resource descriptions for running and deleted stacks.
|
Future<DescribeStackResourcesResult> |
describeStackResourcesAsync(DescribeStackResourcesRequest describeStackResourcesRequest,
AsyncHandler<DescribeStackResourcesRequest,DescribeStackResourcesResult> asyncHandler)
Returns Amazon Web Services resource descriptions for running and deleted stacks.
|
Future<DescribeStacksResult> |
describeStacksAsync()
Simplified method form for invoking the DescribeStacks operation.
|
Future<DescribeStacksResult> |
describeStacksAsync(AsyncHandler<DescribeStacksRequest,DescribeStacksResult> asyncHandler)
Simplified method form for invoking the DescribeStacks operation with an AsyncHandler.
|
Future<DescribeStacksResult> |
describeStacksAsync(DescribeStacksRequest describeStacksRequest)
Returns the description for the specified stack; if no stack name was specified, then it returns the description
for all the stacks created.
|
Future<DescribeStacksResult> |
describeStacksAsync(DescribeStacksRequest describeStacksRequest,
AsyncHandler<DescribeStacksRequest,DescribeStacksResult> asyncHandler)
Returns the description for the specified stack; if no stack name was specified, then it returns the description
for all the stacks created.
|
Future<DescribeStackSetResult> |
describeStackSetAsync(DescribeStackSetRequest describeStackSetRequest)
Returns the description of the specified StackSet.
|
Future<DescribeStackSetResult> |
describeStackSetAsync(DescribeStackSetRequest describeStackSetRequest,
AsyncHandler<DescribeStackSetRequest,DescribeStackSetResult> asyncHandler)
Returns the description of the specified StackSet.
|
Future<DescribeStackSetOperationResult> |
describeStackSetOperationAsync(DescribeStackSetOperationRequest describeStackSetOperationRequest)
Returns the description of the specified StackSet operation.
|
Future<DescribeStackSetOperationResult> |
describeStackSetOperationAsync(DescribeStackSetOperationRequest describeStackSetOperationRequest,
AsyncHandler<DescribeStackSetOperationRequest,DescribeStackSetOperationResult> asyncHandler)
Returns the description of the specified StackSet operation.
|
Future<DescribeTypeResult> |
describeTypeAsync(DescribeTypeRequest describeTypeRequest)
Returns detailed information about an extension that has been registered.
|
Future<DescribeTypeResult> |
describeTypeAsync(DescribeTypeRequest describeTypeRequest,
AsyncHandler<DescribeTypeRequest,DescribeTypeResult> asyncHandler)
Returns detailed information about an extension that has been registered.
|
Future<DescribeTypeRegistrationResult> |
describeTypeRegistrationAsync(DescribeTypeRegistrationRequest describeTypeRegistrationRequest)
Returns information about an extension's registration, including its current status and type and version
identifiers.
|
Future<DescribeTypeRegistrationResult> |
describeTypeRegistrationAsync(DescribeTypeRegistrationRequest describeTypeRegistrationRequest,
AsyncHandler<DescribeTypeRegistrationRequest,DescribeTypeRegistrationResult> asyncHandler)
Returns information about an extension's registration, including its current status and type and version
identifiers.
|
Future<DetectStackDriftResult> |
detectStackDriftAsync(DetectStackDriftRequest detectStackDriftRequest)
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.
|
Future<DetectStackDriftResult> |
detectStackDriftAsync(DetectStackDriftRequest detectStackDriftRequest,
AsyncHandler<DetectStackDriftRequest,DetectStackDriftResult> asyncHandler)
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.
|
Future<DetectStackResourceDriftResult> |
detectStackResourceDriftAsync(DetectStackResourceDriftRequest detectStackResourceDriftRequest)
Returns 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.
|
Future<DetectStackResourceDriftResult> |
detectStackResourceDriftAsync(DetectStackResourceDriftRequest detectStackResourceDriftRequest,
AsyncHandler<DetectStackResourceDriftRequest,DetectStackResourceDriftResult> asyncHandler)
Returns 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.
|
Future<DetectStackSetDriftResult> |
detectStackSetDriftAsync(DetectStackSetDriftRequest detectStackSetDriftRequest)
Detect drift on a stack set.
|
Future<DetectStackSetDriftResult> |
detectStackSetDriftAsync(DetectStackSetDriftRequest detectStackSetDriftRequest,
AsyncHandler<DetectStackSetDriftRequest,DetectStackSetDriftResult> asyncHandler)
Detect drift on a stack set.
|
Future<EstimateTemplateCostResult> |
estimateTemplateCostAsync()
Simplified method form for invoking the EstimateTemplateCost operation.
|
Future<EstimateTemplateCostResult> |
estimateTemplateCostAsync(AsyncHandler<EstimateTemplateCostRequest,EstimateTemplateCostResult> asyncHandler)
Simplified method form for invoking the EstimateTemplateCost operation with an AsyncHandler.
|
Future<EstimateTemplateCostResult> |
estimateTemplateCostAsync(EstimateTemplateCostRequest estimateTemplateCostRequest)
Returns the estimated monthly cost of a template.
|
Future<EstimateTemplateCostResult> |
estimateTemplateCostAsync(EstimateTemplateCostRequest estimateTemplateCostRequest,
AsyncHandler<EstimateTemplateCostRequest,EstimateTemplateCostResult> asyncHandler)
Returns the estimated monthly cost of a template.
|
Future<ExecuteChangeSetResult> |
executeChangeSetAsync(ExecuteChangeSetRequest executeChangeSetRequest)
Updates a stack using the input information that was provided when the specified change set was created.
|
Future<ExecuteChangeSetResult> |
executeChangeSetAsync(ExecuteChangeSetRequest executeChangeSetRequest,
AsyncHandler<ExecuteChangeSetRequest,ExecuteChangeSetResult> asyncHandler)
Updates a stack using the input information that was provided when the specified change set was created.
|
Future<GetGeneratedTemplateResult> |
getGeneratedTemplateAsync(GetGeneratedTemplateRequest getGeneratedTemplateRequest)
Retrieves a generated template.
|
Future<GetGeneratedTemplateResult> |
getGeneratedTemplateAsync(GetGeneratedTemplateRequest getGeneratedTemplateRequest,
AsyncHandler<GetGeneratedTemplateRequest,GetGeneratedTemplateResult> asyncHandler)
Retrieves a generated template.
|
Future<GetStackPolicyResult> |
getStackPolicyAsync(GetStackPolicyRequest getStackPolicyRequest)
Returns the stack policy for a specified stack.
|
Future<GetStackPolicyResult> |
getStackPolicyAsync(GetStackPolicyRequest getStackPolicyRequest,
AsyncHandler<GetStackPolicyRequest,GetStackPolicyResult> asyncHandler)
Returns the stack policy for a specified stack.
|
Future<GetTemplateResult> |
getTemplateAsync(GetTemplateRequest getTemplateRequest)
Returns the template body for a specified stack.
|
Future<GetTemplateResult> |
getTemplateAsync(GetTemplateRequest getTemplateRequest,
AsyncHandler<GetTemplateRequest,GetTemplateResult> asyncHandler)
Returns the template body for a specified stack.
|
Future<GetTemplateSummaryResult> |
getTemplateSummaryAsync()
Simplified method form for invoking the GetTemplateSummary operation.
|
Future<GetTemplateSummaryResult> |
getTemplateSummaryAsync(AsyncHandler<GetTemplateSummaryRequest,GetTemplateSummaryResult> asyncHandler)
Simplified method form for invoking the GetTemplateSummary operation with an AsyncHandler.
|
Future<GetTemplateSummaryResult> |
getTemplateSummaryAsync(GetTemplateSummaryRequest getTemplateSummaryRequest)
Returns information about a new or existing template.
|
Future<GetTemplateSummaryResult> |
getTemplateSummaryAsync(GetTemplateSummaryRequest getTemplateSummaryRequest,
AsyncHandler<GetTemplateSummaryRequest,GetTemplateSummaryResult> asyncHandler)
Returns information about a new or existing template.
|
Future<ImportStacksToStackSetResult> |
importStacksToStackSetAsync(ImportStacksToStackSetRequest importStacksToStackSetRequest)
Import existing stacks into a new stack sets.
|
Future<ImportStacksToStackSetResult> |
importStacksToStackSetAsync(ImportStacksToStackSetRequest importStacksToStackSetRequest,
AsyncHandler<ImportStacksToStackSetRequest,ImportStacksToStackSetResult> asyncHandler)
Import existing stacks into a new stack sets.
|
Future<ListChangeSetsResult> |
listChangeSetsAsync(ListChangeSetsRequest listChangeSetsRequest)
Returns the ID and status of each active change set for a stack.
|
Future<ListChangeSetsResult> |
listChangeSetsAsync(ListChangeSetsRequest listChangeSetsRequest,
AsyncHandler<ListChangeSetsRequest,ListChangeSetsResult> asyncHandler)
Returns the ID and status of each active change set for a stack.
|
Future<ListExportsResult> |
listExportsAsync(ListExportsRequest listExportsRequest)
Lists all exported output values in the account and Region in which you call this action.
|
Future<ListExportsResult> |
listExportsAsync(ListExportsRequest listExportsRequest,
AsyncHandler<ListExportsRequest,ListExportsResult> asyncHandler)
Lists all exported output values in the account and Region in which you call this action.
|
Future<ListGeneratedTemplatesResult> |
listGeneratedTemplatesAsync(ListGeneratedTemplatesRequest listGeneratedTemplatesRequest)
Lists your generated templates in this Region.
|
Future<ListGeneratedTemplatesResult> |
listGeneratedTemplatesAsync(ListGeneratedTemplatesRequest listGeneratedTemplatesRequest,
AsyncHandler<ListGeneratedTemplatesRequest,ListGeneratedTemplatesResult> asyncHandler)
Lists your generated templates in this Region.
|
Future<ListImportsResult> |
listImportsAsync(ListImportsRequest listImportsRequest)
Lists all stacks that are importing an exported output value.
|
Future<ListImportsResult> |
listImportsAsync(ListImportsRequest listImportsRequest,
AsyncHandler<ListImportsRequest,ListImportsResult> asyncHandler)
Lists all stacks that are importing an exported output value.
|
Future<ListResourceScanRelatedResourcesResult> |
listResourceScanRelatedResourcesAsync(ListResourceScanRelatedResourcesRequest listResourceScanRelatedResourcesRequest)
Lists the related resources for a list of resources from a resource scan.
|
Future<ListResourceScanRelatedResourcesResult> |
listResourceScanRelatedResourcesAsync(ListResourceScanRelatedResourcesRequest listResourceScanRelatedResourcesRequest,
AsyncHandler<ListResourceScanRelatedResourcesRequest,ListResourceScanRelatedResourcesResult> asyncHandler)
Lists the related resources for a list of resources from a resource scan.
|
Future<ListResourceScanResourcesResult> |
listResourceScanResourcesAsync(ListResourceScanResourcesRequest listResourceScanResourcesRequest)
Lists the resources from a resource scan.
|
Future<ListResourceScanResourcesResult> |
listResourceScanResourcesAsync(ListResourceScanResourcesRequest listResourceScanResourcesRequest,
AsyncHandler<ListResourceScanResourcesRequest,ListResourceScanResourcesResult> asyncHandler)
Lists the resources from a resource scan.
|
Future<ListResourceScansResult> |
listResourceScansAsync(ListResourceScansRequest listResourceScansRequest)
List the resource scans from newest to oldest.
|
Future<ListResourceScansResult> |
listResourceScansAsync(ListResourceScansRequest listResourceScansRequest,
AsyncHandler<ListResourceScansRequest,ListResourceScansResult> asyncHandler)
List the resource scans from newest to oldest.
|
Future<ListStackInstanceResourceDriftsResult> |
listStackInstanceResourceDriftsAsync(ListStackInstanceResourceDriftsRequest listStackInstanceResourceDriftsRequest)
Returns drift information for resources in a stack instance.
|
Future<ListStackInstanceResourceDriftsResult> |
listStackInstanceResourceDriftsAsync(ListStackInstanceResourceDriftsRequest listStackInstanceResourceDriftsRequest,
AsyncHandler<ListStackInstanceResourceDriftsRequest,ListStackInstanceResourceDriftsResult> asyncHandler)
Returns drift information for resources in a stack instance.
|
Future<ListStackInstancesResult> |
listStackInstancesAsync(ListStackInstancesRequest listStackInstancesRequest)
Returns summary information about stack instances that are associated with the specified stack set.
|
Future<ListStackInstancesResult> |
listStackInstancesAsync(ListStackInstancesRequest listStackInstancesRequest,
AsyncHandler<ListStackInstancesRequest,ListStackInstancesResult> asyncHandler)
Returns summary information about stack instances that are associated with the specified stack set.
|
Future<ListStackResourcesResult> |
listStackResourcesAsync(ListStackResourcesRequest listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
Future<ListStackResourcesResult> |
listStackResourcesAsync(ListStackResourcesRequest listStackResourcesRequest,
AsyncHandler<ListStackResourcesRequest,ListStackResourcesResult> asyncHandler)
Returns descriptions of all resources of the specified stack.
|
Future<ListStacksResult> |
listStacksAsync()
Simplified method form for invoking the ListStacks operation.
|
Future<ListStacksResult> |
listStacksAsync(AsyncHandler<ListStacksRequest,ListStacksResult> asyncHandler)
Simplified method form for invoking the ListStacks operation with an AsyncHandler.
|
Future<ListStacksResult> |
listStacksAsync(ListStacksRequest listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
Future<ListStacksResult> |
listStacksAsync(ListStacksRequest listStacksRequest,
AsyncHandler<ListStacksRequest,ListStacksResult> asyncHandler)
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
Future<ListStackSetAutoDeploymentTargetsResult> |
listStackSetAutoDeploymentTargetsAsync(ListStackSetAutoDeploymentTargetsRequest listStackSetAutoDeploymentTargetsRequest)
Returns summary information about deployment targets for a stack set.
|
Future<ListStackSetAutoDeploymentTargetsResult> |
listStackSetAutoDeploymentTargetsAsync(ListStackSetAutoDeploymentTargetsRequest listStackSetAutoDeploymentTargetsRequest,
AsyncHandler<ListStackSetAutoDeploymentTargetsRequest,ListStackSetAutoDeploymentTargetsResult> asyncHandler)
Returns summary information about deployment targets for a stack set.
|
Future<ListStackSetOperationResultsResult> |
listStackSetOperationResultsAsync(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest)
Returns summary information about the results of a stack set operation.
|
Future<ListStackSetOperationResultsResult> |
listStackSetOperationResultsAsync(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest,
AsyncHandler<ListStackSetOperationResultsRequest,ListStackSetOperationResultsResult> asyncHandler)
Returns summary information about the results of a stack set operation.
|
Future<ListStackSetOperationsResult> |
listStackSetOperationsAsync(ListStackSetOperationsRequest listStackSetOperationsRequest)
Returns summary information about operations performed on a stack set.
|
Future<ListStackSetOperationsResult> |
listStackSetOperationsAsync(ListStackSetOperationsRequest listStackSetOperationsRequest,
AsyncHandler<ListStackSetOperationsRequest,ListStackSetOperationsResult> asyncHandler)
Returns summary information about operations performed on a stack set.
|
Future<ListStackSetsResult> |
listStackSetsAsync(ListStackSetsRequest listStackSetsRequest)
Returns summary information about stack sets that are associated with the user.
|
Future<ListStackSetsResult> |
listStackSetsAsync(ListStackSetsRequest listStackSetsRequest,
AsyncHandler<ListStackSetsRequest,ListStackSetsResult> asyncHandler)
Returns summary information about stack sets that are associated with the user.
|
Future<ListTypeRegistrationsResult> |
listTypeRegistrationsAsync(ListTypeRegistrationsRequest listTypeRegistrationsRequest)
Returns a list of registration tokens for the specified extension(s).
|
Future<ListTypeRegistrationsResult> |
listTypeRegistrationsAsync(ListTypeRegistrationsRequest listTypeRegistrationsRequest,
AsyncHandler<ListTypeRegistrationsRequest,ListTypeRegistrationsResult> asyncHandler)
Returns a list of registration tokens for the specified extension(s).
|
Future<ListTypesResult> |
listTypesAsync(ListTypesRequest listTypesRequest)
Returns summary information about extension that have been registered with CloudFormation.
|
Future<ListTypesResult> |
listTypesAsync(ListTypesRequest listTypesRequest,
AsyncHandler<ListTypesRequest,ListTypesResult> asyncHandler)
Returns summary information about extension that have been registered with CloudFormation.
|
Future<ListTypeVersionsResult> |
listTypeVersionsAsync(ListTypeVersionsRequest listTypeVersionsRequest)
Returns summary information about the versions of an extension.
|
Future<ListTypeVersionsResult> |
listTypeVersionsAsync(ListTypeVersionsRequest listTypeVersionsRequest,
AsyncHandler<ListTypeVersionsRequest,ListTypeVersionsResult> asyncHandler)
Returns summary information about the versions of an extension.
|
Future<PublishTypeResult> |
publishTypeAsync(PublishTypeRequest publishTypeRequest)
Publishes the specified extension to the CloudFormation registry as a public extension in this Region.
|
Future<PublishTypeResult> |
publishTypeAsync(PublishTypeRequest publishTypeRequest,
AsyncHandler<PublishTypeRequest,PublishTypeResult> asyncHandler)
Publishes the specified extension to the CloudFormation registry as a public extension in this Region.
|
Future<RecordHandlerProgressResult> |
recordHandlerProgressAsync(RecordHandlerProgressRequest recordHandlerProgressRequest)
Reports progress of a resource handler to CloudFormation.
|
Future<RecordHandlerProgressResult> |
recordHandlerProgressAsync(RecordHandlerProgressRequest recordHandlerProgressRequest,
AsyncHandler<RecordHandlerProgressRequest,RecordHandlerProgressResult> asyncHandler)
Reports progress of a resource handler to CloudFormation.
|
Future<RegisterPublisherResult> |
registerPublisherAsync(RegisterPublisherRequest registerPublisherRequest)
Registers your account as a publisher of public extensions in the CloudFormation registry.
|
Future<RegisterPublisherResult> |
registerPublisherAsync(RegisterPublisherRequest registerPublisherRequest,
AsyncHandler<RegisterPublisherRequest,RegisterPublisherResult> asyncHandler)
Registers your account as a publisher of public extensions in the CloudFormation registry.
|
Future<RegisterTypeResult> |
registerTypeAsync(RegisterTypeRequest registerTypeRequest)
Registers an extension with the CloudFormation service.
|
Future<RegisterTypeResult> |
registerTypeAsync(RegisterTypeRequest registerTypeRequest,
AsyncHandler<RegisterTypeRequest,RegisterTypeResult> asyncHandler)
Registers an extension with the CloudFormation service.
|
Future<RollbackStackResult> |
rollbackStackAsync(RollbackStackRequest rollbackStackRequest)
When specifying
RollbackStack , you preserve the state of previously provisioned resources when an
operation fails. |
Future<RollbackStackResult> |
rollbackStackAsync(RollbackStackRequest rollbackStackRequest,
AsyncHandler<RollbackStackRequest,RollbackStackResult> asyncHandler)
When specifying
RollbackStack , you preserve the state of previously provisioned resources when an
operation fails. |
Future<SetStackPolicyResult> |
setStackPolicyAsync(SetStackPolicyRequest setStackPolicyRequest)
Sets a stack policy for a specified stack.
|
Future<SetStackPolicyResult> |
setStackPolicyAsync(SetStackPolicyRequest setStackPolicyRequest,
AsyncHandler<SetStackPolicyRequest,SetStackPolicyResult> asyncHandler)
Sets a stack policy for a specified stack.
|
Future<SetTypeConfigurationResult> |
setTypeConfigurationAsync(SetTypeConfigurationRequest setTypeConfigurationRequest)
Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
|
Future<SetTypeConfigurationResult> |
setTypeConfigurationAsync(SetTypeConfigurationRequest setTypeConfigurationRequest,
AsyncHandler<SetTypeConfigurationRequest,SetTypeConfigurationResult> asyncHandler)
Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
|
Future<SetTypeDefaultVersionResult> |
setTypeDefaultVersionAsync(SetTypeDefaultVersionRequest setTypeDefaultVersionRequest)
Specify the default version of an extension.
|
Future<SetTypeDefaultVersionResult> |
setTypeDefaultVersionAsync(SetTypeDefaultVersionRequest setTypeDefaultVersionRequest,
AsyncHandler<SetTypeDefaultVersionRequest,SetTypeDefaultVersionResult> asyncHandler)
Specify the default version of an extension.
|
Future<SignalResourceResult> |
signalResourceAsync(SignalResourceRequest signalResourceRequest)
Sends a signal to the specified resource with a success or failure status.
|
Future<SignalResourceResult> |
signalResourceAsync(SignalResourceRequest signalResourceRequest,
AsyncHandler<SignalResourceRequest,SignalResourceResult> asyncHandler)
Sends a signal to the specified resource with a success or failure status.
|
Future<StartResourceScanResult> |
startResourceScanAsync(StartResourceScanRequest startResourceScanRequest)
Starts a scan of the resources in this account in this Region.
|
Future<StartResourceScanResult> |
startResourceScanAsync(StartResourceScanRequest startResourceScanRequest,
AsyncHandler<StartResourceScanRequest,StartResourceScanResult> asyncHandler)
Starts a scan of the resources in this account in this Region.
|
Future<StopStackSetOperationResult> |
stopStackSetOperationAsync(StopStackSetOperationRequest stopStackSetOperationRequest)
Stops an in-progress operation on a stack set and its associated stack instances.
|
Future<StopStackSetOperationResult> |
stopStackSetOperationAsync(StopStackSetOperationRequest stopStackSetOperationRequest,
AsyncHandler<StopStackSetOperationRequest,StopStackSetOperationResult> asyncHandler)
Stops an in-progress operation on a stack set and its associated stack instances.
|
Future<TestTypeResult> |
testTypeAsync(TestTypeRequest testTypeRequest)
Tests a registered extension to make sure it meets all necessary requirements for being published in the
CloudFormation registry.
|
Future<TestTypeResult> |
testTypeAsync(TestTypeRequest testTypeRequest,
AsyncHandler<TestTypeRequest,TestTypeResult> asyncHandler)
Tests a registered extension to make sure it meets all necessary requirements for being published in the
CloudFormation registry.
|
Future<UpdateGeneratedTemplateResult> |
updateGeneratedTemplateAsync(UpdateGeneratedTemplateRequest updateGeneratedTemplateRequest)
Updates a generated template.
|
Future<UpdateGeneratedTemplateResult> |
updateGeneratedTemplateAsync(UpdateGeneratedTemplateRequest updateGeneratedTemplateRequest,
AsyncHandler<UpdateGeneratedTemplateRequest,UpdateGeneratedTemplateResult> asyncHandler)
Updates a generated template.
|
Future<UpdateStackResult> |
updateStackAsync(UpdateStackRequest updateStackRequest)
Updates a stack as specified in the template.
|
Future<UpdateStackResult> |
updateStackAsync(UpdateStackRequest updateStackRequest,
AsyncHandler<UpdateStackRequest,UpdateStackResult> asyncHandler)
Updates a stack as specified in the template.
|
Future<UpdateStackInstancesResult> |
updateStackInstancesAsync(UpdateStackInstancesRequest updateStackInstancesRequest)
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web
Services Regions.
|
Future<UpdateStackInstancesResult> |
updateStackInstancesAsync(UpdateStackInstancesRequest updateStackInstancesRequest,
AsyncHandler<UpdateStackInstancesRequest,UpdateStackInstancesResult> asyncHandler)
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web
Services Regions.
|
Future<UpdateStackSetResult> |
updateStackSetAsync(UpdateStackSetRequest updateStackSetRequest)
Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
|
Future<UpdateStackSetResult> |
updateStackSetAsync(UpdateStackSetRequest updateStackSetRequest,
AsyncHandler<UpdateStackSetRequest,UpdateStackSetResult> asyncHandler)
Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
|
Future<UpdateTerminationProtectionResult> |
updateTerminationProtectionAsync(UpdateTerminationProtectionRequest updateTerminationProtectionRequest)
Updates termination protection for the specified stack.
|
Future<UpdateTerminationProtectionResult> |
updateTerminationProtectionAsync(UpdateTerminationProtectionRequest updateTerminationProtectionRequest,
AsyncHandler<UpdateTerminationProtectionRequest,UpdateTerminationProtectionResult> asyncHandler)
Updates termination protection for the specified stack.
|
Future<ValidateTemplateResult> |
validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template.
|
Future<ValidateTemplateResult> |
validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest,
AsyncHandler<ValidateTemplateRequest,ValidateTemplateResult> asyncHandler)
Validates a specified template.
|
activateOrganizationsAccess, 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, shutdown, signalResource, startResourceScan, stopStackSetOperation, testType, updateGeneratedTemplate, updateStack, updateStackInstances, updateStackSet, updateTerminationProtection, validateTemplate, waiters
Future<ActivateOrganizationsAccessResult> activateOrganizationsAccessAsync(ActivateOrganizationsAccessRequest activateOrganizationsAccessRequest)
Activate 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.
activateOrganizationsAccessRequest
- Future<ActivateOrganizationsAccessResult> activateOrganizationsAccessAsync(ActivateOrganizationsAccessRequest activateOrganizationsAccessRequest, AsyncHandler<ActivateOrganizationsAccessRequest,ActivateOrganizationsAccessResult> asyncHandler)
Activate 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.
activateOrganizationsAccessRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ActivateTypeResult> activateTypeAsync(ActivateTypeRequest activateTypeRequest)
Activates 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.
activateTypeRequest
- Future<ActivateTypeResult> activateTypeAsync(ActivateTypeRequest activateTypeRequest, AsyncHandler<ActivateTypeRequest,ActivateTypeResult> asyncHandler)
Activates 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.
activateTypeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchDescribeTypeConfigurationsResult> batchDescribeTypeConfigurationsAsync(BatchDescribeTypeConfigurationsRequest batchDescribeTypeConfigurationsRequest)
Returns 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.
batchDescribeTypeConfigurationsRequest
- Future<BatchDescribeTypeConfigurationsResult> batchDescribeTypeConfigurationsAsync(BatchDescribeTypeConfigurationsRequest batchDescribeTypeConfigurationsRequest, AsyncHandler<BatchDescribeTypeConfigurationsRequest,BatchDescribeTypeConfigurationsResult> asyncHandler)
Returns 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.
batchDescribeTypeConfigurationsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CancelUpdateStackResult> cancelUpdateStackAsync(CancelUpdateStackRequest cancelUpdateStackRequest)
Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.
You can cancel only stacks that are in the UPDATE_IN_PROGRESS
state.
cancelUpdateStackRequest
- The input for the CancelUpdateStack action.Future<CancelUpdateStackResult> cancelUpdateStackAsync(CancelUpdateStackRequest cancelUpdateStackRequest, AsyncHandler<CancelUpdateStackRequest,CancelUpdateStackResult> asyncHandler)
Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.
You can cancel only stacks that are in the UPDATE_IN_PROGRESS
state.
cancelUpdateStackRequest
- The input for the CancelUpdateStack action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ContinueUpdateRollbackResult> continueUpdateRollbackAsync(ContinueUpdateRollbackRequest continueUpdateRollbackRequest)
For a specified stack that'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.
continueUpdateRollbackRequest
- The input for the ContinueUpdateRollback action.Future<ContinueUpdateRollbackResult> continueUpdateRollbackAsync(ContinueUpdateRollbackRequest continueUpdateRollbackRequest, AsyncHandler<ContinueUpdateRollbackRequest,ContinueUpdateRollbackResult> asyncHandler)
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.
continueUpdateRollbackRequest
- The input for the ContinueUpdateRollback action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateChangeSetResult> createChangeSetAsync(CreateChangeSetRequest createChangeSetRequest)
Creates a list of changes 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
.
createChangeSetRequest
- The input for the CreateChangeSet action.Future<CreateChangeSetResult> createChangeSetAsync(CreateChangeSetRequest createChangeSetRequest, AsyncHandler<CreateChangeSetRequest,CreateChangeSetResult> asyncHandler)
Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that 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
.
createChangeSetRequest
- The input for the CreateChangeSet action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateGeneratedTemplateResult> createGeneratedTemplateAsync(CreateGeneratedTemplateRequest createGeneratedTemplateRequest)
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.
createGeneratedTemplateRequest
- Future<CreateGeneratedTemplateResult> createGeneratedTemplateAsync(CreateGeneratedTemplateRequest createGeneratedTemplateRequest, AsyncHandler<CreateGeneratedTemplateRequest,CreateGeneratedTemplateResult> asyncHandler)
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.
createGeneratedTemplateRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateStackResult> createStackAsync(CreateStackRequest createStackRequest)
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.
createStackRequest
- The input for CreateStack action.Future<CreateStackResult> createStackAsync(CreateStackRequest createStackRequest, AsyncHandler<CreateStackRequest,CreateStackResult> asyncHandler)
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.
createStackRequest
- The input for CreateStack action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateStackInstancesResult> createStackInstancesAsync(CreateStackInstancesRequest createStackInstancesRequest)
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
.
createStackInstancesRequest
- Future<CreateStackInstancesResult> createStackInstancesAsync(CreateStackInstancesRequest createStackInstancesRequest, AsyncHandler<CreateStackInstancesRequest,CreateStackInstancesResult> asyncHandler)
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
.
createStackInstancesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateStackSetResult> createStackSetAsync(CreateStackSetRequest createStackSetRequest)
Creates a stack set.
createStackSetRequest
- Future<CreateStackSetResult> createStackSetAsync(CreateStackSetRequest createStackSetRequest, AsyncHandler<CreateStackSetRequest,CreateStackSetResult> asyncHandler)
Creates a stack set.
createStackSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeactivateOrganizationsAccessResult> deactivateOrganizationsAccessAsync(DeactivateOrganizationsAccessRequest deactivateOrganizationsAccessRequest)
Deactivates 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.
deactivateOrganizationsAccessRequest
- Future<DeactivateOrganizationsAccessResult> deactivateOrganizationsAccessAsync(DeactivateOrganizationsAccessRequest deactivateOrganizationsAccessRequest, AsyncHandler<DeactivateOrganizationsAccessRequest,DeactivateOrganizationsAccessResult> asyncHandler)
Deactivates 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.
deactivateOrganizationsAccessRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeactivateTypeResult> deactivateTypeAsync(DeactivateTypeRequest deactivateTypeRequest)
Deactivates 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.
deactivateTypeRequest
- Future<DeactivateTypeResult> deactivateTypeAsync(DeactivateTypeRequest deactivateTypeRequest, AsyncHandler<DeactivateTypeRequest,DeactivateTypeResult> asyncHandler)
Deactivates 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.
deactivateTypeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteChangeSetResult> deleteChangeSetAsync(DeleteChangeSetRequest deleteChangeSetRequest)
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, 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
.
deleteChangeSetRequest
- The input for the DeleteChangeSet action.Future<DeleteChangeSetResult> deleteChangeSetAsync(DeleteChangeSetRequest deleteChangeSetRequest, AsyncHandler<DeleteChangeSetRequest,DeleteChangeSetResult> asyncHandler)
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, 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
.
deleteChangeSetRequest
- The input for the DeleteChangeSet action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteGeneratedTemplateResult> deleteGeneratedTemplateAsync(DeleteGeneratedTemplateRequest deleteGeneratedTemplateRequest)
Deleted a generated template.
deleteGeneratedTemplateRequest
- Future<DeleteGeneratedTemplateResult> deleteGeneratedTemplateAsync(DeleteGeneratedTemplateRequest deleteGeneratedTemplateRequest, AsyncHandler<DeleteGeneratedTemplateRequest,DeleteGeneratedTemplateResult> asyncHandler)
Deleted a generated template.
deleteGeneratedTemplateRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteStackResult> deleteStackAsync(DeleteStackRequest deleteStackRequest)
Deletes 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.
deleteStackRequest
- The input for DeleteStack action.Future<DeleteStackResult> deleteStackAsync(DeleteStackRequest deleteStackRequest, AsyncHandler<DeleteStackRequest,DeleteStackResult> asyncHandler)
Deletes 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.
deleteStackRequest
- The input for DeleteStack action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteStackInstancesResult> deleteStackInstancesAsync(DeleteStackInstancesRequest deleteStackInstancesRequest)
Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
deleteStackInstancesRequest
- Future<DeleteStackInstancesResult> deleteStackInstancesAsync(DeleteStackInstancesRequest deleteStackInstancesRequest, AsyncHandler<DeleteStackInstancesRequest,DeleteStackInstancesResult> asyncHandler)
Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
deleteStackInstancesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteStackSetResult> deleteStackSetAsync(DeleteStackSetRequest deleteStackSetRequest)
Deletes 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.
deleteStackSetRequest
- Future<DeleteStackSetResult> deleteStackSetAsync(DeleteStackSetRequest deleteStackSetRequest, AsyncHandler<DeleteStackSetRequest,DeleteStackSetResult> asyncHandler)
Deletes 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.
deleteStackSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeregisterTypeResult> deregisterTypeAsync(DeregisterTypeRequest deregisterTypeRequest)
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.
deregisterTypeRequest
- Future<DeregisterTypeResult> deregisterTypeAsync(DeregisterTypeRequest deregisterTypeRequest, AsyncHandler<DeregisterTypeRequest,DeregisterTypeResult> asyncHandler)
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.
deregisterTypeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAccountLimitsResult> describeAccountLimitsAsync(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Retrieves your account's 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.
describeAccountLimitsRequest
- The input for the DescribeAccountLimits action.Future<DescribeAccountLimitsResult> describeAccountLimitsAsync(DescribeAccountLimitsRequest describeAccountLimitsRequest, AsyncHandler<DescribeAccountLimitsRequest,DescribeAccountLimitsResult> asyncHandler)
Retrieves 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.
describeAccountLimitsRequest
- The input for the DescribeAccountLimits action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeChangeSetResult> describeChangeSetAsync(DescribeChangeSetRequest describeChangeSetRequest)
Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the CloudFormation User Guide.
describeChangeSetRequest
- The input for the DescribeChangeSet action.Future<DescribeChangeSetResult> describeChangeSetAsync(DescribeChangeSetRequest describeChangeSetRequest, AsyncHandler<DescribeChangeSetRequest,DescribeChangeSetResult> asyncHandler)
Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the CloudFormation User Guide.
describeChangeSetRequest
- The input for the DescribeChangeSet action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeChangeSetHooksResult> describeChangeSetHooksAsync(DescribeChangeSetHooksRequest describeChangeSetHooksRequest)
Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
describeChangeSetHooksRequest
- Future<DescribeChangeSetHooksResult> describeChangeSetHooksAsync(DescribeChangeSetHooksRequest describeChangeSetHooksRequest, AsyncHandler<DescribeChangeSetHooksRequest,DescribeChangeSetHooksResult> asyncHandler)
Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
describeChangeSetHooksRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeGeneratedTemplateResult> describeGeneratedTemplateAsync(DescribeGeneratedTemplateRequest describeGeneratedTemplateRequest)
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.
describeGeneratedTemplateRequest
- Future<DescribeGeneratedTemplateResult> describeGeneratedTemplateAsync(DescribeGeneratedTemplateRequest describeGeneratedTemplateRequest, AsyncHandler<DescribeGeneratedTemplateRequest,DescribeGeneratedTemplateResult> asyncHandler)
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.
describeGeneratedTemplateRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeOrganizationsAccessResult> describeOrganizationsAccessAsync(DescribeOrganizationsAccessRequest describeOrganizationsAccessRequest)
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.
describeOrganizationsAccessRequest
- Future<DescribeOrganizationsAccessResult> describeOrganizationsAccessAsync(DescribeOrganizationsAccessRequest describeOrganizationsAccessRequest, AsyncHandler<DescribeOrganizationsAccessRequest,DescribeOrganizationsAccessResult> asyncHandler)
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.
describeOrganizationsAccessRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribePublisherResult> describePublisherAsync(DescribePublisherRequest describePublisherRequest)
Returns 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
describePublisherRequest
- Future<DescribePublisherResult> describePublisherAsync(DescribePublisherRequest describePublisherRequest, AsyncHandler<DescribePublisherRequest,DescribePublisherResult> asyncHandler)
Returns 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
describePublisherRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeResourceScanResult> describeResourceScanAsync(DescribeResourceScanRequest describeResourceScanRequest)
Describes details of a resource scan.
describeResourceScanRequest
- Future<DescribeResourceScanResult> describeResourceScanAsync(DescribeResourceScanRequest describeResourceScanRequest, AsyncHandler<DescribeResourceScanRequest,DescribeResourceScanResult> asyncHandler)
Describes details of a resource scan.
describeResourceScanRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStackDriftDetectionStatusResult> describeStackDriftDetectionStatusAsync(DescribeStackDriftDetectionStatusRequest describeStackDriftDetectionStatusRequest)
Returns 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.
describeStackDriftDetectionStatusRequest
- Future<DescribeStackDriftDetectionStatusResult> describeStackDriftDetectionStatusAsync(DescribeStackDriftDetectionStatusRequest describeStackDriftDetectionStatusRequest, AsyncHandler<DescribeStackDriftDetectionStatusRequest,DescribeStackDriftDetectionStatusResult> asyncHandler)
Returns 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.
describeStackDriftDetectionStatusRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStackEventsResult> describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest)
Returns all stack related events for a specified stack 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).
describeStackEventsRequest
- The input for DescribeStackEvents action.Future<DescribeStackEventsResult> describeStackEventsAsync(DescribeStackEventsRequest describeStackEventsRequest, AsyncHandler<DescribeStackEventsRequest,DescribeStackEventsResult> asyncHandler)
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, 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).
describeStackEventsRequest
- The input for DescribeStackEvents action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStackInstanceResult> describeStackInstanceAsync(DescribeStackInstanceRequest describeStackInstanceRequest)
Returns 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.
describeStackInstanceRequest
- Future<DescribeStackInstanceResult> describeStackInstanceAsync(DescribeStackInstanceRequest describeStackInstanceRequest, AsyncHandler<DescribeStackInstanceRequest,DescribeStackInstanceResult> asyncHandler)
Returns 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.
describeStackInstanceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStackResourceResult> describeStackResourceAsync(DescribeStackResourceRequest describeStackResourceRequest)
Returns a description of the specified resource in the specified stack.
For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
describeStackResourceRequest
- The input for DescribeStackResource action.Future<DescribeStackResourceResult> describeStackResourceAsync(DescribeStackResourceRequest describeStackResourceRequest, AsyncHandler<DescribeStackResourceRequest,DescribeStackResourceResult> asyncHandler)
Returns a description of the specified resource in the specified stack.
For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
describeStackResourceRequest
- The input for DescribeStackResource action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStackResourceDriftsResult> describeStackResourceDriftsAsync(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest)
Returns 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.
describeStackResourceDriftsRequest
- Future<DescribeStackResourceDriftsResult> describeStackResourceDriftsAsync(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest, AsyncHandler<DescribeStackResourceDriftsRequest,DescribeStackResourceDriftsResult> asyncHandler)
Returns 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.
describeStackResourceDriftsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStackResourcesResult> describeStackResourcesAsync(DescribeStackResourcesRequest describeStackResourcesRequest)
Returns 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.
describeStackResourcesRequest
- The input for DescribeStackResources action.Future<DescribeStackResourcesResult> describeStackResourcesAsync(DescribeStackResourcesRequest describeStackResourcesRequest, AsyncHandler<DescribeStackResourcesRequest,DescribeStackResourcesResult> asyncHandler)
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.
describeStackResourcesRequest
- The input for DescribeStackResources action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStackSetResult> describeStackSetAsync(DescribeStackSetRequest describeStackSetRequest)
Returns the description of the specified StackSet.
describeStackSetRequest
- Future<DescribeStackSetResult> describeStackSetAsync(DescribeStackSetRequest describeStackSetRequest, AsyncHandler<DescribeStackSetRequest,DescribeStackSetResult> asyncHandler)
Returns the description of the specified StackSet.
describeStackSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStackSetOperationResult> describeStackSetOperationAsync(DescribeStackSetOperationRequest describeStackSetOperationRequest)
Returns the description of the specified StackSet operation.
describeStackSetOperationRequest
- Future<DescribeStackSetOperationResult> describeStackSetOperationAsync(DescribeStackSetOperationRequest describeStackSetOperationRequest, AsyncHandler<DescribeStackSetOperationRequest,DescribeStackSetOperationResult> asyncHandler)
Returns the description of the specified StackSet operation.
describeStackSetOperationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStacksResult> describeStacksAsync(DescribeStacksRequest describeStacksRequest)
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. 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.
describeStacksRequest
- The input for DescribeStacks action.Future<DescribeStacksResult> describeStacksAsync(DescribeStacksRequest describeStacksRequest, AsyncHandler<DescribeStacksRequest,DescribeStacksResult> asyncHandler)
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. 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.
describeStacksRequest
- The input for DescribeStacks action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStacksResult> describeStacksAsync()
Future<DescribeStacksResult> describeStacksAsync(AsyncHandler<DescribeStacksRequest,DescribeStacksResult> asyncHandler)
Future<DescribeTypeResult> describeTypeAsync(DescribeTypeRequest describeTypeRequest)
Returns 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.
describeTypeRequest
- Future<DescribeTypeResult> describeTypeAsync(DescribeTypeRequest describeTypeRequest, AsyncHandler<DescribeTypeRequest,DescribeTypeResult> asyncHandler)
Returns 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.
describeTypeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeTypeRegistrationResult> describeTypeRegistrationAsync(DescribeTypeRegistrationRequest describeTypeRegistrationRequest)
Returns 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.
describeTypeRegistrationRequest
- Future<DescribeTypeRegistrationResult> describeTypeRegistrationAsync(DescribeTypeRegistrationRequest describeTypeRegistrationRequest, AsyncHandler<DescribeTypeRegistrationRequest,DescribeTypeRegistrationResult> asyncHandler)
Returns 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.
describeTypeRegistrationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DetectStackDriftResult> detectStackDriftAsync(DetectStackDriftRequest detectStackDriftRequest)
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. 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.
detectStackDriftRequest
- Future<DetectStackDriftResult> detectStackDriftAsync(DetectStackDriftRequest detectStackDriftRequest, AsyncHandler<DetectStackDriftRequest,DetectStackDriftResult> asyncHandler)
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. 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.
detectStackDriftRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DetectStackResourceDriftResult> detectStackResourceDriftAsync(DetectStackResourceDriftRequest detectStackResourceDriftRequest)
Returns 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.
detectStackResourceDriftRequest
- Future<DetectStackResourceDriftResult> detectStackResourceDriftAsync(DetectStackResourceDriftRequest detectStackResourceDriftRequest, AsyncHandler<DetectStackResourceDriftRequest,DetectStackResourceDriftResult> asyncHandler)
Returns 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.
detectStackResourceDriftRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DetectStackSetDriftResult> detectStackSetDriftAsync(DetectStackSetDriftRequest detectStackSetDriftRequest)
Detect 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.
detectStackSetDriftRequest
- Future<DetectStackSetDriftResult> detectStackSetDriftAsync(DetectStackSetDriftRequest detectStackSetDriftRequest, AsyncHandler<DetectStackSetDriftRequest,DetectStackSetDriftResult> asyncHandler)
Detect 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.
detectStackSetDriftRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EstimateTemplateCostResult> estimateTemplateCostAsync(EstimateTemplateCostRequest estimateTemplateCostRequest)
Returns 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.
estimateTemplateCostRequest
- The input for an EstimateTemplateCost action.Future<EstimateTemplateCostResult> estimateTemplateCostAsync(EstimateTemplateCostRequest estimateTemplateCostRequest, AsyncHandler<EstimateTemplateCostRequest,EstimateTemplateCostResult> asyncHandler)
Returns 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.
estimateTemplateCostRequest
- The input for an EstimateTemplateCost action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EstimateTemplateCostResult> estimateTemplateCostAsync()
Future<EstimateTemplateCostResult> estimateTemplateCostAsync(AsyncHandler<EstimateTemplateCostRequest,EstimateTemplateCostResult> asyncHandler)
Future<ExecuteChangeSetResult> executeChangeSetAsync(ExecuteChangeSetRequest executeChangeSetRequest)
Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, 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
.
executeChangeSetRequest
- The input for the ExecuteChangeSet action.Future<ExecuteChangeSetResult> executeChangeSetAsync(ExecuteChangeSetRequest executeChangeSetRequest, AsyncHandler<ExecuteChangeSetRequest,ExecuteChangeSetResult> asyncHandler)
Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, 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
.
executeChangeSetRequest
- The input for the ExecuteChangeSet action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetGeneratedTemplateResult> getGeneratedTemplateAsync(GetGeneratedTemplateRequest getGeneratedTemplateRequest)
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.
getGeneratedTemplateRequest
- Future<GetGeneratedTemplateResult> getGeneratedTemplateAsync(GetGeneratedTemplateRequest getGeneratedTemplateRequest, AsyncHandler<GetGeneratedTemplateRequest,GetGeneratedTemplateResult> asyncHandler)
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.
getGeneratedTemplateRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetStackPolicyResult> getStackPolicyAsync(GetStackPolicyRequest getStackPolicyRequest)
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
getStackPolicyRequest
- The input for the GetStackPolicy action.Future<GetStackPolicyResult> getStackPolicyAsync(GetStackPolicyRequest getStackPolicyRequest, AsyncHandler<GetStackPolicyRequest,GetStackPolicyResult> asyncHandler)
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
getStackPolicyRequest
- The input for the GetStackPolicy action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTemplateResult> getTemplateAsync(GetTemplateRequest getTemplateRequest)
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks, GetTemplate
returns the template for up to 90 days after the stack has been
deleted.
If the template doesn't exist, a ValidationError
is returned.
getTemplateRequest
- The input for a GetTemplate action.Future<GetTemplateResult> getTemplateAsync(GetTemplateRequest getTemplateRequest, AsyncHandler<GetTemplateRequest,GetTemplateResult> asyncHandler)
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks, GetTemplate
returns the template for up to 90 days after the stack has been
deleted.
If the template doesn't exist, a ValidationError
is returned.
getTemplateRequest
- The input for a GetTemplate action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTemplateSummaryResult> getTemplateSummaryAsync(GetTemplateSummaryRequest getTemplateSummaryRequest)
Returns information about a new or existing template. The GetTemplateSummary
action is useful for
viewing parameter information, such as default parameter values and parameter types, before you create or update
a stack 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.
getTemplateSummaryRequest
- The input for the GetTemplateSummary action.Future<GetTemplateSummaryResult> getTemplateSummaryAsync(GetTemplateSummaryRequest getTemplateSummaryRequest, AsyncHandler<GetTemplateSummaryRequest,GetTemplateSummaryResult> asyncHandler)
Returns information about a new or existing template. The GetTemplateSummary
action is useful for
viewing parameter information, such as default parameter values and parameter types, before you create or update
a stack 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.
getTemplateSummaryRequest
- The input for the GetTemplateSummary action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTemplateSummaryResult> getTemplateSummaryAsync()
Future<GetTemplateSummaryResult> getTemplateSummaryAsync(AsyncHandler<GetTemplateSummaryRequest,GetTemplateSummaryResult> asyncHandler)
Future<ImportStacksToStackSetResult> importStacksToStackSetAsync(ImportStacksToStackSetRequest importStacksToStackSetRequest)
Import 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.
importStacksToStackSetRequest
- Future<ImportStacksToStackSetResult> importStacksToStackSetAsync(ImportStacksToStackSetRequest importStacksToStackSetRequest, AsyncHandler<ImportStacksToStackSetRequest,ImportStacksToStackSetResult> asyncHandler)
Import 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.
importStacksToStackSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListChangeSetsResult> listChangeSetsAsync(ListChangeSetsRequest listChangeSetsRequest)
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.
listChangeSetsRequest
- The input for the ListChangeSets action.Future<ListChangeSetsResult> listChangeSetsAsync(ListChangeSetsRequest listChangeSetsRequest, AsyncHandler<ListChangeSetsRequest,ListChangeSetsResult> asyncHandler)
Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets
that are in the CREATE_IN_PROGRESS
or CREATE_PENDING
state.
listChangeSetsRequest
- The input for the ListChangeSets action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListExportsResult> listExportsAsync(ListExportsRequest listExportsRequest)
Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.
For more information, see CloudFormation export stack output values.
listExportsRequest
- Future<ListExportsResult> listExportsAsync(ListExportsRequest listExportsRequest, AsyncHandler<ListExportsRequest,ListExportsResult> asyncHandler)
Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.
For more information, see CloudFormation export stack output values.
listExportsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListGeneratedTemplatesResult> listGeneratedTemplatesAsync(ListGeneratedTemplatesRequest listGeneratedTemplatesRequest)
Lists your generated templates in this Region.
listGeneratedTemplatesRequest
- Future<ListGeneratedTemplatesResult> listGeneratedTemplatesAsync(ListGeneratedTemplatesRequest listGeneratedTemplatesRequest, AsyncHandler<ListGeneratedTemplatesRequest,ListGeneratedTemplatesResult> asyncHandler)
Lists your generated templates in this Region.
listGeneratedTemplatesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListImportsResult> listImportsAsync(ListImportsRequest listImportsRequest)
Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
For more information about importing an exported output value, see the Fn::ImportValue function.
listImportsRequest
- Future<ListImportsResult> listImportsAsync(ListImportsRequest listImportsRequest, AsyncHandler<ListImportsRequest,ListImportsResult> asyncHandler)
Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
For more information about importing an exported output value, see the Fn::ImportValue function.
listImportsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListResourceScanRelatedResourcesResult> listResourceScanRelatedResourcesAsync(ListResourceScanRelatedResourcesRequest listResourceScanRelatedResourcesRequest)
Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.
listResourceScanRelatedResourcesRequest
- Future<ListResourceScanRelatedResourcesResult> listResourceScanRelatedResourcesAsync(ListResourceScanRelatedResourcesRequest listResourceScanRelatedResourcesRequest, AsyncHandler<ListResourceScanRelatedResourcesRequest,ListResourceScanRelatedResourcesResult> asyncHandler)
Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.
listResourceScanRelatedResourcesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListResourceScanResourcesResult> listResourceScanResourcesAsync(ListResourceScanResourcesRequest listResourceScanResourcesRequest)
Lists 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.
listResourceScanResourcesRequest
- Future<ListResourceScanResourcesResult> listResourceScanResourcesAsync(ListResourceScanResourcesRequest listResourceScanResourcesRequest, AsyncHandler<ListResourceScanResourcesRequest,ListResourceScanResourcesResult> asyncHandler)
Lists 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.
listResourceScanResourcesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListResourceScansResult> listResourceScansAsync(ListResourceScansRequest listResourceScansRequest)
List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
listResourceScansRequest
- Future<ListResourceScansResult> listResourceScansAsync(ListResourceScansRequest listResourceScansRequest, AsyncHandler<ListResourceScansRequest,ListResourceScansResult> asyncHandler)
List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
listResourceScansRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListStackInstanceResourceDriftsResult> listStackInstanceResourceDriftsAsync(ListStackInstanceResourceDriftsRequest listStackInstanceResourceDriftsRequest)
Returns 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.
listStackInstanceResourceDriftsRequest
- Future<ListStackInstanceResourceDriftsResult> listStackInstanceResourceDriftsAsync(ListStackInstanceResourceDriftsRequest listStackInstanceResourceDriftsRequest, AsyncHandler<ListStackInstanceResourceDriftsRequest,ListStackInstanceResourceDriftsResult> asyncHandler)
Returns 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.
listStackInstanceResourceDriftsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListStackInstancesResult> listStackInstancesAsync(ListStackInstancesRequest listStackInstancesRequest)
Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.
listStackInstancesRequest
- Future<ListStackInstancesResult> listStackInstancesAsync(ListStackInstancesRequest listStackInstancesRequest, AsyncHandler<ListStackInstancesRequest,ListStackInstancesResult> asyncHandler)
Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.
listStackInstancesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListStackResourcesResult> listStackResourcesAsync(ListStackResourcesRequest listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
listStackResourcesRequest
- The input for the ListStackResource action.Future<ListStackResourcesResult> listStackResourcesAsync(ListStackResourcesRequest listStackResourcesRequest, AsyncHandler<ListStackResourcesRequest,ListStackResourcesResult> asyncHandler)
Returns descriptions of all resources of the specified stack.
For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
listStackResourcesRequest
- The input for the ListStackResource action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListStackSetAutoDeploymentTargetsResult> listStackSetAutoDeploymentTargetsAsync(ListStackSetAutoDeploymentTargetsRequest listStackSetAutoDeploymentTargetsRequest)
Returns summary information about deployment targets for a stack set.
listStackSetAutoDeploymentTargetsRequest
- Future<ListStackSetAutoDeploymentTargetsResult> listStackSetAutoDeploymentTargetsAsync(ListStackSetAutoDeploymentTargetsRequest listStackSetAutoDeploymentTargetsRequest, AsyncHandler<ListStackSetAutoDeploymentTargetsRequest,ListStackSetAutoDeploymentTargetsResult> asyncHandler)
Returns summary information about deployment targets for a stack set.
listStackSetAutoDeploymentTargetsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListStackSetOperationResultsResult> listStackSetOperationResultsAsync(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest)
Returns summary information about the results of a stack set operation.
listStackSetOperationResultsRequest
- Future<ListStackSetOperationResultsResult> listStackSetOperationResultsAsync(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest, AsyncHandler<ListStackSetOperationResultsRequest,ListStackSetOperationResultsResult> asyncHandler)
Returns summary information about the results of a stack set operation.
listStackSetOperationResultsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListStackSetOperationsResult> listStackSetOperationsAsync(ListStackSetOperationsRequest listStackSetOperationsRequest)
Returns summary information about operations performed on a stack set.
listStackSetOperationsRequest
- Future<ListStackSetOperationsResult> listStackSetOperationsAsync(ListStackSetOperationsRequest listStackSetOperationsRequest, AsyncHandler<ListStackSetOperationsRequest,ListStackSetOperationsResult> asyncHandler)
Returns summary information about operations performed on a stack set.
listStackSetOperationsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListStackSetsResult> listStackSetsAsync(ListStackSetsRequest listStackSetsRequest)
Returns 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.
listStackSetsRequest
- Future<ListStackSetsResult> listStackSetsAsync(ListStackSetsRequest listStackSetsRequest, AsyncHandler<ListStackSetsRequest,ListStackSetsResult> asyncHandler)
Returns 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.
listStackSetsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListStacksResult> listStacksAsync(ListStacksRequest listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
listStacksRequest
- The input for ListStacks action.Future<ListStacksResult> listStacksAsync(ListStacksRequest listStacksRequest, AsyncHandler<ListStacksRequest,ListStacksResult> asyncHandler)
Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
listStacksRequest
- The input for ListStacks action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListStacksResult> listStacksAsync()
listStacksAsync(ListStacksRequest)
Future<ListStacksResult> listStacksAsync(AsyncHandler<ListStacksRequest,ListStacksResult> asyncHandler)
Future<ListTypeRegistrationsResult> listTypeRegistrationsAsync(ListTypeRegistrationsRequest listTypeRegistrationsRequest)
Returns a list of registration tokens for the specified extension(s).
listTypeRegistrationsRequest
- Future<ListTypeRegistrationsResult> listTypeRegistrationsAsync(ListTypeRegistrationsRequest listTypeRegistrationsRequest, AsyncHandler<ListTypeRegistrationsRequest,ListTypeRegistrationsResult> asyncHandler)
Returns a list of registration tokens for the specified extension(s).
listTypeRegistrationsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTypeVersionsResult> listTypeVersionsAsync(ListTypeVersionsRequest listTypeVersionsRequest)
Returns summary information about the versions of an extension.
listTypeVersionsRequest
- Future<ListTypeVersionsResult> listTypeVersionsAsync(ListTypeVersionsRequest listTypeVersionsRequest, AsyncHandler<ListTypeVersionsRequest,ListTypeVersionsResult> asyncHandler)
Returns summary information about the versions of an extension.
listTypeVersionsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTypesResult> listTypesAsync(ListTypesRequest listTypesRequest)
Returns summary information about extension that have been registered with CloudFormation.
listTypesRequest
- Future<ListTypesResult> listTypesAsync(ListTypesRequest listTypesRequest, AsyncHandler<ListTypesRequest,ListTypesResult> asyncHandler)
Returns summary information about extension that have been registered with CloudFormation.
listTypesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PublishTypeResult> publishTypeAsync(PublishTypeRequest publishTypeRequest)
Publishes 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.
publishTypeRequest
- Future<PublishTypeResult> publishTypeAsync(PublishTypeRequest publishTypeRequest, AsyncHandler<PublishTypeRequest,PublishTypeResult> asyncHandler)
Publishes 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.
publishTypeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RecordHandlerProgressResult> recordHandlerProgressAsync(RecordHandlerProgressRequest recordHandlerProgressRequest)
Reports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Don't use this API in your code.
recordHandlerProgressRequest
- Future<RecordHandlerProgressResult> recordHandlerProgressAsync(RecordHandlerProgressRequest recordHandlerProgressRequest, AsyncHandler<RecordHandlerProgressRequest,RecordHandlerProgressResult> asyncHandler)
Reports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Don't use this API in your code.
recordHandlerProgressRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RegisterPublisherResult> registerPublisherAsync(RegisterPublisherRequest registerPublisherRequest)
Registers 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.
registerPublisherRequest
- Future<RegisterPublisherResult> registerPublisherAsync(RegisterPublisherRequest registerPublisherRequest, AsyncHandler<RegisterPublisherRequest,RegisterPublisherResult> asyncHandler)
Registers 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.
registerPublisherRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RegisterTypeResult> registerTypeAsync(RegisterTypeRequest registerTypeRequest)
Registers 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.
registerTypeRequest
- Future<RegisterTypeResult> registerTypeAsync(RegisterTypeRequest registerTypeRequest, AsyncHandler<RegisterTypeRequest,RegisterTypeResult> asyncHandler)
Registers 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.
registerTypeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RollbackStackResult> rollbackStackAsync(RollbackStackRequest rollbackStackRequest)
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
rollbackStackRequest
- Future<RollbackStackResult> rollbackStackAsync(RollbackStackRequest rollbackStackRequest, AsyncHandler<RollbackStackRequest,RollbackStackResult> asyncHandler)
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
rollbackStackRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SetStackPolicyResult> setStackPolicyAsync(SetStackPolicyRequest setStackPolicyRequest)
Sets a stack policy for a specified stack.
setStackPolicyRequest
- The input for the SetStackPolicy action.Future<SetStackPolicyResult> setStackPolicyAsync(SetStackPolicyRequest setStackPolicyRequest, AsyncHandler<SetStackPolicyRequest,SetStackPolicyResult> asyncHandler)
Sets a stack policy for a specified stack.
setStackPolicyRequest
- The input for the SetStackPolicy action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SetTypeConfigurationResult> setTypeConfigurationAsync(SetTypeConfigurationRequest setTypeConfigurationRequest)
Specifies 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.
setTypeConfigurationRequest
- Future<SetTypeConfigurationResult> setTypeConfigurationAsync(SetTypeConfigurationRequest setTypeConfigurationRequest, AsyncHandler<SetTypeConfigurationRequest,SetTypeConfigurationResult> asyncHandler)
Specifies 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.
setTypeConfigurationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SetTypeDefaultVersionResult> setTypeDefaultVersionAsync(SetTypeDefaultVersionRequest setTypeDefaultVersionRequest)
Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
setTypeDefaultVersionRequest
- Future<SetTypeDefaultVersionResult> setTypeDefaultVersionAsync(SetTypeDefaultVersionRequest setTypeDefaultVersionRequest, AsyncHandler<SetTypeDefaultVersionRequest,SetTypeDefaultVersionResult> asyncHandler)
Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
setTypeDefaultVersionRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SignalResourceResult> signalResourceAsync(SignalResourceRequest signalResourceRequest)
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.
signalResourceRequest
- The input for the SignalResource action.Future<SignalResourceResult> signalResourceAsync(SignalResourceRequest signalResourceRequest, AsyncHandler<SignalResourceRequest,SignalResourceResult> asyncHandler)
Sends a signal to the specified resource with a success or failure status. You can use the
SignalResource
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.
signalResourceRequest
- The input for the SignalResource action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartResourceScanResult> startResourceScanAsync(StartResourceScanRequest startResourceScanRequest)
Starts a scan of the resources in this account in this Region. You can the status of a scan using the
ListResourceScans
API action.
startResourceScanRequest
- Future<StartResourceScanResult> startResourceScanAsync(StartResourceScanRequest startResourceScanRequest, AsyncHandler<StartResourceScanRequest,StartResourceScanResult> asyncHandler)
Starts a scan of the resources in this account in this Region. You can the status of a scan using the
ListResourceScans
API action.
startResourceScanRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopStackSetOperationResult> stopStackSetOperationAsync(StopStackSetOperationRequest stopStackSetOperationRequest)
Stops 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.
stopStackSetOperationRequest
- Future<StopStackSetOperationResult> stopStackSetOperationAsync(StopStackSetOperationRequest stopStackSetOperationRequest, AsyncHandler<StopStackSetOperationRequest,StopStackSetOperationResult> asyncHandler)
Stops 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.
stopStackSetOperationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TestTypeResult> testTypeAsync(TestTypeRequest testTypeRequest)
Tests 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.
testTypeRequest
- Future<TestTypeResult> testTypeAsync(TestTypeRequest testTypeRequest, AsyncHandler<TestTypeRequest,TestTypeResult> asyncHandler)
Tests 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.
testTypeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateGeneratedTemplateResult> updateGeneratedTemplateAsync(UpdateGeneratedTemplateRequest updateGeneratedTemplateRequest)
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.
updateGeneratedTemplateRequest
- Future<UpdateGeneratedTemplateResult> updateGeneratedTemplateAsync(UpdateGeneratedTemplateRequest updateGeneratedTemplateRequest, AsyncHandler<UpdateGeneratedTemplateRequest,UpdateGeneratedTemplateResult> asyncHandler)
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.
updateGeneratedTemplateRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateStackResult> updateStackAsync(UpdateStackRequest updateStackRequest)
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack 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.
updateStackRequest
- The input for an UpdateStack action.Future<UpdateStackResult> updateStackAsync(UpdateStackRequest updateStackRequest, AsyncHandler<UpdateStackRequest,UpdateStackResult> asyncHandler)
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack 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.
updateStackRequest
- The input for an UpdateStack action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateStackInstancesResult> updateStackInstancesAsync(UpdateStackInstancesRequest updateStackInstancesRequest)
Updates 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
.
updateStackInstancesRequest
- Future<UpdateStackInstancesResult> updateStackInstancesAsync(UpdateStackInstancesRequest updateStackInstancesRequest, AsyncHandler<UpdateStackInstancesRequest,UpdateStackInstancesResult> asyncHandler)
Updates 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
.
updateStackInstancesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateStackSetResult> updateStackSetAsync(UpdateStackSetRequest updateStackSetRequest)
Updates 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.
updateStackSetRequest
- Future<UpdateStackSetResult> updateStackSetAsync(UpdateStackSetRequest updateStackSetRequest, AsyncHandler<UpdateStackSetRequest,UpdateStackSetResult> asyncHandler)
Updates 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.
updateStackSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateTerminationProtectionResult> updateTerminationProtectionAsync(UpdateTerminationProtectionRequest updateTerminationProtectionRequest)
Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
updateTerminationProtectionRequest
- Future<UpdateTerminationProtectionResult> updateTerminationProtectionAsync(UpdateTerminationProtectionRequest updateTerminationProtectionRequest, AsyncHandler<UpdateTerminationProtectionRequest,UpdateTerminationProtectionResult> asyncHandler)
Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
updateTerminationProtectionRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ValidateTemplateResult> validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template. 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.
validateTemplateRequest
- The input for ValidateTemplate action.Future<ValidateTemplateResult> validateTemplateAsync(ValidateTemplateRequest validateTemplateRequest, AsyncHandler<ValidateTemplateRequest,ValidateTemplateResult> asyncHandler)
Validates 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.
validateTemplateRequest
- The input for ValidateTemplate action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.