Module: `config`

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

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

Examples

Here is an example of using this module:

examples/complete - complete example of using this module

Variables

Required Variables

global_resource_collector_region (string) required: The region that collects AWS Config data for global resources such as IAM
s3_bucket_arn (string) required: The ARN of the S3 bucket used to store the configuration history
s3_bucket_id (string) required: The id (name) of the S3 bucket used to store the configuration history

Optional Variables

allowed_aws_services_for_sns_published (list(string)) optional

AWS services that will have permission to publish to SNS topic. Used when no external JSON policy is used

Default value: [ ]

allowed_iam_arns_for_sns_publish (list(string)) optional

IAM role/user ARNs that will have permission to publish to SNS topic. Used when no external json policy is used.

Default value: [ ]

central_resource_collector_account (string) optional

The account ID of a central account that will aggregate AWS Config from other accounts

Default value: null

child_resource_collector_accounts (set(string)) optional

The account IDs of other accounts that will send their AWS Configuration to this account

Default value: null

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

create_organization_aggregator_iam_role (bool) optional

Flag to indicate whether an IAM Role should be created to grant the proper permissions for AWS Config to send logs from organization accounts

Default value: false

create_sns_topic (bool) optional

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

Default value: false

disabled_aggregation_regions (list(string)) optional

A list of regions where config aggregation is disabled

Default value:

[
  "ap-northeast-3"
]

findings_notification_arn (string) optional

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.

Default value: null

force_destroy (bool) optional

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

Default value: false

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

Default value: null

iam_role_organization_aggregator_arn (string) optional

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

Default value: null

is_organization_aggregator (bool) optional

The aggregator is an AWS Organizations aggregator

Default value: false

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

Type:

map(object({
description      = string
identifier       = string
input_parameters = any
tags             = map(string)
enabled          = bool
}))

Default value: { }

recording_mode optional

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"]
}
}
*/

Type:

object({
recording_frequency = string
recording_mode_override = optional(object({
  description         = string
  recording_frequency = string
  resource_types      = list(string)
}))
})

Default value: null

s3_key_prefix (string) optional

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

Default value: null

sns_encryption_key_id (string) optional

The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK.

Default value: ""

sqs_queue_kms_master_key_id (string) optional

The ID of an AWS-managed customer master key (CMK) for Amazon SQS Queue or a custom CMK

Default value: ""

subscribers (map(any)) optional

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.

Default value: { }

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

Dependencies

Requirements

terraform, version: >= 1.0
aws, version: >= 5.38.0
http, version: >= 3.4.1

Providers

aws, version: >= 5.38.0

Modules

Name	Version	Source	Description
`aws_config_aggregator_label`	0.25.0	`cloudposse/label/null`	----------------------------------------------------------------------------------------------------------------------- CONFIG AGGREGATION -----------------------------------------------------------------------------------------------------------------------
`aws_config_findings_label`	0.25.0	`cloudposse/label/null`	n/a
`aws_config_label`	0.25.0	`cloudposse/label/null`	---------------------------------------------------------------------------------------------------------------------- Enable and configure AWS Config ----------------------------------------------------------------------------------------------------------------------
`iam_role`	0.19.0	`cloudposse/iam-role/aws`	----------------------------------------------------------------------------------------------------------------------- Optionally create IAM Roles ----------------------------------------------------------------------------------------------------------------------- Create Optional IAM ROLE for S3 bucket and SNS
`iam_role_organization_aggregator`	0.19.0	`cloudposse/iam-role/aws`	Create Optional IAM ROLE for organization wide aggregator
`sns_topic`	0.20.1	`cloudposse/sns-topic/aws`	----------------------------------------------------------------------------------------------------------------------- Optionally create an SNS topic and subscriptions -----------------------------------------------------------------------------------------------------------------------
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

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)

Data Sources

The following data sources are used by this module:

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)

Module: config

Usage​

Examples​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `config`

Usage

Examples

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources