Class: Aws::RDS::Waiters::TenantDatabaseAvailable

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) ⇒ TenantDatabaseAvailable

Returns a new instance of TenantDatabaseAvailable.

Parameters:

  • options (Hash)

Options Hash (options):

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


633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/waiters.rb', line 633

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

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :db_instance_identifier (String) —

    The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn't case-sensitive.

  • :tenant_db_name (String) —

    The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case-sensitive.

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

    A filter that specifies one or more database tenants to describe.

    Supported filters:

    • tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.

    • tenant-database-resource-id - Tenant database resource identifiers.

    • dbi-resource-id - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.

  • :marker (String) —

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

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

Returns:



672
673
674
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/waiters.rb', line 672

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