EBS Snapshot

This table represents the EBS Snapshot resource from Amazon Web Services.

aws.ebs_snapshot

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
availability_zonecorestringThe Availability Zone or Local Zone of the snapshot. For example, <code>us-west-1a</code> (Availability Zone) or <code>us-west-2-lax-1a</code> (Local Zone).
completion_duration_minutescoreint64<note> Only for snapshot copies created with time-based snapshot copy operations. </note> The completion duration requested for the time-based snapshot copy operation.
completion_timecoretimestampThe time stamp when the snapshot was completed.
create_volume_permissionscorejsonThe users and groups that have the permissions for creating volumes from the snapshot.
data_encryption_key_idcorestringThe 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 <a>DescribeSnapshots</a>.
descriptioncorestringThe description for the snapshot.
encryptedcoreboolIndicates whether the snapshot is encrypted.
kms_key_idcorestringThe Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
outpost_arncorestringThe ARN of the Outpost on which the snapshot is stored. For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html">Amazon EBS local snapshots on Outposts</a> in the <i>Amazon EBS User Guide</i>.
owner_aliascorestringThe Amazon Web Services owner alias, from an Amazon-maintained list (<code>amazon</code>). This is not the user-configured Amazon Web Services account alias set using the IAM console.
owner_idcorestringThe ID of the Amazon Web Services account that owns the EBS snapshot.
progresscorestringThe progress of the snapshot, as a percentage.
restore_expiry_timecoretimestampOnly for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
snapshot_arncorestring
snapshot_idcorestringThe ID of the EBS snapshot.
sse_typecorestringReserved for future use.
start_timecoretimestampThe time stamp when the snapshot was initiated.
statecorestringThe snapshot state.
state_messagecorestringEncrypted 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 <a>DescribeSnapshots</a>.
storage_tiercorestringThe storage tier in which the snapshot is stored. <code>standard</code> indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. <code>archive</code> indicates that the snapshot is currently archived and that it must be restored before it can be used.
tagscorehstore
transfer_typecorestring<note> 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. <ul> <li> <code>standard</code> - The snapshot copy was created with a standard snapshot copy operation. </li> <li> <code>time-based</code> - The snapshot copy was created with a time-based snapshot copy operation. </li> </ul>
volume_idcorestringThe ID of the volume that was used to create the snapshot. Snapshots created by the <a>CopySnapshot</a> action have an arbitrary volume ID that should not be used for any purpose.
volume_sizecoreint64The size of the volume, in GiB.