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.

Constant Summary collapse

SENSITIVE =
[]

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)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description for the snapshot.

Returns:

  • (String)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#encryptedBoolean

Indicates whether the snapshot is encrypted.

Returns:

  • (Boolean)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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

Returns:

  • (String)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_arnString

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#owner_aliasString

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

Returns:

  • (String)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#owner_idString

The ID of the Amazon Web Services account that owns the EBS snapshot.

Returns:

  • (String)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#progressString

The progress of the snapshot, as a percentage.

Returns:

  • (String)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#restore_expiry_timeTime

Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.

Returns:

  • (Time)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_idString

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

Returns:

  • (String)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

The time stamp when the snapshot was initiated.

Returns:

  • (Time)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The snapshot state.

Returns:

  • (String)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#state_messageString

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (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)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#storage_tierString

The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.

Returns:

  • (String)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Any tags assigned to the snapshot.

Returns:



61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  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)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end

#volume_sizeInteger

The size of the volume, in GiB.

Returns:

  • (Integer)


61122
61123
61124
61125
61126
61127
61128
61129
61130
61131
61132
61133
61134
61135
61136
61137
61138
61139
61140
61141
61142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61122

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,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time)
  SENSITIVE = []
  include Aws::Structure
end