Class SourceLogsConfiguration

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

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

Configuration for selecting and handling source log groups for centralization.

See Also:
  • Method Details

    • logGroupSelectionCriteria

      public final String logGroupSelectionCriteria()

      The selection criteria that specifies which source log groups to centralize. The selection criteria uses the same format as OAM link filters.

      Returns:
      The selection criteria that specifies which source log groups to centralize. The selection criteria uses the same format as OAM link filters.
    • dataSourceSelectionCriteria

      public final String dataSourceSelectionCriteria()

      The selection criteria that specifies which data sources to centralize. The selection criteria uses the same filter expression format as LogGroupSelectionCriteria, but operates on DataSourceName and DataSourceType operands. When both LogGroupSelectionCriteria and DataSourceSelectionCriteria are specified, a log event must match both criteria to be centralized.

      Returns:
      The selection criteria that specifies which data sources to centralize. The selection criteria uses the same filter expression format as LogGroupSelectionCriteria, but operates on DataSourceName and DataSourceType operands. When both LogGroupSelectionCriteria and DataSourceSelectionCriteria are specified, a log event must match both criteria to be centralized.
    • encryptedLogGroupStrategy

      public final EncryptedLogGroupStrategy encryptedLogGroupStrategy()

      A strategy determining whether to centralize source log groups that are encrypted with customer managed KMS keys (CMK). ALLOW will consider CMK encrypted source log groups for centralization while SKIP will skip CMK encrypted source log groups from centralization.

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

      Returns:
      A strategy determining whether to centralize source log groups that are encrypted with customer managed KMS keys (CMK). ALLOW will consider CMK encrypted source log groups for centralization while SKIP will skip CMK encrypted source log groups from centralization.
      See Also:
    • encryptedLogGroupStrategyAsString

      public final String encryptedLogGroupStrategyAsString()

      A strategy determining whether to centralize source log groups that are encrypted with customer managed KMS keys (CMK). ALLOW will consider CMK encrypted source log groups for centralization while SKIP will skip CMK encrypted source log groups from centralization.

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

      Returns:
      A strategy determining whether to centralize source log groups that are encrypted with customer managed KMS keys (CMK). ALLOW will consider CMK encrypted source log groups for centralization while SKIP will skip CMK encrypted source log groups from centralization.
      See Also:
    • centralizeWithDataProtection

      public final CentralizeWithDataProtection centralizeWithDataProtection()

      Specifies whether this centralization rule centralizes log events with data protection applied. If you don't specify this setting, or you set it to DISABLED, the rule centralizes the original log events, including any sensitive data that a data protection policy on the source log group masks.

      When you set this to ENABLED, the rule centralizes the same masked data that anyone in the source account without the logs:Unmask permission sees. The rule doesn't copy the original values to the destination, so you can't unmask them in the destination account. The rule centralizes log events from source log groups that don't have a data protection policy without changes.

      The setting applies only to log events that the rule centralizes after you enable it. It doesn't change log events that the rule already centralized.

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

      Returns:
      Specifies whether this centralization rule centralizes log events with data protection applied. If you don't specify this setting, or you set it to DISABLED, the rule centralizes the original log events, including any sensitive data that a data protection policy on the source log group masks.

      When you set this to ENABLED, the rule centralizes the same masked data that anyone in the source account without the logs:Unmask permission sees. The rule doesn't copy the original values to the destination, so you can't unmask them in the destination account. The rule centralizes log events from source log groups that don't have a data protection policy without changes.

      The setting applies only to log events that the rule centralizes after you enable it. It doesn't change log events that the rule already centralized.

      See Also:
    • centralizeWithDataProtectionAsString

      public final String centralizeWithDataProtectionAsString()

      Specifies whether this centralization rule centralizes log events with data protection applied. If you don't specify this setting, or you set it to DISABLED, the rule centralizes the original log events, including any sensitive data that a data protection policy on the source log group masks.

      When you set this to ENABLED, the rule centralizes the same masked data that anyone in the source account without the logs:Unmask permission sees. The rule doesn't copy the original values to the destination, so you can't unmask them in the destination account. The rule centralizes log events from source log groups that don't have a data protection policy without changes.

      The setting applies only to log events that the rule centralizes after you enable it. It doesn't change log events that the rule already centralized.

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

      Returns:
      Specifies whether this centralization rule centralizes log events with data protection applied. If you don't specify this setting, or you set it to DISABLED, the rule centralizes the original log events, including any sensitive data that a data protection policy on the source log group masks.

      When you set this to ENABLED, the rule centralizes the same masked data that anyone in the source account without the logs:Unmask permission sees. The rule doesn't copy the original values to the destination, so you can't unmask them in the destination account. The rule centralizes log events from source log groups that don't have a data protection policy without changes.

      The setting applies only to log events that the rule centralizes after you enable it. It doesn't change log events that the rule already centralized.

      See Also:
    • toBuilder

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

      public static SourceLogsConfiguration.Builder builder()
    • serializableBuilderClass

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