Package software.amazon.awssdk.services.cloudfront.waiters

Interface CloudFrontWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
@Immutable
public interface CloudFrontWaiter
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	CloudFrontWaiter.Builder

Method Summary

Modifier and Type	Method	Description
static CloudFrontWaiter.Builder	builder()	Create a builder that can be used to configure and create a CloudFrontWaiter.
static CloudFrontWaiter	create()	Create an instance of CloudFrontWaiter with the default configuration.
default WaiterResponse<GetDistributionResponse>	waitUntilDistributionDeployed(Consumer<GetDistributionRequest.Builder> getDistributionRequest)	Polls CloudFrontClient.getDistribution(software.amazon.awssdk.services.cloudfront.model.GetDistributionRequest) API until the desired condition DistributionDeployed is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetDistributionResponse>	waitUntilDistributionDeployed(Consumer<GetDistributionRequest.Builder> getDistributionRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls CloudFrontClient.getDistribution(software.amazon.awssdk.services.cloudfront.model.GetDistributionRequest) API until the desired condition DistributionDeployed is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetDistributionResponse>	waitUntilDistributionDeployed(GetDistributionRequest getDistributionRequest)	Polls CloudFrontClient.getDistribution(software.amazon.awssdk.services.cloudfront.model.GetDistributionRequest) API until the desired condition DistributionDeployed is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetDistributionResponse>	waitUntilDistributionDeployed(GetDistributionRequest getDistributionRequest, WaiterOverrideConfiguration overrideConfig)	Polls CloudFrontClient.getDistribution(software.amazon.awssdk.services.cloudfront.model.GetDistributionRequest) API until the desired condition DistributionDeployed is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetInvalidationResponse>	waitUntilInvalidationCompleted(Consumer<GetInvalidationRequest.Builder> getInvalidationRequest)	Polls CloudFrontClient.getInvalidation(software.amazon.awssdk.services.cloudfront.model.GetInvalidationRequest) API until the desired condition InvalidationCompleted is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetInvalidationResponse>	waitUntilInvalidationCompleted(Consumer<GetInvalidationRequest.Builder> getInvalidationRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls CloudFrontClient.getInvalidation(software.amazon.awssdk.services.cloudfront.model.GetInvalidationRequest) API until the desired condition InvalidationCompleted is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetInvalidationResponse>	waitUntilInvalidationCompleted(GetInvalidationRequest getInvalidationRequest)	Polls CloudFrontClient.getInvalidation(software.amazon.awssdk.services.cloudfront.model.GetInvalidationRequest) API until the desired condition InvalidationCompleted is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetInvalidationResponse>	waitUntilInvalidationCompleted(GetInvalidationRequest getInvalidationRequest, WaiterOverrideConfiguration overrideConfig)	Polls CloudFrontClient.getInvalidation(software.amazon.awssdk.services.cloudfront.model.GetInvalidationRequest) API until the desired condition InvalidationCompleted is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetStreamingDistributionResponse>	waitUntilStreamingDistributionDeployed(Consumer<GetStreamingDistributionRequest.Builder> getStreamingDistributionRequest)	Polls CloudFrontClient.getStreamingDistribution(software.amazon.awssdk.services.cloudfront.model.GetStreamingDistributionRequest) API until the desired condition StreamingDistributionDeployed is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetStreamingDistributionResponse>	waitUntilStreamingDistributionDeployed(Consumer<GetStreamingDistributionRequest.Builder> getStreamingDistributionRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls CloudFrontClient.getStreamingDistribution(software.amazon.awssdk.services.cloudfront.model.GetStreamingDistributionRequest) API until the desired condition StreamingDistributionDeployed is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetStreamingDistributionResponse>	waitUntilStreamingDistributionDeployed(GetStreamingDistributionRequest getStreamingDistributionRequest)	Polls CloudFrontClient.getStreamingDistribution(software.amazon.awssdk.services.cloudfront.model.GetStreamingDistributionRequest) API until the desired condition StreamingDistributionDeployed is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetStreamingDistributionResponse>	waitUntilStreamingDistributionDeployed(GetStreamingDistributionRequest getStreamingDistributionRequest, WaiterOverrideConfiguration overrideConfig)	Polls CloudFrontClient.getStreamingDistribution(software.amazon.awssdk.services.cloudfront.model.GetStreamingDistributionRequest) API until the desired condition StreamingDistributionDeployed 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

waitUntilDistributionDeployed

default WaiterResponse<GetDistributionResponse> waitUntilDistributionDeployed(GetDistributionRequest getDistributionRequest)

Polls CloudFrontClient.getDistribution(software.amazon.awssdk.services.cloudfront.model.GetDistributionRequest) API until the desired condition DistributionDeployed is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getDistributionRequest - the request to be used for polling

Returns:

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

waitUntilDistributionDeployed

default WaiterResponse<GetDistributionResponse> waitUntilDistributionDeployed(Consumer<GetDistributionRequest.Builder> getDistributionRequest)

Polls CloudFrontClient.getDistribution(software.amazon.awssdk.services.cloudfront.model.GetDistributionRequest) API until the desired condition DistributionDeployed 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 GetDistributionRequest.builder()

Parameters:

getDistributionRequest - 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

waitUntilDistributionDeployed

default WaiterResponse<GetDistributionResponse> waitUntilDistributionDeployed(GetDistributionRequest getDistributionRequest,
                                                                              WaiterOverrideConfiguration overrideConfig)

Polls CloudFrontClient.getDistribution(software.amazon.awssdk.services.cloudfront.model.GetDistributionRequest) API until the desired condition DistributionDeployed is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getDistributionRequest - 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

waitUntilDistributionDeployed

default WaiterResponse<GetDistributionResponse> waitUntilDistributionDeployed(Consumer<GetDistributionRequest.Builder> getDistributionRequest,
                                                                              Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls CloudFrontClient.getDistribution(software.amazon.awssdk.services.cloudfront.model.GetDistributionRequest) API until the desired condition DistributionDeployed 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:

getDistributionRequest - 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

waitUntilInvalidationCompleted

default WaiterResponse<GetInvalidationResponse> waitUntilInvalidationCompleted(GetInvalidationRequest getInvalidationRequest)

Polls CloudFrontClient.getInvalidation(software.amazon.awssdk.services.cloudfront.model.GetInvalidationRequest) API until the desired condition InvalidationCompleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getInvalidationRequest - the request to be used for polling

Returns:

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

waitUntilInvalidationCompleted

default WaiterResponse<GetInvalidationResponse> waitUntilInvalidationCompleted(Consumer<GetInvalidationRequest.Builder> getInvalidationRequest)

Polls CloudFrontClient.getInvalidation(software.amazon.awssdk.services.cloudfront.model.GetInvalidationRequest) API until the desired condition InvalidationCompleted 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 GetInvalidationRequest.builder()

Parameters:

getInvalidationRequest - 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

waitUntilInvalidationCompleted

default WaiterResponse<GetInvalidationResponse> waitUntilInvalidationCompleted(GetInvalidationRequest getInvalidationRequest,
                                                                               WaiterOverrideConfiguration overrideConfig)

Polls CloudFrontClient.getInvalidation(software.amazon.awssdk.services.cloudfront.model.GetInvalidationRequest) API until the desired condition InvalidationCompleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getInvalidationRequest - 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

waitUntilInvalidationCompleted

default WaiterResponse<GetInvalidationResponse> waitUntilInvalidationCompleted(Consumer<GetInvalidationRequest.Builder> getInvalidationRequest,
                                                                               Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls CloudFrontClient.getInvalidation(software.amazon.awssdk.services.cloudfront.model.GetInvalidationRequest) API until the desired condition InvalidationCompleted 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:

getInvalidationRequest - 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

waitUntilStreamingDistributionDeployed

default WaiterResponse<GetStreamingDistributionResponse> waitUntilStreamingDistributionDeployed(GetStreamingDistributionRequest getStreamingDistributionRequest)

Polls CloudFrontClient.getStreamingDistribution(software.amazon.awssdk.services.cloudfront.model.GetStreamingDistributionRequest) API until the desired condition StreamingDistributionDeployed is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getStreamingDistributionRequest - the request to be used for polling

Returns:

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

waitUntilStreamingDistributionDeployed

default WaiterResponse<GetStreamingDistributionResponse> waitUntilStreamingDistributionDeployed(Consumer<GetStreamingDistributionRequest.Builder> getStreamingDistributionRequest)

Polls CloudFrontClient.getStreamingDistribution(software.amazon.awssdk.services.cloudfront.model.GetStreamingDistributionRequest) API until the desired condition StreamingDistributionDeployed 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 GetStreamingDistributionRequest.builder()

Parameters:

getStreamingDistributionRequest - 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

waitUntilStreamingDistributionDeployed

default WaiterResponse<GetStreamingDistributionResponse> waitUntilStreamingDistributionDeployed(GetStreamingDistributionRequest getStreamingDistributionRequest,
                                                                                                WaiterOverrideConfiguration overrideConfig)

Polls CloudFrontClient.getStreamingDistribution(software.amazon.awssdk.services.cloudfront.model.GetStreamingDistributionRequest) API until the desired condition StreamingDistributionDeployed is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getStreamingDistributionRequest - 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

waitUntilStreamingDistributionDeployed

default WaiterResponse<GetStreamingDistributionResponse> waitUntilStreamingDistributionDeployed(Consumer<GetStreamingDistributionRequest.Builder> getStreamingDistributionRequest,
                                                                                                Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls CloudFrontClient.getStreamingDistribution(software.amazon.awssdk.services.cloudfront.model.GetStreamingDistributionRequest) API until the desired condition StreamingDistributionDeployed 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:

getStreamingDistributionRequest - 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 CloudFrontWaiter.Builder builder()

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

Returns:

a builder

create

static CloudFrontWaiter create()

Create an instance of CloudFrontWaiter with the default configuration.

A default CloudFrontClient 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 CloudFrontWaiter