Class: Aws::MemoryDB::Types::DescribeSnapshotsRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_nameString

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

Returns:

  • (String)


1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 1682

class DescribeSnapshotsRequest < Struct.new(
  :cluster_name,
  :snapshot_name,
  :source,
  :next_token,
  :max_results,
  :show_detail)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 1682

class DescribeSnapshotsRequest < Struct.new(
  :cluster_name,
  :snapshot_name,
  :source,
  :next_token,
  :max_results,
  :show_detail)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Returns:

  • (String)


1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 1682

class DescribeSnapshotsRequest < Struct.new(
  :cluster_name,
  :snapshot_name,
  :source,
  :next_token,
  :max_results,
  :show_detail)
  SENSITIVE = []
  include Aws::Structure
end

#show_detailBoolean

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

Returns:

  • (Boolean)


1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 1682

class DescribeSnapshotsRequest < Struct.new(
  :cluster_name,
  :snapshot_name,
  :source,
  :next_token,
  :max_results,
  :show_detail)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_nameString

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

Returns:

  • (String)


1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 1682

class DescribeSnapshotsRequest < Struct.new(
  :cluster_name,
  :snapshot_name,
  :source,
  :next_token,
  :max_results,
  :show_detail)
  SENSITIVE = []
  include Aws::Structure
end

#sourceString

If set to system, the output shows snapshots that were automatically created by MemoryDB. 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)


1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 1682

class DescribeSnapshotsRequest < Struct.new(
  :cluster_name,
  :snapshot_name,
  :source,
  :next_token,
  :max_results,
  :show_detail)
  SENSITIVE = []
  include Aws::Structure
end