Struct aws_sdk_backup::client::fluent_builders::StartBackupJob

pub struct StartBackupJob { /* private fields */ }

Fluent builder constructing a request to StartBackupJob.

Starts an on-demand backup job for the specified resource.

Implementations

impl StartBackupJob

pub async fn customize(
    self
) -> Result<CustomizableOperation<StartBackupJob, AwsResponseRetryClassifier>, SdkError<StartBackupJobError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<StartBackupJobOutput, SdkError<StartBackupJobError>>

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

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

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

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

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

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

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

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

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

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

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

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

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

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

pub fn start_window_minutes(self, input: i64) -> Self

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.

pub fn set_start_window_minutes(self, input: Option<i64>) -> Self

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.

pub fn complete_window_minutes(self, input: i64) -> Self

A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

pub fn set_complete_window_minutes(self, input: Option<i64>) -> Self

A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

pub fn lifecycle(self, input: Lifecycle) -> Self

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

pub fn set_lifecycle(self, input: Option<Lifecycle>) -> Self

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

pub fn recovery_point_tags(
    self,
    k: impl Into<String>,
    v: impl Into<String>
) -> Self

Adds a key-value pair to RecoveryPointTags.

To override the contents of this collection use set_recovery_point_tags.

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

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

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

pub fn backup_options(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to BackupOptions.

To override the contents of this collection use set_backup_options.

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

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

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Trait Implementations

impl Clone for StartBackupJob

fn clone(&self) -> StartBackupJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartBackupJob

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

Formats the value using the given formatter.