# salt.states.boto_cloudtrail

## Manage CloudTrail Objects

Added in version 2016.3.0.

Create and destroy CloudTrail objects. Be aware that this interacts with Amazon's services, and so may incur charges.

depends:

  - boto

  - boto3

The dependencies listed above can be installed via package or pip.

This module accepts explicit vpc credentials but can also utilize IAM roles assigned to the instance through Instance Profiles. Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More information available here.

If IAM roles are not used you need to specify them either in a pillar file or in the minion's config file:

    vpc.keyid: GKTADJGHEIQSXMKKRBJ08H
    vpc.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

It's also possible to specify `key`, `keyid` and `region` via a profile, either passed in as a dict, or as a string to pull from pillars or minion config:

    myprofile:
        keyid: GKTADJGHEIQSXMKKRBJ08H
        key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
            region: us-east-1

    Ensure trail exists:
        boto_cloudtrail.present:
            - Name: mytrail
            - S3BucketName: mybucket
            - S3KeyPrefix: prefix
            - region: us-east-1
            - keyid: GKTADJGHEIQSXMKKRBJ08H
            - key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

salt.states.boto_cloudtrail.absent(name, Name, region=None, key=None, keyid=None, profile=None)

  Ensure trail with passed properties is absent.

  name

    The name of the state definition.

  Name

    Name of the trail.

  region

    Region to connect to.

  key

    Secret key to be used.

  keyid

    Access key to be used.

  profile

    A dict with region, key and keyid, or a pillar key (string) that contains a dict with region, key and keyid.

salt.states.boto_cloudtrail.present(name, Name, S3BucketName, S3KeyPrefix=None, SnsTopicName=None, IncludeGlobalServiceEvents=True, IsMultiRegionTrail=None, EnableLogFileValidation=False, CloudWatchLogsLogGroupArn=None, CloudWatchLogsRoleArn=None, KmsKeyId=None, LoggingEnabled=True, Tags=None, region=None, key=None, keyid=None, profile=None)

  Ensure trail exists.

  name

    The name of the state definition

  Name

    Name of the trail.

  S3BucketName

    Specifies the name of the Amazon S3 bucket designated for publishing log files.

  S3KeyPrefix

    Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.

  SnsTopicName

    Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

  IncludeGlobalServiceEvents

    Specifies whether the trail is publishing events from global services such as IAM to the log files.

  EnableLogFileValidation

    Specifies whether log file integrity validation is enabled. The default is false.

  CloudWatchLogsLogGroupArn

    Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

  CloudWatchLogsRoleArn

    Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

  KmsKeyId

    Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a 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.

  LoggingEnabled

    Whether logging should be enabled for the trail

  Tags

    A dictionary of tags that should be set on the trail

  region

    Region to connect to.

  key

    Secret key to be used.

  keyid

    Access key to be used.

  profile

    A dict with region, key and keyid, or a pillar key (string) that contains a dict with region, key and keyid.