Struct aws_sdk_storagegateway::client::fluent_builders::UpdateSnapshotSchedule

pub struct UpdateSnapshotSchedule { /* private fields */ }

Fluent builder constructing a request to UpdateSnapshotSchedule.

Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types.

The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.

In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.

Implementations

impl UpdateSnapshotSchedule

pub async fn send(
    self
) -> Result<UpdateSnapshotScheduleOutput, SdkError<UpdateSnapshotScheduleError>>

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

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

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

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

pub fn start_at(self, input: i32) -> Self

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

pub fn set_start_at(self, input: Option<i32>) -> Self

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

pub fn recurrence_in_hours(self, input: i32) -> Self

Frequency of snapshots. Specify the number of hours between snapshots.

pub fn set_recurrence_in_hours(self, input: Option<i32>) -> Self

Frequency of snapshots. Specify the number of hours between snapshots.

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

Optional description of the snapshot that overwrites the existing description.

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

Optional description of the snapshot that overwrites the existing description.

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 up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

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

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Trait Implementations

impl Clone for UpdateSnapshotSchedule

fn clone(&self) -> UpdateSnapshotSchedule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateSnapshotSchedule

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

Formats the value using the given formatter.