CfnTrailProps Struct
Properties for defining a CfnTrail.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudtrail as cloudtrail } from 'aws-cdk-lib';
const cfnTrailProps: cloudtrail.CfnTrailProps = {
isLogging: false,
s3BucketName: 's3BucketName',
// the properties below are optional
advancedEventSelectors: [{
fieldSelectors: [{
field: 'field',
// the properties below are optional
endsWith: ['endsWith'],
equalTo: ['equalTo'],
notEndsWith: ['notEndsWith'],
notEquals: ['notEquals'],
notStartsWith: ['notStartsWith'],
startsWith: ['startsWith'],
}],
// the properties below are optional
name: 'name',
}],
aggregationConfigurations: [{
eventCategory: 'eventCategory',
templates: ['templates'],
}],
cloudWatchLogsLogGroupArn: 'cloudWatchLogsLogGroupArn',
cloudWatchLogsRoleArn: 'cloudWatchLogsRoleArn',
enableLogFileValidation: false,
eventSelectors: [{
dataResources: [{
type: 'type',
// the properties below are optional
values: ['values'],
}],
excludeManagementEventSources: ['excludeManagementEventSources'],
includeManagementEvents: false,
readWriteType: 'readWriteType',
}],
includeGlobalServiceEvents: false,
insightSelectors: [{
eventCategories: ['eventCategories'],
insightType: 'insightType',
}],
isMultiRegionTrail: false,
isOrganizationTrail: false,
kmsKeyId: 'kmsKeyId',
s3KeyPrefix: 's3KeyPrefix',
snsTopicName: 'snsTopicName',
tags: [{
key: 'key',
value: 'value',
}],
trailName: 'trailName',
};
Properties
advancedEventSelectorsoptionalIResolvable | IResolvable | CfnTrail.AdvancedEventSelectorProperty[]advanced_event_selectorsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AdvancedEventSelectorProperty]]]advancedEventSelectorsoptionalIResolvableAdvancedEventSelectorsoptionalIResolvableAdvancedEventSelectorsoptionalinterface{}#notes
You can use advanced event selectors to log management events, data events for all resource types, and network activity events.
You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors , but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events and Logging network activity events in the AWS CloudTrail User Guide .
aggregationConfigurationsoptionalIResolvable | IResolvable | CfnTrail.AggregationConfigurationProperty[]aggregation_configurationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AggregationConfigurationProperty]]]aggregationConfigurationsoptionalIResolvableAggregationConfigurationsoptionalIResolvableAggregationConfigurationsoptionalinterface{}#A maximum of 1 aggregation configuration is allowed.
cloudWatchLogsLogGroupArnoptionalstring | ILogGroupRefcloud_watch_logs_log_group_arnoptionaltyping.Union[str, ILogGroupRef]cloudWatchLogsLogGroupArnoptionalStringCloudWatchLogsLogGroupArnoptionalstringCloudWatchLogsLogGroupArnoptionalinterface{}#notes
You must use a log group that exists in your account.
To enable CloudWatch Logs delivery, you must provide values for CloudWatchLogsLogGroupArn and CloudWatchLogsRoleArn .
If you previously enabled CloudWatch Logs delivery and want to disable CloudWatch Logs delivery, you must set the values of the
CloudWatchLogsRoleArnandCloudWatchLogsLogGroupArnfields to"".
cloudWatchLogsRoleArnoptionalstring | IRoleRefcloud_watch_logs_role_arnoptionaltyping.Union[str, IRoleRef]cloudWatchLogsRoleArnoptionalStringCloudWatchLogsRoleArnoptionalstringCloudWatchLogsRoleArnoptionalinterface{}#notes
You must use a role that exists in your account.
To enable CloudWatch Logs delivery, you must provide values for CloudWatchLogsLogGroupArn and CloudWatchLogsRoleArn .
If you previously enabled CloudWatch Logs delivery and want to disable CloudWatch Logs delivery, you must set the values of the
CloudWatchLogsRoleArnandCloudWatchLogsLogGroupArnfields to"".
enableLogFileValidationoptionalboolean | IResolvableenable_log_file_validationoptionaltyping.Union[bool, IResolvable]enableLogFileValidationoptionalBooleanEnableLogFileValidationoptionalboolEnableLogFileValidationoptionalinterface{}#notes
When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
eventSelectorsoptionalIResolvable | IResolvable | CfnTrail.EventSelectorProperty[]event_selectorsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EventSelectorProperty]]]eventSelectorsoptionalIResolvableEventSelectorsoptionalIResolvableEventSelectorsoptionalinterface{}#notes
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.
You cannot apply both event selectors and advanced event selectors to a trail.
includeGlobalServiceEventsoptionalboolean | IResolvableinclude_global_service_eventsoptionaltyping.Union[bool, IResolvable]includeGlobalServiceEventsoptionalBooleanIncludeGlobalServiceEventsoptionalboolIncludeGlobalServiceEventsoptionalinterface{}#insightSelectorsoptionalIResolvable | IResolvable | CfnTrail.InsightSelectorProperty[]insight_selectorsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InsightSelectorProperty]]]insightSelectorsoptionalIResolvableInsightSelectorsoptionalIResolvableInsightSelectorsoptionalinterface{}#notes
ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.
The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.
The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.
isLoggingboolean | IResolvableis_loggingtyping.Union[bool, IResolvable]isLoggingBooleanIsLoggingboolIsLogginginterface{}required#isMultiRegionTrailoptionalboolean | IResolvableis_multi_region_trailoptionaltyping.Union[bool, IResolvable]isMultiRegionTrailoptionalBooleanIsMultiRegionTrailoptionalboolIsMultiRegionTrailoptionalinterface{}#notes
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.
isOrganizationTrailoptionalboolean | IResolvableis_organization_trailoptionaltyping.Union[bool, IResolvable]isOrganizationTrailoptionalBooleanIsOrganizationTrailoptionalboolIsOrganizationTrailoptionalinterface{}#notes
The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the management account for an organization in AWS Organizations . If the trail is not an organization trail and this is set to true , the trail will be created in all AWS accounts that belong to the organization. If the trail is an organization trail and this is set to false , the trail will remain in the current AWS account but be deleted from all member accounts in the organization.
Only the management account for the organization can convert an organization trail to a non-organization trail, or convert a non-organization trail to an organization trail.
kmsKeyIdoptionalstring | IAliasRef | IKeyRefkms_key_idoptionaltyping.Union[str, IAliasRef, IKeyRef]kmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptionalinterface{}#notes
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.
CloudTrail also supports AWS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide .
Examples:
- alias/MyAliasName
- arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
- arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
- 12345678-1234-1234-1234-123456789012
s3BucketNamestring | IBucketRefs3_bucket_nametyping.Union[str, IBucketRef]s3BucketNameStringS3BucketNamestringS3BucketNameinterface{}required#s3KeyPrefixoptionalstrings3_key_prefixoptionalstrs3KeyPrefixoptionalStringS3KeyPrefixoptionalstringS3KeyPrefixoptional*string#For more information, see Finding Your CloudTrail Log Files . The maximum length is 200 characters.
snsTopicNameoptionalstringsns_topic_nameoptionalstrsnsTopicNameoptionalStringSnsTopicNameoptionalstringSnsTopicNameoptional*string#The maximum length is 256 characters.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#trailNameoptionalstringtrail_nameoptionalstrtrailNameoptionalStringTrailNameoptionalstringTrailNameoptional*string#notes
- Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
- Start with a letter or number, and end with a letter or number
- Be between 3 and 128 characters
- Have no adjacent periods, underscores or dashes. Names like
my-_namespaceandmy--namespaceare not valid. - Not be in IP address format (for example, 192.168.5.4)