Class: Aws::MediaLive::Waiters::ClusterCreated

Inherits:

Object

• Object
• Aws::MediaLive::Waiters::ClusterCreated

Defined in:

lib/aws-sdk-medialive/waiters.rb

Overview

Wait until a cluster has been created

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ ClusterCreated constructor

  A new instance of ClusterCreated.

• #wait(params = {}) ⇒ Types::DescribeClusterResponse

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ ClusterCreated

Returns a new instance of ClusterCreated.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-medialive/waiters.rb', line 462

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 5,
    delay: 3,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_cluster,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "ACTIVE"
        },
        {
          "state" => "retry",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "CREATING"
        },
        {
          "state" => "retry",
          "matcher" => "status",
          "expected" => 500
        },
        {
          "state" => "failure",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "CREATE_FAILED"
        }
      ]
    )
  }.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.

# File 'lib/aws-sdk-medialive/waiters.rb', line 505

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #arn => String

• #channel_ids => Array<String>

• #cluster_type => String

• #id => String

• #instance_role_arn => String

• #name => String

• #network_settings => Types::ClusterNetworkSettings

• #state => String

Options Hash (params):

• :cluster_id (required, String)

Returns:

• (Types::DescribeClusterResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #channel_ids => Array<String>

  • #cluster_type => String

  • #id => String

  • #instance_role_arn => String

  • #name => String

  • #network_settings => Types::ClusterNetworkSettings

  • #state => String

# File 'lib/aws-sdk-medialive/waiters.rb', line 500

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