Package software.amazon.awscdk.services.cloudtrail

Class CfnTrail.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnTrail.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnTrail.Builder.

    • isLogging

      @Stability(Stable) public CfnTrail.Builder isLogging(Boolean 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

    • isLogging

      @Stability(Stable) public CfnTrail.Builder isLogging(IResolvable 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

    • s3BucketName

      @Stability(Stable) public CfnTrail.Builder s3BucketName(String s3BucketName)
      Specifies the name of the Amazon S3 bucket designated for publishing log files.

      See Amazon S3 Bucket Naming Requirements .

      Parameters:
      s3BucketName - Specifies the name of the Amazon S3 bucket designated for publishing log files. This parameter is required.
      Returns:
      this

    • advancedEventSelectors

      @Stability(Stable) public CfnTrail.Builder advancedEventSelectors(IResolvable 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 .

      Parameters:
      advancedEventSelectors - Specifies the settings for advanced event selectors. This parameter is required.
      Returns:
      this

    • advancedEventSelectors

      @Stability(Stable) public CfnTrail.Builder advancedEventSelectors(List<? extends Object> 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 .

      Parameters:
      advancedEventSelectors - Specifies the settings for advanced event selectors. This parameter is required.
      Returns:
      this

    • cloudWatchLogsLogGroupArn

      @Stability(Stable) public CfnTrail.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.

      Not required unless you specify CloudWatchLogsRoleArn .

      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

    • cloudWatchLogsRoleArn

      @Stability(Stable) public CfnTrail.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.

      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

    • enableLogFileValidation

      @Stability(Stable) public CfnTrail.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

    • enableLogFileValidation

      @Stability(Stable) public CfnTrail.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

    • eventSelectors

      @Stability(Stable) public CfnTrail.Builder eventSelectors(IResolvable 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.

      For more information about how to configure event selectors, see Examples and Configuring event selectors in the AWS CloudTrail User Guide .

      Parameters:
      eventSelectors - Use event selectors to further specify the management and data event settings for your trail. This parameter is required.
      Returns:
      this

    • eventSelectors

      @Stability(Stable) public CfnTrail.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.

      For more information about how to configure event selectors, see Examples and Configuring event selectors in the AWS CloudTrail User Guide .

      Parameters:
      eventSelectors - Use event selectors to further specify the management and data event settings for your trail. This parameter is required.
      Returns:
      this

    • includeGlobalServiceEvents

      @Stability(Stable) public CfnTrail.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

    • includeGlobalServiceEvents

      @Stability(Stable) public CfnTrail.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

    • insightSelectors

      @Stability(Stable) public CfnTrail.Builder insightSelectors(IResolvable insightSelectors)
      A JSON string that contains the insight 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.

      Parameters:
      insightSelectors - A JSON string that contains the insight types you want to log on a trail. This parameter is required.
      Returns:
      this

    • insightSelectors

      @Stability(Stable) public CfnTrail.Builder insightSelectors(List<? extends Object> insightSelectors)
      A JSON string that contains the insight 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.

      Parameters:
      insightSelectors - A JSON string that contains the insight types you want to log on a trail. This parameter is required.
      Returns:
      this

    • isMultiRegionTrail

      @Stability(Stable) public CfnTrail.Builder isMultiRegionTrail(Boolean 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

    • isMultiRegionTrail

      @Stability(Stable) public CfnTrail.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

    • isOrganizationTrail

      @Stability(Stable) public CfnTrail.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 or delegated administrator 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.

      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

    • isOrganizationTrail

      @Stability(Stable) public CfnTrail.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 or delegated administrator 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.

      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

    • kmsKeyId

      @Stability(Stable) public CfnTrail.Builder kmsKeyId(String 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

      Parameters:
      kmsKeyId - Specifies the AWS KMS key ID to use to encrypt the logs delivered by CloudTrail. This parameter is required.
      Returns:
      this

    • s3KeyPrefix

      @Stability(Stable) public CfnTrail.Builder s3KeyPrefix(String 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

    • snsTopicName

      @Stability(Stable) public CfnTrail.Builder snsTopicName(String snsTopicName)
      Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

      The maximum length is 256 characters.

      Parameters:
      snsTopicName - Specifies the name of the Amazon SNS topic defined for notification of log file delivery. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnTrail.Builder tags(List<? extends CfnTag> 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

    • trailName

      @Stability(Stable) public CfnTrail.Builder trailName(String 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)

      Parameters:
      trailName - Specifies the name of the trail. The name must meet the following requirements:. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnTrail build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnTrail>
      Returns:
      a newly built instance of CfnTrail.