Class: Aws::MemoryDB::Types::Snapshot

Inherits:

Struct

• Object
• Struct
• Aws::MemoryDB::Types::Snapshot

Includes:

Structure

Defined in:

lib/aws-sdk-memorydb/types.rb

Overview

Represents a copy of an entire cluster as of the time when the snapshot was taken.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The ARN (Amazon Resource Name) of the snapshot.

• #cluster_configuration ⇒ Types::ClusterConfiguration

  The configuration of the cluster from which the snapshot was taken.

• #data_tiering ⇒ String

  Enables data tiering.

• #kms_key_id ⇒ String

  The ID of the KMS key used to encrypt the snapshot.

• #name ⇒ String

  The name of the snapshot.

• #source ⇒ String

  Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

• #status ⇒ String

  The status of the snapshot.

Instance Attribute Details

#arn ⇒ String

The ARN (Amazon Resource Name) of the snapshot.

Returns:

• (String)

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

class Snapshot < Struct.new(
  :name,
  :status,
  :source,
  :kms_key_id,
  :arn,
  :cluster_configuration,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_configuration ⇒ Types::ClusterConfiguration

The configuration of the cluster from which the snapshot was taken

Returns:

• (Types::ClusterConfiguration)

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

class Snapshot < Struct.new(
  :name,
  :status,
  :source,
  :kms_key_id,
  :arn,
  :cluster_configuration,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#data_tiering ⇒ String

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see [Data tiering].

[1]: docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html

Returns:

• (String)

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

class Snapshot < Struct.new(
  :name,
  :status,
  :source,
  :kms_key_id,
  :arn,
  :cluster_configuration,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The ID of the KMS key used to encrypt the snapshot.

Returns:

• (String)

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

class Snapshot < Struct.new(
  :name,
  :status,
  :source,
  :kms_key_id,
  :arn,
  :cluster_configuration,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the snapshot

Returns:

• (String)

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

class Snapshot < Struct.new(
  :name,
  :status,
  :source,
  :kms_key_id,
  :arn,
  :cluster_configuration,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ String

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

Returns:

• (String)

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

class Snapshot < Struct.new(
  :name,
  :status,
  :source,
  :kms_key_id,
  :arn,
  :cluster_configuration,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

Returns:

• (String)

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

class Snapshot < Struct.new(
  :name,
  :status,
  :source,
  :kms_key_id,
  :arn,
  :cluster_configuration,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end