Package software.amazon.awscdk.services.cloudtrail

Interface CfnEventDataStoreProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnEventDataStoreProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.881Z") @Stability(Stable) public interface CfnEventDataStoreProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnEventDataStore.

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.*;
 CfnEventDataStoreProps cfnEventDataStoreProps = CfnEventDataStoreProps.builder()
         .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()))
         .ingestionEnabled(false)
         .kmsKeyId("kmsKeyId")
         .multiRegionEnabled(false)
         .name("name")
         .organizationEnabled(false)
         .retentionPeriod(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .terminationProtectionEnabled(false)
         .build();

  • Method Details

    • getAdvancedEventSelectors

      @Stability(Stable) @Nullable default Object getAdvancedEventSelectors()
      The advanced event selectors to use to select the events for the data store.

      You can configure up to five advanced event selectors for each event data store.

      For more information about how to use advanced event selectors to log CloudTrail events, see Log events by using advanced event selectors in the CloudTrail User Guide.

      For more information about how to use advanced event selectors to include AWS Config configuration items in your event data store, see Create an event data store for AWS Config configuration items in the CloudTrail User Guide.

      For more information about how to use advanced event selectors to include non- AWS events in your event data store, see Create an integration to log events from outside AWS in the CloudTrail User Guide.

    • getIngestionEnabled

      @Stability(Stable) @Nullable default Object getIngestionEnabled()
      Specifies whether the event data store should start ingesting live events.

      The default is true.

    • getKmsKeyId

      @Stability(Stable) @Nullable default String getKmsKeyId()
      Specifies the AWS KMS key ID to use to encrypt the events 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.

      Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.

      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

    • getMultiRegionEnabled

      @Stability(Stable) @Nullable default Object getMultiRegionEnabled()
      Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.

    • getName

      @Stability(Stable) @Nullable default String getName()
      The name of the event data store.

    • getOrganizationEnabled

      @Stability(Stable) @Nullable default Object getOrganizationEnabled()
      Specifies whether an event data store collects events logged for an organization in AWS Organizations .

    • getRetentionPeriod

      @Stability(Stable) @Nullable default Number getRetentionPeriod()
      The retention period of the event data store, in days.

      You can set a retention period of up to 2557 days, the equivalent of seven years.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      A list of tags.

    • getTerminationProtectionEnabled

      @Stability(Stable) @Nullable default Object getTerminationProtectionEnabled()
      Specifies whether termination protection is enabled for the event data store.

      If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.

    • builder

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