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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.346Z")
 @Stability(value=Stable)
public interface CfnTrailProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::CloudTrail::Trail`.

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
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnTrailProps.Builder A builder for CfnTrailProps
static class	CfnTrailProps.Jsii$Proxy An implementation for CfnTrailProps

Method Summary

Modifier and Type	Method and Description
static CfnTrailProps.Builder	builder()
default String	getCloudWatchLogsLogGroupArn() `AWS::CloudTrail::Trail.CloudWatchLogsLogGroupArn`.
default String	getCloudWatchLogsRoleArn() `AWS::CloudTrail::Trail.CloudWatchLogsRoleArn`.
default Object	getEnableLogFileValidation() `AWS::CloudTrail::Trail.EnableLogFileValidation`.
default Object	getEventSelectors() `AWS::CloudTrail::Trail.EventSelectors`.
default Object	getIncludeGlobalServiceEvents() `AWS::CloudTrail::Trail.IncludeGlobalServiceEvents`.
default Object	getInsightSelectors() `AWS::CloudTrail::Trail.InsightSelectors`.
Object	getIsLogging() `AWS::CloudTrail::Trail.IsLogging`.
default Object	getIsMultiRegionTrail() `AWS::CloudTrail::Trail.IsMultiRegionTrail`.
default Object	getIsOrganizationTrail() `AWS::CloudTrail::Trail.IsOrganizationTrail`.
default String	getKmsKeyId() `AWS::CloudTrail::Trail.KMSKeyId`.
String	getS3BucketName() `AWS::CloudTrail::Trail.S3BucketName`.
default String	getS3KeyPrefix() `AWS::CloudTrail::Trail.S3KeyPrefix`.
default String	getSnsTopicName() `AWS::CloudTrail::Trail.SnsTopicName`.
default List<CfnTag>	getTags() `AWS::CloudTrail::Trail.Tags`.
default String	getTrailName() `AWS::CloudTrail::Trail.TrailName`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCloudWatchLogsLogGroupArn

@Stability(value=Stable)
 @Nullable
default String getCloudWatchLogsLogGroupArn()

`AWS::CloudTrail::Trail.CloudWatchLogsLogGroupArn`.

getCloudWatchLogsRoleArn

@Stability(value=Stable)
 @Nullable
default String getCloudWatchLogsRoleArn()

`AWS::CloudTrail::Trail.CloudWatchLogsRoleArn`.

getEnableLogFileValidation

@Stability(value=Stable)
 @Nullable
default Object getEnableLogFileValidation()

`AWS::CloudTrail::Trail.EnableLogFileValidation`.

getEventSelectors

@Stability(value=Stable)
 @Nullable
default Object getEventSelectors()

`AWS::CloudTrail::Trail.EventSelectors`.

getIncludeGlobalServiceEvents

@Stability(value=Stable)
 @Nullable
default Object getIncludeGlobalServiceEvents()

`AWS::CloudTrail::Trail.IncludeGlobalServiceEvents`.

getInsightSelectors

@Stability(value=Stable)
 @Nullable
default Object getInsightSelectors()

`AWS::CloudTrail::Trail.InsightSelectors`.

getIsLogging

@Stability(value=Stable)
 @NotNull
Object getIsLogging()

`AWS::CloudTrail::Trail.IsLogging`.

getIsMultiRegionTrail

@Stability(value=Stable)
 @Nullable
default Object getIsMultiRegionTrail()

`AWS::CloudTrail::Trail.IsMultiRegionTrail`.

getIsOrganizationTrail

@Stability(value=Stable)
 @Nullable
default Object getIsOrganizationTrail()

`AWS::CloudTrail::Trail.IsOrganizationTrail`.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()

`AWS::CloudTrail::Trail.KMSKeyId`.

getS3BucketName

@Stability(value=Stable)
 @NotNull
String getS3BucketName()

`AWS::CloudTrail::Trail.S3BucketName`.

getS3KeyPrefix

@Stability(value=Stable)
 @Nullable
default String getS3KeyPrefix()

`AWS::CloudTrail::Trail.S3KeyPrefix`.

getSnsTopicName

@Stability(value=Stable)
 @Nullable
default String getSnsTopicName()

`AWS::CloudTrail::Trail.SnsTopicName`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::CloudTrail::Trail.Tags`.

getTrailName

@Stability(value=Stable)
 @Nullable
default String getTrailName()

`AWS::CloudTrail::Trail.TrailName`.

builder

@Stability(value=Stable)
static CfnTrailProps.Builder builder()

Returns:

a CfnTrailProps.Builder of CfnTrailProps