Describe Db Cluster Snapshots
rds_describe_db_cluster_snapshots | R Documentation |
Returns information about DB cluster snapshots¶
Description¶
Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Usage¶
rds_describe_db_cluster_snapshots(DBClusterIdentifier,
DBClusterSnapshotIdentifier, SnapshotType, Filters, MaxRecords, Marker,
IncludeShared, IncludePublic, DbClusterResourceId)
Arguments¶
DBClusterIdentifier
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.
DBClusterSnapshotIdentifier
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.
SnapshotType
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 theIncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling theIncludePublic
parameter.The
IncludeShared
andIncludePublic
parameters don't apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter doesn't apply whenSnapshotType
is set toshared
. TheIncludeShared
parameter doesn't apply whenSnapshotType
is set topublic
.Filters
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.
MaxRecords
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.
Marker
An optional pagination token provided by a previous
describe_db_cluster_snapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.IncludeShared
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
modify_db_cluster_snapshot_attribute
API action.IncludePublic
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
modify_db_cluster_snapshot_attribute
API action.DbClusterResourceId
A specific DB cluster resource ID to describe.
Value¶
A list with the following syntax:
list(
Marker = "string",
DBClusterSnapshots = list(
list(
AvailabilityZones = list(
"string"
),
DBClusterSnapshotIdentifier = "string",
DBClusterIdentifier = "string",
SnapshotCreateTime = as.POSIXct(
"2015-01-01"
),
Engine = "string",
EngineMode = "string",
AllocatedStorage = 123,
Status = "string",
Port = 123,
VpcId = "string",
ClusterCreateTime = as.POSIXct(
"2015-01-01"
),
MasterUsername = "string",
EngineVersion = "string",
LicenseModel = "string",
SnapshotType = "string",
PercentProgress = 123,
StorageEncrypted = TRUE|FALSE,
KmsKeyId = "string",
DBClusterSnapshotArn = "string",
SourceDBClusterSnapshotArn = "string",
IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
TagList = list(
list(
Key = "string",
Value = "string"
)
),
DBSystemId = "string",
StorageType = "string",
DbClusterResourceId = "string",
StorageThroughput = 123
)
)
)
Request syntax¶
svc$describe_db_cluster_snapshots(
DBClusterIdentifier = "string",
DBClusterSnapshotIdentifier = "string",
SnapshotType = "string",
Filters = list(
list(
Name = "string",
Values = list(
"string"
)
)
),
MaxRecords = 123,
Marker = "string",
IncludeShared = TRUE|FALSE,
IncludePublic = TRUE|FALSE,
DbClusterResourceId = "string"
)