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

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

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

Overview

Describes a snapshot.

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 DescribeSnapshots.

Returns:

  • (String)


34482
34483
34484
34485
34486
34487
34488
34489
34490
34491
34492
34493
34494
34495
34496
34497
34498
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34482

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :tags)
  include Aws::Structure
end

#descriptionString

The description for the snapshot.

Returns:

  • (String)


34482
34483
34484
34485
34486
34487
34488
34489
34490
34491
34492
34493
34494
34495
34496
34497
34498
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34482

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :tags)
  include Aws::Structure
end

#encryptedBoolean

Indicates whether the snapshot is encrypted.

Returns:

  • (Boolean)


34482
34483
34484
34485
34486
34487
34488
34489
34490
34491
34492
34493
34494
34495
34496
34497
34498
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34482

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :tags)
  include Aws::Structure
end

#kms_key_idString

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)


34482
34483
34484
34485
34486
34487
34488
34489
34490
34491
34492
34493
34494
34495
34496
34497
34498
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34482

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :tags)
  include Aws::Structure
end

#owner_aliasString

Value from an Amazon-maintained list (amazon | self | all | 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)


34482
34483
34484
34485
34486
34487
34488
34489
34490
34491
34492
34493
34494
34495
34496
34497
34498
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34482

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :tags)
  include Aws::Structure
end

#owner_idString

The AWS account ID of the EBS snapshot owner.

Returns:

  • (String)


34482
34483
34484
34485
34486
34487
34488
34489
34490
34491
34492
34493
34494
34495
34496
34497
34498
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34482

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :tags)
  include Aws::Structure
end

#progressString

The progress of the snapshot, as a percentage.

Returns:

  • (String)


34482
34483
34484
34485
34486
34487
34488
34489
34490
34491
34492
34493
34494
34495
34496
34497
34498
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34482

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :tags)
  include Aws::Structure
end

#snapshot_idString

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

Returns:

  • (String)


34482
34483
34484
34485
34486
34487
34488
34489
34490
34491
34492
34493
34494
34495
34496
34497
34498
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34482

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :tags)
  include Aws::Structure
end

#start_timeTime

The time stamp when the snapshot was initiated.

Returns:

  • (Time)


34482
34483
34484
34485
34486
34487
34488
34489
34490
34491
34492
34493
34494
34495
34496
34497
34498
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34482

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :tags)
  include Aws::Structure
end

#stateString

The snapshot state.

Returns:

  • (String)


34482
34483
34484
34485
34486
34487
34488
34489
34490
34491
34492
34493
34494
34495
34496
34497
34498
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34482

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :tags)
  include Aws::Structure
end

#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 DescribeSnapshots.

Returns:

  • (String)


34482
34483
34484
34485
34486
34487
34488
34489
34490
34491
34492
34493
34494
34495
34496
34497
34498
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34482

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

Any tags assigned to the snapshot.

Returns:



34482
34483
34484
34485
34486
34487
34488
34489
34490
34491
34492
34493
34494
34495
34496
34497
34498
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34482

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :tags)
  include Aws::Structure
end

#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)


34482
34483
34484
34485
34486
34487
34488
34489
34490
34491
34492
34493
34494
34495
34496
34497
34498
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34482

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :tags)
  include Aws::Structure
end

#volume_sizeInteger

The size of the volume, in GiB.

Returns:

  • (Integer)


34482
34483
34484
34485
34486
34487
34488
34489
34490
34491
34492
34493
34494
34495
34496
34497
34498
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34482

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :tags)
  include Aws::Structure
end