Trail L2 construct

Cloud trail allows you to log events that happen in your AWS account For example:.

import { CloudTrail } from 'aws-cdk-lib/aws-cloudtrail'

const cloudTrail = new CloudTrail(this, 'MyTrail');

CloudFormation: AWS::CloudTrail::Trail
L1 type: CfnTrail
Source: aws-cloudtrail/lib/cloudtrail.ts
Type last changed: v2.196.0 · 16 May 2025

Example

import * as cloudtrail from 'aws-cdk-lib/aws-cloudtrail';

const myKeyAlias = kms.Alias.fromAliasName(this, 'myKey', 'alias/aws/s3');
const trail = new cloudtrail.Trail(this, 'myCloudTrail', {
  sendToCloudWatchLogs: true,
  encryptionKey: myKeyAlias,
});

python

import aws_cdk.aws_cloudtrail as cloudtrail


my_key_alias = kms.Alias.from_alias_name(self, "myKey", "alias/aws/s3")
trail = cloudtrail.Trail(self, "myCloudTrail",
    send_to_cloud_watch_logs=True,
    encryption_key=my_key_alias
)

java

import software.amazon.awscdk.services.cloudtrail.*;


IAlias myKeyAlias = Alias.fromAliasName(this, "myKey", "alias/aws/s3");
Trail trail = Trail.Builder.create(this, "myCloudTrail")
        .sendToCloudWatchLogs(true)
        .encryptionKey(myKeyAlias)
        .build();

csharp

// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.CloudTrail;


var myKeyAlias = Alias.FromAliasName(this, "myKey", "alias/aws/s3");
var trail = new Trail(this, "myCloudTrail", new TrailProps {
    SendToCloudWatchLogs = true,
    EncryptionKey = myKeyAlias
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import cloudtrail "github.com/aws/aws-cdk-go/awscdk"


myKeyAlias := kms.Alias_FromAliasName(this, jsii.String("myKey"), jsii.String("alias/aws/s3"))
trail := cloudtrail.NewTrail(this, jsii.String("myCloudTrail"), &TrailProps{
	SendToCloudWatchLogs: jsii.Boolean(true),
	EncryptionKey: myKeyAlias,
})

Initializer

new Trail(scope: Construct, id: string, props?: TrailProps)

python

Trail(scope: Construct, id: str, props: typing.Optional[TrailProps] = None)

java

new Trail(Construct scope, String id, TrailProps props)

csharp

new Trail(Construct scope, string id, TrailProps? props = null)

NewTrail(Scope Construct, Id *string, Props TrailProps)

Construct Props

bucketoptionalIBucketbucketoptionalIBucketbucketoptionalIBucketBucketoptionalIBucketBucketoptionalIBucket#

The Amazon S3 bucket.

Default: if not supplied a bucket will be created with all the correct permissions

cloudWatchLogGroupoptionalILogGroupRefcloud_watch_log_groupoptionalILogGroupRefcloudWatchLogGroupoptionalILogGroupRefCloudWatchLogGroupoptionalILogGroupRefCloudWatchLogGroupoptionalILogGroupRef#

Log Group to which CloudTrail to push logs to.

Default: a new log group is created and used.

Ignored if sendToCloudWatchLogs is set to false.

cloudWatchLogsRetentionoptionalRetentionDayscloud_watch_logs_retentionoptionalRetentionDayscloudWatchLogsRetentionoptionalRetentionDaysCloudWatchLogsRetentionoptionalRetentionDaysCloudWatchLogsRetentionoptionalRetentionDays= logs.RetentionDays.ONE_YEAR#

How long to retain logs in CloudWatchLogs.

Ignored if sendToCloudWatchLogs is false or if cloudWatchLogGroup is set.

enableFileValidationoptionalbooleanenable_file_validationoptionalboolenableFileValidationoptionalBooleanEnableFileValidationoptionalboolEnableFileValidationoptional*bool= true#

To determine whether a log file was modified, deleted, or unchanged after CloudTrail delivered it, you can use CloudTrail log file integrity validation.

notes

This feature is built using industry standard algorithms: SHA-256 for hashing and SHA-256 with RSA for digital signing. This makes it computationally infeasible to modify, delete or forge CloudTrail log files without detection. You can use the AWS CLI to validate the files in the location where CloudTrail delivered them.

encryptionKeyoptionalIKeyencryption_keyoptionalIKeyencryptionKeyoptionalIKeyEncryptionKeyoptionalIKeyEncryptionKeyoptionalIKey#

The AWS Key Management Service (AWS KMS) key ID that you want to use to encrypt CloudTrail logs.

Default: No encryption.

includeGlobalServiceEventsoptionalbooleaninclude_global_service_eventsoptionalboolincludeGlobalServiceEventsoptionalBooleanIncludeGlobalServiceEventsoptionalboolIncludeGlobalServiceEventsoptional*bool= true#

For most services, events are recorded in the region where the action occurred.

For global services such as AWS Identity and Access Management (IAM), AWS STS, Amazon CloudFront, and Route 53, events are delivered to any trail that includes global services, and are logged as occurring in US East (N. Virginia) Region.

insightTypesoptionalInsightType[]insight_typesoptionaltyping.List[InsightType]insightTypesoptionalList<InsightType>InsightTypesoptionalInsightType[]InsightTypesoptional*[]InsightType#

A JSON string that contains the insight types you want to log on a trail.

Default: No Value.

isMultiRegionTrailoptionalbooleanis_multi_region_trailoptionalboolisMultiRegionTrailoptionalBooleanIsMultiRegionTrailoptionalboolIsMultiRegionTrailoptional*bool= true#

Whether or not this trail delivers log files from multiple regions to a single S3 bucket for a single account.

isOrganizationTrailoptionalbooleanis_organization_trailoptionalboolisOrganizationTrailoptionalBooleanIsOrganizationTrailoptionalboolIsOrganizationTrailoptional*bool= false#

Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account.

notes

If this is set to true then the current account must be the management account. If it is not, then CloudFormation will throw an error.

If this is set to true and the current account is a management account for an organization in AWS Organizations, the trail will be created in all AWS accounts that belong to the organization. If this is set to false, the trail will remain in the current AWS account but be deleted from all member accounts in the organization.

managementEventsoptionalReadWriteTypemanagement_eventsoptionalReadWriteTypemanagementEventsoptionalReadWriteTypeManagementEventsoptionalReadWriteTypeManagementEventsoptionalReadWriteType= ReadWriteType.ALL#

When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.

notes

Only events that match your trail settings are delivered to your Amazon S3 bucket and Amazon CloudWatch Logs log group.

This method sets the management configuration for this trail.

Management events provide insight into management operations that are performed on resources in your AWS account. These are also known as control plane operations. Management events can also include non-API events that occur in your account. For example, when a user logs in to your account, CloudTrail logs the ConsoleLogin event.

orgIdoptionalstringorg_idoptionalstrorgIdoptionalStringOrgIdoptionalstringOrgIdoptional*string#

The orgId.

Default: No orgId

Required when isOrganizationTrail is set to true to attach the necessary permissions.

s3KeyPrefixoptionalstrings3_key_prefixoptionalstrs3KeyPrefixoptionalStringS3KeyPrefixoptionalstringS3KeyPrefixoptional*string#

An Amazon S3 object key prefix that precedes the name of all log files.

Default: No prefix.

sendToCloudWatchLogsoptionalbooleansend_to_cloud_watch_logsoptionalboolsendToCloudWatchLogsoptionalBooleanSendToCloudWatchLogsoptionalboolSendToCloudWatchLogsoptional*bool= false#

If CloudTrail pushes logs to CloudWatch Logs in addition to S3.

Disabled for cost out of the box.

snsTopicoptionalITopicsns_topicoptionalITopicsnsTopicoptionalITopicSnsTopicoptionalITopicSnsTopicoptionalITopic#

SNS topic that is notified when new log files are published.

Default: No notifications.

trailNameoptionalstringtrail_nameoptionalstrtrailNameoptionalStringTrailNameoptionalstringTrailNameoptional*string#

The name of the trail.

Default: AWS CloudFormation generated name.

Required when isOrganizationTrail is set to true to attach the necessary permissions.

Otherwise, we recommend customers do not set an explicit name.

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

logGroupmay be undefinedILogGrouplog_groupmay be undefinedILogGrouplogGroupmay be undefinedILogGroupLogGroupmay be undefinedILogGroupLogGroupmay be undefinedILogGroup#

The CloudWatch log group to which CloudTrail events are sent.

undefined if sendToCloudWatchLogs property is false.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#

Uniquely identifies this class.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

trailArnstringtrail_arnstrtrailArnStringTrailArnstringTrailArn*string#

ARN of the CloudTrail trail i.e. arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail.

trailSnsTopicArnstringtrail_sns_topic_arnstrtrailSnsTopicArnStringTrailSnsTopicArnstringTrailSnsTopicArn*string#

ARN of the Amazon SNS topic that's associated with the CloudTrail trail, i.e. arn:aws:sns:us-east-2:123456789012:mySNSTopic.

Methods

addEventSelector(dataResourceType: DataResourceType, dataResourceValues: string[], options?: AddEventSelectorOptions): void

def add_event_selector(self, data_resource_type: DataResourceType, data_resource_values: typing.List[str], options: typing.Optional[AddEventSelectorOptions] = None) -> None

public void addEventSelector(DataResourceType dataResourceType, List<String> dataResourceValues, AddEventSelectorOptions options)

public void AddEventSelector(DataResourceType dataResourceType, string[] dataResourceValues, AddEventSelectorOptions? options = null)

func AddEventSelector(DataResourceType DataResourceType, DataResourceValues *[]*string, Options AddEventSelectorOptions)#

When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.

notes · 2 parameters

Only events that match your trail settings are delivered to your Amazon S3 bucket and Amazon CloudWatch Logs log group.

This method adds an Event Selector for filtering events that match either S3 or Lambda function operations.

Data events: These events provide insight into the resource operations performed on or within a resource. These are also known as data plane operations.

Parameters

dataResourceValuesdata_resource_valuesdataResourceValuesdataResourceValuesDataResourceValues — the list of data resource ARNs to include in logging (maximum 250 entries).
optionsoptionsoptionsoptionsOptions — the options to configure logging of management and data events.

addLambdaEventSelector(handlers: IFunction[], options?: AddEventSelectorOptions): void

def add_lambda_event_selector(self, handlers: typing.List[IFunction], options: typing.Optional[AddEventSelectorOptions] = None) -> None

public void addLambdaEventSelector(List<IFunction> handlers, AddEventSelectorOptions options)public void AddLambdaEventSelector(IFunction[] handlers, AddEventSelectorOptions? options = null)func AddLambdaEventSelector(Handlers *[]IFunction, Options AddEventSelectorOptions)#

When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.

notes · 2 parameters

Only events that match your trail settings are delivered to your Amazon S3 bucket and Amazon CloudWatch Logs log group.

This method adds a Lambda Data Event Selector for filtering events that match Lambda function operations.

Data events: These events provide insight into the resource operations performed on or within a resource. These are also known as data plane operations.

Parameters

handlershandlershandlershandlersHandlers — the list of lambda function handlers whose data events should be logged (maximum 250 entries).
optionsoptionsoptionsoptionsOptions — the options to configure logging of management and data events.

addS3EventSelector(s3Selector: S3EventSelector[], options?: AddEventSelectorOptions): void

def add_s3_event_selector(self, s3_selector: typing.List[S3EventSelector], options: typing.Optional[AddEventSelectorOptions] = None) -> None

public void addS3EventSelector(List<S3EventSelector> s3Selector, AddEventSelectorOptions options)public void AddS3EventSelector(S3EventSelector[] s3Selector, AddEventSelectorOptions? options = null)func AddS3EventSelector(S3Selector *[]S3EventSelector, Options AddEventSelectorOptions)#

When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.

notes · 2 parameters

Only events that match your trail settings are delivered to your Amazon S3 bucket and Amazon CloudWatch Logs log group.

This method adds an S3 Data Event Selector for filtering events that match S3 operations.

Data events: These events provide insight into the resource operations performed on or within a resource. These are also known as data plane operations.

Parameters

s3Selectors3_selectors3Selectors3SelectorS3Selector — the list of S3 bucket with optional prefix to include in logging (maximum 250 entries).
optionsoptionsoptionsoptionsOptions — the options to configure logging of management and data events.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

logAllLambdaDataEvents(options?: AddEventSelectorOptions): voiddef log_all_lambda_data_events(self, options: typing.Optional[AddEventSelectorOptions] = None) -> Nonepublic void logAllLambdaDataEvents(AddEventSelectorOptions options)public void LogAllLambdaDataEvents(AddEventSelectorOptions? options = null)func LogAllLambdaDataEvents(Options AddEventSelectorOptions)#

Log all Lambda data events for all lambda functions the account.

logAllS3DataEvents(options?: AddEventSelectorOptions): voiddef log_all_s3_data_events(self, options: typing.Optional[AddEventSelectorOptions] = None) -> Nonepublic void logAllS3DataEvents(AddEventSelectorOptions options)public void LogAllS3DataEvents(AddEventSelectorOptions? options = null)func LogAllS3DataEvents(Options AddEventSelectorOptions)#

Log all S3 data events for all objects for all buckets in the account.

onEvent(scope: Construct, id: string, options?: OnEventOptions): Rule@staticmethod def on_event(scope: Construct, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic static Rule onEvent(Construct scope, String id, OnEventOptions options)public static Rule OnEvent(Construct scope, string id, OnEventOptions? options = null)func OnEvent(Scope Construct, Id *string, Options OnEventOptions) Rulestatic#

Create an event rule for when an event is recorded by any Trail in the account.

Note that the event doesn't necessarily have to come from this Trail, it can be captured from any one.

Be sure to filter the event further down using an event pattern.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Trail L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​

Trail L2 construct

Example

Initializer

Construct Props

Properties

Methods