Documentation

cloudtrail - manage CloudTrail create, delete, update

New in version 2.0.

Synopsis

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

Requirements (on host that executes module)

  • boto
  • boto3
  • botocore
  • python >= 2.6

Options

parameter required default choices comments
aws_access_key
no
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
no
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)
no
A full ARN specifying a valid CloudWatch log group to which CloudTrail logs will be delivered. The log group should already exist.
Example arn:aws:logs:us-east-1:123456789012:log-group:CloudTrail/DefaultLogGroup:*
Required when cloudwatch_logs_role_arn
cloudwatch_logs_role_arn
(added in 2.4)
no
Specifies a full ARN for an IAM role that assigns the proper permissions for CloudTrail to create and write to the log group listed below.
Example arn:aws:iam::123456789012:role/CloudTrail_CloudWatchLogs_Role
Required when cloudwatch_logs_log_group_arn
ec2_url
no
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
(added in 2.4)
no
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.
enable_logging
(added in 2.4)
no True
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
no True
Record API calls from global services such as IAM and STS.
is_multi_region_trail
(added in 2.4)
no
Specify whether the trail belongs only to one region or exists in all regions.
kms_key_id
(added in 2.4)
no
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.
Examples
alias/MyAliasName
arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
name
yes
Name for the CloudTrail.
Names are unique per-region unless the CloudTrail is a mulit-region trail, in which case it is unique per-account.
profile
(added in 1.6)
no
Uses a boto profile. Only works with boto >= 2.24.0.
region
no
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)
no
An existing S3 bucket where CloudTrail will deliver log files.
This bucket should exist and have the proper policy.
Required when state=present
s3_key_prefix
no
S3 Key prefix for delivered log files. A trailing slash is not necessary and will be removed.
security_token
(added in 1.6)
no
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)
no
SNS Topic name to send notifications to when a log file is delivered
state
yes
  • 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)
no
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
(added in 1.5)
no yes
  • yes
  • no
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

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
    tags:
      environment: dev
      Name: default

- 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 Return Values, the following are the fields unique to this module:

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


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 http://boto.readthedocs.org/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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.