aws-config

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:

Configuration history: AWS Config maintains a detailed history of changes to your AWS resources, allowing you to see when changes were made, who made them, and what the changes were.
Configuration snapshots: AWS Config can take periodic snapshots of your AWS resources configurations, giving you a point-in-time view of their configuration.
Compliance monitoring: AWS Config provides a range of pre-built rules and checks to monitor your resources for compliance with best practices and industry standards.
Relationship mapping: AWS Config can map the relationships between your AWS resources, enabling you to see how changes to one resource can impact others.
Notifications and alerts: AWS Config can send notifications and alerts when changes are made to your AWS resources that could impact their compliance or security posture.

warning

AWS Config Limitations

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

The maximum number of AWS Config rules that can be evaluated in a single account is 1000.
This can be mitigated by removing rules that are duplicated across packs. You'll have to manually search for these duplicates.
You can also look for rules that do not apply to any resources and remove those. You'll have to manually click through rules in the AWS Config interface to see which rules are not being evaluated.
If you end up still needing more than 1000 rules, one recommendation is to only run packs on a schedule with a lambda that removes the pack after results are collected. If you had different schedule for each day of the week, that would mean 7000 rules over the week. The aggregators would not be able to handle this, so you would need to make sure to store them somewhere else (i.e. S3) so the findings are not lost.
See the Audit Manager docs if you think you would like to convert conformance packs to custom Audit Manager assessments.
The maximum number of AWS Config conformance packs that can be created in a single account is 50.

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}

Variables

Required Variables

central_resource_collector_account (string) required: The name of the account that is the centralized aggregation account.
config_bucket_env (string) required: The environment of the AWS Config S3 Bucket
config_bucket_stage (string) required: The stage of the AWS Config S3 Bucket
global_resource_collector_region (string) required: The region that collects AWS Config data for global resources such as IAM
region (string) required: AWS Region

Optional Variables

account_map_tenant (string) optional

(Optional) The tenant where the account_map component required by remote-state is deployed.

Default value: ""

az_abbreviation_type (string) optional

AZ abbreviation type, fixed or short

Default value: "fixed"

config_bucket_tenant (string) optional

(Optional) The tenant of the AWS Config S3 Bucket

Default value: ""

conformance_packs optional

List of conformance packs. Each conformance pack is a map with the following keys: name, conformance_pack, parameter_overrides.

For example:
conformance_packs = [
{
name = "Operational-Best-Practices-for-CIS-AWS-v1.4-Level1"
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"
parameter_overrides = {
"AccessKeysRotatedParamMaxAccessKeyAge" = "45"
}
},
{
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 = {
"IamPasswordPolicyParamMaxPasswordAge" = "45"
}
}
]

Complete list of AWS Conformance Packs managed by AWSLabs can be found here:
https://github.com/awslabs/aws-config-rules/tree/master/aws-config-conformance-packs

Type:

list(object({
name                = string
conformance_pack    = string
parameter_overrides = map(string)
scope               = optional(string, null)
}))

Default value: [ ]

create_iam_role (bool) optional

Flag to indicate whether an IAM Role should be created to grant the proper permissions for AWS Config

Default value: false

default_scope (string) optional

The default scope of the conformance pack. Valid values are account and organization.

Default value: "account"

delegated_accounts (set(string)) optional

The account IDs of other accounts that will send their AWS Configuration or Security Hub data to this account

Default value: null

global_environment (string) optional

Global environment name

Default value: "gbl"

iam_role_arn (string) optional

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 variable to the ARN of the existing role 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

Default value: null

iam_roles_environment_name (string) optional

The name of the environment where the IAM roles are provisioned

Default value: "gbl"

managed_rules optional

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

Example:

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/>
}<br/>
```<br/>
<br/>
<br/>

**Type:**
```hcl
map(object({
description      = string
identifier       = string
input_parameters = any
tags             = map(string)
enabled          = bool
}))

Default value: { }

privileged (bool) optional

True if the default provider already has access to the backend

Default value: false

root_account_stage (string) optional

The stage name for the Organization root (master) account

Default value: "root"

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

aws_config_configuration_recorder_id: The ID of the AWS Config Recorder
aws_config_iam_role: The ARN of the IAM Role used for AWS Config
storage_bucket_arn: Storage Config bucket ARN
storage_bucket_id: Storage Config bucket ID

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 4.0
awsutils, version: >= 0.16.0

Providers

aws, version: >= 4.0

Modules

Name	Version	Source	Description
`account_map`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`aws_config`	1.1.0	`cloudposse/config/aws`	n/a
`aws_config_label`	0.25.0	`cloudposse/label/null`	n/a
`aws_team_roles`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`config_bucket`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`conformance_pack`	1.1.0	`cloudposse/config/aws//modules/conformance-pack`	n/a
`global_collector_region`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`org_conformance_pack`	latest	`./modules/org-conformance-pack`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a
`utils`	1.3.0	`cloudposse/utils/aws`	n/a

Resources

The following resources are used by this module:

Data Sources

The following data sources are used by this module:

aws_caller_identity.this (data source)
aws_partition.this (data source)
aws_region.this (data source)

AWS Config Limitations​

Prerequisites​

Usage​

Using the account default_scope​

Using the organization default_scope​

Deployment​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

References​

AWS Config Limitations

Prerequisites

Usage

Using the account default_scope

Using the organization default_scope

Deployment

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources

References