Skip to main content

Component: 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.


Stack Level: Global

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


enabled: true
cloudtrail_bucket_environment_name: "ue1"
cloudtrail_bucket_stage_name: "audit"
cloudwatch_logs_retention_in_days: 730
is_organization_trail: true


terraform>= 1.0.0
aws>= 4.9.0


aws>= 4.9.0




aws_caller_identity.thisdata source
aws_iam_policy_document.cloudtrail_cloudwatch_logsdata source
aws_iam_policy_document.cloudtrail_cloudwatch_logs_assume_roledata source
aws_iam_policy_document.kms_key_cloudtraildata source
aws_partition.currentdata source


additional_tag_mapAdditional 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.
attributesID 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.
audit_access_enabledIf 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.boolfalseno
cloudtrail_bucket_component_nameThe name of the CloudTrail bucket componentstring"cloudtrail-bucket"no
cloudtrail_bucket_environment_nameThe name of the environment where the CloudTrail bucket is provisionedstringn/ayes
cloudtrail_bucket_stage_nameThe stage name where the CloudTrail bucket is provisionedstringn/ayes
cloudtrail_cloudwatch_logs_role_max_session_durationThe maximum session duration (in seconds) for the CloudTrail CloudWatch Logs role. Can have a value from 1 hour to 12 hoursnumber43200no
cloudwatch_logs_retention_in_daysNumber 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.number365no
contextSingle 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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe 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).
enable_log_file_validationSpecifies whether log file integrity validation is enabled. Creates signed digest for validated contents of logsbooltrueno
enable_loggingEnable logging for the trailbooltrueno
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
id_length_limitLimit 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.
include_global_service_eventsSpecifies whether the trail is publishing events from global services such as IAM to the log filesbooltrueno
is_multi_region_trailSpecifies whether the trail is created in the current region or in all regionsbooltrueno
is_organization_trailSpecifies 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.
label_key_caseControls 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.
label_orderThe 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.
label_value_caseControls 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.
labels_as_tagsSet 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.
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.
nameID 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.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform 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.
regionAWS Regionstringn/ayes
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno


cloudtrail_arnCloudTrail ARN
cloudtrail_home_regionThe region in which CloudTrail was created
cloudtrail_idCloudTrail ID
cloudtrail_logs_log_group_arnCloudTrail Logs log group ARN
cloudtrail_logs_log_group_nameCloudTrail Logs log group name
cloudtrail_logs_role_arnCloudTrail Logs role ARN
cloudtrail_logs_role_nameCloudTrail Logs role name