Class DestinationLogsConfiguration

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

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

Configuration for centralization destination log groups, including encryption and backup settings.

See Also:
  • Method Details

    • logsEncryptionConfiguration

      public final LogsEncryptionConfiguration logsEncryptionConfiguration()

      The encryption configuration for centralization destination log groups.

      Returns:
      The encryption configuration for centralization destination log groups.
    • backupConfiguration

      public final LogsBackupConfiguration backupConfiguration()

      Configuration defining the backup region and an optional KMS key for the backup destination.

      Returns:
      Configuration defining the backup region and an optional KMS key for the backup destination.
    • logGroupNameConfiguration

      public final LogGroupNameConfiguration 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.

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

      public final TagPropagationConfiguration tagPropagationConfiguration()

      Specifies the tag propagation configuration for this centralization rule. When present, LogGroupNameConfiguration must use a LogGroupNamePattern that contains ${source.logGroup}, ${source.accountId}, and ${source.region}.

      Returns:
      Specifies the tag propagation configuration for this centralization rule. When present, LogGroupNameConfiguration must use a LogGroupNamePattern that contains ${source.logGroup}, ${source.accountId}, and ${source.region}.
    • logGroupDeletionProtection

      public final DeletionProtection logGroupDeletionProtection()

      Specifies whether this centralization rule enables deletion protection on the destination log groups that it creates. If you don't specify this setting, the rule doesn't enable deletion protection on the log groups that it creates. If you specify a backup Region in BackupConfiguration, the setting also applies to the log groups that the rule creates in the backup Region.

      When you set this to ENABLED, the rule enables deletion protection only on log groups that it creates after you enable the setting. It does not add deletion protection to log groups the rule created before you enabled the setting.

      If you remove this setting from the rule or delete the rule, deletion protection stays enabled on log groups that already have it. To delete one of these log groups, first disable deletion protection on the log group in the destination account.

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

      Returns:
      Specifies whether this centralization rule enables deletion protection on the destination log groups that it creates. If you don't specify this setting, the rule doesn't enable deletion protection on the log groups that it creates. If you specify a backup Region in BackupConfiguration, the setting also applies to the log groups that the rule creates in the backup Region.

      When you set this to ENABLED, the rule enables deletion protection only on log groups that it creates after you enable the setting. It does not add deletion protection to log groups the rule created before you enabled the setting.

      If you remove this setting from the rule or delete the rule, deletion protection stays enabled on log groups that already have it. To delete one of these log groups, first disable deletion protection on the log group in the destination account.

      See Also:
    • logGroupDeletionProtectionAsString

      public final String logGroupDeletionProtectionAsString()

      Specifies whether this centralization rule enables deletion protection on the destination log groups that it creates. If you don't specify this setting, the rule doesn't enable deletion protection on the log groups that it creates. If you specify a backup Region in BackupConfiguration, the setting also applies to the log groups that the rule creates in the backup Region.

      When you set this to ENABLED, the rule enables deletion protection only on log groups that it creates after you enable the setting. It does not add deletion protection to log groups the rule created before you enabled the setting.

      If you remove this setting from the rule or delete the rule, deletion protection stays enabled on log groups that already have it. To delete one of these log groups, first disable deletion protection on the log group in the destination account.

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

      Returns:
      Specifies whether this centralization rule enables deletion protection on the destination log groups that it creates. If you don't specify this setting, the rule doesn't enable deletion protection on the log groups that it creates. If you specify a backup Region in BackupConfiguration, the setting also applies to the log groups that the rule creates in the backup Region.

      When you set this to ENABLED, the rule enables deletion protection only on log groups that it creates after you enable the setting. It does not add deletion protection to log groups the rule created before you enabled the setting.

      If you remove this setting from the rule or delete the rule, deletion protection stays enabled on log groups that already have it. To delete one of these log groups, first disable deletion protection on the log group in the destination account.

      See Also:
    • 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<DestinationLogsConfiguration.Builder,DestinationLogsConfiguration>
      Returns:
      a builder for type T
    • builder

      public static DestinationLogsConfiguration.Builder builder()
    • serializableBuilderClass

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