Class: Aws::DatabaseMigrationService::Waiters::TestConnectionSucceeds

Inherits:

Object

• Object
• Aws::DatabaseMigrationService::Waiters::TestConnectionSucceeds

Defined in:

lib/aws-sdk-databasemigrationservice/waiters.rb

Overview

Wait until testing connection succeeds.

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ TestConnectionSucceeds constructor

  A new instance of TestConnectionSucceeds.

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

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

Constructor Details

#initialize(options) ⇒ TestConnectionSucceeds

Returns a new instance of TestConnectionSucceeds.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-databasemigrationservice/waiters.rb', line 986

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    delay: 5,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_connections,
      acceptors: [
        {
          "argument" => "connections[].status",
          "expected" => "successful",
          "matcher" => "pathAll",
          "state" => "success"
        },
        {
          "argument" => "connections[].status",
          "expected" => "failed",
          "matcher" => "pathAny",
          "state" => "failure"
        }
      ]
    )
  }.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-databasemigrationservice/waiters.rb', line 1018

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #marker => String

• #connections => Array<Types::Connection>

Options Hash (params):

• :filters (Array<Types::Filter>) —

  The filters applied to the connection.

  Valid filter names: endpoint-arn | replication-instance-arn

• :max_records (Integer) —

  The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

  Default: 100

  Constraints: Minimum 20, maximum 100.

• :marker (String) —

  An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

Returns:

• (Types::DescribeConnectionsResponse) —

  Returns a response object which responds to the following methods:

  • #marker => String

  • #connections => Array&lt;Types::Connection&gt;

# File 'lib/aws-sdk-databasemigrationservice/waiters.rb', line 1013

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