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

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/waiters.rb

Overview

Wait until testing connection succeeds.

Instance Method Summary collapse

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) 


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/waiters.rb', line 572

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 Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

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:



599
600
601
 
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/waiters.rb', line 599

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