#[non_exhaustive]pub struct CreateSnapshotOutput {Show 23 fields
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>,
pub sse_type: Option<SseType>,
pub availability_zone: Option<String>,
pub transfer_type: Option<TransferType>,
pub completion_duration_minutes: Option<i32>,
pub completion_time: Option<DateTime>,
pub full_snapshot_size_in_bytes: Option<i64>,
pub snapshot_id: Option<String>,
pub volume_id: Option<String>,
pub state: Option<SnapshotState>,
pub state_message: Option<String>,
pub start_time: Option<DateTime>,
pub progress: Option<String>,
pub owner_id: Option<String>,
pub description: Option<String>,
pub volume_size: Option<i32>,
pub encrypted: Option<bool>,
pub kms_key_id: Option<String>,
pub data_encryption_key_id: Option<String>,
/* private fields */
}
Expand description
Describes a snapshot.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.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 EBS User Guide.
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.
sse_type: Option<SseType>
Reserved for future use.
availability_zone: Option<String>
The Availability Zone or Local Zone of the snapshot. For example, us-west-1a
(Availability Zone) or us-west-2-lax-1a
(Local Zone).
transfer_type: Option<TransferType>
Only for snapshot copies.
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.
completion_duration_minutes: Option<i32>
Only for snapshot copies created with time-based snapshot copy operations.
The completion duration requested for the time-based snapshot copy operation.
completion_time: Option<DateTime>
The time stamp when the snapshot was completed.
full_snapshot_size_in_bytes: Option<i64>
The full size of the snapshot, in bytes.
This is not the incremental size of the snapshot. This is the full snapshot size and represents the size of all the blocks that were written to the source volume at the time the snapshot was created.
snapshot_id: Option<String>
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
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.
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 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
.
start_time: Option<DateTime>
The time stamp when the snapshot was initiated.
progress: Option<String>
The progress of the snapshot, as a percentage.
owner_id: Option<String>
The ID of the Amazon Web Services account that owns the EBS snapshot.
description: Option<String>
The description for the snapshot.
volume_size: Option<i32>
The size of the volume, in GiB.
encrypted: Option<bool>
Indicates whether the snapshot is encrypted.
kms_key_id: Option<String>
The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
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
.
Implementations§
Source§impl CreateSnapshotOutput
impl CreateSnapshotOutput
Sourcepub fn owner_alias(&self) -> Option<&str>
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.
Sourcepub fn outpost_arn(&self) -> Option<&str>
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 EBS User Guide.
Any tags assigned to the snapshot.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
Sourcepub fn storage_tier(&self) -> Option<&StorageTier>
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.
Sourcepub fn restore_expiry_time(&self) -> Option<&DateTime>
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.
Sourcepub fn availability_zone(&self) -> Option<&str>
pub fn availability_zone(&self) -> Option<&str>
The Availability Zone or Local Zone of the snapshot. For example, us-west-1a
(Availability Zone) or us-west-2-lax-1a
(Local Zone).
Sourcepub fn transfer_type(&self) -> Option<&TransferType>
pub fn transfer_type(&self) -> Option<&TransferType>
Only for snapshot copies.
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.
Sourcepub fn completion_duration_minutes(&self) -> Option<i32>
pub fn completion_duration_minutes(&self) -> Option<i32>
Only for snapshot copies created with time-based snapshot copy operations.
The completion duration requested for the time-based snapshot copy operation.
Sourcepub fn completion_time(&self) -> Option<&DateTime>
pub fn completion_time(&self) -> Option<&DateTime>
The time stamp when the snapshot was completed.
Sourcepub fn full_snapshot_size_in_bytes(&self) -> Option<i64>
pub fn full_snapshot_size_in_bytes(&self) -> Option<i64>
The full size of the snapshot, in bytes.
This is not the incremental size of the snapshot. This is the full snapshot size and represents the size of all the blocks that were written to the source volume at the time the snapshot was created.
Sourcepub fn snapshot_id(&self) -> Option<&str>
pub fn snapshot_id(&self) -> Option<&str>
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
Sourcepub fn volume_id(&self) -> Option<&str>
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.
Sourcepub fn state(&self) -> Option<&SnapshotState>
pub fn state(&self) -> Option<&SnapshotState>
The snapshot state.
Sourcepub fn state_message(&self) -> Option<&str>
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 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
.
Sourcepub fn start_time(&self) -> Option<&DateTime>
pub fn start_time(&self) -> Option<&DateTime>
The time stamp when the snapshot was initiated.
Sourcepub fn owner_id(&self) -> Option<&str>
pub fn owner_id(&self) -> Option<&str>
The ID of the Amazon Web Services account that owns the EBS snapshot.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description for the snapshot.
Sourcepub fn volume_size(&self) -> Option<i32>
pub fn volume_size(&self) -> Option<i32>
The size of the volume, in GiB.
Sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
Sourcepub fn data_encryption_key_id(&self) -> Option<&str>
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
.
Source§impl CreateSnapshotOutput
impl CreateSnapshotOutput
Sourcepub fn builder() -> CreateSnapshotOutputBuilder
pub fn builder() -> CreateSnapshotOutputBuilder
Creates a new builder-style object to manufacture CreateSnapshotOutput
.
Trait Implementations§
Source§impl Clone for CreateSnapshotOutput
impl Clone for CreateSnapshotOutput
Source§fn clone(&self) -> CreateSnapshotOutput
fn clone(&self) -> CreateSnapshotOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateSnapshotOutput
impl Debug for CreateSnapshotOutput
Source§impl PartialEq for CreateSnapshotOutput
impl PartialEq for CreateSnapshotOutput
Source§impl RequestId for CreateSnapshotOutput
impl RequestId for CreateSnapshotOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for CreateSnapshotOutput
Auto Trait Implementations§
impl Freeze for CreateSnapshotOutput
impl RefUnwindSafe for CreateSnapshotOutput
impl Send for CreateSnapshotOutput
impl Sync for CreateSnapshotOutput
impl Unpin for CreateSnapshotOutput
impl UnwindSafe for CreateSnapshotOutput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);