Returns information about cluster or replication group snapshots¶

Description¶

Returns information about cluster or replication group snapshots. By default, describe_snapshots 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 Valkey or Redis OSS only.

Usage¶

elasticache_describe_snapshots(ReplicationGroupId, CacheClusterId,
  SnapshotName, SnapshotSource, Marker, MaxRecords, ShowNodeGroupConfig)

Arguments¶

ReplicationGroupId

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

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

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

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.
Marker

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.
MaxRecords

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.
ShowNodeGroupConfig

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

Value¶

A list with the following syntax:

list(
  Marker = "string",
  Snapshots = list(
    list(
      SnapshotName = "string",
      ReplicationGroupId = "string",
      ReplicationGroupDescription = "string",
      CacheClusterId = "string",
      SnapshotStatus = "string",
      SnapshotSource = "string",
      CacheNodeType = "string",
      Engine = "string",
      EngineVersion = "string",
      NumCacheNodes = 123,
      PreferredAvailabilityZone = "string",
      PreferredOutpostArn = "string",
      CacheClusterCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      PreferredMaintenanceWindow = "string",
      TopicArn = "string",
      Port = 123,
      CacheParameterGroupName = "string",
      CacheSubnetGroupName = "string",
      VpcId = "string",
      AutoMinorVersionUpgrade = TRUE|FALSE,
      SnapshotRetentionLimit = 123,
      SnapshotWindow = "string",
      NumNodeGroups = 123,
      AutomaticFailover = "enabled"|"disabled"|"enabling"|"disabling",
      NodeSnapshots = list(
        list(
          CacheClusterId = "string",
          NodeGroupId = "string",
          CacheNodeId = "string",
          NodeGroupConfiguration = list(
            NodeGroupId = "string",
            Slots = "string",
            ReplicaCount = 123,
            PrimaryAvailabilityZone = "string",
            ReplicaAvailabilityZones = list(
              "string"
            ),
            PrimaryOutpostArn = "string",
            ReplicaOutpostArns = list(
              "string"
            )
          ),
          CacheSize = "string",
          CacheNodeCreateTime = as.POSIXct(
            "2015-01-01"
          ),
          SnapshotCreateTime = as.POSIXct(
            "2015-01-01"
          )
        )
      ),
      KmsKeyId = "string",
      ARN = "string",
      DataTiering = "enabled"|"disabled",
      Durability = "default"|"async"|"sync"|"disabled"
    )
  )
)

Request syntax¶

svc$describe_snapshots(
  ReplicationGroupId = "string",
  CacheClusterId = "string",
  SnapshotName = "string",
  SnapshotSource = "string",
  Marker = "string",
  MaxRecords = 123,
  ShowNodeGroupConfig = TRUE|FALSE
)

Examples¶

# Returns information about the snapshot mysnapshot. By default.
svc$describe_snapshots(
  SnapshotName = "snapshot-20161212"
)