Hierarchy

  • TrailProps
    • TrailProps

Properties

apiCallRateInsight: boolean
apiErrorRateInsight: boolean
bucket?: IBucket

The Amazon S3 bucket

Default

  • if not supplied a bucket will be created with all the correct permisions
cloudWatchLogGroup?: ILogGroup

Log Group to which CloudTrail to push logs to. Ignored if sendToCloudWatchLogs is set to false.

Default

  • a new log group is created and used.
cloudWatchLogsRetention?: RetentionDays

How long to retain logs in CloudWatchLogs. Ignored if sendToCloudWatchLogs is false or if cloudWatchLogGroup is set.

Default

logs.RetentionDays.ONE_YEAR

enableFileValidation?: boolean

To determine whether a log file was modified, deleted, or unchanged after CloudTrail delivered it, you can use CloudTrail log file integrity validation. 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.

Default

true

encryptionKey?: IKey

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

Default

  • No encryption.
includeGlobalServiceEvents?: boolean

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.

Default

true

insightTypes?: InsightType[]

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

Default

  • No Value.
isMultiRegionTrail?: boolean

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

Default

true

isOrganizationTrail: boolean
managementEvents?: ReadWriteType

When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails. 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.

Param

the management configuration type to log

Default

ReadWriteType.ALL

s3KeyPrefix?: string

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

Default

  • No prefix.
sendToCloudWatchLogs?: boolean

If CloudTrail pushes logs to CloudWatch Logs in addition to S3. Disabled for cost out of the box.

Default

false

snsTopic?: ITopic

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

Default

  • No notifications.
trailName?: string

The name of the trail. We recommend customers do not set an explicit name.

Default

  • AWS CloudFormation generated name.

Generated using TypeDoc