Class EncryptionConfiguration

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

How a resource's data at rest is encrypted.

kmsKeyArn is required when encryptionStrategy is CUSTOMER_MANAGED and must be absent when it is AWS_OWNED; a mismatch is a ValidationException rather than a silently ignored field, so a caller that selects AWS_OWNED while still passing a key learns that the key was not applied.

See Also:

  • Method Details

    • encryptionStrategy

      public final EncryptionStrategy encryptionStrategy()

      Which kind of key to use. Required.

      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:
      Which kind of key to use. Required.
      See Also:

    • encryptionStrategyAsString

      public final String encryptionStrategyAsString()

      Which kind of key to use. Required.

      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:
      Which kind of key to use. Required.
      See Also:

    • kmsKeyArn

      public final String kmsKeyArn()

      Customer managed KMS key ARN. Required when encryptionStrategy is CUSTOMER_MANAGED, and must be omitted when it is AWS_OWNED. Must be a symmetric ENCRYPT_DECRYPT key in the caller's account and region.

      Returns:
      Customer managed KMS key ARN. Required when encryptionStrategy is CUSTOMER_MANAGED, and must be omitted when it is AWS_OWNED. Must be a symmetric ENCRYPT_DECRYPT key in the caller's account and region.

    • toBuilder

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

    • builder

      public static EncryptionConfiguration.Builder builder()

    • serializableBuilderClass

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