Class: Aws::CloudFront::Waiters::StreamingDistributionDeployed

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

Overview

Wait until a streaming distribution is deployed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ StreamingDistributionDeployed

Returns a new instance of StreamingDistributionDeployed.

Parameters:

  • options (Hash)

Options Hash (options):

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

161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/aws-sdk-cloudfront/waiters.rb', line 161

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


185
186
187
# File 'lib/aws-sdk-cloudfront/waiters.rb', line 185

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :id (required, String)

    The streaming distribution's ID.

Returns:


180
181
182
# File 'lib/aws-sdk-cloudfront/waiters.rb', line 180

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