Nacho Portion Monitor

    @aws-cdk/aws-cloudtrail
    TypeScript icon, indicating that this package has built-in type declarations

    1.168.0 • Public • Published

    AWS CloudTrail Construct Library


    cfn-resources: Stable

    cdk-constructs: Stable


    Trail

    AWS CloudTrail enables governance, compliance, and operational and risk auditing of your AWS account. Actions taken by a user, role, or an AWS service are recorded as events in CloudTrail. Learn more at the CloudTrail documentation.

    The Trail construct enables ongoing delivery of events as log files to an Amazon S3 bucket. Learn more about Creating a Trail for Your AWS Account. The following code creates a simple CloudTrail for your account -

    const trail = new cloudtrail.Trail(this, 'CloudTrail');

    By default, this will create a new S3 Bucket that CloudTrail will write to, and choose a few other reasonable defaults such as turning on multi-region and global service events. The defaults for each property and how to override them are all documented on the TrailProps interface.

    Log File Validation

    In order to validate that the CloudTrail log file was not modified after CloudTrail delivered it, CloudTrail provides a digital signature for each file. Learn more at Validating CloudTrail Log File Integrity.

    This is enabled on the Trail construct by default, but can be turned off by setting enableFileValidation to false.

    const trail = new cloudtrail.Trail(this, 'CloudTrail', {
      enableFileValidation: false,
    });

    Notifications

    Amazon SNS notifications can be configured upon new log files containing Trail events are delivered to S3. Learn more at Configuring Amazon SNS Notifications for CloudTrail. The following code configures an SNS topic to be notified -

    const topic = new sns.Topic(this, 'TrailTopic');
    const trail = new cloudtrail.Trail(this, 'CloudTrail', {
      snsTopic: topic,
    });

    Service Integrations

    Besides sending trail events to S3, they can also be configured to notify other AWS services -

    Amazon CloudWatch Logs

    CloudTrail events can be delivered to a CloudWatch Logs LogGroup. By default, a new LogGroup is created with a default retention setting. The following code enables sending CloudWatch logs but specifies a particular retention period for the created Log Group.

    import * as logs from '@aws-cdk/aws-logs';
    
    const trail = new cloudtrail.Trail(this, 'CloudTrail', {
      sendToCloudWatchLogs: true,
      cloudWatchLogsRetention: logs.RetentionDays.FOUR_MONTHS, 
    });

    If you would like to use a specific log group instead, this can be configured via cloudwatchLogGroup.

    Amazon EventBridge

    Amazon EventBridge rules can be configured to be triggered when CloudTrail events occur using the Trail.onEvent() API. Using APIs available in aws-events, these events can be filtered to match to those that are of interest, either from a specific service, account or time range. See Events delivered via CloudTrail to learn more about the event structure for events from CloudTrail.

    The following code filters events for S3 from a specific AWS account and triggers a lambda function.

    const myFunctionHandler = new lambda.Function(this, 'MyFunction', {
      code: lambda.Code.fromAsset('resource/myfunction'),
      runtime: lambda.Runtime.NODEJS_12_X,
      handler: 'index.handler',
    });
    
    const eventRule = cloudtrail.Trail.onEvent(this, 'MyCloudWatchEvent', {
      target: new targets.LambdaFunction(myFunctionHandler),
    });
    
    eventRule.addEventPattern({
      account: ['123456789012'],
      source: ['aws.s3'],
    });

    Multi-Region & Global Service Events

    By default, a Trail is configured to deliver log files from multiple regions to a single S3 bucket for a given account. This creates shadow trails (replication of the trails) in all of the other regions. Learn more about How CloudTrail Behaves Regionally and about the IsMultiRegion property.

    For most services, events are recorded in the region where the action occurred. For global services such as AWS IAM, AWS STS, Amazon CloudFront, Route 53, etc., events are delivered to any trail that includes global services. Learn more About Global Service Events.

    Events for global services are turned on by default for Trail constructs in the CDK.

    The following code disables multi-region trail delivery and trail delivery for global services for a specific Trail -

    const trail = new cloudtrail.Trail(this, 'CloudTrail', {
      // ...
      isMultiRegionTrail: false,
      includeGlobalServiceEvents: false,
    });

    Events Types

    Management events provide information about management operations that are performed on resources in your AWS account. These are also known as control plane operations. Learn more about Management Events.

    By default, a Trail logs all management events. However, they can be configured to either be turned off, or to only log 'Read' or 'Write' events.

    The following code configures the Trail to only track management events that are of type 'Read'.

    const trail = new cloudtrail.Trail(this, 'CloudTrail', {
      // ...
      managementEvents: cloudtrail.ReadWriteType.READ_ONLY,
    });

    Data events provide information about the resource operations performed on or in a resource. These are also known as data plane operations. Learn more about Data Events. By default, no data events are logged for a Trail.

    AWS CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions.

    The logAllS3DataEvents() API configures the trail to log all S3 data events while the addS3EventSelector() API can be used to configure logging of S3 data events for specific buckets and specific object prefix. The following code configures logging of S3 data events for fooBucket and with object prefix bar/.

    import * as s3 from '@aws-cdk/aws-s3';
    
    const trail = new cloudtrail.Trail(this, 'MyAmazingCloudTrail');
    declare const bucket: s3.Bucket;
    
    // Adds an event selector to the bucket foo
    trail.addS3EventSelector([{
      bucket,
      objectPrefix: 'bar/',
    }]);

    Similarly, the logAllLambdaDataEvents() configures the trail to log all Lambda data events while the addLambdaEventSelector() API can be used to configure logging for specific Lambda functions. The following code configures logging of Lambda data events for a specific Function.

    const trail = new cloudtrail.Trail(this, 'MyAmazingCloudTrail');
    const amazingFunction = new lambda.Function(this, 'AnAmazingFunction', {
      runtime: lambda.Runtime.NODEJS_12_X,
      handler: "hello.handler",
      code: lambda.Code.fromAsset("lambda"),
    });
    
    // Add an event selector to log data events for the provided Lambda functions.
    trail.addLambdaEventSelector([ amazingFunction ]);

    Install

    npm i @aws-cdk/aws-cloudtrail

    DownloadsWeekly Downloads

    26,983

    Version

    1.168.0

    License

    Apache-2.0

    Unpacked Size

    567 kB

    Total Files

    16

    Last publish

    Collaborators

    • romainmuller
    • amzn-oss
    • rix0rrr
    • aws-cdk-team