Package software.amazon.awssdk.services.cloudtrail.model

Interface CreateEventDataStoreRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudTrailRequest.Builder, CopyableBuilder<CreateEventDataStoreRequest.Builder,CreateEventDataStoreRequest>, SdkBuilder<CreateEventDataStoreRequest.Builder,CreateEventDataStoreRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateEventDataStoreRequest
public static interface CreateEventDataStoreRequest.Builder extends CloudTrailRequest.Builder, SdkPojo, CopyableBuilder<CreateEventDataStoreRequest.Builder,CreateEventDataStoreRequest>

  • Method Details

    • name

      CreateEventDataStoreRequest.Builder name(String name)

      The name of the event data store.

      Parameters:
      name - The name of the event data store.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • advancedEventSelectors

      CreateEventDataStoreRequest.Builder advancedEventSelectors(Collection<AdvancedEventSelector> 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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

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

      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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • advancedEventSelectors

      CreateEventDataStoreRequest.Builder advancedEventSelectors(AdvancedEventSelector... 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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

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

      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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • advancedEventSelectors

      CreateEventDataStoreRequest.Builder advancedEventSelectors(Consumer<AdvancedEventSelector.Builder>... 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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

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

      This is a convenience method that creates an instance of the AdvancedEventSelector.Builder avoiding the need to create one manually via AdvancedEventSelector.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to advancedEventSelectors(List<AdvancedEventSelector>).

      Parameters:
      advancedEventSelectors - a consumer that will call methods on AdvancedEventSelector.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • multiRegionEnabled

      CreateEventDataStoreRequest.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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • organizationEnabled

      CreateEventDataStoreRequest.Builder organizationEnabled(Boolean organizationEnabled)

      Specifies whether an event data store collects events logged for an organization in Organizations.

      Parameters:
      organizationEnabled - Specifies whether an event data store collects events logged for an organization in Organizations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retentionPeriod

      CreateEventDataStoreRequest.Builder retentionPeriod(Integer 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. 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.

      Parameters:
      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. 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:
      Returns a reference to this object so that method calls can be chained together.

    • terminationProtectionEnabled

      CreateEventDataStoreRequest.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. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagsList

      CreateEventDataStoreRequest.Builder tagsList(Collection<Tag> tagsList)
      Sets the value of the TagsList property for this object.
      Parameters:
      tagsList - The new value for the TagsList property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagsList

      CreateEventDataStoreRequest.Builder tagsList(Tag... tagsList)
      Sets the value of the TagsList property for this object.
      Parameters:
      tagsList - The new value for the TagsList property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagsList

      CreateEventDataStoreRequest.Builder tagsList(Consumer<Tag.Builder>... tagsList)
      Sets the value of the TagsList property for this object. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagsList(List<Tag>).

      Parameters:
      tagsList - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • kmsKeyId

      CreateEventDataStoreRequest.Builder kmsKeyId(String kmsKeyId)

      Specifies the 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 KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the 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 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 KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the 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:
      Returns a reference to this object so that method calls can be chained together.

    • startIngestion

      CreateEventDataStoreRequest.Builder startIngestion(Boolean startIngestion)

      Specifies whether the event data store should start ingesting live events. The default is true.

      Parameters:
      startIngestion - Specifies whether the event data store should start ingesting live events. The default is true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateEventDataStoreRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateEventDataStoreRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.