Class: Aws::GameLiftStreams::Waiters::StreamGroupActive

Inherits:

Object

• Object
• Aws::GameLiftStreams::Waiters::StreamGroupActive

Defined in:

lib/aws-sdk-gameliftstreams/waiters.rb

Overview

Waits until a stream group is active

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ StreamGroupActive constructor

  A new instance of StreamGroupActive.

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

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

Constructor Details

#initialize(options) ⇒ StreamGroupActive

Returns a new instance of StreamGroupActive.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-gameliftstreams/waiters.rb', line 170

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 120,
    delay: 30,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_stream_group,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "ACTIVE"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "ERROR"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "ACTIVE_WITH_ERRORS"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "DELETING"
        }
      ]
    )
  }.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-gameliftstreams/waiters.rb', line 214

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #arn => String

• #description => String

• #default_application => Types::DefaultApplication

• #location_states => Array<Types::LocationState>

• #stream_class => String

• #id => String

• #status => String

• #status_reason => String

• #last_updated_at => Time

• #created_at => Time

• #expires_at => Time

• #associated_applications => Array<String>

Options Hash (params):

• :identifier (required, String) —

  An [Amazon Resource Name (ARN)] or ID that uniquely identifies the stream group resource. Example ARN: ‘arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`. Example ID: `sg-1AB2C3De4`.

  [1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html

Returns:

• (Types::GetStreamGroupOutput) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #description => String

  • #default_application => Types::DefaultApplication

  • #location_states => Array<Types::LocationState>

  • #stream_class => String

  • #id => String

  • #status => String

  • #status_reason => String

  • #last_updated_at => Time

  • #created_at => Time

  • #expires_at => Time

  • #associated_applications => Array<String>

# File 'lib/aws-sdk-gameliftstreams/waiters.rb', line 209

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