Class: Aws::CloudFront::Waiters::InvalidationCompleted

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

Overview

Wait until an invalidation has completed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ InvalidationCompleted

Returns a new instance of InvalidationCompleted.

Parameters:

  • options (Hash)

Options Hash (options):

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

124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/aws-sdk-cloudfront/waiters.rb', line 124

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 30,
    delay: 20,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_invalidation,
      acceptors: [{
        "expected" => "Completed",
        "matcher" => "path",
        "state" => "success",
        "argument" => "invalidation.status"
      }]
    )
  }.merge(options))
end

Instance Attribute Details

#waiterObject (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.


148
149
150
# File 'lib/aws-sdk-cloudfront/waiters.rb', line 148

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :distribution_id (required, String)

    The distribution's ID.

  • :id (required, String)

    The identifier for the invalidation request, for example, `IDFDVBD632BHDS5`.

Returns:


143
144
145
# File 'lib/aws-sdk-cloudfront/waiters.rb', line 143

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