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

Inherits:

Object

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

Defined in:

lib/aws-sdk-dsql/waiters.rb,
sig/waiters.rbs

Overview

Wait until a Stream is ACTIVE

Instance Attribute Summary

• #waiter ⇒ Object readonly private

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 'lib/aws-sdk-dsql/waiters.rb', line 161

def initialize: (?client: Client, ?max_attempts: Integer, ?delay: Integer, ?before_attempt: Proc, ?before_wait: Proc) -> void
| (?Hash[Symbol, untyped]) -> void

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-dsql/waiters.rb', line 185

def waiter
  @waiter
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>

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 'lib/aws-sdk-dsql/waiters.rb', line 180

def wait: (