Struct aws_sdk_ec2::types::Snapshot

#[non_exhaustive]
pub struct Snapshot {

    pub data_encryption_key_id: Option<String>,
    pub description: Option<String>,
    pub encrypted: Option<bool>,
    pub kms_key_id: Option<String>,
    pub owner_id: Option<String>,
    pub progress: Option<String>,
    pub snapshot_id: Option<String>,
    pub start_time: Option<DateTime>,
    pub state: Option<SnapshotState>,
    pub state_message: Option<String>,
    pub volume_id: Option<String>,
    pub volume_size: Option<i32>,
    pub owner_alias: Option<String>,
    pub outpost_arn: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub storage_tier: Option<StorageTier>,
    pub restore_expiry_time: Option<DateTime>,
}

Describes a snapshot.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

data_encryption_key_id: Option<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.

description: Option<String>

The description for the snapshot.

encrypted: Option<bool>

Indicates whether the snapshot is encrypted.

kms_key_id: Option<String>

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.

owner_id: Option<String>

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

progress: Option<String>

The progress of the snapshot, as a percentage.

snapshot_id: Option<String>

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

start_time: Option<DateTime>

The time stamp when the snapshot was initiated.

state: Option<SnapshotState>

The snapshot state.

state_message: Option<String>

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.

volume_id: Option<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.

volume_size: Option<i32>

The size of the volume, in GiB.

owner_alias: Option<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.

outpost_arn: Option<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 Elastic Compute Cloud User Guide.

tags: Option<Vec<Tag>>

Any tags assigned to the snapshot.

storage_tier: Option<StorageTier>

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.

restore_expiry_time: Option<DateTime>

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

Implementations

impl Snapshot

pub fn data_encryption_key_id(&self) -> Option<&str>

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.

pub fn description(&self) -> Option<&str>

The description for the snapshot.

pub fn encrypted(&self) -> Option<bool>

Indicates whether the snapshot is encrypted.

pub fn kms_key_id(&self) -> Option<&str>

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.

pub fn owner_id(&self) -> Option<&str>

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

pub fn progress(&self) -> Option<&str>

The progress of the snapshot, as a percentage.

pub fn snapshot_id(&self) -> Option<&str>

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

pub fn start_time(&self) -> Option<&DateTime>

The time stamp when the snapshot was initiated.

pub fn state(&self) -> Option<&SnapshotState>

The snapshot state.

pub fn state_message(&self) -> Option<&str>

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.

pub fn volume_id(&self) -> Option<&str>

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.

pub fn volume_size(&self) -> Option<i32>

The size of the volume, in GiB.

pub fn owner_alias(&self) -> Option<&str>

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.

pub fn outpost_arn(&self) -> Option<&str>

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.

pub fn tags(&self) -> Option<&[Tag]>

Any tags assigned to the snapshot.

pub fn storage_tier(&self) -> Option<&StorageTier>

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.

pub fn restore_expiry_time(&self) -> Option<&DateTime>

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

impl Snapshot

pub fn builder() -> SnapshotBuilder

Creates a new builder-style object to manufacture Snapshot.

Trait Implementations

impl Clone for Snapshot

fn clone(&self) -> Snapshot

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Snapshot

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Snapshot> for Snapshot

fn eq(&self, other: &Snapshot) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Snapshot