TrailArgs

data class TrailArgs(val advancedEventSelectors: Output<List<TrailAdvancedEventSelectorArgs>>? = null, val cloudWatchLogsLogGroupArn: Output<String>? = null, val cloudWatchLogsRoleArn: Output<String>? = null, val enableLogFileValidation: Output<Boolean>? = null, val eventSelectors: Output<List<TrailEventSelectorArgs>>? = null, val includeGlobalServiceEvents: Output<Boolean>? = null, val insightSelectors: Output<List<TrailInsightSelectorArgs>>? = null, val isLogging: Output<Boolean>? = null, val isMultiRegionTrail: Output<Boolean>? = null, val isOrganizationTrail: Output<Boolean>? = null, val kmsKeyId: Output<String>? = null, val s3BucketName: Output<String>? = null, val s3KeyPrefix: Output<String>? = null, val snsTopicName: Output<String>? = null, val tags: Output<List<TagArgs>>? = null, val trailName: Output<String>? = null) : ConvertibleToJava<TrailArgs>

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.

Constructors

Link copied to clipboard
constructor(advancedEventSelectors: Output<List<TrailAdvancedEventSelectorArgs>>? = null, cloudWatchLogsLogGroupArn: Output<String>? = null, cloudWatchLogsRoleArn: Output<String>? = null, enableLogFileValidation: Output<Boolean>? = null, eventSelectors: Output<List<TrailEventSelectorArgs>>? = null, includeGlobalServiceEvents: Output<Boolean>? = null, insightSelectors: Output<List<TrailInsightSelectorArgs>>? = null, isLogging: Output<Boolean>? = null, isMultiRegionTrail: Output<Boolean>? = null, isOrganizationTrail: Output<Boolean>? = null, kmsKeyId: Output<String>? = null, s3BucketName: Output<String>? = null, s3KeyPrefix: Output<String>? = null, snsTopicName: Output<String>? = null, tags: Output<List<TagArgs>>? = null, trailName: Output<String>? = null)

Properties

Link copied to clipboard

The advanced event selectors that were used to select events for the data store.

Link copied to clipboard
val cloudWatchLogsLogGroupArn: Output<String>? = null

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

Link copied to clipboard
val cloudWatchLogsRoleArn: Output<String>? = null

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Link copied to clipboard
val enableLogFileValidation: Output<Boolean>? = null

Specifies whether log file validation is enabled. The default is false.

Link copied to clipboard

Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.

Link copied to clipboard
val includeGlobalServiceEvents: Output<Boolean>? = null

Specifies whether the trail is publishing events from global services such as IAM to the log files.

Link copied to clipboard

Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.

Link copied to clipboard
val isLogging: Output<Boolean>? = null

Whether the CloudTrail is currently logging AWS API calls.

Link copied to clipboard
val isMultiRegionTrail: Output<Boolean>? = null

Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.

Link copied to clipboard
val isOrganizationTrail: Output<Boolean>? = null

Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.

Link copied to clipboard
val kmsKeyId: Output<String>? = null

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Link copied to clipboard
val s3BucketName: Output<String>? = null

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

Link copied to clipboard
val s3KeyPrefix: Output<String>? = null

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

Link copied to clipboard
val snsTopicName: Output<String>? = null

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

A custom set of tags (key-value pairs) for this trail.

Link copied to clipboard
val trailName: Output<String>? = null

Specifies the name of the trail. The name must meet the following requirements:

Functions

Link copied to clipboard
open override fun toJava(): TrailArgs