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:
import cloudtrail = require('@aws-cdk/aws-cloudtrail');
const trail = new cloudtrail.Trail(this, '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
import cloudtrail = require('@aws-cdk/aws-cloudtrail');
const trail = new cloudtrail.Trail(this, 'CloudTrail', {
sendToCloudWatchLogs: 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:
import cloudtrail = require('@aws-cdk/aws-cloudtrail');
const trail = new cloudtrail.Trail(this, 'MyAmazingCloudTrail');
// Adds an event selector to the bucket magic-bucket.
// By default, this includes management events and all operations (Read + Write)
trail.addS3EventSelector(["arn:aws:s3:::magic-bucket/"]);
// Adds an event selector to the bucket foo, with a specific configuration
trail.addS3EventSelector(["arn:aws:s3:::foo/"], {
includeManagementEvents: false,
readWriteType: 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-0.37.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b246e9f1a91789e2e5c8b1ad42bd795033855015a9c880b12ab1acb31ae296f |
|
MD5 | 221537d0f325b0cf34c3bd139bac820d |
|
BLAKE2b-256 | cd7c35bc3ff9e1f5fb19c6c0797f08ddefb861c77f3b63cc1d0fa105c64aa75c |
Hashes for aws_cdk.aws_cloudtrail-0.37.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6dfd5a38ef30dd8bf736e9309d350f89719192a36fce5d545dd9ee7eab9bdc84 |
|
MD5 | b005958581593a89036d1ad5c5aa6daf |
|
BLAKE2b-256 | 0370564c39bdb48b5065a7ee619a6702c209fb7b380f465ac1861337d0c0e632 |