cloudtrail

This component is responsible for provisioning cloudtrail auditing in an individual account. It's expected to be used alongside the cloudtrail-bucket component as it utilizes that bucket via remote state.

This component can either be deployed selectively to various accounts with is_organization_trail=false, or alternatively created in all accounts if deployed to the management account is_organization_trail=true.

Usage

Stack Level: Global

The following is an example snippet for how to use this component:

(gbl-root.yaml)

components:
  terraform:
    cloudtrail:
      vars:
        enabled: true
        cloudtrail_bucket_environment_name: "ue1"
        cloudtrail_bucket_stage_name: "audit"
        cloudwatch_logs_retention_in_days: 730
        is_organization_trail: true

Variables

Required Variables

cloudtrail_bucket_environment_name (string) required: The name of the environment where the CloudTrail bucket is provisioned
cloudtrail_bucket_stage_name (string) required: The stage name where the CloudTrail bucket is provisioned
region (string) required: AWS Region

Optional Variables

audit_access_enabled (bool) optional

If true, allows the Audit account access to read Cloudtrail logs directly from S3. This is a requirement for running Athena queries in the Audit account.

Default value: false

cloudtrail_bucket_component_name (string) optional

The name of the CloudTrail bucket component

Default value: "cloudtrail-bucket"

cloudtrail_cloudwatch_logs_role_max_session_duration (number) optional

The maximum session duration (in seconds) for the CloudTrail CloudWatch Logs role. Can have a value from 1 hour to 12 hours

Default value: 43200

cloudwatch_logs_retention_in_days (number) optional

Number of days to retain logs for. CIS recommends 365 days. Possible values are: 0, 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653. Set to 0 to keep logs indefinitely.

Default value: 365

enable_log_file_validation (bool) optional

Specifies whether log file integrity validation is enabled. Creates signed digest for validated contents of logs

Default value: true

enable_logging (bool) optional

Enable logging for the trail

Default value: true

include_global_service_events (bool) optional

Specifies whether the trail is publishing events from global services such as IAM to the log files

Default value: true

is_multi_region_trail (bool) optional

Specifies whether the trail is created in the current region or in all regions

Default value: true

is_organization_trail (bool) optional

Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account.

The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the management account
for an organization in AWS Organizations.

Default value: false

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

cloudtrail_arn: CloudTrail ARN
cloudtrail_home_region: The region in which CloudTrail was created
cloudtrail_id: CloudTrail ID
cloudtrail_logs_log_group_arn: CloudTrail Logs log group ARN
cloudtrail_logs_log_group_name: CloudTrail Logs log group name
cloudtrail_logs_role_arn: CloudTrail Logs role ARN
cloudtrail_logs_role_name: CloudTrail Logs role name

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 4.9.0

Providers

aws, version: >= 4.9.0

Modules

Name	Version	Source	Description
`account_map`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`cloudtrail`	0.21.0	`cloudposse/cloudtrail/aws`	n/a
`cloudtrail_bucket`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`kms_key_cloudtrail`	0.12.1	`cloudposse/kms-key/aws`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_cloudwatch_log_group.cloudtrail_cloudwatch_logs (resource)
aws_iam_policy.cloudtrail_cloudwatch_logs (resource)
aws_iam_role.cloudtrail_cloudwatch_logs (resource)
aws_iam_role_policy_attachment.cloudtrail_cloudwatch_logs (resource)

Data Sources

The following data sources are used by this module:

aws_caller_identity.this (data source)
aws_iam_policy_document.cloudtrail_cloudwatch_logs (data source)
aws_iam_policy_document.cloudtrail_cloudwatch_logs_assume_role (data source)
aws_iam_policy_document.kms_key_cloudtrail (data source)
aws_partition.current (data source)

References

cloudposse/terraform-aws-components - Cloud Posse's upstream component

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

References​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources

References