Class: Aws::RDS::Types::DescribeDBClusterSnapshotsMessage

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 DescribeDBClusterSnapshotsMessage data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_identifierString

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

Constraints:

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

^

Returns:

  • (String)

10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
# File 'lib/aws-sdk-rds/types.rb', line 10473

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_snapshot_identifierString

A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the `DBClusterIdentifier` parameter. This value is stored as a lowercase string.

Constraints:

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

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

Returns:

  • (String)

10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
# File 'lib/aws-sdk-rds/types.rb', line 10473

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::Filter>

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

Supported filters:

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

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

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

  • `engine` - Accepts names of database engines.

Returns:


10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
# File 'lib/aws-sdk-rds/types.rb', line 10473

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  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 cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

Returns:

  • (Boolean)

10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
# File 'lib/aws-sdk-rds/types.rb', line 10473

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  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 cluster snapshot from another Amazon Web Services account by the `ModifyDBClusterSnapshotAttribute` API action.

Returns:

  • (Boolean)

10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
# File 'lib/aws-sdk-rds/types.rb', line 10473

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  SENSITIVE = []
  include Aws::Structure
end

#markerString

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

Returns:

  • (String)

10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
# File 'lib/aws-sdk-rds/types.rb', line 10473

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer)

10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
# File 'lib/aws-sdk-rds/types.rb', line 10473

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_typeString

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

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

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

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

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

If you don't specify a `SnapshotType` value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the `IncludeShared` parameter. You can include public DB cluster 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`.

Returns:

  • (String)

10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
# File 'lib/aws-sdk-rds/types.rb', line 10473

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  SENSITIVE = []
  include Aws::Structure
end