- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# cloudtrail – manage CloudTrail create, delete, update

- Synopsis

- Requirements

- Parameters

- Notes

- Examples

- Return Values

- Status

## Synopsis

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

## Requirements

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

- boto

- boto3

- botocore

- python >= 2.6

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
aws_access_key string |  | AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key
aws_secret_key string |  | AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key
cloudwatch_logs_log_group_arn - added in 2.4 |  | 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 - added in 2.4 |  | 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 added in 2.8 | Choices: no ← yes | 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.
ec2_url string |  | Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
enable_log_file_validation boolean added in 2.4 | Choices: no yes | 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. aliases: log_file_validation_enabled
enable_logging boolean added in 2.4 | Choices: no yes ← | Start or stop the CloudTrail logging. If stopped the trail will be paused and will not record events or deliver log files.
include_global_events boolean | Choices: no yes ← | Record API calls from global services such as IAM and STS. aliases: include_global_service_events
is_multi_region_trail boolean added in 2.4 | Choices: no ← yes | Specify whether the trail belongs only to one region or exists in all regions.
kms_key_id - added in 2.4 |  | 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. See https://docs.aws.amazon.com/awscloudtrail/latest/userguide/encrypting-cloudtrail-log-files-with-aws-kms.html.
name - / required |  | 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.
profile string |  | Uses a boto profile. Only works with boto >= 2.24.0.
region string |  | The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region aliases: aws_region, ec2_region
s3_bucket_name - added in 2.4 |  | 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 - |  | S3 Key prefix for delivered log files. A trailing slash is not necessary and will be removed.
security_token string |  | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token
sns_topic_name - added in 2.4 |  | SNS Topic name to send notifications to when a log file is delivered.
state - / required | Choices: present absent enabled disabled | Add or remove CloudTrail configuration. The following states have been preserved for backwards compatibility. `state=enabled` and `state=disabled`. enabled=present and disabled=absent.
tags - added in 2.4 | Default: {} | A hash/dictionary of tags to be applied to the CloudTrail resource. Remove completely or specify an empty dictionary to remove all tags.
validate_certs boolean | Choices: no yes ← | When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

## Notes

Note

- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence `AWS_URL` or `EC2_URL`, `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY` or `EC2_ACCESS_KEY`, `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY` or `EC2_SECRET_KEY`, `AWS_SECURITY_TOKEN` or `EC2_SECURITY_TOKEN`, `AWS_REGION` or `EC2_REGION`

- Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html

- `AWS_REGION` or `EC2_REGION` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

## Examples

    - name: create single region cloudtrail
      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
      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
      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
      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
      cloudtrail:
        state: absent
        name: default

## Return Values

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

Key | Returned | Description
--- | --- | ---
exists boolean | always | whether the resource exists Sample: True
trail complex | always | CloudTrail resource details Sample: hash/dictionary of values
| cloud_watch_logs_log_group_arn string | success when present | Full ARN of the CloudWatch Logs log group where events are delivered. Sample: arn:aws:logs:us-east-1:123456789012:log-group:CloudTrail/DefaultLogGroup:*
| cloud_watch_logs_role_arn string | success when present | Full ARN of the IAM role that CloudTrail assumes to deliver events. Sample: arn:aws:iam::123456789012:role/CloudTrail_CloudWatchLogs_Role
| has_custom_event_selectors boolean | success | Whether any custom event selectors are used for this trail.
| home_region string | success | The home region where the trail was originally created and must be edited. Sample: us-east-1
| include_global_service_events boolean | success | Whether global services (IAM, STS) are logged with this trail Sample: True
| is_logging boolean | success | Whether logging is turned on or paused for the Trail Sample: True
| is_multi_region_trail boolean | success | Whether the trail applies to all regions or just one Sample: True
| kms_key_id string | success when present | Full ARN of the KMS Key used to encrypt log files. Sample: arn:aws:kms::123456789012:key/12345678-1234-1234-1234-123456789012
| log_file_validation_enabled boolean | success | Whether log file validation is enabled on the trail Sample: True
| name string | success | Name of the CloudTrail resource Sample: default
| s3_bucket_name string | success | S3 bucket name where log files are delivered Sample: myBucket
| s3_key_prefix string | success when present | Key prefix in bucket where log files are delivered (if any) Sample: myKeyPrefix
| sns_topic_arn string | success when present | Full ARN of the SNS topic where log delivery notifications are sent. Sample: arn:aws:sns:us-east-1:123456789012:topic/myTopic
| sns_topic_name string | success when present | The SNS topic name where log delivery notifications are sent. Sample: myTopic
| tags dictionary | success | hash/dictionary of tags applied to this resource Sample: {'environment': 'dev', 'Name': 'default'}
| trail_arn string | success | Full ARN of the CloudTrail resource Sample: arn:aws:cloudtrail:us-east-1:123456789012:trail/default

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- Ansible Core Team

- Ted Timmons (@tedder)

- Daniel Shepherd (@shepdelacreme)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.