Class CfnTrailPropsMixin.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTrailPropsMixin>
- Enclosing class:
CfnTrailPropsMixin
CfnTrailPropsMixin.-
Method Summary
Modifier and TypeMethodDescriptionadvancedEventSelectors(List<? extends Object> advancedEventSelectors) Specifies the settings for advanced event selectors.advancedEventSelectors(IResolvable advancedEventSelectors) Specifies the settings for advanced event selectors.aggregationConfigurations(List<? extends Object> aggregationConfigurations) Specifies the aggregation configuration to aggregate CloudTrail Events.aggregationConfigurations(IResolvable aggregationConfigurations) Specifies the aggregation configuration to aggregate CloudTrail Events.build()cloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn) Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered.cloudWatchLogsLogGroupArn(ILogGroupRef cloudWatchLogsLogGroupArn) Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered.cloudWatchLogsRoleArn(String cloudWatchLogsRoleArn) Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.cloudWatchLogsRoleArn(IRoleRef cloudWatchLogsRoleArn) Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.static CfnTrailPropsMixin.Buildercreate()static CfnTrailPropsMixin.Buildercreate(CfnPropertyMixinOptions options) enableLogFileValidation(Boolean enableLogFileValidation) Specifies whether log file validation is enabled.enableLogFileValidation(IResolvable enableLogFileValidation) Specifies whether log file validation is enabled.eventSelectors(List<? extends Object> eventSelectors) Use event selectors to further specify the management and data event settings for your trail.eventSelectors(IResolvable eventSelectors) Use event selectors to further specify the management and data event settings for your trail.includeGlobalServiceEvents(Boolean includeGlobalServiceEvents) Specifies whether the trail is publishing events from global services such as IAM to the log files.includeGlobalServiceEvents(IResolvable includeGlobalServiceEvents) Specifies whether the trail is publishing events from global services such as IAM to the log files.insightSelectors(List<? extends Object> insightSelectors) A JSON string that contains the Insights types you want to log on a trail.insightSelectors(IResolvable insightSelectors) A JSON string that contains the Insights types you want to log on a trail.Whether the CloudTrail trail is currently logging AWS API calls.isLogging(IResolvable isLogging) Whether the CloudTrail trail is currently logging AWS API calls.isMultiRegionTrail(Boolean isMultiRegionTrail) Specifies whether the trail applies only to the current Region or to all Regions.isMultiRegionTrail(IResolvable isMultiRegionTrail) Specifies whether the trail applies only to the current Region or to all Regions.isOrganizationTrail(Boolean isOrganizationTrail) Specifies whether the trail is applied to all accounts in an organization in AWS Organizations , or only for the current AWS account .isOrganizationTrail(IResolvable isOrganizationTrail) Specifies whether the trail is applied to all accounts in an organization in AWS Organizations , or only for the current AWS account .Specifies the AWS key ID to use to encrypt the logs and digest files delivered by CloudTrail.Specifies the AWS key ID to use to encrypt the logs and digest files delivered by CloudTrail.Specifies the AWS key ID to use to encrypt the logs and digest files delivered by CloudTrail.s3BucketName(String s3BucketName) Specifies the name of the Amazon S3 bucket designated for publishing log files.s3BucketName(IBucketRef s3BucketName) Specifies the name of the Amazon S3 bucket designated for publishing log files.s3KeyPrefix(String s3KeyPrefix) Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.snsTopicName(String snsTopicName) Specifies the name or ARN of the Amazon SNS topic defined for notification of log file delivery.A custom set of tags (key-value pairs) for this trail.Specifies the name of the trail.
-
Method Details
-
create
- Parameters:
options- Mixin options.- Returns:
- a new instance of
CfnTrailPropsMixin.Builder.
-
create
- Returns:
- a new instance of
CfnTrailPropsMixin.Builder.
-
advancedEventSelectors
@Stability(Stable) public CfnTrailPropsMixin.Builder advancedEventSelectors(IResolvable advancedEventSelectors) Specifies the settings for advanced event selectors.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
AdvancedEventSelectorsorEventSelectors, but not both. If you applyAdvancedEventSelectorsto a trail, any existingEventSelectorsare overwritten. For more information about advanced event selectors, see Logging data events and Logging network activity events in the AWS CloudTrail User Guide .- Parameters:
advancedEventSelectors- Specifies the settings for advanced event selectors. This parameter is required.- Returns:
this- See Also:
-
advancedEventSelectors
@Stability(Stable) public CfnTrailPropsMixin.Builder advancedEventSelectors(List<? extends Object> advancedEventSelectors) Specifies the settings for advanced event selectors.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
AdvancedEventSelectorsorEventSelectors, but not both. If you applyAdvancedEventSelectorsto a trail, any existingEventSelectorsare overwritten. For more information about advanced event selectors, see Logging data events and Logging network activity events in the AWS CloudTrail User Guide .- Parameters:
advancedEventSelectors- Specifies the settings for advanced event selectors. This parameter is required.- Returns:
this- See Also:
-
aggregationConfigurations
@Stability(Stable) public CfnTrailPropsMixin.Builder aggregationConfigurations(IResolvable aggregationConfigurations) Specifies the aggregation configuration to aggregate CloudTrail Events.A maximum of 1 aggregation configuration is allowed.
- Parameters:
aggregationConfigurations- Specifies the aggregation configuration to aggregate CloudTrail Events. This parameter is required.- Returns:
this- See Also:
-
aggregationConfigurations
@Stability(Stable) public CfnTrailPropsMixin.Builder aggregationConfigurations(List<? extends Object> aggregationConfigurations) Specifies the aggregation configuration to aggregate CloudTrail Events.A maximum of 1 aggregation configuration is allowed.
- Parameters:
aggregationConfigurations- Specifies the aggregation configuration to aggregate CloudTrail Events. This parameter is required.- Returns:
this- See Also:
-
cloudWatchLogsLogGroupArn
@Stability(Stable) public CfnTrailPropsMixin.Builder cloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn) Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered.You must use a log group that exists in your account.
To enable CloudWatch Logs delivery, you must provide values for
CloudWatchLogsLogGroupArnandCloudWatchLogsRoleArn.If you previously enabled CloudWatch Logs delivery and want to disable CloudWatch Logs delivery, you must set the values of the
CloudWatchLogsRoleArnandCloudWatchLogsLogGroupArnfields to"".- Parameters:
cloudWatchLogsLogGroupArn- Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. This parameter is required.- Returns:
this- See Also:
-
cloudWatchLogsLogGroupArn
@Stability(Stable) public CfnTrailPropsMixin.Builder cloudWatchLogsLogGroupArn(ILogGroupRef cloudWatchLogsLogGroupArn) Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered.You must use a log group that exists in your account.
To enable CloudWatch Logs delivery, you must provide values for
CloudWatchLogsLogGroupArnandCloudWatchLogsRoleArn.If you previously enabled CloudWatch Logs delivery and want to disable CloudWatch Logs delivery, you must set the values of the
CloudWatchLogsRoleArnandCloudWatchLogsLogGroupArnfields to"".- Parameters:
cloudWatchLogsLogGroupArn- Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. This parameter is required.- Returns:
this- See Also:
-
cloudWatchLogsRoleArn
@Stability(Stable) public CfnTrailPropsMixin.Builder cloudWatchLogsRoleArn(String cloudWatchLogsRoleArn) Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.You must use a role that exists in your account.
To enable CloudWatch Logs delivery, you must provide values for
CloudWatchLogsLogGroupArnandCloudWatchLogsRoleArn.If you previously enabled CloudWatch Logs delivery and want to disable CloudWatch Logs delivery, you must set the values of the
CloudWatchLogsRoleArnandCloudWatchLogsLogGroupArnfields to"".- Parameters:
cloudWatchLogsRoleArn- Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. This parameter is required.- Returns:
this- See Also:
-
cloudWatchLogsRoleArn
@Stability(Stable) public CfnTrailPropsMixin.Builder cloudWatchLogsRoleArn(IRoleRef cloudWatchLogsRoleArn) Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.You must use a role that exists in your account.
To enable CloudWatch Logs delivery, you must provide values for
CloudWatchLogsLogGroupArnandCloudWatchLogsRoleArn.If you previously enabled CloudWatch Logs delivery and want to disable CloudWatch Logs delivery, you must set the values of the
CloudWatchLogsRoleArnandCloudWatchLogsLogGroupArnfields to"".- Parameters:
cloudWatchLogsRoleArn- Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. This parameter is required.- Returns:
this- See Also:
-
enableLogFileValidation
@Stability(Stable) public CfnTrailPropsMixin.Builder enableLogFileValidation(Boolean enableLogFileValidation) Specifies whether log file validation is enabled. The default is false.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.
- Parameters:
enableLogFileValidation- Specifies whether log file validation is enabled. The default is false. This parameter is required.- Returns:
this- See Also:
-
enableLogFileValidation
@Stability(Stable) public CfnTrailPropsMixin.Builder enableLogFileValidation(IResolvable enableLogFileValidation) Specifies whether log file validation is enabled. The default is false.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.
- Parameters:
enableLogFileValidation- Specifies whether log file validation is enabled. The default is false. This parameter is required.- Returns:
this- See Also:
-
eventSelectors
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.
You cannot apply both event selectors and advanced event selectors to a trail.
- Parameters:
eventSelectors- Use event selectors to further specify the management and data event settings for your trail. This parameter is required.- Returns:
this- See Also:
-
eventSelectors
@Stability(Stable) public CfnTrailPropsMixin.Builder eventSelectors(List<? extends Object> eventSelectors) 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.
You cannot apply both event selectors and advanced event selectors to a trail.
- Parameters:
eventSelectors- Use event selectors to further specify the management and data event settings for your trail. This parameter is required.- Returns:
this- See Also:
-
includeGlobalServiceEvents
@Stability(Stable) public CfnTrailPropsMixin.Builder includeGlobalServiceEvents(Boolean includeGlobalServiceEvents) Specifies whether the trail is publishing events from global services such as IAM to the log files.- Parameters:
includeGlobalServiceEvents- Specifies whether the trail is publishing events from global services such as IAM to the log files. This parameter is required.- Returns:
this- See Also:
-
includeGlobalServiceEvents
@Stability(Stable) public CfnTrailPropsMixin.Builder includeGlobalServiceEvents(IResolvable includeGlobalServiceEvents) Specifies whether the trail is publishing events from global services such as IAM to the log files.- Parameters:
includeGlobalServiceEvents- Specifies whether the trail is publishing events from global services such as IAM to the log files. This parameter is required.- Returns:
this- See Also:
-
insightSelectors
A JSON string that contains the Insights types you want to log on a trail.ApiCallRateInsightandApiErrorRateInsightare valid Insight types.The
ApiCallRateInsightInsights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.The
ApiErrorRateInsightInsights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.- Parameters:
insightSelectors- A JSON string that contains the Insights types you want to log on a trail. This parameter is required.- Returns:
this- See Also:
-
insightSelectors
@Stability(Stable) public CfnTrailPropsMixin.Builder insightSelectors(List<? extends Object> insightSelectors) A JSON string that contains the Insights types you want to log on a trail.ApiCallRateInsightandApiErrorRateInsightare valid Insight types.The
ApiCallRateInsightInsights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.The
ApiErrorRateInsightInsights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.- Parameters:
insightSelectors- A JSON string that contains the Insights types you want to log on a trail. This parameter is required.- Returns:
this- See Also:
-
isLogging
Whether the CloudTrail trail is currently logging AWS API calls.- Parameters:
isLogging- Whether the CloudTrail trail is currently logging AWS API calls. This parameter is required.- Returns:
this- See Also:
-
isLogging
Whether the CloudTrail trail is currently logging AWS API calls.- Parameters:
isLogging- Whether the CloudTrail trail is currently logging AWS API calls. This parameter is required.- Returns:
this- See Also:
-
isMultiRegionTrail
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.
- Parameters:
isMultiRegionTrail- Specifies whether the trail applies only to the current Region or to all Regions. This parameter is required.- Returns:
this- See Also:
-
isMultiRegionTrail
@Stability(Stable) public CfnTrailPropsMixin.Builder isMultiRegionTrail(IResolvable isMultiRegionTrail) 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.
- Parameters:
isMultiRegionTrail- Specifies whether the trail applies only to the current Region or to all Regions. This parameter is required.- Returns:
this- See Also:
-
isOrganizationTrail
@Stability(Stable) public CfnTrailPropsMixin.Builder isOrganizationTrail(Boolean isOrganizationTrail) Specifies whether the trail is applied to 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 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 tofalse, 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.
- Parameters:
isOrganizationTrail- Specifies whether the trail is applied to all accounts in an organization in AWS Organizations , or only for the current AWS account . This parameter is required.- Returns:
this- See Also:
-
isOrganizationTrail
@Stability(Stable) public CfnTrailPropsMixin.Builder isOrganizationTrail(IResolvable isOrganizationTrail) Specifies whether the trail is applied to 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 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 tofalse, 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.
- Parameters:
isOrganizationTrail- Specifies whether the trail is applied to all accounts in an organization in AWS Organizations , or only for the current AWS account . This parameter is required.- Returns:
this- See Also:
-
kmsKeyId
Specifies the AWS key ID to use to encrypt the logs and digest files 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.
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
- Parameters:
kmsKeyId- Specifies the AWS key ID to use to encrypt the logs and digest files delivered by CloudTrail. This parameter is required.- Returns:
this- See Also:
-
kmsKeyId
Specifies the AWS key ID to use to encrypt the logs and digest files 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.
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
- Parameters:
kmsKeyId- Specifies the AWS key ID to use to encrypt the logs and digest files delivered by CloudTrail. This parameter is required.- Returns:
this- See Also:
-
kmsKeyId
Specifies the AWS key ID to use to encrypt the logs and digest files 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.
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
- Parameters:
kmsKeyId- Specifies the AWS key ID to use to encrypt the logs and digest files delivered by CloudTrail. This parameter is required.- Returns:
this- See Also:
-
s3BucketName
Specifies the name of the Amazon S3 bucket designated for publishing log files.- Parameters:
s3BucketName- Specifies the name of the Amazon S3 bucket designated for publishing log files. This parameter is required.- Returns:
this- See Also:
-
s3BucketName
Specifies the name of the Amazon S3 bucket designated for publishing log files.- Parameters:
s3BucketName- Specifies the name of the Amazon S3 bucket designated for publishing log files. This parameter is required.- Returns:
this- See Also:
-
s3KeyPrefix
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.
- Parameters:
s3KeyPrefix- Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. This parameter is required.- Returns:
this- See Also:
-
snsTopicName
Specifies the name or ARN of the Amazon SNS topic defined for notification of log file delivery.The maximum length is 256 characters.
- Parameters:
snsTopicName- Specifies the name or ARN of the Amazon SNS topic defined for notification of log file delivery. This parameter is required.- Returns:
this- See Also:
-
tags
A custom set of tags (key-value pairs) for this trail.- Parameters:
tags- A custom set of tags (key-value pairs) for this trail. This parameter is required.- Returns:
this- See Also:
-
trailName
Specifies the name of the trail. The name must meet the following requirements:.- 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)
- Parameters:
trailName- Specifies the name of the trail. The name must meet the following requirements:. This parameter is required.- Returns:
this- See Also:
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnTrailPropsMixin>- Returns:
- a newly built instance of
CfnTrailPropsMixin.
-