Package software.amazon.awssdk.services.acmpca.waiters

Interface AcmPcaWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
static AcmPcaWaiter.Builder	builder()	Create a builder that can be used to configure and create a AcmPcaWaiter.
static AcmPcaWaiter	create()	Create an instance of AcmPcaWaiter with the default configuration.
default WaiterResponse<DescribeCertificateAuthorityAuditReportResponse>	waitUntilAuditReportCreated(Consumer<DescribeCertificateAuthorityAuditReportRequest.Builder> describeCertificateAuthorityAuditReportRequest)	Polls AcmPcaClient.describeCertificateAuthorityAuditReport(software.amazon.awssdk.services.acmpca.model.DescribeCertificateAuthorityAuditReportRequest) API until the desired condition AuditReportCreated is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeCertificateAuthorityAuditReportResponse>	waitUntilAuditReportCreated(Consumer<DescribeCertificateAuthorityAuditReportRequest.Builder> describeCertificateAuthorityAuditReportRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls AcmPcaClient.describeCertificateAuthorityAuditReport(software.amazon.awssdk.services.acmpca.model.DescribeCertificateAuthorityAuditReportRequest) API until the desired condition AuditReportCreated is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeCertificateAuthorityAuditReportResponse>	waitUntilAuditReportCreated(DescribeCertificateAuthorityAuditReportRequest describeCertificateAuthorityAuditReportRequest)	Polls AcmPcaClient.describeCertificateAuthorityAuditReport(software.amazon.awssdk.services.acmpca.model.DescribeCertificateAuthorityAuditReportRequest) API until the desired condition AuditReportCreated is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeCertificateAuthorityAuditReportResponse>	waitUntilAuditReportCreated(DescribeCertificateAuthorityAuditReportRequest describeCertificateAuthorityAuditReportRequest, WaiterOverrideConfiguration overrideConfig)	Polls AcmPcaClient.describeCertificateAuthorityAuditReport(software.amazon.awssdk.services.acmpca.model.DescribeCertificateAuthorityAuditReportRequest) API until the desired condition AuditReportCreated is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetCertificateAuthorityCsrResponse>	waitUntilCertificateAuthorityCSRCreated(Consumer<GetCertificateAuthorityCsrRequest.Builder> getCertificateAuthorityCsrRequest)	Polls AcmPcaClient.getCertificateAuthorityCsr(software.amazon.awssdk.services.acmpca.model.GetCertificateAuthorityCsrRequest) API until the desired condition CertificateAuthorityCSRCreated is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetCertificateAuthorityCsrResponse>	waitUntilCertificateAuthorityCSRCreated(Consumer<GetCertificateAuthorityCsrRequest.Builder> getCertificateAuthorityCsrRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls AcmPcaClient.getCertificateAuthorityCsr(software.amazon.awssdk.services.acmpca.model.GetCertificateAuthorityCsrRequest) API until the desired condition CertificateAuthorityCSRCreated is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetCertificateAuthorityCsrResponse>	waitUntilCertificateAuthorityCSRCreated(GetCertificateAuthorityCsrRequest getCertificateAuthorityCsrRequest)	Polls AcmPcaClient.getCertificateAuthorityCsr(software.amazon.awssdk.services.acmpca.model.GetCertificateAuthorityCsrRequest) API until the desired condition CertificateAuthorityCSRCreated is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetCertificateAuthorityCsrResponse>	waitUntilCertificateAuthorityCSRCreated(GetCertificateAuthorityCsrRequest getCertificateAuthorityCsrRequest, WaiterOverrideConfiguration overrideConfig)	Polls AcmPcaClient.getCertificateAuthorityCsr(software.amazon.awssdk.services.acmpca.model.GetCertificateAuthorityCsrRequest) API until the desired condition CertificateAuthorityCSRCreated is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetCertificateResponse>	waitUntilCertificateIssued(Consumer<GetCertificateRequest.Builder> getCertificateRequest)	Polls AcmPcaClient.getCertificate(software.amazon.awssdk.services.acmpca.model.GetCertificateRequest) API until the desired condition CertificateIssued is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetCertificateResponse>	waitUntilCertificateIssued(Consumer<GetCertificateRequest.Builder> getCertificateRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls AcmPcaClient.getCertificate(software.amazon.awssdk.services.acmpca.model.GetCertificateRequest) API until the desired condition CertificateIssued is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetCertificateResponse>	waitUntilCertificateIssued(GetCertificateRequest getCertificateRequest)	Polls AcmPcaClient.getCertificate(software.amazon.awssdk.services.acmpca.model.GetCertificateRequest) API until the desired condition CertificateIssued is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetCertificateResponse>	waitUntilCertificateIssued(GetCertificateRequest getCertificateRequest, WaiterOverrideConfiguration overrideConfig)	Polls AcmPcaClient.getCertificate(software.amazon.awssdk.services.acmpca.model.GetCertificateRequest) API until the desired condition CertificateIssued 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

waitUntilAuditReportCreated

default WaiterResponse<DescribeCertificateAuthorityAuditReportResponse> waitUntilAuditReportCreated(DescribeCertificateAuthorityAuditReportRequest describeCertificateAuthorityAuditReportRequest)

Polls AcmPcaClient.describeCertificateAuthorityAuditReport(software.amazon.awssdk.services.acmpca.model.DescribeCertificateAuthorityAuditReportRequest) API until the desired condition AuditReportCreated is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeCertificateAuthorityAuditReportRequest - the request to be used for polling

Returns:

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

waitUntilAuditReportCreated

default WaiterResponse<DescribeCertificateAuthorityAuditReportResponse> waitUntilAuditReportCreated(Consumer<DescribeCertificateAuthorityAuditReportRequest.Builder> describeCertificateAuthorityAuditReportRequest)

Polls AcmPcaClient.describeCertificateAuthorityAuditReport(software.amazon.awssdk.services.acmpca.model.DescribeCertificateAuthorityAuditReportRequest) API until the desired condition AuditReportCreated 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 DescribeCertificateAuthorityAuditReportRequest.builder()

Parameters:

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

waitUntilAuditReportCreated

default WaiterResponse<DescribeCertificateAuthorityAuditReportResponse> waitUntilAuditReportCreated(DescribeCertificateAuthorityAuditReportRequest describeCertificateAuthorityAuditReportRequest,
                                                                                                    WaiterOverrideConfiguration overrideConfig)

Polls AcmPcaClient.describeCertificateAuthorityAuditReport(software.amazon.awssdk.services.acmpca.model.DescribeCertificateAuthorityAuditReportRequest) API until the desired condition AuditReportCreated is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilAuditReportCreated

default WaiterResponse<DescribeCertificateAuthorityAuditReportResponse> waitUntilAuditReportCreated(Consumer<DescribeCertificateAuthorityAuditReportRequest.Builder> describeCertificateAuthorityAuditReportRequest,
                                                                                                    Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls AcmPcaClient.describeCertificateAuthorityAuditReport(software.amazon.awssdk.services.acmpca.model.DescribeCertificateAuthorityAuditReportRequest) API until the desired condition AuditReportCreated 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:

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

waitUntilCertificateAuthorityCSRCreated

default WaiterResponse<GetCertificateAuthorityCsrResponse> waitUntilCertificateAuthorityCSRCreated(GetCertificateAuthorityCsrRequest getCertificateAuthorityCsrRequest)

Polls AcmPcaClient.getCertificateAuthorityCsr(software.amazon.awssdk.services.acmpca.model.GetCertificateAuthorityCsrRequest) API until the desired condition CertificateAuthorityCSRCreated is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getCertificateAuthorityCsrRequest - the request to be used for polling

Returns:

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

waitUntilCertificateAuthorityCSRCreated

default WaiterResponse<GetCertificateAuthorityCsrResponse> waitUntilCertificateAuthorityCSRCreated(Consumer<GetCertificateAuthorityCsrRequest.Builder> getCertificateAuthorityCsrRequest)

Polls AcmPcaClient.getCertificateAuthorityCsr(software.amazon.awssdk.services.acmpca.model.GetCertificateAuthorityCsrRequest) API until the desired condition CertificateAuthorityCSRCreated 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 GetCertificateAuthorityCsrRequest.builder()

Parameters:

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

waitUntilCertificateAuthorityCSRCreated

default WaiterResponse<GetCertificateAuthorityCsrResponse> waitUntilCertificateAuthorityCSRCreated(GetCertificateAuthorityCsrRequest getCertificateAuthorityCsrRequest,
                                                                                                   WaiterOverrideConfiguration overrideConfig)

Polls AcmPcaClient.getCertificateAuthorityCsr(software.amazon.awssdk.services.acmpca.model.GetCertificateAuthorityCsrRequest) API until the desired condition CertificateAuthorityCSRCreated is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilCertificateAuthorityCSRCreated

default WaiterResponse<GetCertificateAuthorityCsrResponse> waitUntilCertificateAuthorityCSRCreated(Consumer<GetCertificateAuthorityCsrRequest.Builder> getCertificateAuthorityCsrRequest,
                                                                                                   Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls AcmPcaClient.getCertificateAuthorityCsr(software.amazon.awssdk.services.acmpca.model.GetCertificateAuthorityCsrRequest) API until the desired condition CertificateAuthorityCSRCreated 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:

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

waitUntilCertificateIssued

default WaiterResponse<GetCertificateResponse> waitUntilCertificateIssued(GetCertificateRequest getCertificateRequest)

Polls AcmPcaClient.getCertificate(software.amazon.awssdk.services.acmpca.model.GetCertificateRequest) API until the desired condition CertificateIssued is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getCertificateRequest - the request to be used for polling

Returns:

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

waitUntilCertificateIssued

default WaiterResponse<GetCertificateResponse> waitUntilCertificateIssued(Consumer<GetCertificateRequest.Builder> getCertificateRequest)

Polls AcmPcaClient.getCertificate(software.amazon.awssdk.services.acmpca.model.GetCertificateRequest) API until the desired condition CertificateIssued 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 GetCertificateRequest.builder()

Parameters:

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

waitUntilCertificateIssued

default WaiterResponse<GetCertificateResponse> waitUntilCertificateIssued(GetCertificateRequest getCertificateRequest,
                                                                          WaiterOverrideConfiguration overrideConfig)

Polls AcmPcaClient.getCertificate(software.amazon.awssdk.services.acmpca.model.GetCertificateRequest) API until the desired condition CertificateIssued is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilCertificateIssued

default WaiterResponse<GetCertificateResponse> waitUntilCertificateIssued(Consumer<GetCertificateRequest.Builder> getCertificateRequest,
                                                                          Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls AcmPcaClient.getCertificate(software.amazon.awssdk.services.acmpca.model.GetCertificateRequest) API until the desired condition CertificateIssued 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:

getCertificateRequest - 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 AcmPcaWaiter.Builder builder()

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

Returns:

a builder

create

static AcmPcaWaiter create()

Create an instance of AcmPcaWaiter with the default configuration.

A default AcmPcaClient 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 AcmPcaWaiter