Skip to content

Latest commit

 

History

History
 
 

plan

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

Inputs

Name Description Type Default Required
completion_window The amount of time AWS Backup attempts a backup before canceling the job and returning an error. Defaults to 8 hours. string "480" no
lifecycle Optionally specify lifecycle configuration for the backup. use_lifecycle must be true. cold_storage_after - (Optional) Specifies the number of days after creation that a recovery point is moved to cold storage. delete_after (Optional) - Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than cold_storage_after. Example: lifecycle = { cold_storage_after = 10 delete_after = 100 } map <map> no
plan_name The display name of a backup plan. string n/a yes
plan_tags Map of Backup plan tags. i.e. { 'tag_name' = 'tag_value' } map <map> no
recovery_point_tags Map of Metadata that you can assign to help organize the resources that you create. i.e. [{key = 'foo', value = 'bar'}]. map <map> no
rule_name A display name for a backup rule. string n/a yes
schedule A CRON expression specifying when AWS Backup initiates a backup job. Default is 05:00 UTC every day. Consult https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html for expression help. string "cron(0 5 * * ? *)" no
start_window The amount of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully. Minimum and Default value is 60. Max is 720 (12 Hours). string "60" no
target_vault_name The name of a logical container where backups are stored. string n/a yes
use_lifecycle Set to true if an input was provided for variable lifecycle. string "false" no

Outputs

Name Description
plan_arn Plan ARN.
plan_id Plan ID
plan_version Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan.