Class AdvancedEventSelector

java.lang.Object
software.amazon.awssdk.services.cloudtrail.model.AdvancedEventSelector
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AdvancedEventSelector.Builder,AdvancedEventSelector>

@Generated("software.amazon.awssdk:codegen") public final class AdvancedEventSelector extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AdvancedEventSelector.Builder,AdvancedEventSelector>

Advanced event selectors let you create fine-grained selectors for CloudTrail management and data events. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging management events and Logging data events in the CloudTrail User Guide.

You cannot apply both event selectors and advanced event selectors to a trail.

Supported CloudTrail event record fields for management events

  • eventCategory (required)

  • eventSource

  • readOnly

Supported CloudTrail event record fields for data events

  • eventCategory (required)

  • resources.type (required)

  • readOnly

  • eventName

  • resources.ARN

For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory.

See Also:
  • Method Details

    • name

      public final String name()

      An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

      Returns:
      An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
    • hasFieldSelectors

      public final boolean hasFieldSelectors()
      For responses, this returns true if the service returned a value for the FieldSelectors 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.
    • fieldSelectors

      public final List<AdvancedFieldSelector> fieldSelectors()

      Contains all selector statements in an advanced event selector.

      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 hasFieldSelectors() method.

      Returns:
      Contains all selector statements in an advanced event selector.
    • toBuilder

      public AdvancedEventSelector.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<AdvancedEventSelector.Builder,AdvancedEventSelector>
      Returns:
      a builder for type T
    • builder

      public static AdvancedEventSelector.Builder builder()
    • serializableBuilderClass

      public static Class<? extends AdvancedEventSelector.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • 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)
    • 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.