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("software.amazon.awssdk:codegen") public final class CreateEventDataStoreRequest extends CloudTrailRequest implements ToCopyableBuilder<CreateEventDataStoreRequest.Builder,CreateEventDataStoreRequest>

  • Method Details

    • 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 events outside of 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 events outside of 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. 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:
      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.

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

    • billingMode

      public final BillingMode 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 CloudTrail Pricing and Managing CloudTrail Lake costs.

      If the service returns an enum value that is not available in the current SDK version, billingMode will return BillingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingModeAsString().

      Returns:
      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 CloudTrail Pricing and Managing CloudTrail Lake costs.

      See Also:

    • billingModeAsString

      public final String billingModeAsString()

      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 CloudTrail Pricing and Managing CloudTrail Lake costs.

      If the service returns an enum value that is not available in the current SDK version, billingMode will return BillingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingModeAsString().

      Returns:
      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 CloudTrail Pricing and Managing CloudTrail Lake costs.

      See Also:

    • toBuilder

      public CreateEventDataStoreRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateEventDataStoreRequest.Builder,CreateEventDataStoreRequest>
      Specified by:
      toBuilder in class CloudTrailRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.