Class LogGroupNameConfiguration

java.lang.Object
software.amazon.awssdk.services.observabilityadmin.model.LogGroupNameConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LogGroupNameConfiguration.Builder,LogGroupNameConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class LogGroupNameConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LogGroupNameConfiguration.Builder,LogGroupNameConfiguration>

Configuration that specifies a naming pattern for destination log groups created during centralization. The pattern supports static text and dynamic variables that are replaced with source attributes when log groups are created.

See Also:

  • Method Details

    • logGroupNamePattern

      public final String logGroupNamePattern()

      The pattern used to generate destination log group names during centralization. The pattern can contain static text and dynamic variables that are replaced with source attributes. If a variable cannot be resolved, it inherits the value from its parent variable in the hierarchy. The pattern must be between 1 and 512 characters.

      Supported variables:

      • ${source.logGroup} — The original log group name from the source account.

      • ${source.accountId} — The AWS account ID where the log originated.

      • ${source.region} — The AWS Region where the log originated.

      • ${source.org.id} — The AWS Organization ID of the source account.

      • ${source.org.ouId} — The organizational unit ID of the source account.

      • ${source.org.rootId} — The organization Root ID.

      • ${source.org.path} — The organizational path from account to root.

      Returns:
      The pattern used to generate destination log group names during centralization. The pattern can contain static text and dynamic variables that are replaced with source attributes. If a variable cannot be resolved, it inherits the value from its parent variable in the hierarchy. The pattern must be between 1 and 512 characters.

      Supported variables:

      • ${source.logGroup} — The original log group name from the source account.

      • ${source.accountId} — The AWS account ID where the log originated.

      • ${source.region} — The AWS Region where the log originated.

      • ${source.org.id} — The AWS Organization ID of the source account.

      • ${source.org.ouId} — The organizational unit ID of the source account.

      • ${source.org.rootId} — The organization Root ID.

      • ${source.org.path} — The organizational path from account to root.

    • toBuilder

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

    • builder

      public static LogGroupNameConfiguration.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.