CDK Constructs for AWS CloudTrail
Project description
AWS CloudTrail Construct Library
---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.
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aws-cdk.aws-cloudtrail-1.15.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1f1fc800c645aa56a9da115f84f7b03c4a534b8b774cf527f381d29ac13c7f5 |
|
MD5 | a8391f5318a5fa9b6cfc7536fb59bbe8 |
|
BLAKE2b-256 | 374c1aa97ebd6bbe99936119c25df6dad96d535ead3f802f7700894c1e156d2c |
Hashes for aws_cdk.aws_cloudtrail-1.15.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0f5baa2e09087e91b5b93e3fc0332bddef6bdaabc6c2d5540b572fd246e6a85 |
|
MD5 | 021d44326d24eaf7c3921742a03d8e6d |
|
BLAKE2b-256 | 8c977952f5b171207682b93ec45a219b50d0810e175846bc796e927bedf60cd8 |