Struct BackupRule

#[non_exhaustive]
pub struct BackupRule {
    pub rule_name: String,
    pub target_backup_vault_name: String,
    pub schedule_expression: Option<String>,
    pub start_window_minutes: Option<i64>,
    pub completion_window_minutes: Option<i64>,
    pub lifecycle: Option<Lifecycle>,
    pub recovery_point_tags: Option<HashMap<String, String>>,
    pub rule_id: Option<String>,
    pub copy_actions: Option<Vec<CopyAction>>,
    pub enable_continuous_backup: Option<bool>,
    pub schedule_expression_timezone: Option<String>,
    pub index_actions: Option<Vec<IndexAction>>,
}

Specifies a scheduled task used to back up a selection of resources.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rule_name: String

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

target_backup_vault_name: 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.

schedule_expression: 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.

start_window_minutes: 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).

completion_window_minutes: 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.

lifecycle: 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.

recovery_point_tags: Option<HashMap<String, String>>

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

rule_id: Option<String>

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

copy_actions: Option<Vec<CopyAction>>

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

enable_continuous_backup: 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.

schedule_expression_timezone: 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.

index_actions: 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.

Implementations

impl BackupRule

pub fn rule_name(&self) -> &str

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

pub fn target_backup_vault_name(&self) -> &str

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) -> Option<&str>

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) -> 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) -> 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) -> 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) -> 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) -> Option<&str>

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

pub fn copy_actions(&self) -> &[CopyAction]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .copy_actions.is_none().

pub fn 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) -> Option<&str>

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) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .index_actions.is_none().

impl BackupRule

pub fn builder() -> BackupRuleBuilder

Creates a new builder-style object to manufacture BackupRule.

Trait Implementations

impl Clone for BackupRule

fn clone(&self) -> BackupRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BackupRule

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

Formats the value using the given formatter.

impl PartialEq for BackupRule

fn eq(&self, other: &BackupRule) -> 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 BackupRule