amazon.aws.cloudtrail module – manage CloudTrail create, delete, update

Note

This module is part of the amazon.aws collection (version 5.5.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install amazon.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.aws.cloudtrail.

New in amazon.aws 5.0.0

Synopsis

  • Creates, deletes, or updates CloudTrail configuration. Ensures logging is also enabled.

  • This module was originally added to community.aws in release 1.0.0.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.18.0

  • botocore >= 1.21.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

AWS access key ID.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference. Prior to release 6.0.0 these environment variables will be ignored if the profile parameter is passed. After release 6.0.0 access_key will always fall back to the environment variables if set.

The aws_access_key and profile options are mutually exclusive.

The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

cloudwatch_logs_log_group_arn

string

A full ARN specifying a valid CloudWatch log group to which CloudTrail logs will be delivered. The log group should already exist.

See https://docs.aws.amazon.com/awscloudtrail/latest/userguide/send-cloudtrail-events-to-cloudwatch-logs.html.

Required when cloudwatch_logs_role_arn.

cloudwatch_logs_role_arn

string

Specifies a full ARN for an IAM role that assigns the proper permissions for CloudTrail to create and write to the log group.

See https://docs.aws.amazon.com/awscloudtrail/latest/userguide/send-cloudtrail-events-to-cloudwatch-logs.html.

Required when cloudwatch_logs_log_group_arn.

debug_botocore_endpoint_logs

boolean

Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook.

The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.

Choices:

  • false ← (default)

  • true

enable_log_file_validation

aliases: log_file_validation_enabled

boolean

Specifies whether log file integrity validation is enabled.

CloudTrail will create a hash for every log file delivered and produce a signed digest file that can be used to ensure log files have not been tampered.

Choices:

  • false

  • true

enable_logging

boolean

Start or stop the CloudTrail logging. If stopped the trail will be paused and will not record events or deliver log files.

Choices:

  • false

  • true ← (default)

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS.

The AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

include_global_events

aliases: include_global_service_events

boolean

Record API calls from global services such as IAM and STS.

Choices:

  • false

  • true ← (default)

is_multi_region_trail

boolean

Specify whether the trail belongs only to one region or exists in all regions.

Choices:

  • false ← (default)

  • true

kms_key_id

string

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. This also has the effect of enabling log file encryption.

The value can be an alias name prefixed by “alias/”, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Encryption can be disabled by setting kms_key_id=””.

See https://docs.aws.amazon.com/awscloudtrail/latest/userguide/encrypting-cloudtrail-log-files-with-aws-kms.html.

name

string

Name for the CloudTrail.

Names are unique per-region unless the CloudTrail is a multi-region trail, in which case it is unique per-account.

Default: "default"

profile

aliases: aws_profile

string

A named AWS profile to use for authentication.

See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

The AWS_PROFILE environment variable may also be used. Prior to release 6.0.0 the AWS_PROFILE environment variable will be ignored if any of access_key, secret_key, or session_token are passed. After release 6.0.0 profile will always fall back to the AWS_PROFILE environment variable if set.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

purge_tags

boolean

If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter.

If the tags parameter is not set then tags will not be modified, even if purge_tags=True.

Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Choices:

  • false

  • true ← (default)

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

s3_bucket_name

string

An existing S3 bucket where CloudTrail will deliver log files.

This bucket should exist and have the proper policy.

See https://docs.aws.amazon.com/awscloudtrail/latest/userguide/aggregating_logs_regions_bucket_policy.html.

Required when state=present.

s3_key_prefix

string

S3 Key prefix for delivered log files. A trailing slash is not necessary and will be removed.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

AWS secret access key.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference. Prior to release 6.0.0 these environment variables will be ignored if the profile parameter is passed. After release 6.0.0 secret_key will always fall back to the environment variables if set.

The secret_key and profile options are mutually exclusive.

The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

AWS STS session token for use with temporary credentials.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference. Prior to release 6.0.0 these environment variables will be ignored if the profile parameter is passed. After release 6.0.0 session_token will always fall back to the environment variables if set.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0.

The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

sns_topic_name

string

SNS Topic name to send notifications to when a log file is delivered.

state

string

Add or remove CloudTrail configuration.

The following states have been preserved for backwards compatibility: state=enabled and state=disabled.

state=enabled is equivalet to state=present.

state=disabled is equivalet to state=absent.

Choices:

  • "present" ← (default)

  • "absent"

  • "enabled"

  • "disabled"

tags

aliases: resource_tags

dictionary

A dictionary representing the tags to be applied to the resource.

If the tags parameter is not set then tags will not be modified.

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • The purge_tags option was added in release 4.0.0

  • Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

  • The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

- name: create single region cloudtrail
  amazon.aws.cloudtrail:
    state: present
    name: default
    s3_bucket_name: mylogbucket
    s3_key_prefix: cloudtrail
    region: us-east-1

- name: create multi-region trail with validation and tags
  amazon.aws.cloudtrail:
    state: present
    name: default
    s3_bucket_name: mylogbucket
    region: us-east-1
    is_multi_region_trail: true
    enable_log_file_validation: true
    cloudwatch_logs_role_arn: "arn:aws:iam::123456789012:role/CloudTrail_CloudWatchLogs_Role"
    cloudwatch_logs_log_group_arn: "arn:aws:logs:us-east-1:123456789012:log-group:CloudTrail/DefaultLogGroup:*"
    kms_key_id: "alias/MyAliasName"
    tags:
      environment: dev
      Name: default

- name: show another valid kms_key_id
  amazon.aws.cloudtrail:
    state: present
    name: default
    s3_bucket_name: mylogbucket
    kms_key_id: "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"
    # simply "12345678-1234-1234-1234-123456789012" would be valid too.

- name: pause logging the trail we just created
  amazon.aws.cloudtrail:
    state: present
    name: default
    enable_logging: false
    s3_bucket_name: mylogbucket
    region: us-east-1
    is_multi_region_trail: true
    enable_log_file_validation: true
    tags:
      environment: dev
      Name: default

- name: delete a trail
  amazon.aws.cloudtrail:
    state: absent
    name: default

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

exists

boolean

whether the resource exists

Returned: always

Sample: true

trail

complex

CloudTrail resource details

Returned: always

Sample: "hash/dictionary of values"

cloud_watch_logs_log_group_arn

string

Full ARN of the CloudWatch Logs log group where events are delivered.

Returned: success when present

Sample: "arn:aws:logs:us-east-1:123456789012:log-group:CloudTrail/DefaultLogGroup:*"

cloud_watch_logs_role_arn

string

Full ARN of the IAM role that CloudTrail assumes to deliver events.

Returned: success when present

Sample: "arn:aws:iam::123456789012:role/CloudTrail_CloudWatchLogs_Role"

has_custom_event_selectors

boolean

Whether any custom event selectors are used for this trail.

Returned: success

Sample: false

home_region

string

The home region where the trail was originally created and must be edited.

Returned: success

Sample: "us-east-1"

include_global_service_events

boolean

Whether global services (IAM, STS) are logged with this trail

Returned: success

Sample: true

is_logging

boolean

Whether logging is turned on or paused for the Trail

Returned: success

Sample: true

is_multi_region_trail

boolean

Whether the trail applies to all regions or just one

Returned: success

Sample: true

kms_key_id

string

Full ARN of the KMS Key used to encrypt log files.

Returned: success when present

Sample: "arn:aws:kms::123456789012:key/12345678-1234-1234-1234-123456789012"

log_file_validation_enabled

boolean

Whether log file validation is enabled on the trail

Returned: success

Sample: true

name

string

Name of the CloudTrail resource

Returned: success

Sample: "default"

s3_bucket_name

string

S3 bucket name where log files are delivered

Returned: success

Sample: "myBucket"

s3_key_prefix

string

Key prefix in bucket where log files are delivered (if any)

Returned: success when present

Sample: "myKeyPrefix"

sns_topic_arn

string

Full ARN of the SNS topic where log delivery notifications are sent.

Returned: success when present

Sample: "arn:aws:sns:us-east-1:123456789012:topic/myTopic"

sns_topic_name

string

The SNS topic name where log delivery notifications are sent.

Returned: success when present

Sample: "myTopic"

tags

dictionary

hash/dictionary of tags applied to this resource

Returned: success

Sample: {"Name": "default", "environment": "dev"}

trail_arn

string

Full ARN of the CloudTrail resource

Returned: success

Sample: "arn:aws:cloudtrail:us-east-1:123456789012:trail/default"

Authors

  • Ansible Core Team

  • Ted Timmons (@tedder)

  • Daniel Shepherd (@shepdelacreme)