Package software.amazon.awscdk.services.cloudtrail

Interface TrailProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
TrailProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-02T15:58:22.651Z") @Stability(Stable) public interface TrailProps extends software.amazon.jsii.JsiiSerializable
Properties for an AWS CloudTrail trail.

Example: 

 Trail trail = Trail.Builder.create(this, "CloudTrail")
         // ...
         .managementEvents(ReadWriteType.READ_ONLY)
         .build();

  • Method Details

    • getBucket

      @Stability(Stable) @Nullable default IBucket getBucket()
      The Amazon S3 bucket.

      Default: - if not supplied a bucket will be created with all the correct permisions

    • getCloudWatchLogGroup

      @Stability(Stable) @Nullable default ILogGroup getCloudWatchLogGroup()
      Log Group to which CloudTrail to push logs to.

      Ignored if sendToCloudWatchLogs is set to false.

      Default: - a new log group is created and used.

    • getCloudWatchLogsRetention

      @Stability(Stable) @Nullable default RetentionDays getCloudWatchLogsRetention()
      How long to retain logs in CloudWatchLogs.

      Ignored if sendToCloudWatchLogs is false or if cloudWatchLogGroup is set.

      Default: logs.RetentionDays.ONE_YEAR

    • getEnableFileValidation

      @Stability(Stable) @Nullable default Boolean getEnableFileValidation()
      To determine whether a log file was modified, deleted, or unchanged after CloudTrail delivered it, you can use CloudTrail log file integrity validation.

      This feature is built using industry standard algorithms: SHA-256 for hashing and SHA-256 with RSA for digital signing. This makes it computationally infeasible to modify, delete or forge CloudTrail log files without detection. You can use the AWS CLI to validate the files in the location where CloudTrail delivered them.

      Default: true

    • getEncryptionKey

      @Stability(Stable) @Nullable default IKey getEncryptionKey()
      The AWS Key Management Service (AWS KMS) key ID that you want to use to encrypt CloudTrail logs.

      Default: - No encryption.

    • getIncludeGlobalServiceEvents

      @Stability(Stable) @Nullable default Boolean getIncludeGlobalServiceEvents()
      For most services, events are recorded in the region where the action occurred.

      For global services such as AWS Identity and Access Management (IAM), AWS STS, Amazon CloudFront, and Route 53, events are delivered to any trail that includes global services, and are logged as occurring in US East (N. Virginia) Region.

      Default: true

    • getInsightTypes

      @Stability(Stable) @Nullable default List<InsightType> getInsightTypes()
      A JSON string that contains the insight types you want to log on a trail.

      Default: - No Value.

    • getIsMultiRegionTrail

      @Stability(Stable) @Nullable default Boolean getIsMultiRegionTrail()
      Whether or not this trail delivers log files from multiple regions to a single S3 bucket for a single account.

      Default: true

    • getIsOrganizationTrail

      @Stability(Stable) @Nullable default Boolean getIsOrganizationTrail()
      Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account.

      If this is set to true then the current account must be the management account. If it is not, then CloudFormation will throw an error.

      If this is set to true and the current account is a management account for an organization in AWS Organizations, the trail will be created in all AWS accounts that belong to the organization. If this is set to false, the trail will remain in the current AWS account but be deleted from all member accounts in the organization.

      Default: - false

    • getManagementEvents

      @Stability(Stable) @Nullable default ReadWriteType getManagementEvents()
      When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.

      Only events that match your trail settings are delivered to your Amazon S3 bucket and Amazon CloudWatch Logs log group.

      This method sets the management configuration for this trail.

      Management events provide insight into management operations that are performed on resources in your AWS account. These are also known as control plane operations. Management events can also include non-API events that occur in your account. For example, when a user logs in to your account, CloudTrail logs the ConsoleLogin event.

      Default: ReadWriteType.ALL

    • getOrgId

      @Stability(Stable) @Nullable default String getOrgId()
      The orgId.

      Required when isOrganizationTrail is set to true to attach the necessary permissions.

      Default: - No orgId

    • getS3KeyPrefix

      @Stability(Stable) @Nullable default String getS3KeyPrefix()
      An Amazon S3 object key prefix that precedes the name of all log files.

      Default: - No prefix.

    • getSendToCloudWatchLogs

      @Stability(Stable) @Nullable default Boolean getSendToCloudWatchLogs()
      If CloudTrail pushes logs to CloudWatch Logs in addition to S3.

      Disabled for cost out of the box.

      Default: false

    • getSnsTopic

      @Stability(Stable) @Nullable default ITopic getSnsTopic()
      SNS topic that is notified when new log files are published.

      Default: - No notifications.

    • getTrailName

      @Stability(Stable) @Nullable default String getTrailName()
      The name of the trail.

      We recommend customers do not set an explicit name.

      Default: - AWS CloudFormation generated name.

    • builder

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