Package software.amazon.awscdk.services.cloudtrail

Interface CfnTrailProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnTrailProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.920Z") @Stability(Stable) public interface CfnTrailProps extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.cloudtrail.*;
 CfnTrailProps cfnTrailProps = CfnTrailProps.builder()
         .isLogging(false)
         .s3BucketName("s3BucketName")
         // the properties below are optional
         .advancedEventSelectors(List.of(AdvancedEventSelectorProperty.builder()
                 .fieldSelectors(List.of(AdvancedFieldSelectorProperty.builder()
                         .field("field")
                         // the properties below are optional
                         .endsWith(List.of("endsWith"))
                         .equalTo(List.of("equalTo"))
                         .notEndsWith(List.of("notEndsWith"))
                         .notEquals(List.of("notEquals"))
                         .notStartsWith(List.of("notStartsWith"))
                         .startsWith(List.of("startsWith"))
                         .build()))
                 // the properties below are optional
                 .name("name")
                 .build()))
         .cloudWatchLogsLogGroupArn("cloudWatchLogsLogGroupArn")
         .cloudWatchLogsRoleArn("cloudWatchLogsRoleArn")
         .enableLogFileValidation(false)
         .eventSelectors(List.of(EventSelectorProperty.builder()
                 .dataResources(List.of(DataResourceProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .values(List.of("values"))
                         .build()))
                 .excludeManagementEventSources(List.of("excludeManagementEventSources"))
                 .includeManagementEvents(false)
                 .readWriteType("readWriteType")
                 .build()))
         .includeGlobalServiceEvents(false)
         .insightSelectors(List.of(InsightSelectorProperty.builder()
                 .insightType("insightType")
                 .build()))
         .isMultiRegionTrail(false)
         .isOrganizationTrail(false)
         .kmsKeyId("kmsKeyId")
         .s3KeyPrefix("s3KeyPrefix")
         .snsTopicName("snsTopicName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .trailName("trailName")
         .build();

  • Method Details

    • getIsLogging

      @Stability(Stable) @NotNull Object getIsLogging()
      Whether the CloudTrail trail is currently logging AWS API calls.

    • getS3BucketName

      @Stability(Stable) @NotNull String getS3BucketName()
      Specifies the name of the Amazon S3 bucket designated for publishing log files.

      See Amazon S3 Bucket Naming Requirements .

    • getAdvancedEventSelectors

      @Stability(Stable) @Nullable default Object getAdvancedEventSelectors()
      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 .

    • getCloudWatchLogsLogGroupArn

      @Stability(Stable) @Nullable default String getCloudWatchLogsLogGroupArn()
      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 .

    • getCloudWatchLogsRoleArn

      @Stability(Stable) @Nullable default String getCloudWatchLogsRoleArn()
      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.

    • getEnableLogFileValidation

      @Stability(Stable) @Nullable default Object getEnableLogFileValidation()
      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.

    • getEventSelectors

      @Stability(Stable) @Nullable default Object getEventSelectors()
      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 .

    • getIncludeGlobalServiceEvents

      @Stability(Stable) @Nullable default Object getIncludeGlobalServiceEvents()
      Specifies whether the trail is publishing events from global services such as IAM to the log files.

    • getInsightSelectors

      @Stability(Stable) @Nullable default Object getInsightSelectors()
      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.

    • getIsMultiRegionTrail

      @Stability(Stable) @Nullable default Object getIsMultiRegionTrail()
      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.

    • getIsOrganizationTrail

      @Stability(Stable) @Nullable default Object getIsOrganizationTrail()
      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.

    • getKmsKeyId

      @Stability(Stable) @Nullable default String getKmsKeyId()
      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

    • getS3KeyPrefix

      @Stability(Stable) @Nullable default String getS3KeyPrefix()
      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.

    • getSnsTopicName

      @Stability(Stable) @Nullable default String getSnsTopicName()
      Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

      The maximum length is 256 characters.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      A custom set of tags (key-value pairs) for this trail.

    • getTrailName

      @Stability(Stable) @Nullable default String getTrailName()
      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)

    • builder

      @Stability(Stable) static CfnTrailProps.Builder builder()
      Returns:
      a CfnTrailProps.Builder of CfnTrailProps