Class EncryptionConfiguration

java.lang.Object
software.amazon.awssdk.services.athena.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>

If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information.

See Also:

  • Method Details

    • encryptionOption

      public final EncryptionOption encryptionOption()

      Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys ( CSE_KMS) is used.

      If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

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

      Returns:
      Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used.

      If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

      See Also:

    • encryptionOptionAsString

      public final String encryptionOptionAsString()

      Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys ( CSE_KMS) is used.

      If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

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

      Returns:
      Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used.

      If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

      See Also:

    • kmsKey

      public final String kmsKey()

      For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

      Returns:
      For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

    • 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.