Class LogsEncryptionConfiguration

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

Configuration for encrypting centralized destination log groups. By default, this configuration applies only to destination log groups whose corresponding source log groups are encrypted using customer managed KMS keys. To encrypt all destination log groups created by the rule, set EncryptionScope to NEW_DESTINATION_LOG_GROUPS.

See Also:

  • Method Details

    • encryptionStrategy

      public final EncryptionStrategy encryptionStrategy()

      Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.

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

      Returns:
      Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.
      See Also:

    • encryptionStrategyAsString

      public final String encryptionStrategyAsString()

      Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.

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

      Returns:
      Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.
      See Also:

    • kmsKeyArn

      public final String kmsKeyArn()

      KMS Key ARN belonging to the primary destination account and region, to encrypt newly created central log groups in the primary destination.

      Returns:
      KMS Key ARN belonging to the primary destination account and region, to encrypt newly created central log groups in the primary destination.

    • encryptionConflictResolutionStrategy

      public final EncryptionConflictResolutionStrategy encryptionConflictResolutionStrategy()

      Conflict resolution strategy for centralization if the encryption strategy is set to CUSTOMER_MANAGED and the destination log group is encrypted with an AWS_OWNED KMS Key. ALLOW lets centralization go through while SKIP prevents centralization into the destination log group.

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

      Returns:
      Conflict resolution strategy for centralization if the encryption strategy is set to CUSTOMER_MANAGED and the destination log group is encrypted with an AWS_OWNED KMS Key. ALLOW lets centralization go through while SKIP prevents centralization into the destination log group.
      See Also:

    • encryptionConflictResolutionStrategyAsString

      public final String encryptionConflictResolutionStrategyAsString()

      Conflict resolution strategy for centralization if the encryption strategy is set to CUSTOMER_MANAGED and the destination log group is encrypted with an AWS_OWNED KMS Key. ALLOW lets centralization go through while SKIP prevents centralization into the destination log group.

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

      Returns:
      Conflict resolution strategy for centralization if the encryption strategy is set to CUSTOMER_MANAGED and the destination log group is encrypted with an AWS_OWNED KMS Key. ALLOW lets centralization go through while SKIP prevents centralization into the destination log group.
      See Also:

    • encryptionScope

      public final EncryptionScope encryptionScope()

      Determines which newly created destination log groups are encrypted with the configured KmsKeyArn when EncryptionStrategy is CUSTOMER_MANAGED.

      If you set this to ENCRYPTED_SOURCE_ONLY (the default), only destination log groups whose source log group is encrypted with a customer managed KMS key use the configured KmsKeyArn. Destination log groups derived from Amazon Web Services owned encrypted source log groups remain Amazon Web Services owned encrypted.

      If you set this to NEW_DESTINATION_LOG_GROUPS, every new destination log group created by this rule uses the configured KmsKeyArn, regardless of the source log group's encryption posture.

      This field is not valid when EncryptionStrategy is AWS_OWNED.

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

      Returns:
      Determines which newly created destination log groups are encrypted with the configured KmsKeyArn when EncryptionStrategy is CUSTOMER_MANAGED.

      If you set this to ENCRYPTED_SOURCE_ONLY (the default), only destination log groups whose source log group is encrypted with a customer managed KMS key use the configured KmsKeyArn. Destination log groups derived from Amazon Web Services owned encrypted source log groups remain Amazon Web Services owned encrypted.

      If you set this to NEW_DESTINATION_LOG_GROUPS, every new destination log group created by this rule uses the configured KmsKeyArn, regardless of the source log group's encryption posture.

      This field is not valid when EncryptionStrategy is AWS_OWNED.

      See Also:

    • encryptionScopeAsString

      public final String encryptionScopeAsString()

      Determines which newly created destination log groups are encrypted with the configured KmsKeyArn when EncryptionStrategy is CUSTOMER_MANAGED.

      If you set this to ENCRYPTED_SOURCE_ONLY (the default), only destination log groups whose source log group is encrypted with a customer managed KMS key use the configured KmsKeyArn. Destination log groups derived from Amazon Web Services owned encrypted source log groups remain Amazon Web Services owned encrypted.

      If you set this to NEW_DESTINATION_LOG_GROUPS, every new destination log group created by this rule uses the configured KmsKeyArn, regardless of the source log group's encryption posture.

      This field is not valid when EncryptionStrategy is AWS_OWNED.

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

      Returns:
      Determines which newly created destination log groups are encrypted with the configured KmsKeyArn when EncryptionStrategy is CUSTOMER_MANAGED.

      If you set this to ENCRYPTED_SOURCE_ONLY (the default), only destination log groups whose source log group is encrypted with a customer managed KMS key use the configured KmsKeyArn. Destination log groups derived from Amazon Web Services owned encrypted source log groups remain Amazon Web Services owned encrypted.

      If you set this to NEW_DESTINATION_LOG_GROUPS, every new destination log group created by this rule uses the configured KmsKeyArn, regardless of the source log group's encryption posture.

      This field is not valid when EncryptionStrategy is AWS_OWNED.

      See Also:

    • toBuilder

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

    • builder

      public static LogsEncryptionConfiguration.Builder builder()

    • serializableBuilderClass

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