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

Class UpdateEventDataStoreRequest

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.UpdateEventDataStoreRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateEventDataStoreRequest.Builder,UpdateEventDataStoreRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateEventDataStoreRequest extends CloudTrailRequest implements ToCopyableBuilder<UpdateEventDataStoreRequest.Builder,UpdateEventDataStoreRequest>

  • Method Details

    • eventDataStore

      public final String eventDataStore()

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

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

    • name

      public final String name()

      The event data store name.

      Returns:
      The event data store name.

    • 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 used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

      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 used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

    • multiRegionEnabled

      public final Boolean multiRegionEnabled()

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

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

    • organizationEnabled

      public final Boolean organizationEnabled()

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

      Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.

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

      Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.

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

    • terminationProtectionEnabled

      public final Boolean terminationProtectionEnabled()

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

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

    • 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

    • toBuilder

      public UpdateEventDataStoreRequest.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<UpdateEventDataStoreRequest.Builder,UpdateEventDataStoreRequest>
      Specified by:
      toBuilder in class CloudTrailRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateEventDataStoreRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateEventDataStoreRequest.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.