Struct aws_sdk_backup::model::backup_job::Builder

#[non_exhaustive]
pub struct Builder { /* private fields */ }

A builder for BackupJob

Implementations

impl Builder

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

The account ID that owns the backup job.

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

The account ID that owns the backup job.

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

Uniquely identifies a request to Backup to back up a resource.

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

Uniquely identifies a request to Backup to back up a resource.

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

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

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

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

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

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

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

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

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

An 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 ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

pub fn creation_date(self, input: DateTime) -> Self

The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

pub fn set_creation_date(self, input: Option<DateTime>) -> Self

The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

pub fn completion_date(self, input: DateTime) -> Self

The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

pub fn set_completion_date(self, input: Option<DateTime>) -> Self

The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

pub fn state(self, input: BackupJobState) -> Self

The current state of a resource recovery point.

pub fn set_state(self, input: Option<BackupJobState>) -> Self

The current state of a resource recovery point.

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

A detailed message explaining the status of the job to back up a resource.

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

A detailed message explaining the status of the job to back up a resource.

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

Contains an estimated percentage complete of a job at the time the job status was queried.

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

Contains an estimated percentage complete of a job at the time the job status was queried.

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

The size, in bytes, of a backup.

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

The size, in bytes, of a backup.

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

Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.

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

Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.

pub fn created_by(self, input: RecoveryPointCreator) -> Self

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

pub fn set_created_by(self, input: Option<RecoveryPointCreator>) -> Self

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

pub fn expected_completion_date(self, input: DateTime) -> Self

The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

pub fn set_expected_completion_date(self, input: Option<DateTime>) -> Self

The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

pub fn start_by(self, input: DateTime) -> Self

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

pub fn set_start_by(self, input: Option<DateTime>) -> Self

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

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

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

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

The size in bytes transferred to a backup vault at the time that the job status was queried.

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

The size in bytes transferred to a backup vault at the time that the job status was queried.

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

Adds a key-value pair to backup_options.

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. If you specify an invalid option, you get an InvalidParameterValueException exception.

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. If you specify an invalid option, you get an InvalidParameterValueException exception.

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

Represents the type of backup for a backup job.

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

Represents the type of backup for a backup job.

pub fn build(self) -> BackupJob

Consumes the builder and constructs a BackupJob

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder) -> bool

This method tests for !=.

impl StructuralPartialEq for Builder