generated from geekcell/terraform-aws-module-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: initial commit
- Loading branch information
Showing
7 changed files
with
484 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,104 @@ | ||
| <!-- BEGIN_TF_DOCS --> | ||
| [](https://www.geekcell.io/) | ||
|
|
||
| <!-- | ||
| Replace the GitHub Repo name and comment in these badges if they BridgeCrew is enabled for this repository. | ||
|
|
||
| ### Code Quality | ||
| [](https://github.com/geekcell/terraform-aws-module-template/blob/master/LICENSE) | ||
| [](https://github.com/geekcell/terraform-aws-module-template/releases) | ||
| [](https://github.com/geekcell/terraform-aws-module-template/actions/workflows/release.yaml) | ||
| [](https://github.com/geekcell/terraform-aws-module-template/actions/workflows/validate.yaml) | ||
| [](https://github.com/geekcell/terraform-aws-module-template/actions/workflows/linter.yaml) | ||
| [](https://github.com/geekcell/terraform-aws-cloudtrail-alerts/blob/master/LICENSE) | ||
| [](https://github.com/geekcell/terraform-aws-cloudtrail-alerts/releases) | ||
| [](https://github.com/geekcell/terraform-aws-cloudtrail-alerts/actions/workflows/release.yaml) | ||
| [](https://github.com/geekcell/terraform-aws-cloudtrail-alerts/actions/workflows/validate.yaml) | ||
| [](https://github.com/geekcell/terraform-aws-cloudtrail-alerts/actions/workflows/linter.yaml) | ||
|
|
||
| <!-- | ||
| Replace the GitHub Repo name and comment in these badges if they BridgeCrew is enabled for this repository. | ||
| ### Security | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=INFRASTRUCTURE+SECURITY) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=INFRASTRUCTURE+SECURITY) | ||
| #### Cloud | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=CIS+AWS+V1.2) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=CIS+AWS+V1.3) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=CIS+AZURE+V1.1) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=CIS+AZURE+V1.3) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=CIS+GCP+V1.1) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=CIS+AWS+V1.2) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=CIS+AWS+V1.3) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=CIS+AZURE+V1.1) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=CIS+AZURE+V1.3) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=CIS+GCP+V1.1) | ||
| ##### Container | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=CIS+KUBERNETES+V1.6) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=CIS+EKS+V1.1) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=CIS+GKE+V1.1) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=CIS+KUBERNETES+V1.5) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=CIS+KUBERNETES+V1.6) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=CIS+EKS+V1.1) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=CIS+GKE+V1.1) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=CIS+KUBERNETES+V1.5) | ||
| #### Data protection | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=SOC2) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=PCI-DSS+V3.2) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=PCI-DSS+V3.2.1) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=ISO27001) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=NIST-800-53) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=HIPAA) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-module-template&benchmark=FEDRAMP+%28MODERATE%29) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=SOC2) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=PCI-DSS+V3.2) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=PCI-DSS+V3.2.1) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=ISO27001) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=NIST-800-53) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=HIPAA) | ||
| [](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-cloudtrail-alerts&benchmark=FEDRAMP+%28MODERATE%29) | ||
| --> | ||
|
|
||
| # Terraform AWS Module Template | ||
| # Terraform AWS CloudTrail Alerts Module | ||
|
|
||
| A module that create CloudWatch metric filters and alarms required for most modern compliance reports. This | ||
| module includes the necessary metric filters and alarms for the following compliance reports: | ||
|
|
||
| A template repository for creating our AWS Terraform modules. It gives you a good starting point for creating new modules quickly. | ||
| It comes with: | ||
| * Basic directory structure | ||
| * GitHub Workflow for Linting and Validation | ||
| * Pre-Commit Hooks | ||
| * Makefile for common tasks | ||
| | Compliance Report | Sections | | ||
| |---|---| | ||
| | CIS AWS Foundations Benchmark v1.5.0 | Section 4.1 - 4.15 | | ||
| | NIST 800-171 v2 | Section 3.12.3 | | ||
| | ISO/IEC 27001 v2 | Section A.12.4.1 | | ||
| | PCI DSS v3.2.1 | Section 10.1 | | ||
| | SOC 2 v2 | Section 5.2 | | ||
|
|
||
| This module can also create an SNS topic with a Slack channel configuration for AWS Chatbot (must be configured) | ||
| manually in the AWS Console. | ||
|
|
||
| ## Inputs | ||
|
|
||
| No inputs. | ||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|------|---------|:--------:| | ||
| | <a name="input_cloudtrail_log_group_name"></a> [cloudtrail\_log\_group\_name](#input\_cloudtrail\_log\_group\_name) | The name of the CloudWatch log group to filter for events. Defaults to the AWS Control Tower created Baseline. | `string` | `"aws-controltower/CloudTrailLogs"` | no | | ||
| | <a name="input_cloudwatch_namespace"></a> [cloudwatch\_namespace](#input\_cloudwatch\_namespace) | The namespace to use for the CloudWatch metric filter. | `string` | `"CISBenchmark"` | no | | ||
| | <a name="input_prefix"></a> [prefix](#input\_prefix) | Prefix that will added to created resources. | `string` | n/a | yes | | ||
| | <a name="input_slack_channel_id"></a> [slack\_channel\_id](#input\_slack\_channel\_id) | The ID of the Slack channel to send alerts to. | `string` | `null` | no | | ||
| | <a name="input_slack_workspace_id"></a> [slack\_workspace\_id](#input\_slack\_workspace\_id) | The ID of the Slack workspace to send alerts to. | `string` | `null` | no | | ||
| | <a name="input_sns_kms_master_key_alias"></a> [sns\_kms\_master\_key\_alias](#input\_sns\_kms\_master\_key\_alias) | The alias of the KMS key to use to encrypt the SNS topic if no key is provided. | `string` | `"sns/cloudtrail-alerts"` | no | | ||
| | <a name="input_sns_kms_master_key_id"></a> [sns\_kms\_master\_key\_id](#input\_sns\_kms\_master\_key\_id) | The ARN of the KMS key to use to encrypt the SNS topic. Will create a new CMK if not provided. | `string` | `null` | no | | ||
| | <a name="input_sns_topic_arn"></a> [sns\_topic\_arn](#input\_sns\_topic\_arn) | Use an existing SNS topic to send alerts to. | `string` | `null` | no | | ||
| | <a name="input_tags"></a> [tags](#input\_tags) | Tags to add to the created resources. | `map(any)` | `{}` | no | | ||
|
|
||
| ## Outputs | ||
|
|
||
| No outputs. | ||
|
|
||
| ## Providers | ||
|
|
||
| No providers. | ||
| | Name | Version | | ||
| |------|---------| | ||
| | <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.40 | | ||
| | <a name="provider_awscc"></a> [awscc](#provider\_awscc) | 0.53.0 | | ||
|
|
||
| ## Resources | ||
|
|
||
| - resource.aws_cloudwatch_log_metric_filter.main (main.tf#24) | ||
| - resource.aws_cloudwatch_metric_alarm.main (main.tf#38) | ||
| - resource.aws_kms_alias.main (main.tf#69) | ||
| - resource.aws_kms_key.main (main.tf#59) | ||
| - resource.aws_sns_topic.main (main.tf#108) | ||
| - resource.awscc_chatbot_slack_channel_configuration.main (main.tf#118) | ||
| - data source.aws_caller_identity.current (main.tf#18) | ||
| - data source.aws_cloudwatch_log_group.cloudtrail (main.tf#20) | ||
| - data source.aws_iam_policy_document.kms (main.tf#76) | ||
|
|
||
| # Examples | ||
| ### Complete | ||
| ```hcl | ||
| module "example" { | ||
| source = "../../" | ||
| prefix = "root" | ||
| } | ||
| ``` | ||
| <!-- END_TF_DOCS --> |
Oops, something went wrong.