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

Inherits:

Struct

• Object
• Struct
• Aws::MemoryDB::Types::DescribeSnapshotsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-memorydb/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cluster_name ⇒ String

  A user-supplied cluster identifier.

• #max_results ⇒ Integer

  The maximum number of records to include in the response.

• #next_token ⇒ String

  An optional argument to pass in case the total number of records exceeds the value of MaxResults.

• #show_detail ⇒ Boolean

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

• #snapshot_name ⇒ String

  A user-supplied name of the snapshot.

• #source ⇒ String

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

Instance Attribute Details

#cluster_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-memorydb/types.rb', line 1704

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

#max_results ⇒ Integer

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)

# File 'lib/aws-sdk-memorydb/types.rb', line 1704

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

#next_token ⇒ String

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)

# File 'lib/aws-sdk-memorydb/types.rb', line 1704

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

#show_detail ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-memorydb/types.rb', line 1704

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

#snapshot_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-memorydb/types.rb', line 1704

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

#source ⇒ String

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)

# File 'lib/aws-sdk-memorydb/types.rb', line 1704

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