Struct BackupRuleBuilder

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

A builder for BackupRule.

Implementations

impl BackupRuleBuilder

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

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

This field is required.

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

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

pub fn get_rule_name(&self) -> &Option<String>

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

pub fn target_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.

This field is required.

pub fn set_target_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.

pub fn get_target_backup_vault_name(&self) -> &Option<String>

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.

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

A cron expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression cron(0 5 ? * * *).

For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.

Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC).

For a table of examples, click the preceding link and scroll down the page.

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

A cron expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression cron(0 5 ? * * *).

For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.

Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC).

For a table of examples, click the preceding link and scroll down the page.

pub fn get_schedule_expression(&self) -> &Option<String>

A cron expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression cron(0 5 ? * * *).

For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.

Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC).

For a table of examples, click the preceding link and scroll down the page.

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. If this value is included, it must be at least 60 minutes to avoid errors.

During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

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. If this value is included, it must be at least 60 minutes to avoid errors.

During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

pub fn get_start_window_minutes(&self) -> &Option<i64>

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. If this value is included, it must be at least 60 minutes to avoid errors.

During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

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

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.

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

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.

pub fn get_completion_window_minutes(&self) -> &Option<i64>

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.

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

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires 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 can transition to cold storage are listed in 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 transitions and expires 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 can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

pub fn get_lifecycle(&self) -> &Option<Lifecycle>

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires 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 can transition to cold storage are listed in 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 recovery_point_tags.

To override the contents of this collection use set_recovery_point_tags.

The tags that are assigned to resources that are associated with this rule when restored from backup.

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

The tags that are assigned to resources that are associated with this rule when restored from backup.

pub fn get_recovery_point_tags(&self) -> &Option<HashMap<String, String>>

The tags that are assigned to resources that are associated with this rule when restored from backup.

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

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

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

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

pub fn get_rule_id(&self) -> &Option<String>

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

pub fn copy_actions(self, input: CopyAction) -> Self

Appends an item to copy_actions.

To override the contents of this collection use set_copy_actions.

An array of CopyAction objects, which contains the details of the copy operation.

pub fn set_copy_actions(self, input: Option<Vec<CopyAction>>) -> Self

An array of CopyAction objects, which contains the details of the copy operation.

pub fn get_copy_actions(&self) -> &Option<Vec<CopyAction>>

An array of CopyAction objects, which contains the details of the copy operation.

pub fn enable_continuous_backup(self, input: bool) -> Self

Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

pub fn set_enable_continuous_backup(self, input: Option<bool>) -> Self

Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

pub fn get_enable_continuous_backup(&self) -> &Option<bool>

Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

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

The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

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

The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

pub fn get_schedule_expression_timezone(&self) -> &Option<String>

The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

pub fn index_actions(self, input: IndexAction) -> Self

Appends an item to index_actions.

To override the contents of this collection use set_index_actions.

IndexActions is an array you use to specify how backup data should be indexed.

eEach BackupRule can have 0 or 1 IndexAction, as each backup can have up to one index associated with it.

Within the array is ResourceType. Only one will be accepted for each BackupRule.

pub fn set_index_actions(self, input: Option<Vec<IndexAction>>) -> Self

IndexActions is an array you use to specify how backup data should be indexed.

eEach BackupRule can have 0 or 1 IndexAction, as each backup can have up to one index associated with it.

Within the array is ResourceType. Only one will be accepted for each BackupRule.

pub fn get_index_actions(&self) -> &Option<Vec<IndexAction>>

IndexActions is an array you use to specify how backup data should be indexed.

eEach BackupRule can have 0 or 1 IndexAction, as each backup can have up to one index associated with it.

Within the array is ResourceType. Only one will be accepted for each BackupRule.

pub fn build(self) -> Result<BackupRule, BuildError>

Consumes the builder and constructs a BackupRule. This method will fail if any of the following fields are not set:

• rule_name
• target_backup_vault_name

Trait Implementations

impl Clone for BackupRuleBuilder

fn clone(&self) -> BackupRuleBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BackupRuleBuilder

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

Formats the value using the given formatter.

impl Default for BackupRuleBuilder

fn default() -> BackupRuleBuilder

Returns the “default value” for a type.

impl PartialEq for BackupRuleBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BackupRuleBuilder