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:

Instance Attribute Summary collapse

Instance Attribute Details

#data_encryption_key_idString

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 the DescribeSnapshots API operation.

Returns:

  • (String)

    The data encryption key identifier for the snapshot.

#descriptionString

The description for the snapshot.

Returns:

  • (String)

    The description for the snapshot.

#encryptedBoolean

Indicates whether the snapshot is encrypted.

Returns:

  • (Boolean)

    Indicates whether the snapshot is encrypted.

#kms_key_idString

The full 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 full 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_aliasString

Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

Returns:

  • (String)

    Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners.

#owner_idString

The AWS account ID of the EBS snapshot owner.

Returns:

  • (String)

    The AWS account ID of the EBS snapshot owner.

#progressString

The progress of the snapshot, as a percentage.

Returns:

  • (String)

    The progress of the snapshot, as a percentage.

#snapshot_idString

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

Returns:

  • (String)

    The ID of the snapshot.

#start_timeTime

The time stamp when the snapshot was initiated.

Returns:

  • (Time)

    The time stamp when the snapshot was initiated.

#stateString

The snapshot state.

Possible values:

  • pending
  • completed
  • error

Returns:

  • (String)

    The snapshot state.

#state_messageString

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 the DescribeSnapshots API operation.

Returns:

  • (String)

    Encrypted Amazon EBS snapshots are copied asynchronously.

#tagsArray<Types::Tag>

Any tags assigned to the snapshot.

Returns:

  • (Array<Types::Tag>)

    Any tags assigned to the snapshot.

#volume_idString

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_sizeInteger

The size of the volume, in GiB.

Returns:

  • (Integer)

    The size of the volume, in GiB.