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
Constraints:
|
DBClusterSnapshotIdentifier |
A specific DB cluster snapshot identifier to describe. This
parameter can't be used in conjunction with the
Constraints:
|
SnapshotType |
The type of DB cluster snapshots to be returned. You can specify one of the following values:
If you don't specify a The |
Filters |
A filter that specifies one or more DB cluster snapshots to describe. Supported filters:
|
MaxRecords |
The maximum number of records to include in the response. If more
records exist than the specified Default: 100 Constraints: Minimum 20, maximum 100. |
Marker |
An optional pagination token provided by a previous
|
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 |
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
|
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"
)
Examples¶
## Not run:
# This example lists settings for the specified, manually-created cluster
# snapshot.
svc$describe_db_cluster_snapshots(
DBClusterSnapshotIdentifier = "mydbclustersnapshot",
SnapshotType = "manual"
)
## End(Not run)