Query

aws::backup-plan

Creates a backup plan.

Example

aws::backup-plan backup
    configuration
        name: my-rds-backups

        rule
            name: weekly
            target-backup-vault: $(aws::backup-vault target-vault)

            schedule: 'cron(0 5 ? * * *)'
            start-window-minutes: 60

            completion-window-minutes: 120
            enable-continuous-backup: false

            recovery-point-tags: {
               "example-tag": "example-value"
            }

            lifecycle
                delete-after-days: 365
                move-to-cold-storage-after-days: 30
            end

            copy-action
                destination-backup-vault: $(aws::backup-vault destination-vault)

                lifecycle
                    delete-after-days: 365
                    move-to-cold-storage-after-days: 30
                end
            end
        end
    end

    tags: {
        project: "my project"
    }
end

Attributes

Attribute	Description
configuration subresource	The body of a backup plan. (Required) advanced-backup-setting list subresource The list of backup options for each resource type. backup-options map The backup option for a selected resource. resource-type The object containing resource type and backup options. Currently the only supported value is EC2. name The name of a backup plan. (Required) rule list subresource The list of rules, each of which specifies a scheduled task that is used to back up a selection of resources. (Required) completion-window-minutes The value in minutes a backup job has to complete itself after a successfully start, before it is canceled by AWS Backup. copy-action list subresource The list of copy actions, which contains the details of the copy operation. destination-backup-vault The destination backup vault for the copied backup. (Required) lifecycle subresource The value of the Lifecycle property for this object. delete-after-days The number of days after creation that a recovery point is deleted. move-to-cold-storage-after-days The number of days after creation that a recovery point is moved to cold storage. enable-continuous-backup When set to true, AWS Backup creates continuous backups. lifecycle subresource The lifecycle which defines when a protected resource is transitioned to cold storage and when it expires. delete-after-days The number of days after creation that a recovery point is deleted. move-to-cold-storage-after-days The number of days after creation that a recovery point is moved to cold storage. recovery-point-tags map The tags for the rule. name The display name for the backup rule. Must be a string 1 to 50 characters long containing letters, numbers, underscores, periods and hyphens. Valid values satisfy the regex: [^[a-zA-Z0-9\\-\\_\\.]{1,50}$]. (Required) schedule The CRON expression specifying when AWS Backup initiates a backup job. start-window-minutes The value in minutes after a backup is scheduled before a job will be canceled if it doesn’t start successfully. Minimum allowed value is 60. target-backup-vault The logical container where backups are stored. (Required)
tags map	The tags for the plan.
creator-request-id	The ID Identifies the request and allows failed requests to be retried without the risk of running the operation twice.

Outputs

Attribute	Description
arn	The ARN of the backup plan.
id	The ID of the backup plan.