Class: Aws::DatabaseMigrationService::Waiters::EndpointDeleted

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

Overview

Wait until testing endpoint is deleted.

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ EndpointDeleted

Returns a new instance of EndpointDeleted.

Parameters:

  • options (Hash)

Options Hash (options):

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


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/waiters.rb', line 92

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_endpoints,
      acceptors: [
        {
          "expected" => "ResourceNotFoundFault",
          "matcher" => "error",
          "state" => "success"
        },
        {
          "argument" => "endpoints[].status",
          "expected" => "active",
          "matcher" => "pathAny",
          "state" => "failure"
        },
        {
          "argument" => "endpoints[].status",
          "expected" => "creating",
          "matcher" => "pathAny",
          "state" => "failure"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

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>) —

    Filters applied to the endpoints.

    Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name

  • :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:



124
125
126
 
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/waiters.rb', line 124

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