/AWS1/CL_ECA=>DESCRIBESNAPSHOTS()¶
About DescribeSnapshots¶
Returns information about cluster or replication group snapshots. By default,
DescribeSnapshots lists all of your snapshots; it can optionally
describe a single snapshot, or just the snapshots associated with a particular cache
cluster.
This operation is valid for Redis only.
Method Signature¶
IMPORTING¶
Optional arguments:¶
IV_REPLICATIONGROUPID TYPE /AWS1/ECASTRING /AWS1/ECASTRING¶
A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
IV_CACHECLUSTERID TYPE /AWS1/ECASTRING /AWS1/ECASTRING¶
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
IV_SNAPSHOTNAME TYPE /AWS1/ECASTRING /AWS1/ECASTRING¶
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
IV_SNAPSHOTSOURCE TYPE /AWS1/ECASTRING /AWS1/ECASTRING¶
If set to
system, the output shows snapshots that were automatically created by ElastiCache. If set touserthe output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
IV_MARKER TYPE /AWS1/ECASTRING /AWS1/ECASTRING¶
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
IV_MAXRECORDS TYPE /AWS1/ECAINTEGEROPTIONAL /AWS1/ECAINTEGEROPTIONAL¶
The maximum number of records to include in the response. If more records exist than the specified
MaxRecordsvalue, a marker is included in the response so that the remaining results can be retrieved.Default: 50
Constraints: minimum 20; maximum 50.
IV_SHOWNODEGROUPCONFIG TYPE /AWS1/ECABOOLEANOPTIONAL /AWS1/ECABOOLEANOPTIONAL¶
A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.