Documentation

cloudtrail - manage CloudTrail creation and deletion

New in version 2.0.

Synopsis

Creates or deletes CloudTrail configuration. Ensures logging is also enabled.

Requirements (on host that executes module)

  • boto
  • boto >= 2.21
  • 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
      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.
        include_global_events
        		 no
        • true
        • false
        record API calls from global services such as IAM and STS?
        name
        		 no
          name for given CloudTrail configuration.
          This is a primary key and is used to identify the configuration.
          profile
          (added in 1.6)
          		 no
            uses a boto profile. Only works with boto >= 2.24.0
            region
            (added in 1.5)
            		 no
              The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used.

              aliases: aws_region, ec2_region
              s3_bucket_prefix
              		 no
                bucket to place CloudTrail in.
                required when state=enabled.
                s3_key_prefix
                		 no
                  prefix to keys in bucket. 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
                    state
                    		 yes
                    • enabled
                    • disabled
                    add or remove CloudTrail configuration.
                    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: enable cloudtrail
  local_action: cloudtrail
    state=enabled name=main s3_bucket_name=ourbucket
    s3_key_prefix=cloudtrail region=us-east-1

- name: enable cloudtrail with different configuration
  local_action: cloudtrail
    state=enabled name=main s3_bucket_name=ourbucket2
    s3_key_prefix='' region=us-east-1

- name: remove cloudtrail
  local_action: cloudtrail state=disabled name=main region=us-east-1

                    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

                    Note

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

                    Note

                    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

                    This is an Extras Module

                    For more information on what this means please read Extras Modules

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