Package software.amazon.awscdk.services.cloudtrail

Class CfnTrailProps.Builder

java.lang.Object
software.amazon.awscdk.services.cloudtrail.CfnTrailProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTrailProps>
Enclosing interface:
CfnTrailProps
@Stability(Stable) public static final class CfnTrailProps.Builder extends Object implements software.amazon.jsii.Builder<CfnTrailProps>
A builder for CfnTrailProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • isLogging

      @Stability(Stable) public CfnTrailProps.Builder isLogging(Boolean isLogging)
      Sets the value of CfnTrailProps.getIsLogging()
      Parameters:
      isLogging - Whether the CloudTrail trail is currently logging AWS API calls. This parameter is required.
      Returns:
      this

    • isLogging

      @Stability(Stable) public CfnTrailProps.Builder isLogging(IResolvable isLogging)
      Sets the value of CfnTrailProps.getIsLogging()
      Parameters:
      isLogging - Whether the CloudTrail trail is currently logging AWS API calls. This parameter is required.
      Returns:
      this

    • s3BucketName

      @Stability(Stable) public CfnTrailProps.Builder s3BucketName(String s3BucketName)
      Sets the value of CfnTrailProps.getS3BucketName()
      Parameters:
      s3BucketName - Specifies the name of the Amazon S3 bucket designated for publishing log files. This parameter is required. See Amazon S3 Bucket naming rules .
      Returns:
      this

    • advancedEventSelectors

      @Stability(Stable) public CfnTrailProps.Builder advancedEventSelectors(IResolvable advancedEventSelectors)
      Sets the value of CfnTrailProps.getAdvancedEventSelectors()
      Parameters:
      advancedEventSelectors - Specifies the settings for advanced event selectors. 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 in the AWS CloudTrail User Guide .
      Returns:
      this

    • advancedEventSelectors

      @Stability(Stable) public CfnTrailProps.Builder advancedEventSelectors(List<? extends Object> advancedEventSelectors)
      Sets the value of CfnTrailProps.getAdvancedEventSelectors()
      Parameters:
      advancedEventSelectors - Specifies the settings for advanced event selectors. 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 in the AWS CloudTrail User Guide .
      Returns:
      this

    • cloudWatchLogsLogGroupArn

      @Stability(Stable) public CfnTrailProps.Builder cloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)
      Sets the value of CfnTrailProps.getCloudWatchLogsLogGroupArn()
      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. 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 CloudWatchLogsRoleArn and CloudWatchLogsLogGroupArn fields to "" .

      Returns:
      this

    • cloudWatchLogsRoleArn

      @Stability(Stable) public CfnTrailProps.Builder cloudWatchLogsRoleArn(String cloudWatchLogsRoleArn)
      Sets the value of CfnTrailProps.getCloudWatchLogsRoleArn()
      Parameters:
      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 CloudWatchLogsLogGroupArn and CloudWatchLogsRoleArn .

      If you previously enabled CloudWatch Logs delivery and want to disable CloudWatch Logs delivery, you must set the values of the CloudWatchLogsRoleArn and CloudWatchLogsLogGroupArn fields to "" .

      Returns:
      this

    • enableLogFileValidation

      @Stability(Stable) public CfnTrailProps.Builder enableLogFileValidation(Boolean enableLogFileValidation)
      Sets the value of CfnTrailProps.getEnableLogFileValidation()
      Parameters:
      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.

      Returns:
      this

    • enableLogFileValidation

      @Stability(Stable) public CfnTrailProps.Builder enableLogFileValidation(IResolvable enableLogFileValidation)
      Sets the value of CfnTrailProps.getEnableLogFileValidation()
      Parameters:
      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.

      Returns:
      this

    • eventSelectors

      @Stability(Stable) public CfnTrailProps.Builder eventSelectors(IResolvable eventSelectors)
      Sets the value of CfnTrailProps.getEventSelectors()
      Parameters:
      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.

      Returns:
      this

    • eventSelectors

      @Stability(Stable) public CfnTrailProps.Builder eventSelectors(List<? extends Object> eventSelectors)
      Sets the value of CfnTrailProps.getEventSelectors()
      Parameters:
      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.

      Returns:
      this

    • includeGlobalServiceEvents

      @Stability(Stable) public CfnTrailProps.Builder includeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
      Sets the value of CfnTrailProps.getIncludeGlobalServiceEvents()
      Parameters:
      includeGlobalServiceEvents - Specifies whether the trail is publishing events from global services such as IAM to the log files.
      Returns:
      this

    • includeGlobalServiceEvents

      @Stability(Stable) public CfnTrailProps.Builder includeGlobalServiceEvents(IResolvable includeGlobalServiceEvents)
      Sets the value of CfnTrailProps.getIncludeGlobalServiceEvents()
      Parameters:
      includeGlobalServiceEvents - Specifies whether the trail is publishing events from global services such as IAM to the log files.
      Returns:
      this

    • insightSelectors

      @Stability(Stable) public CfnTrailProps.Builder insightSelectors(IResolvable insightSelectors)
      Sets the value of CfnTrailProps.getInsightSelectors()
      Parameters:
      insightSelectors - A JSON string that contains the Insights types you want to log on a trail. 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.

      Returns:
      this

    • insightSelectors

      @Stability(Stable) public CfnTrailProps.Builder insightSelectors(List<? extends Object> insightSelectors)
      Sets the value of CfnTrailProps.getInsightSelectors()
      Parameters:
      insightSelectors - A JSON string that contains the Insights types you want to log on a trail. 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.

      Returns:
      this

    • isMultiRegionTrail

      @Stability(Stable) public CfnTrailProps.Builder isMultiRegionTrail(Boolean isMultiRegionTrail)
      Sets the value of CfnTrailProps.getIsMultiRegionTrail()
      Parameters:
      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.
      Returns:
      this

    • isMultiRegionTrail

      @Stability(Stable) public CfnTrailProps.Builder isMultiRegionTrail(IResolvable isMultiRegionTrail)
      Sets the value of CfnTrailProps.getIsMultiRegionTrail()
      Parameters:
      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.
      Returns:
      this

    • isOrganizationTrail

      @Stability(Stable) public CfnTrailProps.Builder isOrganizationTrail(Boolean isOrganizationTrail)
      Sets the value of CfnTrailProps.getIsOrganizationTrail()
      Parameters:
      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 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.

      Returns:
      this

    • isOrganizationTrail

      @Stability(Stable) public CfnTrailProps.Builder isOrganizationTrail(IResolvable isOrganizationTrail)
      Sets the value of CfnTrailProps.getIsOrganizationTrail()
      Parameters:
      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 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.

      Returns:
      this

    • kmsKeyId

      @Stability(Stable) public CfnTrailProps.Builder kmsKeyId(String kmsKeyId)
      Sets the value of CfnTrailProps.getKmsKeyId()
      Parameters:
      kmsKeyId - Specifies the AWS 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.

      CloudTrail also supports AWS KMS 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
      Returns:
      this

    • s3KeyPrefix

      @Stability(Stable) public CfnTrailProps.Builder s3KeyPrefix(String s3KeyPrefix)
      Sets the value of CfnTrailProps.getS3KeyPrefix()
      Parameters:
      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.
      Returns:
      this

    • snsTopicName

      @Stability(Stable) public CfnTrailProps.Builder snsTopicName(String snsTopicName)
      Sets the value of CfnTrailProps.getSnsTopicName()
      Parameters:
      snsTopicName - Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnTrailProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnTrailProps.getTags()
      Parameters:
      tags - A custom set of tags (key-value pairs) for this trail.
      Returns:
      this

    • trailName

      @Stability(Stable) public CfnTrailProps.Builder trailName(String trailName)
      Sets the value of CfnTrailProps.getTrailName()
      Parameters:
      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-_namespace and my--namespace are not valid.
      • Not be in IP address format (for example, 192.168.5.4)
      Returns:
      this

    • build

      @Stability(Stable) public CfnTrailProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnTrailProps>
      Returns:
      a new instance of CfnTrailProps
      Throws:
      NullPointerException - if any required attribute was not provided