Documentation and changelog updates (#207)

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [1.0.107] - 2024-11-05
+
+- [Maintenance Calendar]
+  - Remove definition for reserved lambda environment variable
+  - Update documentation
+
 ## [1.0.106] - 2024-11-01
 - [Fargate Ecs] Add Fargate Ecs Module
 

maintenance-calendar/README.md

@@ -67,7 +67,7 @@ module "calendar" {
 | <a name="input_create_github_inactive_user_reminder"></a> [create\_github\_inactive\_user\_reminder](#input\_create\_github\_inactive\_user\_reminder) | Determines if the inactive github user reminder will be created | `bool` | `false` | no |
 | <a name="input_create_rds_snapshots"></a> [create\_rds\_snapshots](#input\_create\_rds\_snapshots) | Determines if maintenance calendar tasks for managaing RDS snapshots will be created | `bool` | `false` | no |
 | <a name="input_image_scan_ignore_arn"></a> [image\_scan\_ignore\_arn](#input\_image\_scan\_ignore\_arn) | ARN of an SSM parameter containing CVEs that can safely be ignored.<br/>    This parameter must be created manually if it doesn't already exist.<br/><br/>    Parameter format: `[{"name":"CVE-2024-1", "packageName":"cowsay", "packageVersion":["1.2.3", "1.2.4"]},{"name"...}]` | `string` | `null` | no |
-| <a name="input_image_scan_snooze_arn"></a> [image\_scan\_snooze\_arn](#input\_image\_scan\_snooze\_arn) | ARN of an SSM parameter containing ECS cluster names and a date to snooze alerts.<br/>    This parameter must be created manually if it doesn't already exist.<br/><br/>    Parameter format: `[{"cluster":"ecs-cluster-1", "date":"2024-10-24"},{"cluster"...}]` | `string` | `null` | no |
+| <a name="input_image_scan_snooze_arn"></a> [image\_scan\_snooze\_arn](#input\_image\_scan\_snooze\_arn) | ARN of an SSM parameter containing ECS cluster names and a date to snooze alerts.<br/>    This parameter must be created manually if it doesn't already exist.<br/><br/>    Parameter format: `[{"cluster":"ecs-cluster-1", "snoozeUntil":"2024-10-24"},{"cluster"...}]` | `string` | `null` | no |
 | <a name="input_maintenance_sns_display_name"></a> [maintenance\_sns\_display\_name](#input\_maintenance\_sns\_display\_name) | (Optional) Display name for the maintenance notifications SNS topic | `string` | `null` | no |
 | <a name="input_rds_instance_names"></a> [rds\_instance\_names](#input\_rds\_instance\_names) | A list of RDS instance names we want to manage snapshots for | `list(string)` | `null` | no |
 | <a name="input_scan_ecr_repositories"></a> [scan\_ecr\_repositories](#input\_scan\_ecr\_repositories) | Map relating project titles to a list of ECR repository names which ought to be scanned periodically | <pre>map(<br/>    list(string)<br/>  )</pre> | `{}` | no |

maintenance-calendar/modules/ecs_scans/README.md

@@ -20,7 +20,7 @@
 |------|-------------|------|---------|:--------:|
 | <a name="input_account_id"></a> [account\_id](#input\_account\_id) | The AWS account ID | `string` | n/a | yes |
 | <a name="input_image_scan_ignore_arn"></a> [image\_scan\_ignore\_arn](#input\_image\_scan\_ignore\_arn) | ARN of an SSM parameter containing CVEs that can safely be ignored.<br/>    This parameter must be created manually if it doesn't already exist.<br/><br/>    Parameter format: `[{"name":"CVE-2024-1", "packageName":"cowsay", "packageVersion":["1.2.3", "1.2.4"]},{"name"...}]` | `string` | n/a | yes |
-| <a name="input_image_scan_snooze_arn"></a> [image\_scan\_snooze\_arn](#input\_image\_scan\_snooze\_arn) | ARN of an SSM parameter containing ECS cluster names and a date to snooze alerts.<br/>    This parameter must be created manually if it doesn't already exist.<br/><br/>    Parameter format: `[{"cluster":"ecs-cluster-1", "date":"2024-10-24"},{"cluster"...}]` | `string` | n/a | yes |
+| <a name="input_image_scan_snooze_arn"></a> [image\_scan\_snooze\_arn](#input\_image\_scan\_snooze\_arn) | ARN of an SSM parameter containing ECS cluster names and a date to snooze alerts.<br/>    This parameter must be created manually if it doesn't already exist.<br/><br/>    Parameter format: `[{"cluster":"ecs-cluster-1", "snoozeUntil":"2024-10-24"},{"cluster"...}]` | `string` | n/a | yes |
 | <a name="input_publish_alerts_policy"></a> [publish\_alerts\_policy](#input\_publish\_alerts\_policy) | An IAM policy that allows writing to the SNS topic | `string` | n/a | yes |
 | <a name="input_region"></a> [region](#input\_region) | The AWS region | `string` | n/a | yes |
 | <a name="input_sns_topic_arn"></a> [sns\_topic\_arn](#input\_sns\_topic\_arn) | The SNS topic to send alerts to | `string` | n/a | yes |

maintenance-calendar/modules/ecs_scans/variables.tf

@@ -30,7 +30,7 @@ variable "image_scan_snooze_arn" {
     ARN of an SSM parameter containing ECS cluster names and a date to snooze alerts.
     This parameter must be created manually if it doesn't already exist.
     
-    Parameter format: `[{"cluster":"ecs-cluster-1", "date":"2024-10-24"},{"cluster"...}]`
+    Parameter format: `[{"cluster":"ecs-cluster-1", "snoozeUntil":"2024-10-24"},{"cluster"...}]`
   EOF
 }
 

maintenance-calendar/variables.tf

@@ -54,7 +54,7 @@ variable "image_scan_snooze_arn" {
     ARN of an SSM parameter containing ECS cluster names and a date to snooze alerts.
     This parameter must be created manually if it doesn't already exist.
     
-    Parameter format: `[{"cluster":"ecs-cluster-1", "date":"2024-10-24"},{"cluster"...}]`
+    Parameter format: `[{"cluster":"ecs-cluster-1", "snoozeUntil":"2024-10-24"},{"cluster"...}]`
   EOF
 }