You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ACM::Waiters::CertificateValidated

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-acm/lib/aws-sdk-acm/waiters.rb

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ CertificateValidated

Returns a new instance of CertificateValidated

Parameters:

  • options (Hash)

Options Hash (options):

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


21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/waiters.rb', line 21

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 40,
    delay: 60,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_certificate,
      acceptors: [
        {
          "matcher" => "pathAll",
          "expected" => "SUCCESS",
          "argument" => "certificate.domain_validation_options[].validation_status",
          "state" => "success"
        },
        {
          "matcher" => "pathAny",
          "expected" => "PENDING_VALIDATION",
          "argument" => "certificate.domain_validation_options[].validation_status",
          "state" => "retry"
        },
        {
          "matcher" => "path",
          "expected" => "FAILED",
          "argument" => "certificate.status",
          "state" => "failure"
        },
        {
          "matcher" => "error",
          "expected" => "ResourceNotFoundException",
          "state" => "failure"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

  • params (Hash) (defaults to: {})

    a customizable set of options

Options Hash (params):

  • :certificate_arn (required, String)

    The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Returns:



59
60
61
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/waiters.rb', line 59

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