Class: Aws::RDS::Types::DescribeDBClusterSnapshotsMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::DescribeDBClusterSnapshotsMessage
- Defined in:
- gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#db_cluster_identifier ⇒ String
The ID of the DB cluster to retrieve the list of DB cluster snapshots for.
-
#db_cluster_resource_id ⇒ String
A specific DB cluster resource ID to describe.
-
#db_cluster_snapshot_identifier ⇒ String
A specific DB cluster snapshot identifier to describe.
-
#filters ⇒ Array<Types::Filter>
A filter that specifies one or more DB cluster snapshots to describe.
-
#include_public ⇒ Boolean
Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account.
-
#include_shared ⇒ Boolean
Specifies 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.
-
#marker ⇒ String
An optional pagination token provided by a previous
DescribeDBClusterSnapshots
request. -
#max_records ⇒ Integer
The maximum number of records to include in the response.
-
#snapshot_type ⇒ String
The type of DB cluster snapshots to be returned.
Instance Attribute Details
#db_cluster_identifier ⇒ String
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.
^
12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12537 class DescribeDBClusterSnapshotsMessage < Struct.new( :db_cluster_identifier, :db_cluster_snapshot_identifier, :snapshot_type, :filters, :max_records, :marker, :include_shared, :include_public, :db_cluster_resource_id) SENSITIVE = [] include Aws::Structure end |
#db_cluster_resource_id ⇒ String
A specific DB cluster resource ID to describe.
12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12537 class DescribeDBClusterSnapshotsMessage < Struct.new( :db_cluster_identifier, :db_cluster_snapshot_identifier, :snapshot_type, :filters, :max_records, :marker, :include_shared, :include_public, :db_cluster_resource_id) SENSITIVE = [] include Aws::Structure end |
#db_cluster_snapshot_identifier ⇒ String
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.
12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12537 class DescribeDBClusterSnapshotsMessage < Struct.new( :db_cluster_identifier, :db_cluster_snapshot_identifier, :snapshot_type, :filters, :max_records, :marker, :include_shared, :include_public, :db_cluster_resource_id) SENSITIVE = [] include Aws::Structure end |
#filters ⇒ Array<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.
12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12537 class DescribeDBClusterSnapshotsMessage < Struct.new( :db_cluster_identifier, :db_cluster_snapshot_identifier, :snapshot_type, :filters, :max_records, :marker, :include_shared, :include_public, :db_cluster_resource_id) SENSITIVE = [] include Aws::Structure end |
#include_public ⇒ Boolean
Specifies 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.
12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12537 class DescribeDBClusterSnapshotsMessage < Struct.new( :db_cluster_identifier, :db_cluster_snapshot_identifier, :snapshot_type, :filters, :max_records, :marker, :include_shared, :include_public, :db_cluster_resource_id) SENSITIVE = [] include Aws::Structure end |
#include_shared ⇒ Boolean
Specifies 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.
12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12537 class DescribeDBClusterSnapshotsMessage < Struct.new( :db_cluster_identifier, :db_cluster_snapshot_identifier, :snapshot_type, :filters, :max_records, :marker, :include_shared, :include_public, :db_cluster_resource_id) SENSITIVE = [] include Aws::Structure end |
#marker ⇒ String
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
.
12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12537 class DescribeDBClusterSnapshotsMessage < Struct.new( :db_cluster_identifier, :db_cluster_snapshot_identifier, :snapshot_type, :filters, :max_records, :marker, :include_shared, :include_public, :db_cluster_resource_id) SENSITIVE = [] 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 you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12537 class DescribeDBClusterSnapshotsMessage < Struct.new( :db_cluster_identifier, :db_cluster_snapshot_identifier, :snapshot_type, :filters, :max_records, :marker, :include_shared, :include_public, :db_cluster_resource_id) SENSITIVE = [] include Aws::Structure end |
#snapshot_type ⇒ String
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
.
12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12537 class DescribeDBClusterSnapshotsMessage < Struct.new( :db_cluster_identifier, :db_cluster_snapshot_identifier, :snapshot_type, :filters, :max_records, :marker, :include_shared, :include_public, :db_cluster_resource_id) SENSITIVE = [] include Aws::Structure end |