» Resource: aws_backup_plan

Provides an AWS Backup plan resource.

» Example Usage

resource "aws_backup_plan" "example" {
  name = "tf_example_backup_plan"

  rule {
    rule_name         = "tf_example_backup_rule"
    target_vault_name = "${aws_backup_vault.test.name}"
    schedule          = "cron(0 12 * * ? *)"
  }
}

» Argument Reference

The following arguments are supported:

  • name - (Required) The display name of a backup plan.
  • rule - (Required) A rule object that specifies a scheduled task that is used to back up a selection of resources.
  • tags - (Optional) Metadata that you can assign to help organize the plans you create.

» Rule Arguments

For rule the following attributes are supported:

  • rule_name - (Required) An display name for a backup rule.
  • target_vault_name (Required) - The name of a logical container where backups are stored.
  • schedule (Optional) - A CRON expression specifying when AWS Backup initiates a backup job.
  • start_window (Optional) - The amount of time in minutes before beginning a backup.
  • completion_window (Optional) - The amount of time AWS Backup attempts a backup before canceling the job and returning an error.
  • lifecycle (Optional) - The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Fields documented below.
  • recovery_point_tags (Optional) - Metadata that you can assign to help organize the resources that you create.

» Lifecycle Arguments

For lifecycle the following attributes are supported:

  • 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.

» Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - The id of the backup plan.
  • arn - The ARN of the backup plan.
  • version - Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan.