terraform-aws-ssm-patch-manager

This module provisions AWS SSM Patch manager maintenance window tasks, targets, patch baselines and patch groups and a s3 bucket for storing patch task logs.

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

Introduction

Acknowledgements

This module was heavily inspired by @jparnaudeau module https://github.com/jparnaudeau/terraform-aws-ssm-patch-management

Usage

For a complete example, see examples/complete.

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

module "ssm_patch_manager" {
  source  = "cloudposse/ssm-patch-manager/aws"
  version = "xxxx"
  name = "test"
}

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Examples

Here is an example of using this module:

examples/complete - complete example of using this module

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
terraform	>= 1.3
aws	>= 4.0

Providers

Name	Version
aws	>= 4.0

Modules

Name	Source	Version
install_window_label	cloudposse/label/null	0.25.0
scan_window_label	cloudposse/label/null	0.25.0
ssm_patch_log_s3_bucket	cloudposse/s3-bucket/aws	4.0.1
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_ssm_maintenance_window.install_window	resource
aws_ssm_maintenance_window.scan_window	resource
aws_ssm_maintenance_window_target.target_install	resource
aws_ssm_maintenance_window_target.target_scan	resource
aws_ssm_maintenance_window_task.task_install_patches	resource
aws_ssm_maintenance_window_task.task_scan_patches	resource
aws_ssm_patch_baseline.baseline	resource
aws_ssm_patch_group.install_patchgroup	resource
aws_ssm_patch_group.scan_patchgroup	resource
aws_caller_identity.current	data source
aws_iam_policy_document.bucket_policy	data source
aws_partition.current	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	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.	`map(string)`	`{}`	no
approved_patches	A list of explicitly approved patches for the baseline	`list(string)`	`[]`	no
approved_patches_compliance_level	Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. Valid compliance levels include the following: CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED. The default value is UNSPECIFIED.	`string`	`"HIGH"`	no
attributes	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.	`list(string)`	`[]`	no
bucket_id	The bucket ID to use for the patch log. If no bucket ID is provided, the module will create a new one. This is of type `list(string)` to work around #41 / hashicorp/terraform#28962.	`list(string)`	`[]`	no
cloudwatch_log_group_name	The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.	`string`	`null`	no
cloudwatch_log_output_enabled	Enables Systems Manager to send command output to CloudWatch Logs.	`bool`	`false`	no
context	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.	`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
delimiter	Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
descriptor_formats	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).	`any`	`{}`	no
enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
id_length_limit	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`.	`number`	`null`	no
install_maintenance_window_cutoff	The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution	`number`	`1`	no
install_maintenance_window_duration	The duration of the maintenence windows (hours)	`number`	`3`	no
install_maintenance_window_schedule	The schedule of the Maintenance Window in the form of a cron or rate expression	`string`	`"cron(0 0 21 ? * WED *)"`	no
install_maintenance_windows_targets	The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs. You can specify targets using instance IDs, resource group names, or tags that have been applied to instances. For more information about these examples formats see (https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html)	list(object({ key : string values : list(string) } ) )	`[]`	no
install_patch_groups	The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs. You can specify targets using instance IDs, resource group names, or tags that have been applied to instances. For more information about these examples formats see (https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html)	`list(string)`	[ "TOPATCH" ]	no
install_sns_notification_enabled	Enable/disable the SNS notification for install patches	`bool`	`false`	no
label_key_case	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`.	`string`	`null`	no
label_order	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.	`list(string)`	`null`	no
label_value_case	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`.	`string`	`null`	no
labels_as_tags	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.	`set(string)`	[ "default" ]	no
max_concurrency	The maximum number of targets this task can be run for in parallel	`number`	`20`	no
max_errors	The maximum number of errors allowed before this task stops being scheduled	`number`	`50`	no
name	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.	`string`	`null`	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	`string`	`null`	no
notification_arn	An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.	`string`	`""`	no
notification_events	The different events for which you can receive notifications. Valid values: All, InProgress, Success, TimedOut, Cancelled, and Failed	`list(string)`	[ "All" ]	no
notification_type	When specified with Command, receive notification when the status of a command changes. When specified with Invocation, for commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. Valid values: Command and Invocation	`string`	`"Command"`	no
operating_system	Defines the operating system the patch baseline applies to. Supported operating systems include WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, SUSE, UBUNTU, CENTOS, and REDHAT_ENTERPRISE_LINUX. The Default value is WINDOWS.	`string`	`"AMAZON_LINUX_2"`	no
patch_baseline_approval_rules	A set of rules used to include patches in the baseline. Up to 10 approval rules can be specified. Each `approval_rule` block requires the fields documented below (unless marked optional). `approve_after_days` and `approve_until_date` conflict, do not set both in the same `approval_rule`. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_patch_baseline#approval_rule-block for full details.	list(object({ approve_after_days : optional(number) approve_until_date : optional(string) compliance_level : string enable_non_security : bool patch_baseline_filters : list(object({ name : string values : list(string) })) }))	[ { "approve_after_days": 7, "compliance_level": "HIGH", "enable_non_security": true, "patch_baseline_filters": [ { "name": "PRODUCT", "values": [ "AmazonLinux2", "AmazonLinux2.0" ] }, { "name": "CLASSIFICATION", "values": [ "Security", "Bugfix", "Recommended" ] }, { "name": "SEVERITY", "values": [ "Critical", "Important", "Medium" ] } ] } ]	no
reboot_option	When you choose the RebootIfNeeded option, the instance is rebooted if Patch Manager installed new patches, or if it detected any patches with a status of INSTALLED_PENDING_REBOOT during the Install operation. Possible values : RebootIfNeeded, NoReboot	`string`	`"RebootIfNeeded"`	no
regex_replace_chars	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.	`string`	`null`	no
rejected_patches	A list of rejected patches	`list(string)`	`[]`	no
s3_bucket_prefix_install_logs	The Amazon S3 bucket subfolder for install logs	`string`	`"install"`	no
s3_bucket_prefix_scan_logs	The Amazon S3 bucket subfolder for scan logs	`string`	`"scanning"`	no
s3_log_output_enabled	To enable or disable s3 bucket output for the runCommand logs	`bool`	`true`	no
scan_maintenance_window_cutoff	The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution	`number`	`1`	no
scan_maintenance_window_duration	The duration of the maintenence windows (hours)	`number`	`3`	no
scan_maintenance_window_schedule	The schedule of the Maintenance Window in the form of a cron or rate expression.	`string`	`"cron(0 0 18 ? * WED *)"`	no
scan_maintenance_windows_targets	The map of tags for targetting which EC2 instances will be scaned	list(object({ key : string values : list(string) } ) )	`[]`	no
scan_patch_groups	The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs. You can specify targets using instance IDs, resource group names, or tags that have been applied to instances. For more information about these examples formats see (https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html)	`list(string)`	[ "TOSCAN" ]	no
scan_sns_notification_enabled	Enable/Disable the SNS notification for scans	`bool`	`false`	no
service_role_arn	The role that should be assumed when executing the task. If a role is not provided, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created for you	`string`	`null`	no
sns_notification_role_arn	An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.	`string`	`""`	no
ssm_bucket_policy	Custom bucket policy for the SSM log bucket	`string`	`null`	no
ssm_bucket_versioning_enable	To enable or disable S3 bucket versioning for the log bucket.	`string`	`true`	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
task_install_priority	The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.	`number`	`1`	no
task_scan_priority	The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel. Default 1	`number`	`1`	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no

Outputs

Name	Description
install_maintenance_window_id	SSM Patch Manager install maintenance window ID
install_maintenance_window_target_id	SSM Patch Manager install maintenance window target ID
install_maintenance_window_task_id	SSM Patch Manager install maintenance windows task ID
install_patch_group_id	SSM Patch Manager install patch group ID
patch_baseline_arn	SSM Patch Manager patch baseline ARN
scan_maintenance_window_target_id	SSM Patch Manager scan maintenance window target ID
scan_maintenance_window_task_id	SSM Patch Manager scan maintenance windows task ID
scan_patch_group_id	SSM Patch Manager scan patch group ID
ssm_patch_log_s3_bucket_arn	SSM Patch Manager s3 log bucket ARN
ssm_patch_log_s3_bucket_id	SSM Patch Manager s3 log bucket ID

Related Projects

Check out these related projects.

terraform-null-label - Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention.

References

For additional context, refer to some of these links.

Terraform Standard Module Structure - HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories.
Terraform Module Requirements - HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy.
Terraform random_integer Resource - The resource random_integer generates random values from a given range, described by the min and max attributes of a given resource.
Terraform Version Pinning - The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it with you.
✅ You own everything.
✅ Your team wins.

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Preamble to the Apache License, Version 2.0

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

adamtylerlynch / terraform-aws-ssm-patch-manager Goto Github PK