AwsBackupBackupPlanRuleDetails - Amazon Security Hub
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AwsBackupBackupPlanRuleDetails

Provides details about an array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

Contents

CompletionWindowMinutes

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

Type: Long

Required: No

CopyActions

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

Type: Array of AwsBackupBackupPlanRuleCopyActionsDetails objects

Required: No

EnableContinuousBackup

Specifies whether Amazon Backup creates continuous backups capable of point-in-time restore (PITR).

Type: Boolean

Required: No

Lifecycle

Defines when a protected resource is transitioned to cold storage and when it expires. Amazon Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Amazon Backup applies the lifecycle policy of the source backup to the destination backup.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

Type: AwsBackupBackupPlanLifecycleDetails object

Required: No

RuleId

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

Type: String

Pattern: .*\S.*

Required: No

RuleName

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

Type: String

Pattern: .*\S.*

Required: No

ScheduleExpression

A cron expression in UTC specifying when Amazon Backup initiates a backup job.

Type: String

Pattern: .*\S.*

Required: No

StartWindowMinutes

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.

Type: Long

Required: No

TargetBackupVault

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

Type: String

Pattern: .*\S.*

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: