Class: Aws::RDS::Waiters::DBClusterDeleted

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ DBClusterDeleted

Returns a new instance of DBClusterDeleted.

Parameters:

  • options (Hash)

Options Hash (options):

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


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
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/waiters.rb', line 159

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    delay: 30,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_db_clusters,
      acceptors: [
        {
          "expected" => true,
          "matcher" => "path",
          "state" => "success",
          "argument" => "length(db_clusters) == `0`"
        },
        {
          "expected" => "DBClusterNotFoundFault",
          "matcher" => "error",
          "state" => "success"
        },
        {
          "expected" => "creating",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "db_clusters[].status"
        },
        {
          "expected" => "modifying",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "db_clusters[].status"
        },
        {
          "expected" => "rebooting",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "db_clusters[].status"
        },
        {
          "expected" => "resetting-master-credentials",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "db_clusters[].status"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :db_cluster_identifier (String)

    The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

    Constraints:

    • If supplied, must match an existing DBClusterIdentifier.

    ^

  • :filters (Array<Types::Filter>)

    A filter that specifies one or more DB clusters to describe.

    Supported filters:

    • clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

    • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.

    • domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

    • engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

  • :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 you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • :marker (String)

    An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • :include_shared (Boolean)

    Optional Boolean parameter that specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

Returns:



209
210
211
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/waiters.rb', line 209

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