software.amazon.awssdk.services.cloudtrail.model

Class CreateEventDataStoreRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudtrail.model.CloudTrailRequest

software.amazon.awssdk.services.cloudtrail.model.CreateEventDataStoreRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEventDataStoreRequest.Builder,CreateEventDataStoreRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateEventDataStoreRequest
extends CloudTrailRequest
implements ToCopyableBuilder<CreateEventDataStoreRequest.Builder,CreateEventDataStoreRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateEventDataStoreRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<AdvancedEventSelector>	advancedEventSelectors() The advanced event selectors to use to select the events for the data store.
static CreateEventDataStoreRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdvancedEventSelectors() For responses, this returns true if the service returned a value for the AdvancedEventSelectors property.
int	hashCode()
boolean	hasTagsList() For responses, this returns true if the service returned a value for the TagsList property.
String	kmsKeyId() Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail.
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.
String	name() The name of the event data store.
Boolean	organizationEnabled() Specifies whether an event data store collects events logged for an organization in Organizations.
Integer	retentionPeriod() The retention period of the event data store, in days.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateEventDataStoreRequest.Builder>	serializableBuilderClass()
Boolean	startIngestion() Specifies whether the event data store should start ingesting live events.
List<Tag>	tagsList() Returns the value of the TagsList property for this object.
Boolean	terminationProtectionEnabled() Specifies whether termination protection is enabled for the event data store.
CreateEventDataStoreRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

The name of the event data store.

Returns:

The name of the event data store.

hasAdvancedEventSelectors

public final boolean hasAdvancedEventSelectors()

For responses, this returns true if the service returned a value for the AdvancedEventSelectors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

advancedEventSelectors

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdvancedEventSelectors() method.

Returns:

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.

multiRegionEnabled

public final 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.

Returns:

Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.

organizationEnabled

public final Boolean organizationEnabled()

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

Returns:

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

retentionPeriod

public final 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.

Returns:

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.

terminationProtectionEnabled

public final 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.

Returns:

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.

hasTagsList

public final boolean hasTagsList()

For responses, this returns true if the service returned a value for the TagsList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tagsList

public final List<Tag> tagsList()

Returns the value of the TagsList property for this object.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagsList() method.

Returns:

The value of the TagsList property for this object.

kmsKeyId

public final 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

Returns:

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

startIngestion

public final Boolean startIngestion()

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

Returns:

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

toBuilder

public CreateEventDataStoreRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEventDataStoreRequest.Builder,CreateEventDataStoreRequest>

Specified by:

toBuilder in class CloudTrailRequest

builder

public static CreateEventDataStoreRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateEventDataStoreRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo