Class: Aws::ACMPCA::Waiters::CertificateAuthorityCSRCreated

Inherits:

Object

• Object
• Aws::ACMPCA::Waiters::CertificateAuthorityCSRCreated

Defined in:

lib/aws-sdk-acmpca/waiters.rb

Overview

Wait until a Certificate Authority CSR is created

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ CertificateAuthorityCSRCreated constructor

  A new instance of CertificateAuthorityCSRCreated.

• #wait(params = {}) ⇒ Types::GetCertificateAuthorityCsrResponse

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ CertificateAuthorityCSRCreated

Returns a new instance of CertificateAuthorityCSRCreated.

Parameters:

• options (Hash)

Options Hash (options):

• :client (required, Client)
• :max_attempts (Integer) — default: 60
• :delay (Integer) — default: 3
• :before_attempt (Proc)
• :before_wait (Proc)

# File 'lib/aws-sdk-acmpca/waiters.rb', line 137

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    delay: 3,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_certificate_authority_csr,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "status",
          "expected" => 200
        },
        {
          "state" => "retry",
          "matcher" => "error",
          "expected" => "RequestInProgressException"
        },
        {
          "state" => "failure",
          "matcher" => "error",
          "expected" => "AccessDeniedException"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiter ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-acmpca/waiters.rb', line 172

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ Types::GetCertificateAuthorityCsrResponse

Returns a response object which responds to the following methods:

• #csr => String

Options Hash (params):

• :certificate_authority_arn (required, String) —

  The Amazon Resource Name (ARN) that was returned when you called the

  CreateCertificateAuthority][1

  action. This must be of the form:

  ‘arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 `

  [1]: docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html

Returns:

• (Types::GetCertificateAuthorityCsrResponse) —

  Returns a response object which responds to the following methods:

  • #csr => String

# File 'lib/aws-sdk-acmpca/waiters.rb', line 167

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end