Struct aws_sdk_ec2::operation::lock_snapshot::builders::LockSnapshotFluentBuilder

pub struct LockSnapshotFluentBuilder { /* private fields */ }

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

impl LockSnapshotFluentBuilder

pub fn as_input(&self) -> &LockSnapshotInputBuilder

Access the LockSnapshot as a reference.

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.

pub fn customize( self ) -> CustomizableOperation<LockSnapshotOutput, LockSnapshotError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn snapshot_id(self, input: impl Into<String>) -> Self

The ID of the snapshot to lock.

pub fn set_snapshot_id(self, input: Option<String>) -> Self

The ID of the snapshot to lock.

pub fn get_snapshot_id(&self) -> &Option<String>

The ID of the snapshot to lock.

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.

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.

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.

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 to governance. 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.

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 to governance. 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.

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 to governance. 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.

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.

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.

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.

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

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

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

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.

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.

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

impl Clone for LockSnapshotFluentBuilder

fn clone(&self) -> LockSnapshotFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LockSnapshotFluentBuilder

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

Formats the value using the given formatter.