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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb

Overview

Note:

When making an API call, you may pass DescribeSnapshotsMessage data as a 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)


2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2986

class DescribeSnapshotsMessage < Struct.new(
  :replication_group_id,
  :cache_cluster_id,
  :snapshot_name,
  :snapshot_source,
  :marker,
  :max_records,
  :show_node_group_config)
  include Aws::Structure
end

#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)


2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2986

class DescribeSnapshotsMessage < Struct.new(
  :replication_group_id,
  :cache_cluster_id,
  :snapshot_name,
  :snapshot_source,
  :marker,
  :max_records,
  :show_node_group_config)
  include Aws::Structure
end

#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)


2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2986

class DescribeSnapshotsMessage < Struct.new(
  :replication_group_id,
  :cache_cluster_id,
  :snapshot_name,
  :snapshot_source,
  :marker,
  :max_records,
  :show_node_group_config)
  include Aws::Structure
end

#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)


2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2986

class DescribeSnapshotsMessage < Struct.new(
  :replication_group_id,
  :cache_cluster_id,
  :snapshot_name,
  :snapshot_source,
  :marker,
  :max_records,
  :show_node_group_config)
  include Aws::Structure
end

#show_node_group_configBoolean

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

Returns:

  • (Boolean)


2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2986

class DescribeSnapshotsMessage < Struct.new(
  :replication_group_id,
  :cache_cluster_id,
  :snapshot_name,
  :snapshot_source,
  :marker,
  :max_records,
  :show_node_group_config)
  include Aws::Structure
end

#snapshot_nameString

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

Returns:

  • (String)


2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2986

class DescribeSnapshotsMessage < Struct.new(
  :replication_group_id,
  :cache_cluster_id,
  :snapshot_name,
  :snapshot_source,
  :marker,
  :max_records,
  :show_node_group_config)
  include Aws::Structure
end

#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)


2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2986

class DescribeSnapshotsMessage < Struct.new(
  :replication_group_id,
  :cache_cluster_id,
  :snapshot_name,
  :snapshot_source,
  :marker,
  :max_records,
  :show_node_group_config)
  include Aws::Structure
end