Module: `backup`

Terraform module to provision AWS Backup, a fully managed backup service that makes it easy to centralize and automate the back up of data across AWS services such as Amazon EBS volumes, Amazon EC2 instances, Amazon RDS databases, Amazon DynamoDB tables, Amazon EFS file systems, and AWS Storage Gateway volumes.

note

The syntax of declaring a backup schedule has changed as of release 0.14.0, follow the instructions in the 0.13.x to 0.14.x+ migration guide.

warning

The deprecated variables have been fully deprecated as of 1.x.x. Please use the new variables as described in the 0.13.x to 0.14.x+ migration guide.

Usage

For a complete example on how to backup an Elastic File System (EFS), see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

provider "aws" {
  region = var.region
}

module "vpc" {
  source = "cloudposse/vpc/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  namespace  = var.namespace
  stage      = var.stage
  name       = var.name
  attributes = var.attributes
  tags       = var.tags
  delimiter  = var.delimiter

  ipv4_primary_cidr_block = "172.16.0.0/16"
}

module "subnets" {
  source = "cloudposse/dynamic-subnets/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  namespace  = var.namespace
  stage      = var.stage
  name       = var.name
  attributes = var.attributes
  tags       = var.tags
  delimiter  = var.delimiter

  availability_zones   = var.availability_zones
  vpc_id               = module.vpc.vpc_id
  igw_id               = [module.vpc.igw_id]
  ipv4_cidr_block      = module.vpc.vpc_cidr_block
  nat_gateway_enabled  = false
  nat_instance_enabled = false
}

module "efs" {
  source = "cloudposse/efs/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  namespace  = var.namespace
  stage      = var.stage
  name       = var.name
  attributes = var.attributes
  tags       = var.tags
  delimiter  = var.delimiter

  region             = var.region
  availability_zones = var.availability_zones
  vpc_id             = module.vpc.vpc_id
  subnets            = module.subnets.private_subnet_ids

  allowed_security_group_ids = [module.vpc.vpc_default_security_group_id]
}

module "backup" {
  source = "cloudposse/backup/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  namespace  = var.namespace
  stage      = var.stage
  name       = var.name
  attributes = var.attributes
  tags       = var.tags
  delimiter  = var.delimiter

  plan_name_suffix = var.plan_name_suffix
  vault_enabled    = var.vault_enabled
  iam_role_enabled = var.iam_role_enabled
  plan_enabled     = var.plan_enabled

  selection_tags   = var.selection_tags
  backup_resources = [module.efs.arn]
  not_resources    = var.not_resources

  rules = var.rules

  kms_key_arn = var.kms_key_arn

  advanced_backup_setting         = var.advanced_backup_setting
  backup_vault_lock_configuration = var.backup_vault_lock_configuration

}

In the above example var.rules could be defined as follows:

rules = [
  {
    name              = "${module.this.name}-daily"
    schedule          = var.schedule
    start_window      = var.start_window
    completion_window = var.completion_window
    lifecycle         = {
      cold_storage_after = var.cold_storage_after
      delete_after       = var.delete_after
    }
  }
]

or as yaml

rules:
  - name: "plan-daily"
    schedule: "cron(0 5 ? * * *)"
    start_window: 320 # 60 * 8             # minutes
    completion_window: 10080 # 60 * 24 * 7 # minutes
    delete_after: 35 # 7 * 5     

Variables

Required Variables

Optional Variables

advanced_backup_setting optional

An object that specifies backup options for each resource type

Type:

object({
backup_options = string
resource_type  = string
})

Default value: null

backup_resources (list(string)) optional

An array of strings that either contain Amazon Resource Names (ARNs) or match patterns of resources to assign to a backup plan

Default value: [ ]

backup_vault_lock_configuration optional

The backup vault lock configuration, each vault can have one vault lock in place. This will enable Backup Vault Lock on an AWS Backup vault it prevents the deletion of backup data for the specified retention period. During this time, the backup data remains immutable and cannot be deleted or modified."
changeable_for_days - The number of days before the lock date. If omitted creates a vault lock in governance mode, otherwise it will create a vault lock in compliance mode.

Type:

object({
changeable_for_days = optional(number)
max_retention_days  = optional(number)
min_retention_days  = optional(number)
})

Default value: null

iam_role_enabled (bool) optional

Should we create a new Iam Role and Policy Attachment

Default value: true

iam_role_name (string) optional

Override target IAM Role Name

Default value: null

kms_key_arn (string) optional

The server-side encryption key that is used to protect your backups

Default value: null

not_resources (list(string)) optional

An array of strings that either contain Amazon Resource Names (ARNs) or match patterns of resources to exclude from a backup plan

Default value: [ ]

permissions_boundary (string) optional

The permissions boundary to set on the role

Default value: null

plan_enabled (bool) optional

Should we create a new Plan

Default value: true

plan_name_suffix (string) optional

The string appended to the plan name

Default value: null

rules optional

A list of rule objects used to define schedules in a backup plan. Follows the following structure:

  rules:<br/>
    - name: "plan-daily"<br/>
      schedule: "cron(0 5 ? * * *)"<br/>
      start_window: 320 # 60 * 8             # minutes<br/>
      completion_window: 10080 # 60 * 24 * 7 # minutes<br/>
      delete_after: 35 # 7 * 5               # days<br/>
    - name: "plan-weekly"<br/>
      schedule: "cron(0 5 ? * SAT *)"<br/>
      start_window: 320 # 60 * 8              # minutes<br/>
      completion_window: 10080 # 60 * 24 * 7  # minutes<br/>
      delete_after: 90 # 30 * 3<br/>
```<br/>
<br/>
<br/>
<br/>

**Type:**
```hcl
list(object({
name                     = string
schedule                 = optional(string)
enable_continuous_backup = optional(bool)
start_window             = optional(number)
completion_window        = optional(number)
lifecycle = optional(object({
 cold_storage_after                        = optional(number)
 delete_after                              = optional(number)
 opt_in_to_archive_for_supported_resources = optional(bool)
}))
copy_action = optional(object({
 destination_vault_arn = optional(string)
 lifecycle = optional(object({
   cold_storage_after                        = optional(number)
   delete_after                              = optional(number)
   opt_in_to_archive_for_supported_resources = optional(bool)
 }))
}))
}))

Default value: [ ]

selection_tags optional

An array of tag condition objects used to filter resources based on tags for assigning to a backup plan

Type:

list(object({
type  = string
key   = string
value = string
}))

Default value: [ ]

vault_enabled (bool) optional

Should we create a new Vault

Default value: true

vault_name (string) optional

Override target Vault Name

Default value: null

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.

Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.

Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.

Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.

Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

backup_plan_arn: Backup Plan ARN
backup_plan_version: Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan
backup_selection_id: Backup Selection ID
backup_vault_arn: Backup Vault ARN
backup_vault_id: Backup Vault ID
role_arn: The Amazon Resource Name (ARN) specifying the role
role_name: The name of the IAM role created

Dependencies

Requirements

terraform, version: >= 1.3.0
aws, version: >= 3.0

Providers

aws, version: >= 3.0

Modules

Name	Version	Source	Description
`label_backup_role`	0.25.0	`cloudposse/label/null`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_backup_plan.default (resource)
aws_backup_selection.default (resource)
aws_backup_vault.default (resource)
aws_backup_vault_lock_configuration.default (resource)
aws_iam_role.default (resource)
aws_iam_role_policy_attachment.default (resource)

Data Sources

The following data sources are used by this module:

aws_backup_vault.existing (data source)
aws_iam_policy_document.assume_role (data source)
aws_iam_role.existing (data source)
aws_partition.current (data source)

Module: backup

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `backup`

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources