Class: Aws::CloudFront::Waiters::DistributionDeployed

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

Overview

Wait until a distribution is deployed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ DistributionDeployed

Returns a new instance of DistributionDeployed.

Parameters:

  • options (Hash)

Options Hash (options):

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

87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/aws-sdk-cloudfront/waiters.rb', line 87

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 35,
    delay: 60,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_distribution,
      acceptors: [{
        "expected" => "Deployed",
        "matcher" => "path",
        "state" => "success",
        "argument" => "distribution.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.


111
112
113
# File 'lib/aws-sdk-cloudfront/waiters.rb', line 111

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :id (required, String)

    The distribution's ID. If the ID is empty, an empty distribution configuration is returned.

Returns:


106
107
108
# File 'lib/aws-sdk-cloudfront/waiters.rb', line 106

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