Class: Aws::EC2::Types::Snapshot
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::Snapshot
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-ec2/types.rb
Overview
Describes a snapshot.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#completion_duration_minutes ⇒ Integer
<note markdown=“1”> Only for snapshot copies created with time-based snapshot copy operations.
-
#completion_time ⇒ Time
The time stamp when the snapshot was completed.
-
#data_encryption_key_id ⇒ String
The data encryption key identifier for the snapshot.
-
#description ⇒ String
The description for the snapshot.
-
#encrypted ⇒ Boolean
Indicates whether the snapshot is encrypted.
-
#kms_key_id ⇒ String
The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
-
#outpost_arn ⇒ String
The ARN of the Outpost on which the snapshot is stored.
-
#owner_alias ⇒ String
The Amazon Web Services owner alias, from an Amazon-maintained list (‘amazon`).
-
#owner_id ⇒ String
The ID of the Amazon Web Services account that owns the EBS snapshot.
-
#progress ⇒ String
The progress of the snapshot, as a percentage.
-
#restore_expiry_time ⇒ Time
Only for archived snapshots that are temporarily restored.
-
#snapshot_id ⇒ String
The ID of the snapshot.
-
#sse_type ⇒ String
Reserved for future use.
-
#start_time ⇒ Time
The time stamp when the snapshot was initiated.
-
#state ⇒ String
The snapshot state.
-
#state_message ⇒ String
Encrypted Amazon EBS snapshots are copied asynchronously.
-
#storage_tier ⇒ String
The storage tier in which the snapshot is stored.
-
#tags ⇒ Array<Types::Tag>
Any tags assigned to the snapshot.
-
#transfer_type ⇒ String
<note markdown=“1”> Only for snapshot copies.
-
#volume_id ⇒ String
The ID of the volume that was used to create the snapshot.
-
#volume_size ⇒ Integer
The size of the volume, in GiB.
Instance Attribute Details
#completion_duration_minutes ⇒ Integer
<note markdown=“1”> Only for snapshot copies created with time-based snapshot copy operations.
</note>
The completion duration requested for the time-based snapshot copy operation.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#completion_time ⇒ Time
The time stamp when the snapshot was completed.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#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.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description for the snapshot.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#encrypted ⇒ Boolean
Indicates whether the snapshot is encrypted.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ String
The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#outpost_arn ⇒ String
The ARN of the Outpost on which the snapshot is stored. For more information, see [Amazon EBS local snapshots on Outposts] in the *Amazon EBS User Guide*.
[1]: docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#owner_alias ⇒ String
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.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#owner_id ⇒ String
The ID of the Amazon Web Services account that owns the EBS snapshot.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#progress ⇒ String
The progress of the snapshot, as a percentage.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#restore_expiry_time ⇒ Time
Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#snapshot_id ⇒ String
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#sse_type ⇒ String
Reserved for future use.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#start_time ⇒ Time
The time stamp when the snapshot was initiated.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#state ⇒ String
The snapshot state.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#state_message ⇒ String
Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper 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.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#storage_tier ⇒ String
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.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
Any tags assigned to the snapshot.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#transfer_type ⇒ String
<note markdown=“1”> Only for snapshot copies.
</note>
Indicates whether the snapshot copy was created with a standard or time-based snapshot copy operation. Time-based snapshot copy operations complete within the completion duration specified in the request. Standard snapshot copy operations are completed on a best-effort basis.
-
‘standard` - The snapshot copy was created with a standard snapshot copy operation.
-
‘time-based` - The snapshot copy was created with a time-based snapshot copy operation.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#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.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |
#volume_size ⇒ Integer
The size of the volume, in GiB.
65629 65630 65631 65632 65633 65634 65635 65636 65637 65638 65639 65640 65641 65642 65643 65644 65645 65646 65647 65648 65649 65650 65651 65652 65653 |
# File 'lib/aws-sdk-ec2/types.rb', line 65629 class Snapshot < Struct.new( :owner_alias, :outpost_arn, :tags, :storage_tier, :restore_expiry_time, :sse_type, :transfer_type, :completion_duration_minutes, :completion_time, :snapshot_id, :volume_id, :state, :state_message, :start_time, :progress, :owner_id, :description, :volume_size, :encrypted, :kms_key_id, :data_encryption_key_id) SENSITIVE = [] include Aws::Structure end |