Package software.amazon.awscdk.services.cloudtrail

Class CfnEventDataStoreProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • advancedEventSelectors

      @Stability(Stable) public CfnEventDataStoreProps.Builder advancedEventSelectors(IResolvable advancedEventSelectors)
      Sets the value of CfnEventDataStoreProps.getAdvancedEventSelectors()
      Parameters:
      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 events outside of AWS events in your event data store, see Create an integration to log events from outside AWS in the CloudTrail User Guide.

      Returns:
      this

    • advancedEventSelectors

      @Stability(Stable) public CfnEventDataStoreProps.Builder advancedEventSelectors(List<? extends Object> advancedEventSelectors)
      Sets the value of CfnEventDataStoreProps.getAdvancedEventSelectors()
      Parameters:
      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 events outside of AWS events in your event data store, see Create an integration to log events from outside AWS in the CloudTrail User Guide.

      Returns:
      this

    • billingMode

      @Stability(Stable) public CfnEventDataStoreProps.Builder billingMode(String billingMode)
      Sets the value of CfnEventDataStoreProps.getBillingMode()
      Parameters:
      billingMode - The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store. The following are the possible values:

      • EXTENDABLE_RETENTION_PRICING - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). The default retention period for this billing mode is 366 days.
      • FIXED_RETENTION_PRICING - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). The default retention period for this billing mode is 2557 days.

      The default value is EXTENDABLE_RETENTION_PRICING .

      For more information about CloudTrail pricing, see AWS CloudTrail Pricing and Managing CloudTrail Lake costs .

      Returns:
      this

    • federationEnabled

      @Stability(Stable) public CfnEventDataStoreProps.Builder federationEnabled(Boolean federationEnabled)
      Sets the value of CfnEventDataStoreProps.getFederationEnabled()
      Parameters:
      federationEnabled - Indicates if Lake query federation is enabled. By default, Lake query federation is disabled. You cannot delete an event data store if Lake query federation is enabled.
      Returns:
      this

    • federationEnabled

      @Stability(Stable) public CfnEventDataStoreProps.Builder federationEnabled(IResolvable federationEnabled)
      Sets the value of CfnEventDataStoreProps.getFederationEnabled()
      Parameters:
      federationEnabled - Indicates if Lake query federation is enabled. By default, Lake query federation is disabled. You cannot delete an event data store if Lake query federation is enabled.
      Returns:
      this

    • federationRoleArn

      @Stability(Stable) public CfnEventDataStoreProps.Builder federationRoleArn(String federationRoleArn)
      Sets the value of CfnEventDataStoreProps.getFederationRoleArn()
      Parameters:
      federationRoleArn - If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store. The federation role must exist in your account and provide the required minimum permissions .
      Returns:
      this

    • ingestionEnabled

      @Stability(Stable) public CfnEventDataStoreProps.Builder ingestionEnabled(Boolean ingestionEnabled)
      Sets the value of CfnEventDataStoreProps.getIngestionEnabled()
      Parameters:
      ingestionEnabled - Specifies whether the event data store should start ingesting live events. The default is true.
      Returns:
      this

    • ingestionEnabled

      @Stability(Stable) public CfnEventDataStoreProps.Builder ingestionEnabled(IResolvable ingestionEnabled)
      Sets the value of CfnEventDataStoreProps.getIngestionEnabled()
      Parameters:
      ingestionEnabled - Specifies whether the event data store should start ingesting live events. The default is true.
      Returns:
      this

    • insightsDestination

      @Stability(Stable) public CfnEventDataStoreProps.Builder insightsDestination(String insightsDestination)
      Sets the value of CfnEventDataStoreProps.getInsightsDestination()
      Parameters:
      insightsDestination - The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. For more information, see Create an event data store for CloudTrail Insights events .
      Returns:
      this

    • insightSelectors

      @Stability(Stable) public CfnEventDataStoreProps.Builder insightSelectors(IResolvable insightSelectors)
      Sets the value of CfnEventDataStoreProps.getInsightSelectors()
      Parameters:
      insightSelectors - A JSON string that contains the Insights types you want to log on an event data store. 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.

      Returns:
      this

    • insightSelectors

      @Stability(Stable) public CfnEventDataStoreProps.Builder insightSelectors(List<? extends Object> insightSelectors)
      Sets the value of CfnEventDataStoreProps.getInsightSelectors()
      Parameters:
      insightSelectors - A JSON string that contains the Insights types you want to log on an event data store. 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.

      Returns:
      this

    • kmsKeyId

      @Stability(Stable) public CfnEventDataStoreProps.Builder kmsKeyId(String kmsKeyId)
      Sets the value of CfnEventDataStoreProps.getKmsKeyId()
      Parameters:
      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
      Returns:
      this

    • multiRegionEnabled

      @Stability(Stable) public CfnEventDataStoreProps.Builder multiRegionEnabled(Boolean multiRegionEnabled)
      Sets the value of CfnEventDataStoreProps.getMultiRegionEnabled()
      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.
      Returns:
      this

    • multiRegionEnabled

      @Stability(Stable) public CfnEventDataStoreProps.Builder multiRegionEnabled(IResolvable multiRegionEnabled)
      Sets the value of CfnEventDataStoreProps.getMultiRegionEnabled()
      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.
      Returns:
      this

    • name

      @Stability(Stable) public CfnEventDataStoreProps.Builder name(String name)
      Sets the value of CfnEventDataStoreProps.getName()
      Parameters:
      name - The name of the event data store.
      Returns:
      this

    • organizationEnabled

      @Stability(Stable) public CfnEventDataStoreProps.Builder organizationEnabled(Boolean organizationEnabled)
      Sets the value of CfnEventDataStoreProps.getOrganizationEnabled()
      Parameters:
      organizationEnabled - Specifies whether an event data store collects events logged for an organization in AWS Organizations .
      Returns:
      this

    • organizationEnabled

      @Stability(Stable) public CfnEventDataStoreProps.Builder organizationEnabled(IResolvable organizationEnabled)
      Sets the value of CfnEventDataStoreProps.getOrganizationEnabled()
      Parameters:
      organizationEnabled - Specifies whether an event data store collects events logged for an organization in AWS Organizations .
      Returns:
      this

    • retentionPeriod

      @Stability(Stable) public CfnEventDataStoreProps.Builder retentionPeriod(Number retentionPeriod)
      Sets the value of CfnEventDataStoreProps.getRetentionPeriod()
      Parameters:
      retentionPeriod - The retention period of the event data store, in days. If BillingMode is set to EXTENDABLE_RETENTION_PRICING , you can set a retention period of up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING , you can set a retention period of up to 2557 days, the equivalent of seven years.

      CloudTrail Lake determines whether to retain an event by checking if the eventTime of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the eventTime is older than 90 days.

      If you plan to copy trail events to this event data store, we recommend that you consider both the age of the events that you want to copy as well as how long you want to keep the copied events in your event data store. For example, if you copy trail events that are 5 years old and specify a retention period of 7 years, the event data store will retain those events for two years.

      Returns:
      this

    • tags

      @Stability(Stable) public CfnEventDataStoreProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnEventDataStoreProps.getTags()
      Parameters:
      tags - A list of tags.
      Returns:
      this

    • terminationProtectionEnabled

      @Stability(Stable) public CfnEventDataStoreProps.Builder terminationProtectionEnabled(Boolean terminationProtectionEnabled)
      Sets the value of CfnEventDataStoreProps.getTerminationProtectionEnabled()
      Parameters:
      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.
      Returns:
      this

    • terminationProtectionEnabled

      @Stability(Stable) public CfnEventDataStoreProps.Builder terminationProtectionEnabled(IResolvable terminationProtectionEnabled)
      Sets the value of CfnEventDataStoreProps.getTerminationProtectionEnabled()
      Parameters:
      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.
      Returns:
      this

    • build

      @Stability(Stable) public CfnEventDataStoreProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnEventDataStoreProps>
      Returns:
      a new instance of CfnEventDataStoreProps
      Throws:
      NullPointerException - if any required attribute was not provided