Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

CDK Constructs for AWS CloudTrail

Project description

AWS CloudTrail Construct Library

<html></html>---

Stability: Experimental

This is a developer preview (public beta) module. Releases might lack important features and might have future breaking changes.

This API is still under active development and subject to non-backward compatible changes or removal in any future version. Use of the API is not recommended in production environments. Experimental APIs are not subject to the Semantic Versioning model.


<html></html>

Add a CloudTrail construct - for ease of setting up CloudTrail logging in your account

Example usage:

# Example may have issues. See https://github.com/aws/jsii/issues/826
import aws_cdk.aws_cloudtrail as cloudtrail

trail = cloudtrail.Trail(self, "CloudTrail")

You can instantiate the CloudTrail construct with no arguments - this will by default:

  • Create a new S3 Bucket and associated Policy that allows CloudTrail to write to it
  • Create a CloudTrail with the following configuration:
  • Logging Enabled
  • Log file validation enabled
  • Multi Region set to true
  • Global Service Events set to true
  • The created S3 bucket
  • CloudWatch Logging Disabled
  • No SNS configuartion
  • No tags
  • No fixed name

You can override any of these properties using the CloudTrailProps configuraiton object.

For example, to log to CloudWatch Logs

# Example may have issues. See https://github.com/aws/jsii/issues/826

import aws_cdk.aws_cloudtrail as cloudtrail

trail = cloudtrail.Trail(self, "CloudTrail",
    send_to_cloud_watch_logs=True
)

This creates the same setup as above - but also logs events to a created CloudWatch Log stream. By default, the created log group has a retention period of 365 Days, but this is also configurable.

For using CloudTrail event selector to log specific S3 events, you can use the CloudTrailProps configuration object. Example:

# Example may have issues. See https://github.com/aws/jsii/issues/826
import aws_cdk.aws_cloudtrail as cloudtrail

trail = cloudtrail.Trail(self, "MyAmazingCloudTrail")

# Adds an event selector to the bucket magic-bucket.
# By default, this includes management events and all operations (Read + Write)
trail.add_s3_event_selector(["arn:aws:s3:::magic-bucket/"])

# Adds an event selector to the bucket foo, with a specific configuration
trail.add_s3_event_selector(["arn:aws:s3:::foo/"],
    include_management_events=False,
    read_write_type=ReadWriteType.ALL
)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for aws-cdk.aws-cloudtrail, version 1.16.3
Filename, size File type Python version Upload date Hashes
Filename, size aws_cdk.aws_cloudtrail-1.16.3-py3-none-any.whl (57.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size aws-cdk.aws-cloudtrail-1.16.3.tar.gz (58.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page