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

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

Instance Attribute Summary collapse

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) 


84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/aws-sdk-acm/waiters.rb', line 84

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



127
128
129
 
# File 'lib/aws-sdk-acm/waiters.rb', line 127

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

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)].

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:



122
123
124
 
# File 'lib/aws-sdk-acm/waiters.rb', line 122

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