software.amazon.awssdk.services.cloudtrail.model

Interface UpdateEventDataStoreRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CloudTrailRequest.Builder, CopyableBuilder<UpdateEventDataStoreRequest.Builder,UpdateEventDataStoreRequest>, SdkBuilder<UpdateEventDataStoreRequest.Builder,UpdateEventDataStoreRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateEventDataStoreRequest

public static interface UpdateEventDataStoreRequest.Builder
extends CloudTrailRequest.Builder, SdkPojo, CopyableBuilder<UpdateEventDataStoreRequest.Builder,UpdateEventDataStoreRequest>

Method Summary

Modifier and Type	Method and Description
UpdateEventDataStoreRequest.Builder	advancedEventSelectors(AdvancedEventSelector... advancedEventSelectors) The advanced event selectors used to select events for the event data store.
UpdateEventDataStoreRequest.Builder	advancedEventSelectors(Collection<AdvancedEventSelector> advancedEventSelectors) The advanced event selectors used to select events for the event data store.
UpdateEventDataStoreRequest.Builder	advancedEventSelectors(Consumer<AdvancedEventSelector.Builder>... advancedEventSelectors) The advanced event selectors used to select events for the event data store.
UpdateEventDataStoreRequest.Builder	eventDataStore(String eventDataStore) The ARN (or the ID suffix of the ARN) of the event data store that you want to update.
UpdateEventDataStoreRequest.Builder	kmsKeyId(String kmsKeyId) Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail.
UpdateEventDataStoreRequest.Builder	multiRegionEnabled(Boolean multiRegionEnabled) Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.
UpdateEventDataStoreRequest.Builder	name(String name) The event data store name.
UpdateEventDataStoreRequest.Builder	organizationEnabled(Boolean organizationEnabled) Specifies whether an event data store collects events logged for an organization in Organizations.
UpdateEventDataStoreRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateEventDataStoreRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateEventDataStoreRequest.Builder	retentionPeriod(Integer retentionPeriod) The retention period of the event data store, in days.
UpdateEventDataStoreRequest.Builder	terminationProtectionEnabled(Boolean terminationProtectionEnabled) Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

Methods inherited from interface software.amazon.awssdk.services.cloudtrail.model.CloudTrailRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

eventDataStore

UpdateEventDataStoreRequest.Builder eventDataStore(String eventDataStore)

The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

Parameters:

eventDataStore - The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

Returns:

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

name

UpdateEventDataStoreRequest.Builder name(String name)

The event data store name.

Parameters:

name - The event data store name.

Returns:

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

advancedEventSelectors

UpdateEventDataStoreRequest.Builder advancedEventSelectors(Collection<AdvancedEventSelector> advancedEventSelectors)

The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

Parameters:

advancedEventSelectors - The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

Returns:

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

advancedEventSelectors

UpdateEventDataStoreRequest.Builder advancedEventSelectors(AdvancedEventSelector... advancedEventSelectors)

The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

Parameters:

advancedEventSelectors - The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

Returns:

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

advancedEventSelectors

UpdateEventDataStoreRequest.Builder advancedEventSelectors(Consumer<AdvancedEventSelector.Builder>... advancedEventSelectors)

The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

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

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:

#advancedEventSelectors(java.util.Collection)

multiRegionEnabled

UpdateEventDataStoreRequest.Builder multiRegionEnabled(Boolean multiRegionEnabled)

Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.

Parameters:

multiRegionEnabled - Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.

Returns:

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

organizationEnabled

UpdateEventDataStoreRequest.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

UpdateEventDataStoreRequest.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 decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.

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 decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.

Returns:

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

terminationProtectionEnabled

UpdateEventDataStoreRequest.Builder terminationProtectionEnabled(Boolean terminationProtectionEnabled)

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

Parameters:

terminationProtectionEnabled - Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

Returns:

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

kmsKeyId

UpdateEventDataStoreRequest.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.

overrideConfiguration

UpdateEventDataStoreRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateEventDataStoreRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder