major update: remove deprecated, singular rule type (#63)

* major update: remove deprecated, singular rule type * docs * bugfix: disabled * Apply suggestions from code review Co-authored-by: Yonatan Koren <[email protected]> * update docs from PR changes --------- Co-authored-by: Yonatan Koren <[email protected]>
cloudposse · Jan 30, 2024 · b4167fc · b4167fc
1 parent ab48d1c
commit b4167fc
Show file tree

Hide file tree

Showing 7 changed files with 184 additions and 163 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,11 @@ Terraform module to provision [AWS Backup](https://aws.amazon.com/backup), a ful
 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](./docs/migration-0.13.x-0.14.x+.md).
+> [!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](./docs/migration-0.13.x-0.14.x+.md).
+
+> [!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](./docs/migration-0.13.x-0.14.x+.md).
 
 
 ---
@@ -137,19 +141,51 @@ module "backup" {
   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 = [
-    {
-      name               = var.name
-      schedule           = var.schedule
-      start_window       = var.start_window
-      completion_window  = var.completion_window
+
+  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:
+
+```hcl
+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
+
+```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     
 ```
 
 
@@ -210,19 +246,13 @@ Available targets:
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_additional_tag_map"></a> [additional\_tag\_map](#input\_additional\_tag\_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no |
+| <a name="input_advanced_backup_setting"></a> [advanced\_backup\_setting](#input\_advanced\_backup\_setting) | n/a | <pre>object({<br>    backup_options = string<br>    resource_type  = string<br>  })</pre> | `null` | no |
 | <a name="input_attributes"></a> [attributes](#input\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the `delimiter`<br>and treated as a single ID element. | `list(string)` | `[]` | no |
 | <a name="input_backup_resources"></a> [backup\_resources](#input\_backup\_resources) | An array of strings that either contain Amazon Resource Names (ARNs) or match patterns of resources to assign to a backup plan | `list(string)` | `[]` | no |
 | <a name="input_backup_vault_lock_configuration"></a> [backup\_vault\_lock\_configuration](#input\_backup\_vault\_lock\_configuration) | 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."<br>`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. | <pre>object({<br>    changeable_for_days = optional(number)<br>    max_retention_days  = optional(number)<br>    min_retention_days  = optional(number)<br>  })</pre> | `null` | no |
-| <a name="input_cold_storage_after"></a> [cold\_storage\_after](#input\_cold\_storage\_after) | DEPRECATED: see [migration guide](./docs/migration-0.13.x-0.14.x+.md)<br>Specifies the number of days after creation that a recovery point is moved to cold storage | `number` | `null` | no |
-| <a name="input_completion_window"></a> [completion\_window](#input\_completion\_window) | DEPRECATED: see [migration guide](./docs/migration-0.13.x-0.14.x+.md)<br>The 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_window` | `number` | `null` | no |
 | <a name="input_context"></a> [context](#input\_context) | Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | <pre>{<br>  "additional_tag_map": {},<br>  "attributes": [],<br>  "delimiter": null,<br>  "descriptor_formats": {},<br>  "enabled": true,<br>  "environment": null,<br>  "id_length_limit": null,<br>  "label_key_case": null,<br>  "label_order": [],<br>  "label_value_case": null,<br>  "labels_as_tags": [<br>    "unset"<br>  ],<br>  "name": null,<br>  "namespace": null,<br>  "regex_replace_chars": null,<br>  "stage": null,<br>  "tags": {},<br>  "tenant": null<br>}</pre> | no |
-| <a name="input_copy_action_cold_storage_after"></a> [copy\_action\_cold\_storage\_after](#input\_copy\_action\_cold\_storage\_after) | DEPRECATED: see [migration guide](./docs/migration-0.13.x-0.14.x+.md)<br>For copy operation, specifies the number of days after creation that a recovery point is moved to cold storage | `number` | `null` | no |
-| <a name="input_copy_action_delete_after"></a> [copy\_action\_delete\_after](#input\_copy\_action\_delete\_after) | DEPRECATED: see [migration guide](./docs/migration-0.13.x-0.14.x+.md)<br>For 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_after` | `number` | `null` | no |
-| <a name="input_delete_after"></a> [delete\_after](#input\_delete\_after) | DEPRECATED: see [migration guide](./docs/migration-0.13.x-0.14.x+.md)<br>Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than `cold_storage_after` | `number` | `null` | no |
 | <a name="input_delimiter"></a> [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.<br>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no |
 | <a name="input_descriptor_formats"></a> [descriptor\_formats](#input\_descriptor\_formats) | Describe additional descriptors to be output in the `descriptors` output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>`{<br>   format = string<br>   labels = list(string)<br>}`<br>(Type is `any` so the map values can later be enhanced to provide additional options.)<br>`format` is a Terraform format string to be passed to the `format()` function.<br>`labels` is a list of labels, in order, to pass to `format()` function.<br>Label values will be normalized before being passed to `format()` so they will be<br>identical to how they appear in `id`.<br>Default is `{}` (`descriptors` output will be empty). | `any` | `{}` | no |
-| <a name="input_destination_vault_arn"></a> [destination\_vault\_arn](#input\_destination\_vault\_arn) | DEPRECATED: see [migration guide](./docs/migration-0.13.x-0.14.x+.md)<br>An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup | `string` | `null` | no |
-| <a name="input_enable_continuous_backup"></a> [enable\_continuous\_backup](#input\_enable\_continuous\_backup) | DEPRECATED: see [migration guide](./docs/migration-0.13.x-0.14.x+.md)<br>Enable continuous backups for supported resources. | `bool` | `null` | no |
 | <a name="input_enabled"></a> [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |
 | <a name="input_environment"></a> [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |
 | <a name="input_iam_role_enabled"></a> [iam\_role\_enabled](#input\_iam\_role\_enabled) | Should we create a new Iam Role and Policy Attachment | `bool` | `true` | no |
@@ -240,11 +270,9 @@ Available targets:
 | <a name="input_plan_enabled"></a> [plan\_enabled](#input\_plan\_enabled) | Should we create a new Plan | `bool` | `true` | no |
 | <a name="input_plan_name_suffix"></a> [plan\_name\_suffix](#input\_plan\_name\_suffix) | The string appended to the plan name | `string` | `null` | no |
 | <a name="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no |
-| <a name="input_rules"></a> [rules](#input\_rules) | An array of rule maps used to define schedules in a backup plan | `list(any)` | `[]` | no |
-| <a name="input_schedule"></a> [schedule](#input\_schedule) | DEPRECATED: see [migration guide](./docs/migration-0.13.x-0.14.x+.md)<br>A CRON expression specifying when AWS Backup initiates a backup job | `string` | `null` | no |
+| <a name="input_rules"></a> [rules](#input\_rules) | A list of rule objects used to define schedules in a backup plan. Follows the following structure:<pre>yaml<br>   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</pre> | <pre>list(object({<br>    name                     = string<br>    schedule                 = optional(string)<br>    enable_continuous_backup = optional(bool)<br>    start_window             = optional(number)<br>    completion_window        = optional(number)<br>    lifecycle = optional(object({<br>      cold_storage_after                        = optional(number)<br>      delete_after                              = optional(number)<br>      opt_in_to_archive_for_supported_resources = optional(bool)<br>    }))<br>    copy_action = optional(object({<br>      destination_vault_arn = optional(string)<br>      lifecycle = optional(object({<br>        cold_storage_after                        = optional(number)<br>        delete_after                              = optional(number)<br>        opt_in_to_archive_for_supported_resources = optional(bool)<br>      }))<br>    }))<br>  }))</pre> | `[]` | no |
 | <a name="input_selection_tags"></a> [selection\_tags](#input\_selection\_tags) | An array of tag condition objects used to filter resources based on tags for assigning to a backup plan | <pre>list(object({<br>    type  = string<br>    key   = string<br>    value = string<br>  }))</pre> | `[]` | no |
 | <a name="input_stage"></a> [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |
-| <a name="input_start_window"></a> [start\_window](#input\_start\_window) | DEPRECATED: see [migration guide](./docs/migration-0.13.x-0.14.x+.md)<br>The amount of time in minutes before beginning a backup. Minimum value is 60 minutes | `number` | `null` | no |
 | <a name="input_tags"></a> [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br>Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no |
 | <a name="input_tenant"></a> [tenant](#input\_tenant) | ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no |
 | <a name="input_vault_enabled"></a> [vault\_enabled](#input\_vault\_enabled) | Should we create a new Vault | `bool` | `true` | no |

diff --git a/README.yaml b/README.yaml
@@ -64,8 +64,12 @@ description: |-
   Terraform module to provision [AWS Backup](https://aws.amazon.com/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](./docs/migration-0.13.x-0.14.x+.md).
 
-  **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](./docs/migration-0.13.x-0.14.x+.md).
+  > [!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](./docs/migration-0.13.x-0.14.x+.md).
 
 # How to use this project
 usage: |2-
@@ -147,21 +151,55 @@ usage: |2-
     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 = [
-      {
-        name               = var.name
-        schedule           = var.schedule
-        start_window       = var.start_window
-        completion_window  = var.completion_window
+  
+    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:
+  
+  ```hcl
+  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
+  
+  ```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     
   ```
 
+
+
 include:
   - "docs/targets.md"
   - "docs/terraform.md"