Struct aws_sdk_lightsail::client::fluent_builders::CreateDiskSnapshot

pub struct CreateDiskSnapshot<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateDiskSnapshot.

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.

You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.

You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.

The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

Implementations

impl<C, M, R> CreateDiskSnapshot<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateDiskSnapshotOutput, SdkError<CreateDiskSnapshotError>> where
    R::Policy: SmithyRetryPolicy<CreateDiskSnapshotInputOperationOutputAlias, CreateDiskSnapshotOutput, CreateDiskSnapshotError, CreateDiskSnapshotInputOperationRetryAlias>, 

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

The unique name of the source disk (e.g., Disk-Virginia-1).

This parameter cannot be defined together with the instance name parameter. The disk name and instance name parameters are mutually exclusive.

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

The unique name of the source disk (e.g., Disk-Virginia-1).

This parameter cannot be defined together with the instance name parameter. The disk name and instance name parameters are mutually exclusive.

pub fn disk_snapshot_name(self, inp: impl Into<String>) -> Self

The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the source disk.

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

The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the source disk.

pub fn instance_name(self, inp: impl Into<String>) -> Self

The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1). When this is defined, a snapshot of the instance's system volume is created.

This parameter cannot be defined together with the disk name parameter. The instance name and disk name parameters are mutually exclusive.

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

The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1). When this is defined, a snapshot of the instance's system volume is created.

This parameter cannot be defined together with the disk name parameter. The instance name and disk name parameters are mutually exclusive.

pub fn tags(self, inp: impl Into<Tag>) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

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

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CreateDiskSnapshot<C, M, R>

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

Formats the value using the given formatter.