Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DescribeSnapshotsMessage

Represents the input of a DescribeSnapshotsMessage operation.

Hierarchy

Index

Properties

Optional CacheClusterId

CacheClusterId: undefined | string

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

Optional Marker

Marker: undefined | string

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.

Optional MaxRecords

MaxRecords: undefined | number

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 50

Constraints: minimum 20; maximum 50.

Optional ReplicationGroupId

ReplicationGroupId: undefined | string

A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

Optional ShowNodeGroupConfig

ShowNodeGroupConfig: undefined | false | true

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

Optional SnapshotName

SnapshotName: undefined | string

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

Optional SnapshotSource

SnapshotSource: undefined | string

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.