You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElastiCache::Types::DescribeSnapshotsMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeSnapshotsMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  replication_group_id: "String",
  cache_cluster_id: "String",
  snapshot_name: "String",
  snapshot_source: "String",
  marker: "String",
  max_records: 1,
  show_node_group_config: false,
}

Represents the input of a DescribeSnapshotsMessage operation.

Instance Attribute Summary collapse

Instance Attribute Details

#cache_cluster_idString

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

Returns:

  • (String)

    A user-supplied cluster identifier.

#markerString

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.

Returns:

  • (String)

    An optional marker returned from a prior request.

#max_recordsInteger

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.

Returns:

  • (Integer)

    The maximum number of records to include in the response.

#replication_group_idString

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

Returns:

  • (String)

    A user-supplied replication group identifier.

#show_node_group_configBoolean

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

Returns:

  • (Boolean)

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

#snapshot_nameString

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

Returns:

  • (String)

    A user-supplied name of the snapshot.

#snapshot_sourceString

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.

Returns:

  • (String)

    If set to system, the output shows snapshots that were automatically created by ElastiCache.