Skip to main content

Component: aws-backup

This component is responsible for provisioning an AWS Backup Plan. It creates a schedule for backing up given ARNs.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component.

Component Abstraction and Separation

By separating the "common" settings from the component, we can first provision the IAM Role and AWS Backup Vault to prepare resources for future use without incuring cost.

For example, stacks/catalog/aws-backup/common:

# This configuration creates the AWS Backup Vault and IAM Role, and does not incur any cost on its own.
# See: https://aws.amazon.com/backup/pricing/
components:
terraform:
aws-backup:
metadata:
type: abstract
settings:
spacelift:
workspace_enabled: true
vars: {}

aws-backup/common:
metadata:
component: aws-backup
inherits:
- aws-backup
vars:
enabled: true
iam_role_enabled: true # this will be reused
vault_enabled: true # this will be reused
plan_enabled: false

## Please be careful when enabling backup_vault_lock_configuration,
# backup_vault_lock_configuration:
## `changeable_for_days` enables compliance mode and once the lock is set, the retention policy cannot be changed unless through account deletion!
# changeable_for_days: 36500
# max_retention_days: 365
# min_retention_days: 1

Then if we would like to deploy the component into a given stacks we can import the following to deploy our backup plans.

Since most of these values are shared and common, we can put them in a catalog/aws-backup/ yaml file and share them across environments.

This makes deploying the same configuration to multiple environments easy.

stacks/catalog/aws-backup/defaults:

import:
- catalog/aws-backup/common

components:
terraform:
aws-backup/plan-defaults:
metadata:
component: aws-backup
type: abstract
settings:
spacelift:
workspace_enabled: true
depends_on:
- aws-backup/common
vars:
enabled: true
iam_role_enabled: false # reuse from aws-backup-vault
vault_enabled: false # reuse from aws-backup-vault
plan_enabled: true
plan_name_suffix: aws-backup-defaults
# in minutes
start_window: 60
completion_window: 240
# in days
cold_storage_after: null
delete_after: 30 # 1 month
copy_action_cold_storage_after: null
copy_action_delete_after: null

aws-backup/daily-plan:
metadata:
component: aws-backup
inherits:
- aws-backup/plan-defaults
vars:
plan_name_suffix: aws-backup-daily
# https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html
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 # days
selection_tags:
- type: STRINGEQUALS
key: aws-backup/efs
value: daily
- type: STRINGEQUALS
key: aws-backup/rds
value: daily

aws-backup/weekly-plan:
metadata:
component: aws-backup
inherits:
- aws-backup/plan-defaults
vars:
plan_name_suffix: aws-backup-weekly
# https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html
rules:
- name: "plan-weekly"
schedule: "cron(0 5 ? * SAT *)"
start_window: 320 # 60 * 8 # minutes
completion_window: 10080 # 60 * 24 * 7 # minutes
delete_after: 90 # 30 * 3 # days
selection_tags:
- type: STRINGEQUALS
key: aws-backup/efs
value: weekly
- type: STRINGEQUALS
key: aws-backup/rds
value: weekly

aws-backup/monthly-plan:
metadata:
component: aws-backup
inherits:
- aws-backup/plan-defaults
vars:
plan_name_suffix: aws-backup-monthly
# https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html
rules:
- name: "plan-monthly"
schedule: "cron(0 5 1 * ? *)"
start_window: 320 # 60 * 8 # minutes
completion_window: 10080 # 60 * 24 * 7 # minutes
delete_after: 2555 # 365 * 7 # days
cold_storage_after: 90 # 30 * 3 # days

selection_tags:
- type: STRINGEQUALS
key: aws-backup/efs
value: monthly
- type: STRINGEQUALS
key: aws-backup/rds
value: monthly

Deploying to a new stack (environment) then only requires:

import:
- catalog/aws-backup/defaults

The above configuration can be used to deploy a new backup to a new region.


Adding Resources to the Backup - Adding Tags

Once an aws-backup with a plan and selection_tags has been established we can begin adding resources for it to backup by using the tagging method.

This only requires that we add tags to the resources we wish to backup, which can be done with the following snippet:

components:
terraform:
<my-resource>
vars:
tags:
aws-backup/resource_schedule: "daily-14day-backup"

Just ensure the tag key-value pair matches what was added to your backup plan and aws will take care of the rest.

Copying across regions

If we want to create a backup vault in another region that we can copy to, then we need to create another vault, and then specify that we want to copy to it.

To create a vault in a region simply:

components:
terraform:
aws-backup:
vars:
plan_enabled: false # disables the plan (which schedules resource backups)

This will output an arn - which you can then use as the copy destination, as seen in the following snippet:

components:
terraform:
aws-backup:
vars:
destination_vault_arn: arn:aws:backup:<other-region>:111111111111:backup-vault:<namespace>-<other-region>-<stage>
copy_action_delete_after: 14

Backup Lock Configuration

To enable backup lock configuration, you can use the following snippet:

Compliance Mode

Vaults locked in compliance mode cannot be deleted once the cooling-off period ("grace time") expires. During grace time, you can still remove the vault lock and change the lock configuration.

To enable Compliance Mode, set changeable_for_days to a value greater than 0. Once the lock is set, the retention policy cannot be changed unless through account deletion!

# Please be careful when enabling backup_vault_lock_configuration,  
backup_vault_lock_configuration:
# `changeable_for_days` enables compliance mode and once the lock is set, the retention policy cannot be changed unless through account deletion!
changeable_for_days: 36500
max_retention_days: 365
min_retention_days: 1

Governance Mode

Vaults locked in governance mode can have the lock removed by users with sufficient IAM permissions.

To enable governance mode

        backup_vault_lock_configuration:
max_retention_days: 365
min_retention_days: 1

Requirements

NameVersion
terraform>= 1.3.0
aws>= 4.9.0

Providers

No providers.

Modules

NameSourceVersion
backupcloudposse/backup/aws1.0.0
copy_destination_vaultcloudposse/stack-config/yaml//modules/remote-state1.5.0
iam_roles../account-map/modules/iam-rolesn/a
thiscloudposse/label/null0.25.0

Resources

No resources.

Inputs

NameDescriptionTypeDefaultRequired
additional_tag_mapAdditional 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.
map(string){}no
advanced_backup_settingAn object that specifies backup options for each resource type.
object({
backup_options = string
resource_type = string
})
nullno
attributesID 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.
list(string)[]no
backup_resourcesAn array of strings that either contain Amazon Resource Names (ARNs) or match patterns of resources to assign to a backup planlist(string)[]no
backup_vault_lock_configurationThe 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.
object({
changeable_for_days = optional(number)
max_retention_days = optional(number)
min_retention_days = optional(number)
})
nullno
cold_storage_afterSpecifies the number of days after creation that a recovery point is moved to cold storagenumbernullno
completion_windowThe amount of time AWS Backup attempts a backup before canceling the job and returning an error. Must be at least 60 minutes greater than start_windownumbernullno
contextSingle 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.
any
{
"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
}
no
copy_action_cold_storage_afterFor copy operation, specifies the number of days after creation that a recovery point is moved to cold storagenumbernullno
copy_action_delete_afterFor copy operation, specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than copy_action_cold_storage_afternumbernullno
delete_afterSpecifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than cold_storage_afternumbernullno
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
stringnullno
descriptor_formatsDescribe 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).
any{}no
destination_vault_arnAn Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backupstringnullno
destination_vault_component_nameThe name of the component to be used to look up the destination vaultstring"aws-backup/common"no
destination_vault_regionThe short region of the destination backup vaultstringnullno
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
iam_role_enabledWhether or not to create a new IAM Role and Policy Attachmentbooltrueno
id_length_limitLimit 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.
numbernullno
kms_key_arnThe server-side encryption key that is used to protect your backupsstringnullno
label_key_caseControls 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.
stringnullno
label_orderThe 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.
list(string)nullno
label_value_caseControls 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.
stringnullno
labels_as_tagsSet 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.
set(string)
[
"default"
]
no
nameID 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.
stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
plan_enabledWhether or not to create a new Planbooltrueno
plan_name_suffixThe string appended to the plan namestringnullno
regex_replace_charsTerraform 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.
stringnullno
regionAWS Regionstringn/ayes
rulesAn array of rule maps used to define schedules in a backup plan
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)
}))
}))
}))
[]no
scheduleA CRON expression specifying when AWS Backup initiates a backup jobstringnullno
selection_tagsAn array of tag condition objects used to filter resources based on tags for assigning to a backup planlist(map(string))[]no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
start_windowThe amount of time in minutes before beginning a backup. Minimum value is 60 minutesnumbernullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
vault_enabledWhether or not a new Vault should be createdbooltrueno

Outputs

NameDescription
backup_plan_arnBackup Plan ARN
backup_plan_versionUnique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan
backup_selection_idBackup Selection ID
backup_vault_arnBackup Vault ARN
backup_vault_idBackup Vault ID
copy_destination_backup_vault_arnARN of the destination Backup Vault copy

References