Class: Aws::RDS::Waiters::DBSnapshotAvailable

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ DBSnapshotAvailable

Returns a new instance of DBSnapshotAvailable.

Parameters:

  • options (Hash)

Options Hash (options):

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

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
# File 'lib/aws-sdk-rds/waiters.rb', line 496

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

Instance Attribute Details

#waiterObject (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.


552
553
554
# File 'lib/aws-sdk-rds/waiters.rb', line 552

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :db_instance_identifier (String)

    The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.

    Constraints:

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

    ^

  • :db_snapshot_identifier (String)

    A specific DB snapshot identifier to describe. This value is stored as a lowercase string.

    Constraints:

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

    • If this identifier is for an automated snapshot, the `SnapshotType` parameter must also be specified.

  • :snapshot_type (String)

    The type of snapshots to be returned. You can specify one of the following values:

    • `automated` - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

    • `manual` - Return all DB snapshots that have been taken by my Amazon Web Services account.

    • `shared` - Return all manual DB snapshots that have been shared to my Amazon Web Services account.

    • `public` - Return all DB snapshots that have been marked as public.

    • `awsbackup` - Return the DB snapshots managed by the Amazon Web Services Backup service.

      For information about Amazon Web Services Backup, see the [ *Amazon Web Services Backup Developer Guide.* ][1]

      The `awsbackup` type does not apply to Aurora.

    If you don't specify a `SnapshotType` value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the `IncludeShared` parameter. You can include public snapshots with these results by enabling the `IncludePublic` parameter.

    The `IncludeShared` and `IncludePublic` parameters don't apply for `SnapshotType` values of `manual` or `automated`. The `IncludePublic` parameter doesn't apply when `SnapshotType` is set to `shared`. The `IncludeShared` parameter doesn't apply when `SnapshotType` is set to `public`.

    [1]: docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html

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

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

    Supported filters:

    • `db-instance-id` - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

    • `db-snapshot-id` - Accepts DB snapshot identifiers.

    • `dbi-resource-id` - Accepts identifiers of source DB instances.

    • `snapshot-type` - Accepts types of DB snapshots.

    • `engine` - Accepts names of database 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 `DescribeDBSnapshots` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.

  • :include_shared (Boolean)

    A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

    You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the `ModifyDBSnapshotAttribute` API action.

    This setting doesn't apply to RDS Custom.

  • :include_public (Boolean)

    A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

    You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

    This setting doesn't apply to RDS Custom.

  • :dbi_resource_id (String)

    A specific DB resource ID to describe.

Returns:


547
548
549
# File 'lib/aws-sdk-rds/waiters.rb', line 547

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