Package software.amazon.awssdk.services.cloudformation.waiters

Interface CloudFormationWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
@Immutable
public interface CloudFormationWaiter
extends SdkAutoCloseable

Waiter utility class that polls a resource until a desired state is reached or until it is determined that the resource will never enter into the desired state. This can be created using the static builder() method

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CloudFormationWaiter.Builder

Method Summary

Modifier and Type	Method	Description
static CloudFormationWaiter.Builder	builder()	Create a builder that can be used to configure and create a CloudFormationWaiter.
static CloudFormationWaiter	create()	Create an instance of CloudFormationWaiter with the default configuration.
default WaiterResponse<DescribeChangeSetResponse>	waitUntilChangeSetCreateComplete(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest)	Polls CloudFormationClient.describeChangeSet(software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetRequest) API until the desired condition ChangeSetCreateComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeChangeSetResponse>	waitUntilChangeSetCreateComplete(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls CloudFormationClient.describeChangeSet(software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetRequest) API until the desired condition ChangeSetCreateComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeChangeSetResponse>	waitUntilChangeSetCreateComplete(DescribeChangeSetRequest describeChangeSetRequest)	Polls CloudFormationClient.describeChangeSet(software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetRequest) API until the desired condition ChangeSetCreateComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeChangeSetResponse>	waitUntilChangeSetCreateComplete(DescribeChangeSetRequest describeChangeSetRequest, WaiterOverrideConfiguration overrideConfig)	Polls CloudFormationClient.describeChangeSet(software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetRequest) API until the desired condition ChangeSetCreateComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeStacksResponse>	waitUntilStackCreateComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackCreateComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeStacksResponse>	waitUntilStackCreateComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackCreateComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeStacksResponse>	waitUntilStackCreateComplete(DescribeStacksRequest describeStacksRequest)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackCreateComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeStacksResponse>	waitUntilStackCreateComplete(DescribeStacksRequest describeStacksRequest, WaiterOverrideConfiguration overrideConfig)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackCreateComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeStacksResponse>	waitUntilStackDeleteComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackDeleteComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeStacksResponse>	waitUntilStackDeleteComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackDeleteComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeStacksResponse>	waitUntilStackDeleteComplete(DescribeStacksRequest describeStacksRequest)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackDeleteComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeStacksResponse>	waitUntilStackDeleteComplete(DescribeStacksRequest describeStacksRequest, WaiterOverrideConfiguration overrideConfig)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackDeleteComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeStacksResponse>	waitUntilStackExists(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackExists is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeStacksResponse>	waitUntilStackExists(Consumer<DescribeStacksRequest.Builder> describeStacksRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackExists is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeStacksResponse>	waitUntilStackExists(DescribeStacksRequest describeStacksRequest)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackExists is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeStacksResponse>	waitUntilStackExists(DescribeStacksRequest describeStacksRequest, WaiterOverrideConfiguration overrideConfig)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackExists is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeStacksResponse>	waitUntilStackImportComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackImportComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeStacksResponse>	waitUntilStackImportComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackImportComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeStacksResponse>	waitUntilStackImportComplete(DescribeStacksRequest describeStacksRequest)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackImportComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeStacksResponse>	waitUntilStackImportComplete(DescribeStacksRequest describeStacksRequest, WaiterOverrideConfiguration overrideConfig)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackImportComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeStacksResponse>	waitUntilStackRollbackComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackRollbackComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeStacksResponse>	waitUntilStackRollbackComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackRollbackComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeStacksResponse>	waitUntilStackRollbackComplete(DescribeStacksRequest describeStacksRequest)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackRollbackComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeStacksResponse>	waitUntilStackRollbackComplete(DescribeStacksRequest describeStacksRequest, WaiterOverrideConfiguration overrideConfig)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackRollbackComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeStacksResponse>	waitUntilStackUpdateComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackUpdateComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeStacksResponse>	waitUntilStackUpdateComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackUpdateComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeStacksResponse>	waitUntilStackUpdateComplete(DescribeStacksRequest describeStacksRequest)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackUpdateComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeStacksResponse>	waitUntilStackUpdateComplete(DescribeStacksRequest describeStacksRequest, WaiterOverrideConfiguration overrideConfig)	Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackUpdateComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeTypeRegistrationResponse>	waitUntilTypeRegistrationComplete(Consumer<DescribeTypeRegistrationRequest.Builder> describeTypeRegistrationRequest)	Polls CloudFormationClient.describeTypeRegistration(software.amazon.awssdk.services.cloudformation.model.DescribeTypeRegistrationRequest) API until the desired condition TypeRegistrationComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeTypeRegistrationResponse>	waitUntilTypeRegistrationComplete(Consumer<DescribeTypeRegistrationRequest.Builder> describeTypeRegistrationRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls CloudFormationClient.describeTypeRegistration(software.amazon.awssdk.services.cloudformation.model.DescribeTypeRegistrationRequest) API until the desired condition TypeRegistrationComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeTypeRegistrationResponse>	waitUntilTypeRegistrationComplete(DescribeTypeRegistrationRequest describeTypeRegistrationRequest)	Polls CloudFormationClient.describeTypeRegistration(software.amazon.awssdk.services.cloudformation.model.DescribeTypeRegistrationRequest) API until the desired condition TypeRegistrationComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeTypeRegistrationResponse>	waitUntilTypeRegistrationComplete(DescribeTypeRegistrationRequest describeTypeRegistrationRequest, WaiterOverrideConfiguration overrideConfig)	Polls CloudFormationClient.describeTypeRegistration(software.amazon.awssdk.services.cloudformation.model.DescribeTypeRegistrationRequest) API until the desired condition TypeRegistrationComplete is met, or until it is determined that the resource will never enter into the desired state

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Method Detail

waitUntilChangeSetCreateComplete

default WaiterResponse<DescribeChangeSetResponse> waitUntilChangeSetCreateComplete(DescribeChangeSetRequest describeChangeSetRequest)

Polls CloudFormationClient.describeChangeSet(software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetRequest) API until the desired condition ChangeSetCreateComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeChangeSetRequest - the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilChangeSetCreateComplete

default WaiterResponse<DescribeChangeSetResponse> waitUntilChangeSetCreateComplete(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest)

Polls CloudFormationClient.describeChangeSet(software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetRequest) API until the desired condition ChangeSetCreateComplete is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder without the need to create one manually using DescribeChangeSetRequest.builder()

Parameters:

describeChangeSetRequest - The consumer that will configure the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilChangeSetCreateComplete

default WaiterResponse<DescribeChangeSetResponse> waitUntilChangeSetCreateComplete(DescribeChangeSetRequest describeChangeSetRequest,
                                                                                   WaiterOverrideConfiguration overrideConfig)

Polls CloudFormationClient.describeChangeSet(software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetRequest) API until the desired condition ChangeSetCreateComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeChangeSetRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilChangeSetCreateComplete

default WaiterResponse<DescribeChangeSetResponse> waitUntilChangeSetCreateComplete(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest,
                                                                                   Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls CloudFormationClient.describeChangeSet(software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetRequest) API until the desired condition ChangeSetCreateComplete is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder and instance of the override config builder

Parameters:

describeChangeSetRequest - The consumer that will configure the request to be used for polling

overrideConfig - The consumer that will configure the per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackCreateComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackCreateComplete(DescribeStacksRequest describeStacksRequest)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackCreateComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeStacksRequest - the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackCreateComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackCreateComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackCreateComplete is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder without the need to create one manually using DescribeStacksRequest.builder()

Parameters:

describeStacksRequest - The consumer that will configure the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackCreateComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackCreateComplete(DescribeStacksRequest describeStacksRequest,
                                                                            WaiterOverrideConfiguration overrideConfig)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackCreateComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeStacksRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackCreateComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackCreateComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest,
                                                                            Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackCreateComplete is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder and instance of the override config builder

Parameters:

describeStacksRequest - The consumer that will configure the request to be used for polling

overrideConfig - The consumer that will configure the per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackDeleteComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackDeleteComplete(DescribeStacksRequest describeStacksRequest)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackDeleteComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeStacksRequest - the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackDeleteComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackDeleteComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackDeleteComplete is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder without the need to create one manually using DescribeStacksRequest.builder()

Parameters:

describeStacksRequest - The consumer that will configure the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackDeleteComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackDeleteComplete(DescribeStacksRequest describeStacksRequest,
                                                                            WaiterOverrideConfiguration overrideConfig)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackDeleteComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeStacksRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackDeleteComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackDeleteComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest,
                                                                            Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackDeleteComplete is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder and instance of the override config builder

Parameters:

describeStacksRequest - The consumer that will configure the request to be used for polling

overrideConfig - The consumer that will configure the per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackExists

default WaiterResponse<DescribeStacksResponse> waitUntilStackExists(DescribeStacksRequest describeStacksRequest)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeStacksRequest - the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackExists

default WaiterResponse<DescribeStacksResponse> waitUntilStackExists(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackExists is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder without the need to create one manually using DescribeStacksRequest.builder()

Parameters:

describeStacksRequest - The consumer that will configure the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackExists

default WaiterResponse<DescribeStacksResponse> waitUntilStackExists(DescribeStacksRequest describeStacksRequest,
                                                                    WaiterOverrideConfiguration overrideConfig)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeStacksRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackExists

default WaiterResponse<DescribeStacksResponse> waitUntilStackExists(Consumer<DescribeStacksRequest.Builder> describeStacksRequest,
                                                                    Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackExists is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder and instance of the override config builder

Parameters:

describeStacksRequest - The consumer that will configure the request to be used for polling

overrideConfig - The consumer that will configure the per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackImportComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackImportComplete(DescribeStacksRequest describeStacksRequest)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackImportComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeStacksRequest - the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackImportComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackImportComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackImportComplete is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder without the need to create one manually using DescribeStacksRequest.builder()

Parameters:

describeStacksRequest - The consumer that will configure the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackImportComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackImportComplete(DescribeStacksRequest describeStacksRequest,
                                                                            WaiterOverrideConfiguration overrideConfig)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackImportComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeStacksRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackImportComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackImportComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest,
                                                                            Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackImportComplete is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder and instance of the override config builder

Parameters:

describeStacksRequest - The consumer that will configure the request to be used for polling

overrideConfig - The consumer that will configure the per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackRollbackComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackRollbackComplete(DescribeStacksRequest describeStacksRequest)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackRollbackComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeStacksRequest - the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackRollbackComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackRollbackComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackRollbackComplete is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder without the need to create one manually using DescribeStacksRequest.builder()

Parameters:

describeStacksRequest - The consumer that will configure the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackRollbackComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackRollbackComplete(DescribeStacksRequest describeStacksRequest,
                                                                              WaiterOverrideConfiguration overrideConfig)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackRollbackComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeStacksRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackRollbackComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackRollbackComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest,
                                                                              Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackRollbackComplete is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder and instance of the override config builder

Parameters:

describeStacksRequest - The consumer that will configure the request to be used for polling

overrideConfig - The consumer that will configure the per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackUpdateComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackUpdateComplete(DescribeStacksRequest describeStacksRequest)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackUpdateComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeStacksRequest - the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackUpdateComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackUpdateComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackUpdateComplete is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder without the need to create one manually using DescribeStacksRequest.builder()

Parameters:

describeStacksRequest - The consumer that will configure the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackUpdateComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackUpdateComplete(DescribeStacksRequest describeStacksRequest,
                                                                            WaiterOverrideConfiguration overrideConfig)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackUpdateComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeStacksRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilStackUpdateComplete

default WaiterResponse<DescribeStacksResponse> waitUntilStackUpdateComplete(Consumer<DescribeStacksRequest.Builder> describeStacksRequest,
                                                                            Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls CloudFormationClient.describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) API until the desired condition StackUpdateComplete is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder and instance of the override config builder

Parameters:

describeStacksRequest - The consumer that will configure the request to be used for polling

overrideConfig - The consumer that will configure the per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilTypeRegistrationComplete

default WaiterResponse<DescribeTypeRegistrationResponse> waitUntilTypeRegistrationComplete(DescribeTypeRegistrationRequest describeTypeRegistrationRequest)

Polls CloudFormationClient.describeTypeRegistration(software.amazon.awssdk.services.cloudformation.model.DescribeTypeRegistrationRequest) API until the desired condition TypeRegistrationComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeTypeRegistrationRequest - the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilTypeRegistrationComplete

default WaiterResponse<DescribeTypeRegistrationResponse> waitUntilTypeRegistrationComplete(Consumer<DescribeTypeRegistrationRequest.Builder> describeTypeRegistrationRequest)

Polls CloudFormationClient.describeTypeRegistration(software.amazon.awssdk.services.cloudformation.model.DescribeTypeRegistrationRequest) API until the desired condition TypeRegistrationComplete is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder without the need to create one manually using DescribeTypeRegistrationRequest.builder()

Parameters:

describeTypeRegistrationRequest - The consumer that will configure the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilTypeRegistrationComplete

default WaiterResponse<DescribeTypeRegistrationResponse> waitUntilTypeRegistrationComplete(DescribeTypeRegistrationRequest describeTypeRegistrationRequest,
                                                                                           WaiterOverrideConfiguration overrideConfig)

Polls CloudFormationClient.describeTypeRegistration(software.amazon.awssdk.services.cloudformation.model.DescribeTypeRegistrationRequest) API until the desired condition TypeRegistrationComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeTypeRegistrationRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilTypeRegistrationComplete

default WaiterResponse<DescribeTypeRegistrationResponse> waitUntilTypeRegistrationComplete(Consumer<DescribeTypeRegistrationRequest.Builder> describeTypeRegistrationRequest,
                                                                                           Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls CloudFormationClient.describeTypeRegistration(software.amazon.awssdk.services.cloudformation.model.DescribeTypeRegistrationRequest) API until the desired condition TypeRegistrationComplete is met, or until it is determined that the resource will never enter into the desired state.

This is a convenience method to create an instance of the request builder and instance of the override config builder

Parameters:

describeTypeRegistrationRequest - The consumer that will configure the request to be used for polling

overrideConfig - The consumer that will configure the per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

builder

static CloudFormationWaiter.Builder builder()

Create a builder that can be used to configure and create a CloudFormationWaiter.

Returns:

a builder

create

static CloudFormationWaiter create()

Create an instance of CloudFormationWaiter with the default configuration.

A default CloudFormationClient will be created to poll resources. It is recommended to share a single instance of the waiter created via this method. If it is not desirable to share a waiter instance, invoke SdkAutoCloseable.close() to release the resources once the waiter is not needed.

Returns:

an instance of CloudFormationWaiter