Package software.amazon.awscdk.services.cloudtrail

Class CfnEventDataStore.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnEventDataStore.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 CfnEventDataStore.Builder.

    • advancedEventSelectors

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

      Parameters:
      advancedEventSelectors - The advanced event selectors to use to select the events for the data store. This parameter is required.
      Returns:
      this

    • advancedEventSelectors

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

      Parameters:
      advancedEventSelectors - The advanced event selectors to use to select the events for the data store. This parameter is required.
      Returns:
      this

    • ingestionEnabled

      @Stability(Stable) public CfnEventDataStore.Builder ingestionEnabled(Boolean ingestionEnabled)
      Specifies whether the event data store should start ingesting live events.

      The default is true.

      Parameters:
      ingestionEnabled - Specifies whether the event data store should start ingesting live events. This parameter is required.
      Returns:
      this

    • ingestionEnabled

      @Stability(Stable) public CfnEventDataStore.Builder ingestionEnabled(IResolvable ingestionEnabled)
      Specifies whether the event data store should start ingesting live events.

      The default is true.

      Parameters:
      ingestionEnabled - Specifies whether the event data store should start ingesting live events. This parameter is required.
      Returns:
      this

    • kmsKeyId

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

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

    • multiRegionEnabled

      @Stability(Stable) public CfnEventDataStore.Builder multiRegionEnabled(Boolean multiRegionEnabled)
      Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.

      Parameters:
      multiRegionEnabled - Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created. This parameter is required.
      Returns:
      this

    • multiRegionEnabled

      @Stability(Stable) public CfnEventDataStore.Builder multiRegionEnabled(IResolvable multiRegionEnabled)
      Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.

      Parameters:
      multiRegionEnabled - Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnEventDataStore.Builder name(String name)
      The name of the event data store.

      Parameters:
      name - The name of the event data store. This parameter is required.
      Returns:
      this

    • organizationEnabled

      @Stability(Stable) public CfnEventDataStore.Builder organizationEnabled(Boolean organizationEnabled)
      Specifies whether an event data store collects events logged for an organization in AWS Organizations .

      Parameters:
      organizationEnabled - Specifies whether an event data store collects events logged for an organization in AWS Organizations . This parameter is required.
      Returns:
      this

    • organizationEnabled

      @Stability(Stable) public CfnEventDataStore.Builder organizationEnabled(IResolvable organizationEnabled)
      Specifies whether an event data store collects events logged for an organization in AWS Organizations .

      Parameters:
      organizationEnabled - Specifies whether an event data store collects events logged for an organization in AWS Organizations . This parameter is required.
      Returns:
      this

    • retentionPeriod

      @Stability(Stable) public CfnEventDataStore.Builder retentionPeriod(Number retentionPeriod)
      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.

      Parameters:
      retentionPeriod - The retention period of the event data store, in days. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnEventDataStore.Builder tags(List<? extends CfnTag> tags)
      A list of tags.

      Parameters:
      tags - A list of tags. This parameter is required.
      Returns:
      this

    • terminationProtectionEnabled

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

      Parameters:
      terminationProtectionEnabled - Specifies whether termination protection is enabled for the event data store. This parameter is required.
      Returns:
      this

    • terminationProtectionEnabled

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

      Parameters:
      terminationProtectionEnabled - Specifies whether termination protection is enabled for the event data store. This parameter is required.
      Returns:
      this

    • build

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