Class: Aws::RDS::Waiters::DBInstanceAvailable

Inherits:

Object

• Object
• Aws::RDS::Waiters::DBInstanceAvailable

Defined in:

lib/aws-sdk-rds/waiters.rb

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ DBInstanceAvailable constructor

  A new instance of DBInstanceAvailable.

• #wait(params = {}) ⇒ Types::DBInstanceMessage

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ DBInstanceAvailable

Returns a new instance of DBInstanceAvailable.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-rds/waiters.rb', line 361

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_instances,
      acceptors: [
        {
          "expected" => "available",
          "matcher" => "pathAll",
          "state" => "success",
          "argument" => "db_instances[].db_instance_status"
        },
        {
          "expected" => "deleted",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "db_instances[].db_instance_status"
        },
        {
          "expected" => "deleting",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "db_instances[].db_instance_status"
        },
        {
          "expected" => "failed",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "db_instances[].db_instance_status"
        },
        {
          "expected" => "incompatible-restore",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "db_instances[].db_instance_status"
        },
        {
          "expected" => "incompatible-parameters",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "db_instances[].db_instance_status"
        }
      ]
    )
  }.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.

# File 'lib/aws-sdk-rds/waiters.rb', line 417

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #marker => String

• #db_instances => Array<Types::DBInstance>

Options Hash (params):

• :db_instance_identifier (String) —

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

  Constraints:

  • If supplied, must match the identifier of an existing DBInstance.

  ^

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

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

  Supported filters:

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

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

  • ‘dbi-resource-id` - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

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

  • ‘engine` - Accepts engine names. The results list only includes information about the DB instances 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 that you can retrieve the remaining results.

  Default: 100

  Constraints: Minimum 20, maximum 100.

• :marker (String) —

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

Returns:

• (Types::DBInstanceMessage) —

  Returns a response object which responds to the following methods:

  • #marker => String

  • #db_instances => Array&lt;Types::DBInstance&gt;

# File 'lib/aws-sdk-rds/waiters.rb', line 412

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