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,
  dbi_resource_id: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_instance_identifierString

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with `DBSnapshotIdentifier`. This parameter isn't case-sensitive.

Constraints:

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

^

Returns:

  • (String)

11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
# File 'lib/aws-sdk-rds/types.rb', line 11723

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

#db_snapshot_identifierString

A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with `DBInstanceIdentifier`. 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.

Returns:

  • (String)

11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
# File 'lib/aws-sdk-rds/types.rb', line 11723

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

#dbi_resource_idString

A specific DB resource ID to describe.

Returns:

  • (String)

11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
# File 'lib/aws-sdk-rds/types.rb', line 11723

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

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

Returns:


11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
# File 'lib/aws-sdk-rds/types.rb', line 11723

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

#include_publicBoolean

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.

Returns:

  • (Boolean)

11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
# File 'lib/aws-sdk-rds/types.rb', line 11723

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

#include_sharedBoolean

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.

Returns:

  • (Boolean)

11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
# File 'lib/aws-sdk-rds/types.rb', line 11723

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

#markerString

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)

11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
# File 'lib/aws-sdk-rds/types.rb', line 11723

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

#max_recordsInteger

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.

Returns:

  • (Integer)

11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
# File 'lib/aws-sdk-rds/types.rb', line 11723

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

#snapshot_typeString

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

Returns:

  • (String)

11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
# File 'lib/aws-sdk-rds/types.rb', line 11723

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