Class: Aws::RDS::Types::DescribeDBSnapshotsMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass DescribeDBSnapshotsMessage data as a hash:

{
  db_instance_identifier: "String",
  db_snapshot_identifier: "String",
  snapshot_type: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
  include_shared: false,
  include_public: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#db_instance_identifier ⇒ String

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with ‘DBSnapshotIdentifier`. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Returns:

  • (String) 


6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
 
# File 'lib/aws-sdk-rds/types.rb', line 6555

class DescribeDBSnapshotsMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  include Aws::Structure
end

#db_snapshot_identifier ⇒ String

A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with ‘DBInstanceIdentifier`. This value is stored as a lowercase string.

Constraints:

  • Must be 1 to 255 alphanumeric characters.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

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

Returns:

  • (String) 


6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
 
# File 'lib/aws-sdk-rds/types.rb', line 6555

class DescribeDBSnapshotsMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

This parameter is not currently supported.

Returns:



6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
 
# File 'lib/aws-sdk-rds/types.rb', line 6555

class DescribeDBSnapshotsMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  include Aws::Structure
end

#include_public ⇒ Boolean

Set this value to ‘true` to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to `false`. The default is `false`.

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

Returns:

  • (Boolean) 


6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
 
# File 'lib/aws-sdk-rds/types.rb', line 6555

class DescribeDBSnapshotsMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  include Aws::Structure
end

#include_shared ⇒ Boolean

Set this value to ‘true` to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to `false`. The default is `false`.

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

Returns:

  • (Boolean) 


6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
 
# File 'lib/aws-sdk-rds/types.rb', line 6555

class DescribeDBSnapshotsMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  include Aws::Structure
end

#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`.

Returns:

  • (String) 


6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
 
# File 'lib/aws-sdk-rds/types.rb', line 6555

class DescribeDBSnapshotsMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  include Aws::Structure
end

#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 the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer) 


6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
 
# File 'lib/aws-sdk-rds/types.rb', line 6555

class DescribeDBSnapshotsMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  include Aws::Structure
end

#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 AWS account.

  • ‘manual` - Return all DB snapshots that have been taken by my AWS account.

  • ‘shared` - Return all manual DB snapshots that have been shared to my AWS account.

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

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 setting the `IncludeShared` parameter to `true`. You can include public snapshots with these results by setting the `IncludePublic` parameter to `true`.

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`.

Returns:

  • (String) 


6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
 
# File 'lib/aws-sdk-rds/types.rb', line 6555

class DescribeDBSnapshotsMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  include Aws::Structure
end