@Generated(value="software.amazon.awssdk:codegen") public interface CloudFormationAsyncClient extends SdkClient, SdkAutoCloseable
builder() method.
AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.
With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about AWS CloudFormation, see the AWS CloudFormation Product Page.
Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at docs.aws.amazon.com.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static CloudFormationAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudFormationAsyncClient. |
default CompletableFuture<CancelUpdateStackResponse> |
cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest)
Cancels an update on the specified stack.
|
default CompletableFuture<CancelUpdateStackResponse> |
cancelUpdateStack(Consumer<CancelUpdateStackRequest.Builder> cancelUpdateStackRequest)
Cancels an update on the specified stack.
|
default CompletableFuture<ContinueUpdateRollbackResponse> |
continueUpdateRollback(Consumer<ContinueUpdateRollbackRequest.Builder> continueUpdateRollbackRequest)
For a specified stack that is in the
UPDATE_ROLLBACK_FAILED state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE state. |
default CompletableFuture<ContinueUpdateRollbackResponse> |
continueUpdateRollback(ContinueUpdateRollbackRequest continueUpdateRollbackRequest)
For a specified stack that is in the
UPDATE_ROLLBACK_FAILED state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE state. |
static CloudFormationAsyncClient |
create()
Create a
CloudFormationAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateChangeSetResponse> |
createChangeSet(Consumer<CreateChangeSetRequest.Builder> createChangeSetRequest)
Creates a list of changes that will be applied to a stack so that you can review the changes before executing
them.
|
default CompletableFuture<CreateChangeSetResponse> |
createChangeSet(CreateChangeSetRequest createChangeSetRequest)
Creates a list of changes that will be applied to a stack so that you can review the changes before executing
them.
|
default CompletableFuture<CreateStackResponse> |
createStack(Consumer<CreateStackRequest.Builder> createStackRequest)
Creates a stack as specified in the template.
|
default CompletableFuture<CreateStackResponse> |
createStack(CreateStackRequest createStackRequest)
Creates a stack as specified in the template.
|
default CompletableFuture<CreateStackInstancesResponse> |
createStackInstances(Consumer<CreateStackInstancesRequest.Builder> createStackInstancesRequest)
Creates stack instances for the specified accounts, within the specified regions.
|
default CompletableFuture<CreateStackInstancesResponse> |
createStackInstances(CreateStackInstancesRequest createStackInstancesRequest)
Creates stack instances for the specified accounts, within the specified regions.
|
default CompletableFuture<CreateStackSetResponse> |
createStackSet(Consumer<CreateStackSetRequest.Builder> createStackSetRequest)
Creates a stack set.
|
default CompletableFuture<CreateStackSetResponse> |
createStackSet(CreateStackSetRequest createStackSetRequest)
Creates a stack set.
|
default CompletableFuture<DeleteChangeSetResponse> |
deleteChangeSet(Consumer<DeleteChangeSetRequest.Builder> deleteChangeSetRequest)
Deletes the specified change set.
|
default CompletableFuture<DeleteChangeSetResponse> |
deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest)
Deletes the specified change set.
|
default CompletableFuture<DeleteStackResponse> |
deleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest)
Deletes a specified stack.
|
default CompletableFuture<DeleteStackResponse> |
deleteStack(DeleteStackRequest deleteStackRequest)
Deletes a specified stack.
|
default CompletableFuture<DeleteStackInstancesResponse> |
deleteStackInstances(Consumer<DeleteStackInstancesRequest.Builder> deleteStackInstancesRequest)
Deletes stack instances for the specified accounts, in the specified regions.
|
default CompletableFuture<DeleteStackInstancesResponse> |
deleteStackInstances(DeleteStackInstancesRequest deleteStackInstancesRequest)
Deletes stack instances for the specified accounts, in the specified regions.
|
default CompletableFuture<DeleteStackSetResponse> |
deleteStackSet(Consumer<DeleteStackSetRequest.Builder> deleteStackSetRequest)
Deletes a stack set.
|
default CompletableFuture<DeleteStackSetResponse> |
deleteStackSet(DeleteStackSetRequest deleteStackSetRequest)
Deletes a stack set.
|
default CompletableFuture<DescribeAccountLimitsResponse> |
describeAccountLimits()
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in
your account.
|
default CompletableFuture<DescribeAccountLimitsResponse> |
describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest)
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in
your account.
|
default CompletableFuture<DescribeAccountLimitsResponse> |
describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in
your account.
|
default CompletableFuture<DescribeChangeSetResponse> |
describeChangeSet(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest)
Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the
change set.
|
default CompletableFuture<DescribeChangeSetResponse> |
describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest)
Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the
change set.
|
default CompletableFuture<DescribeStackEventsResponse> |
describeStackEvents(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order.
|
default CompletableFuture<DescribeStackEventsResponse> |
describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order.
|
default DescribeStackEventsPublisher |
describeStackEventsPaginator(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order.
|
default DescribeStackEventsPublisher |
describeStackEventsPaginator(DescribeStackEventsRequest describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order.
|
default CompletableFuture<DescribeStackInstanceResponse> |
describeStackInstance(Consumer<DescribeStackInstanceRequest.Builder> describeStackInstanceRequest)
Returns the stack instance that's associated with the specified stack set, AWS account, and region.
|
default CompletableFuture<DescribeStackInstanceResponse> |
describeStackInstance(DescribeStackInstanceRequest describeStackInstanceRequest)
Returns the stack instance that's associated with the specified stack set, AWS account, and region.
|
default CompletableFuture<DescribeStackResourceResponse> |
describeStackResource(Consumer<DescribeStackResourceRequest.Builder> describeStackResourceRequest)
Returns a description of the specified resource in the specified stack.
|
default CompletableFuture<DescribeStackResourceResponse> |
describeStackResource(DescribeStackResourceRequest describeStackResourceRequest)
Returns a description of the specified resource in the specified stack.
|
default CompletableFuture<DescribeStackResourcesResponse> |
describeStackResources(Consumer<DescribeStackResourcesRequest.Builder> describeStackResourcesRequest)
Returns AWS resource descriptions for running and deleted stacks.
|
default CompletableFuture<DescribeStackResourcesResponse> |
describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest)
Returns AWS resource descriptions for running and deleted stacks.
|
default CompletableFuture<DescribeStacksResponse> |
describeStacks()
Returns the description for the specified stack; if no stack name was specified, then it returns the description
for all the stacks created.
|
default CompletableFuture<DescribeStacksResponse> |
describeStacks(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)
Returns the description for the specified stack; if no stack name was specified, then it returns the description
for all the stacks created.
|
default CompletableFuture<DescribeStacksResponse> |
describeStacks(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.
|
default CompletableFuture<DescribeStackSetResponse> |
describeStackSet(Consumer<DescribeStackSetRequest.Builder> describeStackSetRequest)
Returns the description of the specified stack set.
|
default CompletableFuture<DescribeStackSetResponse> |
describeStackSet(DescribeStackSetRequest describeStackSetRequest)
Returns the description of the specified stack set.
|
default CompletableFuture<DescribeStackSetOperationResponse> |
describeStackSetOperation(Consumer<DescribeStackSetOperationRequest.Builder> describeStackSetOperationRequest)
Returns the description of the specified stack set operation.
|
default CompletableFuture<DescribeStackSetOperationResponse> |
describeStackSetOperation(DescribeStackSetOperationRequest describeStackSetOperationRequest)
Returns the description of the specified stack set operation.
|
default DescribeStacksPublisher |
describeStacksPaginator()
Returns the description for the specified stack; if no stack name was specified, then it returns the description
for all the stacks created.
|
default DescribeStacksPublisher |
describeStacksPaginator(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.
|
default CompletableFuture<EstimateTemplateCostResponse> |
estimateTemplateCost(Consumer<EstimateTemplateCostRequest.Builder> estimateTemplateCostRequest)
Returns the estimated monthly cost of a template.
|
default CompletableFuture<EstimateTemplateCostResponse> |
estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest)
Returns the estimated monthly cost of a template.
|
default CompletableFuture<ExecuteChangeSetResponse> |
executeChangeSet(Consumer<ExecuteChangeSetRequest.Builder> executeChangeSetRequest)
Updates a stack using the input information that was provided when the specified change set was created.
|
default CompletableFuture<ExecuteChangeSetResponse> |
executeChangeSet(ExecuteChangeSetRequest executeChangeSetRequest)
Updates a stack using the input information that was provided when the specified change set was created.
|
default CompletableFuture<GetStackPolicyResponse> |
getStackPolicy(Consumer<GetStackPolicyRequest.Builder> getStackPolicyRequest)
Returns the stack policy for a specified stack.
|
default CompletableFuture<GetStackPolicyResponse> |
getStackPolicy(GetStackPolicyRequest getStackPolicyRequest)
Returns the stack policy for a specified stack.
|
default CompletableFuture<GetTemplateResponse> |
getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest)
Returns the template body for a specified stack.
|
default CompletableFuture<GetTemplateResponse> |
getTemplate(GetTemplateRequest getTemplateRequest)
Returns the template body for a specified stack.
|
default CompletableFuture<GetTemplateSummaryResponse> |
getTemplateSummary(Consumer<GetTemplateSummaryRequest.Builder> getTemplateSummaryRequest)
Returns information about a new or existing template.
|
default CompletableFuture<GetTemplateSummaryResponse> |
getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest)
Returns information about a new or existing template.
|
default CompletableFuture<ListChangeSetsResponse> |
listChangeSets(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest)
Returns the ID and status of each active change set for a stack.
|
default CompletableFuture<ListChangeSetsResponse> |
listChangeSets(ListChangeSetsRequest listChangeSetsRequest)
Returns the ID and status of each active change set for a stack.
|
default CompletableFuture<ListExportsResponse> |
listExports()
Lists all exported output values in the account and region in which you call this action.
|
default CompletableFuture<ListExportsResponse> |
listExports(Consumer<ListExportsRequest.Builder> listExportsRequest)
Lists all exported output values in the account and region in which you call this action.
|
default CompletableFuture<ListExportsResponse> |
listExports(ListExportsRequest listExportsRequest)
Lists all exported output values in the account and region in which you call this action.
|
default ListExportsPublisher |
listExportsPaginator()
Lists all exported output values in the account and region in which you call this action.
|
default ListExportsPublisher |
listExportsPaginator(ListExportsRequest listExportsRequest)
Lists all exported output values in the account and region in which you call this action.
|
default CompletableFuture<ListImportsResponse> |
listImports(Consumer<ListImportsRequest.Builder> listImportsRequest)
Lists all stacks that are importing an exported output value.
|
default CompletableFuture<ListImportsResponse> |
listImports(ListImportsRequest listImportsRequest)
Lists all stacks that are importing an exported output value.
|
default ListImportsPublisher |
listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest)
Lists all stacks that are importing an exported output value.
|
default ListImportsPublisher |
listImportsPaginator(ListImportsRequest listImportsRequest)
Lists all stacks that are importing an exported output value.
|
default CompletableFuture<ListStackInstancesResponse> |
listStackInstances(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest)
Returns summary information about stack instances that are associated with the specified stack set.
|
default CompletableFuture<ListStackInstancesResponse> |
listStackInstances(ListStackInstancesRequest listStackInstancesRequest)
Returns summary information about stack instances that are associated with the specified stack set.
|
default CompletableFuture<ListStackResourcesResponse> |
listStackResources(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
default CompletableFuture<ListStackResourcesResponse> |
listStackResources(ListStackResourcesRequest listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
default ListStackResourcesPublisher |
listStackResourcesPaginator(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
default ListStackResourcesPublisher |
listStackResourcesPaginator(ListStackResourcesRequest listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
default CompletableFuture<ListStacksResponse> |
listStacks()
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default CompletableFuture<ListStacksResponse> |
listStacks(Consumer<ListStacksRequest.Builder> listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default CompletableFuture<ListStacksResponse> |
listStacks(ListStacksRequest listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default CompletableFuture<ListStackSetOperationResultsResponse> |
listStackSetOperationResults(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest)
Returns summary information about the results of a stack set operation.
|
default CompletableFuture<ListStackSetOperationResultsResponse> |
listStackSetOperationResults(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest)
Returns summary information about the results of a stack set operation.
|
default CompletableFuture<ListStackSetOperationsResponse> |
listStackSetOperations(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest)
Returns summary information about operations performed on a stack set.
|
default CompletableFuture<ListStackSetOperationsResponse> |
listStackSetOperations(ListStackSetOperationsRequest listStackSetOperationsRequest)
Returns summary information about operations performed on a stack set.
|
default CompletableFuture<ListStackSetsResponse> |
listStackSets()
Returns summary information about stack sets that are associated with the user.
|
default CompletableFuture<ListStackSetsResponse> |
listStackSets(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest)
Returns summary information about stack sets that are associated with the user.
|
default CompletableFuture<ListStackSetsResponse> |
listStackSets(ListStackSetsRequest listStackSetsRequest)
Returns summary information about stack sets that are associated with the user.
|
default ListStacksPublisher |
listStacksPaginator()
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default ListStacksPublisher |
listStacksPaginator(ListStacksRequest listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default CompletableFuture<SetStackPolicyResponse> |
setStackPolicy(Consumer<SetStackPolicyRequest.Builder> setStackPolicyRequest)
Sets a stack policy for a specified stack.
|
default CompletableFuture<SetStackPolicyResponse> |
setStackPolicy(SetStackPolicyRequest setStackPolicyRequest)
Sets a stack policy for a specified stack.
|
default CompletableFuture<SignalResourceResponse> |
signalResource(Consumer<SignalResourceRequest.Builder> signalResourceRequest)
Sends a signal to the specified resource with a success or failure status.
|
default CompletableFuture<SignalResourceResponse> |
signalResource(SignalResourceRequest signalResourceRequest)
Sends a signal to the specified resource with a success or failure status.
|
default CompletableFuture<StopStackSetOperationResponse> |
stopStackSetOperation(Consumer<StopStackSetOperationRequest.Builder> stopStackSetOperationRequest)
Stops an in-progress operation on a stack set and its associated stack instances.
|
default CompletableFuture<StopStackSetOperationResponse> |
stopStackSetOperation(StopStackSetOperationRequest stopStackSetOperationRequest)
Stops an in-progress operation on a stack set and its associated stack instances.
|
default CompletableFuture<UpdateStackResponse> |
updateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest)
Updates a stack as specified in the template.
|
default CompletableFuture<UpdateStackResponse> |
updateStack(UpdateStackRequest updateStackRequest)
Updates a stack as specified in the template.
|
default CompletableFuture<UpdateStackSetResponse> |
updateStackSet(Consumer<UpdateStackSetRequest.Builder> updateStackSetRequest)
Updates the stack set and all associated stack instances.
|
default CompletableFuture<UpdateStackSetResponse> |
updateStackSet(UpdateStackSetRequest updateStackSetRequest)
Updates the stack set and all associated stack instances.
|
default CompletableFuture<UpdateTerminationProtectionResponse> |
updateTerminationProtection(Consumer<UpdateTerminationProtectionRequest.Builder> updateTerminationProtectionRequest)
Updates termination protection for the specified stack.
|
default CompletableFuture<UpdateTerminationProtectionResponse> |
updateTerminationProtection(UpdateTerminationProtectionRequest updateTerminationProtectionRequest)
Updates termination protection for the specified stack.
|
default CompletableFuture<ValidateTemplateResponse> |
validateTemplate(Consumer<ValidateTemplateRequest.Builder> validateTemplateRequest)
Validates a specified template.
|
default CompletableFuture<ValidateTemplateResponse> |
validateTemplate(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template.
|
serviceNameclosestatic final String SERVICE_NAME
static CloudFormationAsyncClient create()
CloudFormationAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CloudFormationAsyncClientBuilder builder()
CloudFormationAsyncClient.default CompletableFuture<CancelUpdateStackResponse> cancelUpdateStack(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.default CompletableFuture<CancelUpdateStackResponse> cancelUpdateStack(Consumer<CancelUpdateStackRequest.Builder> 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.
This is a convenience which creates an instance of the CancelUpdateStackRequest.Builder avoiding the need
to create one manually via CancelUpdateStackRequest.builder()
cancelUpdateStackRequest - A Consumer that will call methods on CancelUpdateStackInput.Builder to create a request.
The input for the CancelUpdateStack action.default CompletableFuture<ContinueUpdateRollbackResponse> continueUpdateRollback(ContinueUpdateRollbackRequest continueUpdateRollbackRequest)
For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working
state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all
changes after a failed stack update. For example, you might have a stack that is rolling back to an old database
instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was
deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update
rollback to fail.
continueUpdateRollbackRequest - The input for the ContinueUpdateRollback action.default CompletableFuture<ContinueUpdateRollbackResponse> continueUpdateRollback(Consumer<ContinueUpdateRollbackRequest.Builder> continueUpdateRollbackRequest)
For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working
state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all
changes after a failed stack update. For example, you might have a stack that is rolling back to an old database
instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was
deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update
rollback to fail.
This is a convenience which creates an instance of the ContinueUpdateRollbackRequest.Builder avoiding the
need to create one manually via ContinueUpdateRollbackRequest.builder()
continueUpdateRollbackRequest - A Consumer that will call methods on ContinueUpdateRollbackInput.Builder to create a
request. The input for the ContinueUpdateRollback action.default CompletableFuture<CreateChangeSetResponse> createChangeSet(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 AWS CloudFormation will create. If you create a change set for an existing stack, AWS 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 AWS 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. After the CreateChangeSet call successfully completes, AWS
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. AWS CloudFormation doesn't make changes until you execute the change set.
createChangeSetRequest - The input for the CreateChangeSet action.For information on stack set limitations, see Limitations of StackSets.
default CompletableFuture<CreateChangeSetResponse> createChangeSet(Consumer<CreateChangeSetRequest.Builder> 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 AWS CloudFormation will create. If you create a change set for an existing stack, AWS 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 AWS 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. After the CreateChangeSet call successfully completes, AWS
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. AWS CloudFormation doesn't make changes until you execute the change set.
This is a convenience which creates an instance of the CreateChangeSetRequest.Builder avoiding the need
to create one manually via CreateChangeSetRequest.builder()
createChangeSetRequest - A Consumer that will call methods on CreateChangeSetInput.Builder to create a request. The
input for the CreateChangeSet action.For information on stack set limitations, see Limitations of StackSets.
default CompletableFuture<CreateStackResponse> createStack(CreateStackRequest createStackRequest)
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.
createStackRequest - The input for CreateStack action.For information on stack set limitations, see Limitations of StackSets.
default CompletableFuture<CreateStackResponse> createStack(Consumer<CreateStackRequest.Builder> createStackRequest)
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.
This is a convenience which creates an instance of the CreateStackRequest.Builder avoiding the need to
create one manually via CreateStackRequest.builder()
createStackRequest - A Consumer that will call methods on CreateStackInput.Builder to create a request. The
input for CreateStack action.For information on stack set limitations, see Limitations of StackSets.
default CompletableFuture<CreateStackInstancesResponse> createStackInstances(CreateStackInstancesRequest createStackInstancesRequest)
Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a
stack in a specific account and region. Accounts and Regions are required
parameters—you must specify at least one account and one region.
createStackInstancesRequest - For information on stack set limitations, see Limitations of StackSets.
default CompletableFuture<CreateStackInstancesResponse> createStackInstances(Consumer<CreateStackInstancesRequest.Builder> createStackInstancesRequest)
Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a
stack in a specific account and region. Accounts and Regions are required
parameters—you must specify at least one account and one region.
This is a convenience which creates an instance of the CreateStackInstancesRequest.Builder avoiding the
need to create one manually via CreateStackInstancesRequest.builder()
createStackInstancesRequest - A Consumer that will call methods on CreateStackInstancesInput.Builder to create a
request.For information on stack set limitations, see Limitations of StackSets.
default CompletableFuture<CreateStackSetResponse> createStackSet(CreateStackSetRequest createStackSetRequest)
Creates a stack set.
createStackSetRequest - For information on stack set limitations, see Limitations of StackSets.
default CompletableFuture<CreateStackSetResponse> createStackSet(Consumer<CreateStackSetRequest.Builder> createStackSetRequest)
Creates a stack set.
This is a convenience which creates an instance of the CreateStackSetRequest.Builder avoiding the need to
create one manually via CreateStackSetRequest.builder()
createStackSetRequest - A Consumer that will call methods on CreateStackSetInput.Builder to create a request.For information on stack set limitations, see Limitations of StackSets.
default CompletableFuture<DeleteChangeSetResponse> deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest)
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, AWS CloudFormation successfully deleted the change set.
deleteChangeSetRequest - The input for the DeleteChangeSet action.CREATE_IN_PROGRESS, or the stack status might be
UPDATE_IN_PROGRESS.default CompletableFuture<DeleteChangeSetResponse> deleteChangeSet(Consumer<DeleteChangeSetRequest.Builder> deleteChangeSetRequest)
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, AWS CloudFormation successfully deleted the change set.
This is a convenience which creates an instance of the DeleteChangeSetRequest.Builder avoiding the need
to create one manually via DeleteChangeSetRequest.builder()
deleteChangeSetRequest - A Consumer that will call methods on DeleteChangeSetInput.Builder to create a request. The
input for the DeleteChangeSet action.CREATE_IN_PROGRESS, or the stack status might be
UPDATE_IN_PROGRESS.default CompletableFuture<DeleteStackResponse> deleteStack(DeleteStackRequest deleteStackRequest)
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
deleteStackRequest - The input for DeleteStack action.default CompletableFuture<DeleteStackResponse> deleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest)
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
This is a convenience which creates an instance of the DeleteStackRequest.Builder avoiding the need to
create one manually via DeleteStackRequest.builder()
deleteStackRequest - A Consumer that will call methods on DeleteStackInput.Builder to create a request. The
input for DeleteStack action.default CompletableFuture<DeleteStackInstancesResponse> deleteStackInstances(DeleteStackInstancesRequest deleteStackInstancesRequest)
Deletes stack instances for the specified accounts, in the specified regions.
deleteStackInstancesRequest - default CompletableFuture<DeleteStackInstancesResponse> deleteStackInstances(Consumer<DeleteStackInstancesRequest.Builder> deleteStackInstancesRequest)
Deletes stack instances for the specified accounts, in the specified regions.
This is a convenience which creates an instance of the DeleteStackInstancesRequest.Builder avoiding the
need to create one manually via DeleteStackInstancesRequest.builder()
deleteStackInstancesRequest - A Consumer that will call methods on DeleteStackInstancesInput.Builder to create a
request.default CompletableFuture<DeleteStackSetResponse> deleteStackSet(DeleteStackSetRequest deleteStackSetRequest)
Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances.
deleteStackSetRequest - default CompletableFuture<DeleteStackSetResponse> deleteStackSet(Consumer<DeleteStackSetRequest.Builder> deleteStackSetRequest)
Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances.
This is a convenience which creates an instance of the DeleteStackSetRequest.Builder avoiding the need to
create one manually via DeleteStackSetRequest.builder()
deleteStackSetRequest - A Consumer that will call methods on DeleteStackSetInput.Builder to create a request.default CompletableFuture<DescribeAccountLimitsResponse> describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
describeAccountLimitsRequest - The input for the DescribeAccountLimits action.default CompletableFuture<DescribeAccountLimitsResponse> describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest)
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
This is a convenience which creates an instance of the DescribeAccountLimitsRequest.Builder avoiding the
need to create one manually via DescribeAccountLimitsRequest.builder()
describeAccountLimitsRequest - A Consumer that will call methods on DescribeAccountLimitsInput.Builder to create a
request. The input for the DescribeAccountLimits action.default CompletableFuture<DescribeAccountLimitsResponse> describeAccountLimits()
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
default CompletableFuture<DescribeChangeSetResponse> describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest)
Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.
describeChangeSetRequest - The input for the DescribeChangeSet action.ListChangeSets action.default CompletableFuture<DescribeChangeSetResponse> describeChangeSet(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest)
Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.
This is a convenience which creates an instance of the DescribeChangeSetRequest.Builder avoiding the need
to create one manually via DescribeChangeSetRequest.builder()
describeChangeSetRequest - A Consumer that will call methods on DescribeChangeSetInput.Builder to create a request.
The input for the DescribeChangeSet action.ListChangeSets action.default CompletableFuture<DescribeStackEventsResponse> describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
describeStackEventsRequest - The input for DescribeStackEvents action.default CompletableFuture<DescribeStackEventsResponse> describeStackEvents(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
This is a convenience which creates an instance of the DescribeStackEventsRequest.Builder avoiding the
need to create one manually via DescribeStackEventsRequest.builder()
describeStackEventsRequest - A Consumer that will call methods on DescribeStackEventsInput.Builder to create a request.
The input for DescribeStackEvents action.default DescribeStackEventsPublisher describeStackEventsPaginator(DescribeStackEventsRequest describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
This is a variant of
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsPublisher publisher = client.describeStackEventsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsPublisher publisher = client.describeStackEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)
operation.
describeStackEventsRequest - The input for DescribeStackEvents action.default DescribeStackEventsPublisher describeStackEventsPaginator(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
This is a variant of
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsPublisher publisher = client.describeStackEventsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsPublisher publisher = client.describeStackEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)
operation.
This is a convenience which creates an instance of the DescribeStackEventsRequest.Builder avoiding the
need to create one manually via DescribeStackEventsRequest.builder()
describeStackEventsRequest - A Consumer that will call methods on DescribeStackEventsInput.Builder to create a request.
The input for DescribeStackEvents action.default CompletableFuture<DescribeStackInstanceResponse> describeStackInstance(DescribeStackInstanceRequest describeStackInstanceRequest)
Returns the stack instance that's associated with the specified stack set, AWS account, and region.
For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
describeStackInstanceRequest - default CompletableFuture<DescribeStackInstanceResponse> describeStackInstance(Consumer<DescribeStackInstanceRequest.Builder> describeStackInstanceRequest)
Returns the stack instance that's associated with the specified stack set, AWS account, and region.
For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
This is a convenience which creates an instance of the DescribeStackInstanceRequest.Builder avoiding the
need to create one manually via DescribeStackInstanceRequest.builder()
describeStackInstanceRequest - A Consumer that will call methods on DescribeStackInstanceInput.Builder to create a
request.default CompletableFuture<DescribeStackResourceResponse> describeStackResource(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.default CompletableFuture<DescribeStackResourceResponse> describeStackResource(Consumer<DescribeStackResourceRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeStackResourceRequest.Builder avoiding the
need to create one manually via DescribeStackResourceRequest.builder()
describeStackResourceRequest - A Consumer that will call methods on DescribeStackResourceInput.Builder to create a
request. The input for DescribeStackResource action.default CompletableFuture<DescribeStackResourcesResponse> describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest)
Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the
associated resources that are part of the stack are returned. If PhysicalResourceId is specified,
the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use
ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the
stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition, you
can specify LogicalResourceId to filter the returned result. For more information about resources,
the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and
PhysicalResourceId in the same request.
describeStackResourcesRequest - The input for DescribeStackResources action.default CompletableFuture<DescribeStackResourcesResponse> describeStackResources(Consumer<DescribeStackResourcesRequest.Builder> describeStackResourcesRequest)
Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the
associated resources that are part of the stack are returned. If PhysicalResourceId is specified,
the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use
ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the
stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition, you
can specify LogicalResourceId to filter the returned result. For more information about resources,
the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and
PhysicalResourceId in the same request.
This is a convenience which creates an instance of the DescribeStackResourcesRequest.Builder avoiding the
need to create one manually via DescribeStackResourcesRequest.builder()
describeStackResourcesRequest - A Consumer that will call methods on DescribeStackResourcesInput.Builder to create a
request. The input for DescribeStackResources action.default CompletableFuture<DescribeStackSetResponse> describeStackSet(DescribeStackSetRequest describeStackSetRequest)
Returns the description of the specified stack set.
describeStackSetRequest - default CompletableFuture<DescribeStackSetResponse> describeStackSet(Consumer<DescribeStackSetRequest.Builder> describeStackSetRequest)
Returns the description of the specified stack set.
This is a convenience which creates an instance of the DescribeStackSetRequest.Builder avoiding the need
to create one manually via DescribeStackSetRequest.builder()
describeStackSetRequest - A Consumer that will call methods on DescribeStackSetInput.Builder to create a request.default CompletableFuture<DescribeStackSetOperationResponse> describeStackSetOperation(DescribeStackSetOperationRequest describeStackSetOperationRequest)
Returns the description of the specified stack set operation.
describeStackSetOperationRequest - default CompletableFuture<DescribeStackSetOperationResponse> describeStackSetOperation(Consumer<DescribeStackSetOperationRequest.Builder> describeStackSetOperationRequest)
Returns the description of the specified stack set operation.
This is a convenience which creates an instance of the DescribeStackSetOperationRequest.Builder avoiding
the need to create one manually via DescribeStackSetOperationRequest.builder()
describeStackSetOperationRequest - A Consumer that will call methods on DescribeStackSetOperationInput.Builder to create a
request.default CompletableFuture<DescribeStacksResponse> describeStacks(DescribeStacksRequest describeStacksRequest)
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
If the stack does not exist, an AmazonCloudFormationException is returned.
describeStacksRequest - The input for DescribeStacks action.default CompletableFuture<DescribeStacksResponse> describeStacks(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
If the stack does not exist, an AmazonCloudFormationException is returned.
This is a convenience which creates an instance of the DescribeStacksRequest.Builder avoiding the need to
create one manually via DescribeStacksRequest.builder()
describeStacksRequest - A Consumer that will call methods on DescribeStacksInput.Builder to create a request. The
input for DescribeStacks action.default CompletableFuture<DescribeStacksResponse> describeStacks()
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
If the stack does not exist, an AmazonCloudFormationException is returned.
default DescribeStacksPublisher describeStacksPaginator(DescribeStacksRequest describeStacksRequest)
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
If the stack does not exist, an AmazonCloudFormationException is returned.
This is a variant of
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation.
describeStacksRequest - The input for DescribeStacks action.default DescribeStacksPublisher describeStacksPaginator()
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
If the stack does not exist, an AmazonCloudFormationException is returned.
This is a variant of
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation.
default CompletableFuture<EstimateTemplateCostResponse> estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest)
Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
estimateTemplateCostRequest - The input for an EstimateTemplateCost action.default CompletableFuture<EstimateTemplateCostResponse> estimateTemplateCost(Consumer<EstimateTemplateCostRequest.Builder> estimateTemplateCostRequest)
Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
This is a convenience which creates an instance of the EstimateTemplateCostRequest.Builder avoiding the
need to create one manually via EstimateTemplateCostRequest.builder()
estimateTemplateCostRequest - A Consumer that will call methods on EstimateTemplateCostInput.Builder to create a
request. The input for an EstimateTemplateCost action.default CompletableFuture<ExecuteChangeSetResponse> executeChangeSet(ExecuteChangeSetRequest executeChangeSetRequest)
Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.
If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
executeChangeSetRequest - The input for the ExecuteChangeSet action.CREATE_IN_PROGRESS, or the stack status might be
UPDATE_IN_PROGRESS.ListChangeSets action.default CompletableFuture<ExecuteChangeSetResponse> executeChangeSet(Consumer<ExecuteChangeSetRequest.Builder> executeChangeSetRequest)
Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.
If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
This is a convenience which creates an instance of the ExecuteChangeSetRequest.Builder avoiding the need
to create one manually via ExecuteChangeSetRequest.builder()
executeChangeSetRequest - A Consumer that will call methods on ExecuteChangeSetInput.Builder to create a request.
The input for the ExecuteChangeSet action.CREATE_IN_PROGRESS, or the stack status might be
UPDATE_IN_PROGRESS.ListChangeSets action.default CompletableFuture<GetStackPolicyResponse> getStackPolicy(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.default CompletableFuture<GetStackPolicyResponse> getStackPolicy(Consumer<GetStackPolicyRequest.Builder> getStackPolicyRequest)
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
This is a convenience which creates an instance of the GetStackPolicyRequest.Builder avoiding the need to
create one manually via GetStackPolicyRequest.builder()
getStackPolicyRequest - A Consumer that will call methods on GetStackPolicyInput.Builder to create a request. The
input for the GetStackPolicy action.default CompletableFuture<GetTemplateResponse> getTemplate(GetTemplateRequest getTemplateRequest)
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.
If the template does not exist, a ValidationError is returned.
getTemplateRequest - The input for a GetTemplate action.ListChangeSets action.default CompletableFuture<GetTemplateResponse> getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest)
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.
If the template does not exist, a ValidationError is returned.
This is a convenience which creates an instance of the GetTemplateRequest.Builder avoiding the need to
create one manually via GetTemplateRequest.builder()
getTemplateRequest - A Consumer that will call methods on GetTemplateInput.Builder to create a request. The
input for a GetTemplate action.ListChangeSets action.default CompletableFuture<GetTemplateSummaryResponse> getTemplateSummary(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 does not exist, a ValidationError is returned.
getTemplateSummaryRequest - The input for the GetTemplateSummary action.default CompletableFuture<GetTemplateSummaryResponse> getTemplateSummary(Consumer<GetTemplateSummaryRequest.Builder> 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 does not exist, a ValidationError is returned.
This is a convenience which creates an instance of the GetTemplateSummaryRequest.Builder avoiding the
need to create one manually via GetTemplateSummaryRequest.builder()
getTemplateSummaryRequest - A Consumer that will call methods on GetTemplateSummaryInput.Builder to create a request.
The input for the GetTemplateSummary action.default CompletableFuture<ListChangeSetsResponse> listChangeSets(ListChangeSetsRequest listChangeSetsRequest)
Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change
sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
listChangeSetsRequest - The input for the ListChangeSets action.default CompletableFuture<ListChangeSetsResponse> listChangeSets(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest)
Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change
sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
This is a convenience which creates an instance of the ListChangeSetsRequest.Builder avoiding the need to
create one manually via ListChangeSetsRequest.builder()
listChangeSetsRequest - A Consumer that will call methods on ListChangeSetsInput.Builder to create a request. The
input for the ListChangeSets action.default CompletableFuture<ListExportsResponse> listExports(ListExportsRequest listExportsRequest)
Lists all exported output values in the account and region in which you call this action. Use this action to see
the exported output values that you can import into other stacks. To import values, use the
Fn::ImportValue function.
For more information, see AWS CloudFormation Export Stack Output Values.
listExportsRequest - default CompletableFuture<ListExportsResponse> listExports(Consumer<ListExportsRequest.Builder> listExportsRequest)
Lists all exported output values in the account and region in which you call this action. Use this action to see
the exported output values that you can import into other stacks. To import values, use the
Fn::ImportValue function.
For more information, see AWS CloudFormation Export Stack Output Values.
This is a convenience which creates an instance of the ListExportsRequest.Builder avoiding the need to
create one manually via ListExportsRequest.builder()
listExportsRequest - A Consumer that will call methods on ListExportsInput.Builder to create a request.default CompletableFuture<ListExportsResponse> listExports()
Lists all exported output values in the account and region in which you call this action. Use this action to see
the exported output values that you can import into other stacks. To import values, use the
Fn::ImportValue function.
For more information, see AWS CloudFormation Export Stack Output Values.
default ListExportsPublisher listExportsPaginator(ListExportsRequest listExportsRequest)
Lists all exported output values in the account and region in which you call this action. Use this action to see
the exported output values that you can import into other stacks. To import values, use the
Fn::ImportValue function.
For more information, see AWS CloudFormation Export Stack Output Values.
This is a variant of
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListExportsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest) operation.
listExportsRequest - default ListExportsPublisher listExportsPaginator()
Lists all exported output values in the account and region in which you call this action. Use this action to see
the exported output values that you can import into other stacks. To import values, use the
Fn::ImportValue function.
For more information, see AWS CloudFormation Export Stack Output Values.
This is a variant of
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListExportsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest) operation.
default CompletableFuture<ListImportsResponse> listImports(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 - default CompletableFuture<ListImportsResponse> listImports(Consumer<ListImportsRequest.Builder> 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.
This is a convenience which creates an instance of the ListImportsRequest.Builder avoiding the need to
create one manually via ListImportsRequest.builder()
listImportsRequest - A Consumer that will call methods on ListImportsInput.Builder to create a request.default ListImportsPublisher listImportsPaginator(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.
This is a variant of
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudformation.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudformation.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListImportsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudformation.model.ListImportsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest) operation.
listImportsRequest - default ListImportsPublisher listImportsPaginator(Consumer<ListImportsRequest.Builder> 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.
This is a variant of
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudformation.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudformation.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListImportsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudformation.model.ListImportsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest) operation.
This is a convenience which creates an instance of the ListImportsRequest.Builder avoiding the need to
create one manually via ListImportsRequest.builder()
listImportsRequest - A Consumer that will call methods on ListImportsInput.Builder to create a request.default CompletableFuture<ListStackInstancesResponse> listStackInstances(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 AWS account name or region.
listStackInstancesRequest - default CompletableFuture<ListStackInstancesResponse> listStackInstances(Consumer<ListStackInstancesRequest.Builder> 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 AWS account name or region.
This is a convenience which creates an instance of the ListStackInstancesRequest.Builder avoiding the
need to create one manually via ListStackInstancesRequest.builder()
listStackInstancesRequest - A Consumer that will call methods on ListStackInstancesInput.Builder to create a request.default CompletableFuture<ListStackResourcesResponse> listStackResources(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.default CompletableFuture<ListStackResourcesResponse> listStackResources(Consumer<ListStackResourcesRequest.Builder> 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.
This is a convenience which creates an instance of the ListStackResourcesRequest.Builder avoiding the
need to create one manually via ListStackResourcesRequest.builder()
listStackResourcesRequest - A Consumer that will call methods on ListStackResourcesInput.Builder to create a request.
The input for the ListStackResource action.default ListStackResourcesPublisher listStackResourcesPaginator(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.
This is a variant of
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesPublisher publisher = client.listStackResourcesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesPublisher publisher = client.listStackResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)
operation.
listStackResourcesRequest - The input for the ListStackResource action.default ListStackResourcesPublisher listStackResourcesPaginator(Consumer<ListStackResourcesRequest.Builder> 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.
This is a variant of
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesPublisher publisher = client.listStackResourcesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesPublisher publisher = client.listStackResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)
operation.
This is a convenience which creates an instance of the ListStackResourcesRequest.Builder avoiding the
need to create one manually via ListStackResourcesRequest.builder()
listStackResourcesRequest - A Consumer that will call methods on ListStackResourcesInput.Builder to create a request.
The input for the ListStackResource action.default CompletableFuture<ListStackSetOperationResultsResponse> listStackSetOperationResults(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest)
Returns summary information about the results of a stack set operation.
listStackSetOperationResultsRequest - default CompletableFuture<ListStackSetOperationResultsResponse> listStackSetOperationResults(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest)
Returns summary information about the results of a stack set operation.
This is a convenience which creates an instance of the ListStackSetOperationResultsRequest.Builder
avoiding the need to create one manually via ListStackSetOperationResultsRequest.builder()
listStackSetOperationResultsRequest - A Consumer that will call methods on ListStackSetOperationResultsInput.Builder to create a
request.default CompletableFuture<ListStackSetOperationsResponse> listStackSetOperations(ListStackSetOperationsRequest listStackSetOperationsRequest)
Returns summary information about operations performed on a stack set.
listStackSetOperationsRequest - default CompletableFuture<ListStackSetOperationsResponse> listStackSetOperations(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest)
Returns summary information about operations performed on a stack set.
This is a convenience which creates an instance of the ListStackSetOperationsRequest.Builder avoiding the
need to create one manually via ListStackSetOperationsRequest.builder()
listStackSetOperationsRequest - A Consumer that will call methods on ListStackSetOperationsInput.Builder to create a
request.default CompletableFuture<ListStackSetsResponse> listStackSets(ListStackSetsRequest listStackSetsRequest)
Returns summary information about stack sets that are associated with the user.
listStackSetsRequest - default CompletableFuture<ListStackSetsResponse> listStackSets(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest)
Returns summary information about stack sets that are associated with the user.
This is a convenience which creates an instance of the ListStackSetsRequest.Builder avoiding the need to
create one manually via ListStackSetsRequest.builder()
listStackSetsRequest - A Consumer that will call methods on ListStackSetsInput.Builder to create a request.default CompletableFuture<ListStackSetsResponse> listStackSets()
Returns summary information about stack sets that are associated with the user.
default CompletableFuture<ListStacksResponse> listStacks(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.default CompletableFuture<ListStacksResponse> listStacks(Consumer<ListStacksRequest.Builder> 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).
This is a convenience which creates an instance of the ListStacksRequest.Builder avoiding the need to
create one manually via ListStacksRequest.builder()
listStacksRequest - A Consumer that will call methods on ListStacksInput.Builder to create a request. The
input for ListStacks action.default CompletableFuture<ListStacksResponse> listStacks()
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).
default ListStacksPublisher listStacksPaginator(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).
This is a variant of listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStacksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest) operation.
listStacksRequest - The input for ListStacks action.default ListStacksPublisher listStacksPaginator()
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).
This is a variant of listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStacksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest) operation.
default CompletableFuture<SetStackPolicyResponse> setStackPolicy(SetStackPolicyRequest setStackPolicyRequest)
Sets a stack policy for a specified stack.
setStackPolicyRequest - The input for the SetStackPolicy action.default CompletableFuture<SetStackPolicyResponse> setStackPolicy(Consumer<SetStackPolicyRequest.Builder> setStackPolicyRequest)
Sets a stack policy for a specified stack.
This is a convenience which creates an instance of the SetStackPolicyRequest.Builder avoiding the need to
create one manually via SetStackPolicyRequest.builder()
setStackPolicyRequest - A Consumer that will call methods on SetStackPolicyInput.Builder to create a request. The
input for the SetStackPolicy action.default CompletableFuture<SignalResourceResponse> signalResource(SignalResourceRequest signalResourceRequest)
Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
signalResourceRequest - The input for the SignalResource action.default CompletableFuture<SignalResourceResponse> signalResource(Consumer<SignalResourceRequest.Builder> signalResourceRequest)
Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
This is a convenience which creates an instance of the SignalResourceRequest.Builder avoiding the need to
create one manually via SignalResourceRequest.builder()
signalResourceRequest - A Consumer that will call methods on SignalResourceInput.Builder to create a request. The
input for the SignalResource action.default CompletableFuture<StopStackSetOperationResponse> stopStackSetOperation(StopStackSetOperationRequest stopStackSetOperationRequest)
Stops an in-progress operation on a stack set and its associated stack instances.
stopStackSetOperationRequest - default CompletableFuture<StopStackSetOperationResponse> stopStackSetOperation(Consumer<StopStackSetOperationRequest.Builder> stopStackSetOperationRequest)
Stops an in-progress operation on a stack set and its associated stack instances.
This is a convenience which creates an instance of the StopStackSetOperationRequest.Builder avoiding the
need to create one manually via StopStackSetOperationRequest.builder()
stopStackSetOperationRequest - A Consumer that will call methods on StopStackSetOperationInput.Builder to create a
request.default CompletableFuture<UpdateStackResponse> updateStack(UpdateStackRequest updateStackRequest)
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
updateStackRequest - The input for an UpdateStack action.default CompletableFuture<UpdateStackResponse> updateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest)
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
This is a convenience which creates an instance of the UpdateStackRequest.Builder avoiding the need to
create one manually via UpdateStackRequest.builder()
updateStackRequest - A Consumer that will call methods on UpdateStackInput.Builder to create a request. The
input for an UpdateStack action.default CompletableFuture<UpdateStackSetResponse> updateStackSet(UpdateStackSetRequest updateStackSetRequest)
Updates the stack set and all associated stack instances.
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 - default CompletableFuture<UpdateStackSetResponse> updateStackSet(Consumer<UpdateStackSetRequest.Builder> updateStackSetRequest)
Updates the stack set and all associated stack instances.
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.
This is a convenience which creates an instance of the UpdateStackSetRequest.Builder avoiding the need to
create one manually via UpdateStackSetRequest.builder()
updateStackSetRequest - A Consumer that will call methods on UpdateStackSetInput.Builder to create a request.default CompletableFuture<UpdateTerminationProtectionResponse> updateTerminationProtection(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 AWS CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
updateTerminationProtectionRequest - default CompletableFuture<UpdateTerminationProtectionResponse> updateTerminationProtection(Consumer<UpdateTerminationProtectionRequest.Builder> 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 AWS CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
This is a convenience which creates an instance of the UpdateTerminationProtectionRequest.Builder
avoiding the need to create one manually via UpdateTerminationProtectionRequest.builder()
updateTerminationProtectionRequest - A Consumer that will call methods on UpdateTerminationProtectionInput.Builder to create a
request.default CompletableFuture<ValidateTemplateResponse> validateTemplate(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.
validateTemplateRequest - The input for ValidateTemplate action.default CompletableFuture<ValidateTemplateResponse> validateTemplate(Consumer<ValidateTemplateRequest.Builder> validateTemplateRequest)
Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.
This is a convenience which creates an instance of the ValidateTemplateRequest.Builder avoiding the need
to create one manually via ValidateTemplateRequest.builder()
validateTemplateRequest - A Consumer that will call methods on ValidateTemplateInput.Builder to create a request.
The input for ValidateTemplate action.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.