pub struct LockSnapshotFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to LockSnapshot
.
Locks an Amazon EBS snapshot in either governance or compliance mode to protect it against accidental or malicious deletions for a specific duration. A locked snapshot can't be deleted.
You can also use this action to modify the lock settings for a snapshot that is already locked. The allowed modifications depend on the lock mode and lock state:
-
If the snapshot is locked in governance mode, you can modify the lock mode and the lock duration or lock expiration date.
-
If the snapshot is locked in compliance mode and it is in the cooling-off period, you can modify the lock mode and the lock duration or lock expiration date.
-
If the snapshot is locked in compliance mode and the cooling-off period has lapsed, you can only increase the lock duration or extend the lock expiration date.
Implementations§
Source§impl LockSnapshotFluentBuilder
impl LockSnapshotFluentBuilder
Sourcepub fn as_input(&self) -> &LockSnapshotInputBuilder
pub fn as_input(&self) -> &LockSnapshotInputBuilder
Access the LockSnapshot as a reference.
Sourcepub async fn send(
self,
) -> Result<LockSnapshotOutput, SdkError<LockSnapshotError, HttpResponse>>
pub async fn send( self, ) -> Result<LockSnapshotOutput, SdkError<LockSnapshotError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<LockSnapshotOutput, LockSnapshotError, Self>
pub fn customize( self, ) -> CustomizableOperation<LockSnapshotOutput, LockSnapshotError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn snapshot_id(self, input: impl Into<String>) -> Self
pub fn snapshot_id(self, input: impl Into<String>) -> Self
The ID of the snapshot to lock.
Sourcepub fn set_snapshot_id(self, input: Option<String>) -> Self
pub fn set_snapshot_id(self, input: Option<String>) -> Self
The ID of the snapshot to lock.
Sourcepub fn get_snapshot_id(&self) -> &Option<String>
pub fn get_snapshot_id(&self) -> &Option<String>
The ID of the snapshot to lock.
Sourcepub fn dry_run(self, input: bool) -> Self
pub fn dry_run(self, input: bool) -> Self
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Sourcepub fn set_dry_run(self, input: Option<bool>) -> Self
pub fn set_dry_run(self, input: Option<bool>) -> Self
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Sourcepub fn get_dry_run(&self) -> &Option<bool>
pub fn get_dry_run(&self) -> &Option<bool>
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Sourcepub fn lock_mode(self, input: LockMode) -> Self
pub fn lock_mode(self, input: LockMode) -> Self
The mode in which to lock the snapshot. Specify one of the following:
-
governance
- Locks the snapshot in governance mode. Snapshots locked in governance mode can't be deleted until one of the following conditions are met:-
The lock duration expires.
-
The snapshot is unlocked by a user with the appropriate permissions.
Users with the appropriate IAM permissions can unlock the snapshot, increase or decrease the lock duration, and change the lock mode to
compliance
at any time.If you lock a snapshot in
governance
mode, omit CoolOffPeriod. -
-
compliance
- Locks the snapshot in compliance mode. Snapshots locked in compliance mode can't be unlocked by any user. They can be deleted only after the lock duration expires. Users can't decrease the lock duration or change the lock mode togovernance
. However, users with appropriate IAM permissions can increase the lock duration at any time.If you lock a snapshot in
compliance
mode, you can optionally specify CoolOffPeriod.
Sourcepub fn set_lock_mode(self, input: Option<LockMode>) -> Self
pub fn set_lock_mode(self, input: Option<LockMode>) -> Self
The mode in which to lock the snapshot. Specify one of the following:
-
governance
- Locks the snapshot in governance mode. Snapshots locked in governance mode can't be deleted until one of the following conditions are met:-
The lock duration expires.
-
The snapshot is unlocked by a user with the appropriate permissions.
Users with the appropriate IAM permissions can unlock the snapshot, increase or decrease the lock duration, and change the lock mode to
compliance
at any time.If you lock a snapshot in
governance
mode, omit CoolOffPeriod. -
-
compliance
- Locks the snapshot in compliance mode. Snapshots locked in compliance mode can't be unlocked by any user. They can be deleted only after the lock duration expires. Users can't decrease the lock duration or change the lock mode togovernance
. However, users with appropriate IAM permissions can increase the lock duration at any time.If you lock a snapshot in
compliance
mode, you can optionally specify CoolOffPeriod.
Sourcepub fn get_lock_mode(&self) -> &Option<LockMode>
pub fn get_lock_mode(&self) -> &Option<LockMode>
The mode in which to lock the snapshot. Specify one of the following:
-
governance
- Locks the snapshot in governance mode. Snapshots locked in governance mode can't be deleted until one of the following conditions are met:-
The lock duration expires.
-
The snapshot is unlocked by a user with the appropriate permissions.
Users with the appropriate IAM permissions can unlock the snapshot, increase or decrease the lock duration, and change the lock mode to
compliance
at any time.If you lock a snapshot in
governance
mode, omit CoolOffPeriod. -
-
compliance
- Locks the snapshot in compliance mode. Snapshots locked in compliance mode can't be unlocked by any user. They can be deleted only after the lock duration expires. Users can't decrease the lock duration or change the lock mode togovernance
. However, users with appropriate IAM permissions can increase the lock duration at any time.If you lock a snapshot in
compliance
mode, you can optionally specify CoolOffPeriod.
Sourcepub fn cool_off_period(self, input: i32) -> Self
pub fn cool_off_period(self, input: i32) -> Self
The cooling-off period during which you can unlock the snapshot or modify the lock settings after locking the snapshot in compliance mode, in hours. After the cooling-off period expires, you can't unlock or delete the snapshot, decrease the lock duration, or change the lock mode. You can increase the lock duration after the cooling-off period expires.
The cooling-off period is optional when locking a snapshot in compliance mode. If you are locking the snapshot in governance mode, omit this parameter.
To lock the snapshot in compliance mode immediately without a cooling-off period, omit this parameter.
If you are extending the lock duration for a snapshot that is locked in compliance mode after the cooling-off period has expired, omit this parameter. If you specify a cooling-period in a such a request, the request fails.
Allowed values: Min 1, max 72.
Sourcepub fn set_cool_off_period(self, input: Option<i32>) -> Self
pub fn set_cool_off_period(self, input: Option<i32>) -> Self
The cooling-off period during which you can unlock the snapshot or modify the lock settings after locking the snapshot in compliance mode, in hours. After the cooling-off period expires, you can't unlock or delete the snapshot, decrease the lock duration, or change the lock mode. You can increase the lock duration after the cooling-off period expires.
The cooling-off period is optional when locking a snapshot in compliance mode. If you are locking the snapshot in governance mode, omit this parameter.
To lock the snapshot in compliance mode immediately without a cooling-off period, omit this parameter.
If you are extending the lock duration for a snapshot that is locked in compliance mode after the cooling-off period has expired, omit this parameter. If you specify a cooling-period in a such a request, the request fails.
Allowed values: Min 1, max 72.
Sourcepub fn get_cool_off_period(&self) -> &Option<i32>
pub fn get_cool_off_period(&self) -> &Option<i32>
The cooling-off period during which you can unlock the snapshot or modify the lock settings after locking the snapshot in compliance mode, in hours. After the cooling-off period expires, you can't unlock or delete the snapshot, decrease the lock duration, or change the lock mode. You can increase the lock duration after the cooling-off period expires.
The cooling-off period is optional when locking a snapshot in compliance mode. If you are locking the snapshot in governance mode, omit this parameter.
To lock the snapshot in compliance mode immediately without a cooling-off period, omit this parameter.
If you are extending the lock duration for a snapshot that is locked in compliance mode after the cooling-off period has expired, omit this parameter. If you specify a cooling-period in a such a request, the request fails.
Allowed values: Min 1, max 72.
Sourcepub fn lock_duration(self, input: i32) -> Self
pub fn lock_duration(self, input: i32) -> Self
The period of time for which to lock the snapshot, in days. The snapshot lock will automatically expire after this period lapses.
You must specify either this parameter or ExpirationDate, but not both.
Allowed values: Min: 1, max 36500
Sourcepub fn set_lock_duration(self, input: Option<i32>) -> Self
pub fn set_lock_duration(self, input: Option<i32>) -> Self
The period of time for which to lock the snapshot, in days. The snapshot lock will automatically expire after this period lapses.
You must specify either this parameter or ExpirationDate, but not both.
Allowed values: Min: 1, max 36500
Sourcepub fn get_lock_duration(&self) -> &Option<i32>
pub fn get_lock_duration(&self) -> &Option<i32>
The period of time for which to lock the snapshot, in days. The snapshot lock will automatically expire after this period lapses.
You must specify either this parameter or ExpirationDate, but not both.
Allowed values: Min: 1, max 36500
Sourcepub fn expiration_date(self, input: DateTime) -> Self
pub fn expiration_date(self, input: DateTime) -> Self
The date and time at which the snapshot lock is to automatically expire, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ
).
You must specify either this parameter or LockDuration, but not both.
Sourcepub fn set_expiration_date(self, input: Option<DateTime>) -> Self
pub fn set_expiration_date(self, input: Option<DateTime>) -> Self
The date and time at which the snapshot lock is to automatically expire, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ
).
You must specify either this parameter or LockDuration, but not both.
Sourcepub fn get_expiration_date(&self) -> &Option<DateTime>
pub fn get_expiration_date(&self) -> &Option<DateTime>
The date and time at which the snapshot lock is to automatically expire, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ
).
You must specify either this parameter or LockDuration, but not both.
Trait Implementations§
Source§impl Clone for LockSnapshotFluentBuilder
impl Clone for LockSnapshotFluentBuilder
Source§fn clone(&self) -> LockSnapshotFluentBuilder
fn clone(&self) -> LockSnapshotFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for LockSnapshotFluentBuilder
impl !RefUnwindSafe for LockSnapshotFluentBuilder
impl Send for LockSnapshotFluentBuilder
impl Sync for LockSnapshotFluentBuilder
impl Unpin for LockSnapshotFluentBuilder
impl !UnwindSafe for LockSnapshotFluentBuilder
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);