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-1.6.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 405f442978f1e0184841f660df74dd5f4abf3d9688e23442b0725e744d5b9ea5 |
|
MD5 | de54bfa80a9f6338105b45f033dec963 |
|
BLAKE2b-256 | bcad0d21dadfcdf983d5ec165ca47eed78185337d48ad8b34e8af884c4732926 |
Hashes for aws_cdk.aws_cloudtrail-1.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9fa4eefba10619c4cfb6a68ebd937357cda0594f63f21548d750077f076298b |
|
MD5 | 69244f946bd3d1fef4377c0c41a83473 |
|
BLAKE2b-256 | 04c9ecae42a32170db5bab1ca1f8cdf23ab663ab2255af9e710a8d25fdd826f6 |