Class: Aws::ElastiCache::Waiters::ReplicationGroupDeleted

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

Overview

Wait until ElastiCache replication group is deleted.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ReplicationGroupDeleted

Returns a new instance of ReplicationGroupDeleted.

Parameters:

  • options (Hash)

Options Hash (options):

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


276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/aws-sdk-elasticache/waiters.rb', line 276

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 40,
    delay: 15,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_replication_groups,
      acceptors: [
        {
          "argument" => "replication_groups[].status",
          "expected" => "deleted",
          "matcher" => "pathAll",
          "state" => "success"
        },
        {
          "argument" => "replication_groups[].status",
          "expected" => "available",
          "matcher" => "pathAny",
          "state" => "failure"
        },
        {
          "expected" => "ReplicationGroupNotFoundFault",
          "matcher" => "error",
          "state" => "success"
        }
      ]
    )
  }.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. 



313
314
315
 
# File 'lib/aws-sdk-elasticache/waiters.rb', line 313

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :replication_group_id (String) —

    The identifier for the replication group to be described. This parameter is not case sensitive.

    If you do not specify this parameter, information about all replication groups is returned.

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, 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 marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

Returns:



308
309
310
 
# File 'lib/aws-sdk-elasticache/waiters.rb', line 308

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