Struct aws_sdk_fsx::client::fluent_builders::CreateSnapshot

pub struct CreateSnapshot { /* private fields */ }

Fluent builder constructing a request to CreateSnapshot.

Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.

If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a snapshot with the specified client request token doesn't exist, CreateSnapshot does the following:

• Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of CREATING.

• Returns the description of the snapshot.

By using the idempotent operation, you can retry a CreateSnapshot operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same.

The CreateSnapshot operation returns while the snapshot's lifecycle state is still CREATING. You can check the snapshot creation status by calling the DescribeSnapshots operation, which returns the snapshot state along with other information.

Implementations

impl CreateSnapshot

pub async fn send(
    self
) -> Result<CreateSnapshotOutput, SdkError<CreateSnapshotError>>

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 client_request_token(self, input: impl Into<String>) -> Self

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

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

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

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

The name of the snapshot.

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

The name of the snapshot.

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

The ID of the volume that you are taking a snapshot of.

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

The ID of the volume that you are taking a snapshot of.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

A list of Tag values, with a maximum of 50 elements.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of Tag values, with a maximum of 50 elements.

Trait Implementations

impl Clone for CreateSnapshot

fn clone(&self) -> CreateSnapshot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateSnapshot

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

Formats the value using the given formatter.