Awesome

Terraform module for creating alarms for tracking important changes and occurances from cloudtrail.

This module creates a set of filter metrics and alarms based on the security best practices covered in the AWS CIS Foundations Benchmark guide.

[!TIP]

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. Works with Github Actions, Atlantis, or Spacelift.
<details> <summary>Watch demo of using Atmos with Terraform</summary> <img src="https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true"/> Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial. </detalis>

Usage

module "metric_configs" {
  source  = "cloudposse/config/yaml"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  map_config_local_base_path = "./catalog"
  map_config_paths           = "*.yaml"

  context = module.this.context
}

module "cloudtrail_api_alarms" {
  source  = "cloudposse/cloudtrail-cloudwatch-alarms/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  log_group_name = "${aws_cloudwatch_log_group.default.name}"
  metrics = module.metric_configs.map_configs
}

For detailed usage which includes setting up cloudtrail, cloudwatch logs, roles, policies, and the s3 bucket - as well as using this module see the example directory

For aditional CIS rules and controls https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-cis-controls.html#securityhub-cis-controls-3.8

[!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's a complete example of using this terraform-aws-cloudtrail-cloudwatch-alarms module.

Requirements

Name	Version
<a name="requirement_terraform"></a> terraform	>= 1.0
<a name="requirement_aws"></a> aws	>= 4.0

Providers

Name	Version
<a name="provider_aws"></a> aws	>= 4.0

Modules

Name	Source	Version
<a name="module_aws_sns_topic_label"></a> aws_sns_topic_label	cloudposse/label/null	0.25.0
<a name="module_sns_kms_key"></a> sns_kms_key	cloudposse/kms-key/aws	0.10.0
<a name="module_sns_kms_key_label"></a> sns_kms_key_label	cloudposse/label/null	0.25.0
<a name="module_this"></a> this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_cloudwatch_dashboard.combined	resource
aws_cloudwatch_dashboard.individual	resource
aws_cloudwatch_log_metric_filter.default	resource
aws_cloudwatch_metric_alarm.default	resource
aws_sns_topic.default	resource
aws_sns_topic_policy.default	resource
aws_caller_identity.default	data source
aws_iam_policy_document.sns_kms_key_policy	data source
aws_iam_policy_document.sns_topic_policy	data source
aws_region.current	data source

Inputs

Name	Description	Type	Default	Required
<a name="input_additional_endpoint_arns"></a> additional_endpoint_arns	Any alert endpoints, such as autoscaling, or app scaling endpoint arns that will respond to an alert	`list(string)`	`[]`	no
<a name="input_additional_tag_map"></a> 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_attributes"></a> 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_context"></a> 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_dashboard_enabled"></a> dashboard_enabled	When true a dashboard that displays the statistics as a line graph will be created in CloudWatch	`bool`	`true`	no
<a name="input_delimiter"></a> 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	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_enabled"></a> enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
<a name="input_environment"></a> 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_id_length_limit"></a> id_length_limit	Limit `id` to this many characters (minimum 6).<br/>Set to `0` for unlimited length.<br/>Set to `null` for keep the existing setting, which defaults to `0`.<br/>Does not affect `id_full`.	`number`	`null`	no
<a name="input_kms_master_key_id"></a> kms_master_key_id	The ID or alias of the customer master key (CMK) to use for encrypting the Amazon SNS topic.<br/> The CMK must have its resource-based policy allow the service `cloudwatch.amazonaws.com` to perform `kms:Decrypt` and `kms:GenerateDataKey` on it.<br/> If this variable is not supplied, a CMK with the sufficient resource-based policy will be created and used when configuring encryption for<br/> the SNS topic.	`string`	`null`	no
<a name="input_label_key_case"></a> label_key_case	Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper`.<br/>Default value: `title`.	`string`	`null`	no
<a name="input_label_order"></a> label_order	The order in which the labels (ID elements) appear in the `id`.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	`list(string)`	`null`	no
<a name="input_label_value_case"></a> label_value_case	Controls the letter case of ID elements (labels) as included in `id`,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br/>Default value: `lower`.	`string`	`null`	no
<a name="input_labels_as_tags"></a> labels_as_tags	Set of labels (ID elements) to include as tags in the `tags` output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the `tags` output.<br/>Set to `[]` to suppress all generated tags.<br/>Notes:<br/> The value of the `name` tag, if included, will be the `id`, not the `name`.<br/> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	<pre>[<br/> "default"<br/>]</pre>	no
<a name="input_log_group_name"></a> log_group_name	The cloudtrail cloudwatch log group name	`string`	n/a	yes
<a name="input_log_group_region"></a> log_group_region	The log group region that should be monitored for unauthorised AWS API Access. Current region used if none provided.	`string`	`""`	no
<a name="input_metric_namespace"></a> metric_namespace	A namespace for grouping all of the metrics together	`string`	`"CISBenchmark"`	no
<a name="input_metrics"></a> metrics	The cloudwatch metrics and corresponding alarm definitions	<pre>map(object({<br/> metric_name = string<br/> filter_pattern = string<br/> metric_namespace = string<br/> metric_value = string<br/> alarm_name = string<br/> alarm_comparison_operator = string<br/> alarm_evaluation_periods = string<br/> alarm_period = string<br/> alarm_statistic = string<br/> alarm_treat_missing_data = string<br/> alarm_threshold = string<br/> alarm_description = string<br/> }))</pre>	`{}`	no
<a name="input_name"></a> name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a `tag`.<br/>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.	`string`	`null`	no
<a name="input_namespace"></a> 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
<a name="input_regex_replace_chars"></a> 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_sns_policy_enabled"></a> sns_policy_enabled	Attach a policy that allows the notifications through to the SNS topic endpoint	`bool`	`false`	no
<a name="input_sns_topic_arn"></a> sns_topic_arn	An SNS topic ARN that has already been created. Its policy must already allow access from CloudWatch Alarms, or set `add_sns_policy` to `true`	`string`	`null`	no
<a name="input_stage"></a> stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
<a name="input_tags"></a> 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	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
<a name="output_dashboard_combined"></a> dashboard_combined	URL to CloudWatch Combined Metric Dashboard
<a name="output_dashboard_individual"></a> dashboard_individual	URL to CloudWatch Individual Metric Dashboard
<a name="output_sns_topic_arn"></a> sns_topic_arn	The ARN of the SNS topic used

Metrics Tracked

Alarm's Name	Description
`AuthorizationFailureCount`	Alarms when an unauthorized API call is made.
`S3BucketActivityEventCount`	Alarms when an API call is made to S3 to put or delete a Bucket, Bucket Policy or Bucket ACL.
`SecurityGroupEventCount`	Alarms when an API call is made to create, update or delete a Security Group.
`NetworkAclEventCount`	Alarms when an API call is made to create, update or delete a Network ACL.
`GatewayEventCount`	Alarms when an API call is made to create, update or delete a Customer or Internet Gateway.
`VpcEventCount`	Alarms when an API call is made to create, update or delete a VPC, VPC peering connection or VPC connection to classic.
`EC2InstanceEventCount`	Alarms when an API call is made to create, terminate, start, stop or reboot an EC2 instance.
`EC2LargeInstanceEventCount`	Alarms when an API call is made to create, terminate, start, stop or reboot a 4x-large or greater EC2 instance.
`CloudTrailEventCount`	Alarms when an API call is made to create, update or delete a .cloudtrail. trail, or to start or stop logging to a trail.
`ConsoleSignInFailureCount`	Alarms when an unauthenticated API call is made to sign into the console.
`IAMPolicyEventCount`	Alarms when an API call is made to change an IAM policy.
`ConsoleSignInWithoutMfaCount`	Alarms when a user logs into the console without MFA.
`RootAccountUsageCount`	Alarms when a root account usage is detected.
`KMSKeyPendingDeletionErrorCount`	Alarms when a customer created KMS key is pending deletion.
`AWSConfigChangeCount`	Alarms when AWS Config changes.
`RouteTableChangesCount`	Alarms when route table changes are detected.

Dashboard Created

Two CloudWatch Dashboards can be created as well, and will be automatically created by default.

CloudWatch Dashboard

Credits

The alarm metric names, descriptions, and filters from this repository were used.

With many thanks to Anton Babenko for pointing it out and saving us a lot of time scouring reference documents and describing alarms!

Related Projects

Check out these related projects.

terraform-aws-cloudtrail - Terraform module to provision an AWS CloudTrail and an encrypted S3 bucket with versioning to store CloudTrail logs
terraform-aws-cloudtrail-s3-bucket - S3 bucket with built in IAM policy to allow CloudTrail logs
terraform-aws-cloudwatch-logs - Terraform Module to Provide a CloudWatch Logs Endpoint
terraform-aws-cloudwatch-flow-logs - Terraform module for enabling flow logs for vpc and subnets.
terraform-aws-ec2-cloudwatch-sns-alarms - Terraform module that configures CloudWatch SNS alerts for EC2 instances
terraform-aws-ecs-cloudwatch-sns-alarms - Terraform module for creating ECS service level alerts that go to an SNS endpoint
terraform-aws-efs-cloudwatch-sns-alarms - Terraform module that configures CloudWatch SNS alerts for EFS
terrform-aws-elasticache-cloudwatch-sns-alarms - Terraform module that configures CloudWatch SNS alerts for ElastiCache
terraform-aws-lambda-cloudwatch-sns-alarms - Terraform module for creating a set of Lambda alarms and outputting to an endpoint
terraform-aws-rds-cloudwatch-sns-alarms - Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic
terraform-aws-sqs-cloudwatch-sns-alarms - Terraform module for creating alarms for SQS and notifying endpoints

[!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 together with your team. ✅ Your team owns everything. ✅ 100% Open Source and backed by fanatical support. 

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-cloudtrail-cloudwatch-alarms&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
<details><summary>📚 Learn More</summary> 
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.

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-cloudtrail-cloudwatch-alarms&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

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.

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-cloudtrail-cloudwatch-alarms&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
</details>

✨ 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 <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-cloudtrail-cloudwatch-alarms&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

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

<details> <summary>Preamble to the Apache License, Version 2.0</summary>

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.

</details>

Trademarks

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