Home

Awesome

<!-- markdownlint-disable -->

<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse-terraform-components/aws-config/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse-terraform-components/aws-config/releases/latest"><img src="https://img.shields.io/github/release/cloudposse-terraform-components/aws-config.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>

<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->

This component is responsible for configuring AWS Config.

AWS Config service enables you to track changes to your AWS resources over time. It continuously monitors and records configuration changes to your AWS resources and provides you with a detailed view of the relationships between those resources. With AWS Config, you can assess, audit, and evaluate the configurations of your AWS resources for compliance, security, and governance purposes.

Some of the key features of AWS Config include:

[!WARNING]

AWS Config Limitations

You'll also want to be aware of some limitations with AWS Config:

Overall, AWS Config provides you with a powerful toolset to help you monitor and manage the configurations of your AWS resources, ensuring that they remain compliant, secure, and properly configured over time.

Prerequisites

As part of CIS AWS Foundations 1.20, this component assumes that a designated support IAM role with the following permissions has been deployed to every account in the organization:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "AllowSupport",
      "Effect": "Allow",
      "Action": ["support:*"],
      "Resource": "*"
    },
    {
      "Sid": "AllowTrustedAdvisor",
      "Effect": "Allow",
      "Action": "trustedadvisor:Describe*",
      "Resource": "*"
    }
  ]
}

Before deploying this AWS Config component config-bucket and cloudtrail-bucket should be deployed first.

Usage

Stack Level: Regional or Global

This component has a default_scope variable for configuring if it will be an organization-wide or account-level component by default. Note that this can be overridden by the scope variable in the conformance_packs items.

[!TIP]

Using the account default_scope

If default_scope == account, AWS Config is regional AWS service, so this component needs to be deployed to all regions. If an individual conformance_packs item has scope set to organization, that particular pack will be deployed to the organization level.

[!TIP]

Using the organization default_scope

If default_scope == organization, AWS Config is global unless overridden in the conformance_packs items. You will need to update your org to allow the config-multiaccountsetup.amazonaws.com service access principal for this to work. If you are using our account component, just add that principal to the aws_service_access_principals variable.

At the AWS Organizational level, the Components designate an account to be the central collection account and a single region to be the central collection region so that compliance information can be aggregated into a central location.

Logs are typically written to the audit account and AWS Config deployed into to the security account.

Here's an example snippet for how to use this component:

components:
  terraform:
    aws-config:
      vars:
        enabled: true
        account_map_tenant: core
        az_abbreviation_type: fixed
        # In each AWS account, an IAM role should be created in the main region.
        # If the main region is set to us-east-1, the value of the var.create_iam_role variable should be true.
        # For all other regions, the value of var.create_iam_role should be false.
        create_iam_role: false
        central_resource_collector_account: core-security
        global_resource_collector_region: us-east-1
        config_bucket_env: ue1
        config_bucket_stage: audit
        config_bucket_tenant: core
        conformance_packs:
          - name: Operational-Best-Practices-for-CIS-AWS-v1.4-Level2
            conformance_pack: https://raw.githubusercontent.com/awslabs/aws-config-rules/master/aws-config-conformance-packs/Operational-Best-Practices-for-CIS-AWS-v1.4-Level2.yaml
            parameter_overrides:
              AccessKeysRotatedParamMaxAccessKeyAge: '45'
          - name: Operational-Best-Practices-for-HIPAA-Security.yaml
            conformance_pack: https://raw.githubusercontent.com/awslabs/aws-config-rules/master/aws-config-conformance-packs/Operational-Best-Practices-for-HIPAA-Security.yaml
            parameter_overrides:
          ...
          (etc)
        managed_rules:
          access-keys-rotated:
            identifier: ACCESS_KEYS_ROTATED
            description: "Checks whether the active access keys are rotated within the number of days specified in maxAccessKeyAge. The rule is NON_COMPLIANT if the access keys have not been rotated for more than maxAccessKeyAge number of days."
            input_parameters:
              maxAccessKeyAge: "30"
            enabled: true
            tags: { }

Deployment

Apply to your central region security account

atmos terraform plan aws-config-{central-region} --stack core-{central-region}-security -var=create_iam_role=true

For example when central region is us-east-1:

atmos terraform plan aws-config-ue1 --stack core-ue1-security -var=create_iam_role=true

Apply aws-config to all stacks in all stages.

atmos terraform plan aws-config-{each region} --stack {each region}-{each stage}
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

Requirements

NameVersion
<a name="requirement_terraform"></a> terraform>= 1.0.0
<a name="requirement_aws"></a> aws>= 4.0
<a name="requirement_awsutils"></a> awsutils>= 0.16.0

Providers

NameVersion
<a name="provider_aws"></a> aws>= 4.0

Modules

NameSourceVersion
<a name="module_account_map"></a> account_mapcloudposse/stack-config/yaml//modules/remote-state1.5.0
<a name="module_aws_config"></a> aws_configcloudposse/config/aws1.1.0
<a name="module_aws_config_label"></a> aws_config_labelcloudposse/label/null0.25.0
<a name="module_aws_team_roles"></a> aws_team_rolescloudposse/stack-config/yaml//modules/remote-state1.5.0
<a name="module_config_bucket"></a> config_bucketcloudposse/stack-config/yaml//modules/remote-state1.5.0
<a name="module_conformance_pack"></a> conformance_packcloudposse/config/aws//modules/conformance-pack1.1.0
<a name="module_global_collector_region"></a> global_collector_regioncloudposse/stack-config/yaml//modules/remote-state1.5.0
<a name="module_iam_roles"></a> iam_roles../account-map/modules/iam-rolesn/a
<a name="module_org_conformance_pack"></a> org_conformance_pack./modules/org-conformance-packn/a
<a name="module_this"></a> thiscloudposse/label/null0.25.0
<a name="module_utils"></a> utilscloudposse/utils/aws1.3.0

Resources

NameType
aws_caller_identity.thisdata source
aws_partition.thisdata source
aws_region.thisdata source

Inputs

NameDescriptionTypeDefaultRequired
<a name="input_account_map_tenant"></a> account_map_tenant(Optional) The tenant where the account_map component required by remote-state is deployed.string""no
<a name="input_additional_tag_map"></a> additional_tag_mapAdditional 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> attributesID 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_az_abbreviation_type"></a> az_abbreviation_typeAZ abbreviation type, fixed or shortstring"fixed"no
<a name="input_central_resource_collector_account"></a> central_resource_collector_accountThe name of the account that is the centralized aggregation account.stringn/ayes
<a name="input_config_bucket_env"></a> config_bucket_envThe environment of the AWS Config S3 Bucketstringn/ayes
<a name="input_config_bucket_stage"></a> config_bucket_stageThe stage of the AWS Config S3 Bucketstringn/ayes
<a name="input_config_bucket_tenant"></a> config_bucket_tenant(Optional) The tenant of the AWS Config S3 Bucketstring""no
<a name="input_conformance_packs"></a> conformance_packsList of conformance packs. Each conformance pack is a map with the following keys: name, conformance_pack, parameter_overrides.<br/><br/>For example:<br/>conformance_packs = [<br/> {<br/> name = "Operational-Best-Practices-for-CIS-AWS-v1.4-Level1"<br/> conformance_pack = "https://raw.githubusercontent.com/awslabs/aws-config-rules/master/aws-config-conformance-packs/Operational-Best-Practices-for-CIS-AWS-v1.4-Level1.yaml"<br/> parameter_overrides = {<br/> "AccessKeysRotatedParamMaxAccessKeyAge" = "45"<br/> }<br/> },<br/> {<br/> name = "Operational-Best-Practices-for-CIS-AWS-v1.4-Level2"<br/> conformance_pack = "https://raw.githubusercontent.com/awslabs/aws-config-rules/master/aws-config-conformance-packs/Operational-Best-Practices-for-CIS-AWS-v1.4-Level2.yaml"<br/> parameter_overrides = {<br/> "IamPasswordPolicyParamMaxPasswordAge" = "45"<br/> }<br/> }<br/>]<br/><br/>Complete list of AWS Conformance Packs managed by AWSLabs can be found here:<br/>https://github.com/awslabs/aws-config-rules/tree/master/aws-config-conformance-packs<pre>list(object({<br/> name = string<br/> conformance_pack = string<br/> parameter_overrides = map(string)<br/> scope = optional(string, null)<br/> }))</pre>[]no
<a name="input_context"></a> contextSingle 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_create_iam_role"></a> create_iam_roleFlag to indicate whether an IAM Role should be created to grant the proper permissions for AWS Configboolfalseno
<a name="input_default_scope"></a> default_scopeThe default scope of the conformance pack. Valid values are account and organization.string"account"no
<a name="input_delegated_accounts"></a> delegated_accountsThe account IDs of other accounts that will send their AWS Configuration or Security Hub data to this accountset(string)nullno
<a name="input_delimiter"></a> delimiterDelimiter to be used between ID elements.<br/>Defaults to - (hyphen). Set to "" to use no delimiter at all.stringnullno
<a name="input_descriptor_formats"></a> descriptor_formatsDescribe 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> enabledSet to false to prevent the module from creating any resourcesboolnullno
<a name="input_environment"></a> environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
<a name="input_global_environment"></a> global_environmentGlobal environment namestring"gbl"no
<a name="input_global_resource_collector_region"></a> global_resource_collector_regionThe region that collects AWS Config data for global resources such as IAMstringn/ayes
<a name="input_iam_role_arn"></a> iam_role_arnThe ARN for an IAM Role AWS Config uses to make read or write requests to the delivery channel and to describe the<br/>AWS resources associated with the account. This is only used if create_iam_role is false.<br/><br/>If you want to use an existing IAM Role, set the variable to the ARN of the existing role and set create_iam_role to false.<br/><br/>See the AWS Docs for further information:<br/>http://docs.aws.amazon.com/config/latest/developerguide/iamrole-permissions.htmlstringnullno
<a name="input_iam_roles_environment_name"></a> iam_roles_environment_nameThe name of the environment where the IAM roles are provisionedstring"gbl"no
<a name="input_id_length_limit"></a> id_length_limitLimit 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.numbernullno
<a name="input_label_key_case"></a> label_key_caseControls 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.stringnullno
<a name="input_label_order"></a> label_orderThe 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)nullno
<a name="input_label_value_case"></a> label_value_caseControls 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.stringnullno
<a name="input_labels_as_tags"></a> labels_as_tagsSet 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_managed_rules"></a> managed_rulesA list of AWS Managed Rules that should be enabled on the account.<br/><br/>See the following for a list of possible rules to enable:<br/>https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html<br/><br/>Example:<pre>managed_rules = {<br/> access-keys-rotated = {<br/> identifier = "ACCESS_KEYS_ROTATED"<br/> description = "Checks whether the active access keys are rotated within the number of days specified in maxAccessKeyAge. The rule is NON_COMPLIANT if the access keys have not been rotated for more than maxAccessKeyAge number of days."<br/> input_parameters = {<br/> maxAccessKeyAge : "90"<br/> }<br/> enabled = true<br/> tags = {}<br/> }<br/>}</pre><pre>map(object({<br/> description = string<br/> identifier = string<br/> input_parameters = any<br/> tags = map(string)<br/> enabled = bool<br/> }))</pre>{}no
<a name="input_name"></a> nameID 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.stringnullno
<a name="input_namespace"></a> namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
<a name="input_privileged"></a> privilegedTrue if the default provider already has access to the backendboolfalseno
<a name="input_regex_replace_chars"></a> regex_replace_charsTerraform 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.stringnullno
<a name="input_region"></a> regionAWS Regionstringn/ayes
<a name="input_root_account_stage"></a> root_account_stageThe stage name for the Organization root (master) accountstring"root"no
<a name="input_stage"></a> stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
<a name="input_tags"></a> tagsAdditional 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> tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno

Outputs

NameDescription
<a name="output_aws_config_configuration_recorder_id"></a> aws_config_configuration_recorder_idThe ID of the AWS Config Recorder
<a name="output_aws_config_iam_role"></a> aws_config_iam_roleThe ARN of the IAM Role used for AWS Config
<a name="output_storage_bucket_arn"></a> storage_bucket_arnStorage Config bucket ARN
<a name="output_storage_bucket_id"></a> storage_bucket_idStorage Config bucket ID
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

References

[!TIP]

πŸ‘½ Use Atmos with Terraform

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

<details> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/><br/> <i>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.</i> </detalis>

Related Projects

Check out these related projects.

[!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.<br/> βœ… Your team owns everything.<br/> βœ… 100% Open Source and backed by fanatical support.<br/>

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-config&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>πŸ“š <strong>Learn More</strong></summary> <br/>

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

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-config&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

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-config&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:

<a href="https://github.com/cloudposse-terraform-components/aws-config/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse-terraform-components/aws-config&max=24" /> </a>

For πŸ› bug reports & feature requests, please use the issue tracker.

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

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. 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-components/aws-config&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

<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>

<details> <summary>Preamble to the Apache License, Version 2.0</summary> <br/> <br/>
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.


Copyright Β© 2017-2024 Cloud Posse, LLC

<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-config&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>

<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse-terraform-components/aws-config?pixel&cs=github&cm=readme&an=aws-config"/>