Class: Aws::DSQL::Waiters::StreamActive

Inherits:

Object

• Object
• Aws::DSQL::Waiters::StreamActive

Defined in:

gems/aws-sdk-dsql/lib/aws-sdk-dsql/waiters.rb

Overview

Wait until a Stream is ACTIVE

Instance Method Summary

• #initialize(options) ⇒ StreamActive constructor

  A new instance of StreamActive.

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

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

Constructor Details

#initialize(options) ⇒ StreamActive

Returns a new instance of StreamActive.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/waiters.rb', line 161

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

Instance Method Details

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

Returns a response object which responds to the following methods:

• #cluster_identifier => String
• #stream_identifier => String
• #arn => String
• #status => String
• #creation_time => Time
• #ordering => String
• #format => String
• #target_definition => Types::TargetDefinition
• #status_reason => Types::StatusReason
• #tags => Hash<String,String>

Parameters:

• params (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (params):

• :cluster_identifier (required, String) —

  The ID of the cluster containing the stream to retrieve.

• :stream_identifier (required, String) —

  The ID of the stream to retrieve.

Returns:

• (Types::GetStreamOutput) —

  Returns a response object which responds to the following methods:

  • #cluster_identifier => String
  • #stream_identifier => String
  • #arn => String
  • #status => String
  • #creation_time => Time
  • #ordering => String
  • #format => String
  • #target_definition => Types::TargetDefinition
  • #status_reason => Types::StatusReason
  • #tags => Hash<String,String>

# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/waiters.rb', line 180

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