Class: Aws::ElastiCache::Waiters::CacheClusterDeleted

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

Overview

Wait until ElastiCache cluster is deleted.

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ CacheClusterDeleted

Returns a new instance of CacheClusterDeleted.

Parameters:

  • options (Hash)

Options Hash (options):

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


149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/waiters.rb', line 149

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_cache_clusters,
      acceptors: [
        {
          "argument" => "cache_clusters[].cache_cluster_status",
          "expected" => "deleted",
          "matcher" => "pathAll",
          "state" => "success"
        },
        {
          "expected" => "CacheClusterNotFound",
          "matcher" => "error",
          "state" => "success"
        },
        {
          "argument" => "cache_clusters[].cache_cluster_status",
          "expected" => "available",
          "matcher" => "pathAny",
          "state" => "failure"
        },
        {
          "argument" => "cache_clusters[].cache_cluster_status",
          "expected" => "creating",
          "matcher" => "pathAny",
          "state" => "failure"
        },
        {
          "argument" => "cache_clusters[].cache_cluster_status",
          "expected" => "incompatible-network",
          "matcher" => "pathAny",
          "state" => "failure"
        },
        {
          "argument" => "cache_clusters[].cache_cluster_status",
          "expected" => "modifying",
          "matcher" => "pathAny",
          "state" => "failure"
        },
        {
          "argument" => "cache_clusters[].cache_cluster_status",
          "expected" => "restore-failed",
          "matcher" => "pathAny",
          "state" => "failure"
        },
        {
          "argument" => "cache_clusters[].cache_cluster_status",
          "expected" => "snapshotting",
          "matcher" => "pathAny",
          "state" => "failure"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :cache_cluster_id (String)

    The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

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

  • :show_cache_node_info (Boolean)

    An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

  • :show_cache_clusters_not_in_replication_groups (Boolean)

    An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

Returns:



211
212
213
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/waiters.rb', line 211

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