This module enables AWS Config and optionally sets up an SNS topic to receive notifications of its findings.

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.

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 "example" {
  source = "cloudposse/config/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  create_sns_topic = true
  create_iam_role  = true

  managed_rules = {
    account-part-of-organizations = {
      description  = "Checks whether AWS account is part of AWS Organizations. The rule is NON_COMPLIANT if an AWS account is not part of AWS Organizations or AWS Organizations master account ID does not match rule parameter MasterAccountId.",
      identifier   = "ACCOUNT_PART_OF_ORGANIZATIONS",
      trigger_type = "PERIODIC"
      enabled      = true
    }
  }
}

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.0
aws	>= 5.38.0
http	>= 3.4.1

Providers

Name	Version
aws	>= 5.38.0

Modules

Name	Source	Version
aws_config_aggregator_label	cloudposse/label/null	0.25.0
aws_config_findings_label	cloudposse/label/null	0.25.0
aws_config_label	cloudposse/label/null	0.25.0
iam_role	cloudposse/iam-role/aws	0.19.0
iam_role_organization_aggregator	cloudposse/iam-role/aws	0.19.0
sns_topic	cloudposse/sns-topic/aws	0.20.1
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_config_aggregate_authorization.central	resource
aws_config_aggregate_authorization.child	resource
aws_config_config_rule.rules	resource
aws_config_configuration_aggregator.this	resource
aws_config_configuration_recorder.recorder	resource
aws_config_configuration_recorder_status.recorder_status	resource
aws_config_delivery_channel.channel	resource
aws_iam_role_policy_attachment.config_policy_attachment	resource
aws_iam_role_policy_attachment.organization_config_policy_attachment	resource
aws_caller_identity.this	data source
aws_iam_policy.aws_config_built_in_role	data source
aws_iam_policy.aws_config_organization_role	data source
aws_iam_policy_document.config_s3_policy	data source
aws_iam_policy_document.config_sns_policy	data source
aws_partition.current	data source
aws_region.this	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
allowed_aws_services_for_sns_published	AWS services that will have permission to publish to SNS topic. Used when no external JSON policy is used	`list(string)`	`[]`	no
allowed_iam_arns_for_sns_publish	IAM role/user ARNs that will have permission to publish to SNS topic. Used when no external json policy is used.	`list(string)`	`[]`	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
central_resource_collector_account	The account ID of a central account that will aggregate AWS Config from other accounts	`string`	`null`	no
child_resource_collector_accounts	The account IDs of other accounts that will send their AWS Configuration to this account	`set(string)`	`null`	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
create_iam_role	Flag to indicate whether an IAM Role should be created to grant the proper permissions for AWS Config	`bool`	`false`	no
create_organization_aggregator_iam_role	Flag to indicate whether an IAM Role should be created to grant the proper permissions for AWS Config to send logs from organization accounts	`bool`	`false`	no
create_sns_topic	Flag to indicate whether an SNS topic should be created for notifications If you want to send findings to a new SNS topic, set this to true and provide a valid configuration for subscribers	`bool`	`false`	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
disabled_aggregation_regions	A list of regions where config aggregation is disabled	`list(string)`	[ "ap-northeast-3" ]	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
findings_notification_arn	The ARN for an SNS topic to send findings notifications to. This is only used if create_sns_topic is false. If you want to send findings to an existing SNS topic, set the value of this to the ARN of the existing topic and set create_sns_topic to false.	`string`	`null`	no
force_destroy	A boolean that indicates all objects should be deleted from the bucket so that the bucket can be destroyed without error. These objects are not recoverable	`bool`	`false`	no
global_resource_collector_region	The region that collects AWS Config data for global resources such as IAM	`string`	n/a	yes
iam_role_arn	The ARN for an IAM Role AWS Config uses to make read or write requests to the delivery channel and to describe the AWS resources associated with the account. This is only used if create_iam_role is false. If you want to use an existing IAM Role, set the value of this to the ARN of the existing topic and set create_iam_role to false. See the AWS Docs for further information: http://docs.aws.amazon.com/config/latest/developerguide/iamrole-permissions.html	`string`	`null`	no
iam_role_organization_aggregator_arn	The ARN for an IAM Role that AWS Config uses for the organization aggregator that fetches AWS config data from AWS accounts. This is only used if create_organization_aggregator_iam_role is false. If you want to use an existing IAM Role, set the value of this to the ARN of the existing role and set create_organization_aggregator_iam_role to false. See the AWS docs for further information: http://docs.aws.amazon.com/config/latest/developerguide/iamrole-permissions.html	`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
is_organization_aggregator	The aggregator is an AWS Organizations aggregator	`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
managed_rules	A list of AWS Managed Rules that should be enabled on the account. See the following for a list of possible rules to enable: https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html	map(object({ description = string identifier = string input_parameters = any tags = map(string) enabled = bool }))	`{}`	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
recording_mode	The mode for AWS Config to record configuration changes. recording_frequency: The frequency with which AWS Config records configuration changes (service defaults to CONTINUOUS). - CONTINUOUS - DAILY You can also override the recording frequency for specific resource types. recording_mode_override: description: A description for the override. recording_frequency: The frequency with which AWS Config records configuration changes for the specified resource types. - CONTINUOUS - DAILY resource_types: A list of resource types for which AWS Config records configuration changes. For example, AWS::EC2::Instance. See the following for more information: https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html / recording_mode = { recording_frequency = "DAILY" recording_mode_override = { description = "Override for specific resource types" recording_frequency = "CONTINUOUS" resource_types = ["AWS::EC2::Instance"] } } /	object({ recording_frequency = string recording_mode_override = optional(object({ description = string recording_frequency = string resource_types = list(string) })) })	`null`	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
s3_bucket_arn	The ARN of the S3 bucket used to store the configuration history	`string`	n/a	yes
s3_bucket_id	The id (name) of the S3 bucket used to store the configuration history	`string`	n/a	yes
s3_key_prefix	The prefix for AWS Config objects stored in the the S3 bucket. If this variable is set to null, the default, no prefix will be used. Examples: with prefix: {S3_BUCKET NAME}:/{S3_KEY_PREFIX}/AWSLogs/{ACCOUNT_ID}/Config/. without prefix: {S3_BUCKET NAME}:/AWSLogs/{ACCOUNT_ID}/Config/.	`string`	`null`	no
sns_encryption_key_id	The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK.	`string`	`""`	no
sqs_queue_kms_master_key_id	The ID of an AWS-managed customer master key (CMK) for Amazon SQS Queue or a custom CMK	`string`	`""`	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
subscribers	A map of subscription configurations for SNS topics For more information, see: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic_subscription#argument-reference protocol: The protocol to use. The possible values for this are: sqs, sms, lambda, application. (http or https are partially supported, see link) (email is an option but is unsupported in terraform, see link). endpoint: The endpoint to send data to, the contents will vary with the protocol. (see link for more information) endpoint_auto_confirms (Optional): Boolean indicating whether the end point is capable of auto confirming subscription e.g., PagerDuty. Default is false raw_message_delivery (Optional): Boolean indicating whether or not to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false.	`map(any)`	`{}`	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
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
aws_config_configuration_recorder_id	The ID of the AWS Config Recorder
iam_role	IAM Role used to make read or write requests to the delivery channel and to describe the AWS resources associated with the account.
iam_role_organization_aggregator	IAM Role used to make read or write requests to the delivery channel and to describe the AWS resources associated with the account.
sns_topic	SNS topic
sns_topic_subscriptions	SNS topic subscriptions
storage_bucket_arn	Bucket ARN
storage_bucket_id	Bucket Name (aka 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.
terraform-aws-config-storage - Terraform module that creates an S3 bucket suitable for storing AWS Config data.
terraform-aws-guardduty - Terraform module that enables and configures AWS GuardDuty.
terraform-aws-security-hub - Terraform module that enables and configures AWS Security Hub.

References

For additional context, refer to some of these links.

List of AWS Config Managed Rules - A list of rules AWS Config currently supports in the analytics; compute; cryptography and PKI; database; machine learning; management and governance; migration and transfer; network and content delivery; security; identity and compliance; and storage categories.

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.

📚 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.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

👽 Use Atmos with Terraform

Usage

Examples

Makefile Targets

Requirements

Providers

Modules

Resources

Inputs

Outputs

Related Projects

References

Use Terraform Reference Architectures for AWS

Day-0: Your Foundation for Success

Day-2: Your Operational Mastery

✨ Contributing

🌎 Slack Community

📰 Newsletter

📆 Office Hours

License

Trademarks

Copyrights

Files

README.md

Latest commit

History

README.md

File metadata and controls

👽 Use Atmos with Terraform

Usage

Examples

Makefile Targets

Requirements

Providers

Modules

Resources

Inputs

Outputs

Related Projects

References

Use Terraform Reference Architectures for AWS

Day-0: Your Foundation for Success

Day-2: Your Operational Mastery

✨ Contributing

🌎 Slack Community

📰 Newsletter

📆 Office Hours

License

Trademarks

Copyrights