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

Class: Aws::EC2::Types::Snapshot

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

Overview

Describes a snapshot.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#data_encryption_key_id ⇒ String

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

Returns:

  • (String) —

    The data encryption key identifier for the snapshot.

#description ⇒ String

The description for the snapshot.

Returns:

  • (String) —

    The description for the snapshot.

#encrypted ⇒ Boolean

Indicates whether the snapshot is encrypted.

Returns:

  • (Boolean) —

    Indicates whether the snapshot is encrypted.

#kms_key_id ⇒ String

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

#owner_alias ⇒ String

The AWS owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console.

Returns:

  • (String) —

    The AWS owner alias, from an Amazon-maintained list (amazon).

#owner_id ⇒ String

The AWS account ID of the EBS snapshot owner.

Returns:

  • (String) —

    The AWS account ID of the EBS snapshot owner.

#progress ⇒ String

The progress of the snapshot, as a percentage.

Returns:

  • (String) —

    The progress of the snapshot, as a percentage.

#snapshot_id ⇒ String

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

Returns:

  • (String) —

    The ID of the snapshot.

#start_time ⇒ Time

The time stamp when the snapshot was initiated.

Returns:

  • (Time) —

    The time stamp when the snapshot was initiated.

#state ⇒ String

The snapshot state.

Possible values:

  • pending
  • completed
  • error

Returns:

  • (String) —

    The snapshot state.

#state_message ⇒ String

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.

Returns:

  • (String) —

    Encrypted Amazon EBS snapshots are copied asynchronously.

#tags ⇒ Array<Types::Tag>

Any tags assigned to the snapshot.

Returns:

  • (Array<Types::Tag>) —

    Any tags assigned to the snapshot.

#volume_id ⇒ String

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

Returns:

  • (String) —

    The ID of the volume that was used to create the snapshot.

#volume_size ⇒ Integer

The size of the volume, in GiB.

Returns:

  • (Integer) —

    The size of the volume, in GiB.