You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElastiCache::Waiters::ReplicationGroupAvailable

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

Overview

Wait until ElastiCache replication group is available.

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ReplicationGroupAvailable

Returns a new instance of ReplicationGroupAvailable

Parameters:

  • options (Hash)

Options Hash (options):

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


165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/waiters.rb', line 165

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" => "available",
          "matcher" => "pathAll",
          "state" => "success"
        },
        {
          "argument" => "replication_groups[].status",
          "expected" => "deleted",
          "matcher" => "pathAny",
          "state" => "failure"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

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:



192
193
194
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/waiters.rb', line 192

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