Class Encryption

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

Contains the type of server-side encryption used.

See Also:

  • Method Details

    • encryptionType

      public final ServerSideEncryption encryptionType()

      The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

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

      Returns:
      The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).
      See Also:

    • encryptionTypeAsString

      public final String encryptionTypeAsString()

      The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

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

      Returns:
      The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).
      See Also:

    • kmsKeyId

      public final String kmsKeyId()

      If the encryption type is aws:kms, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service Developer Guide.

      Returns:
      If the encryption type is aws:kms, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service Developer Guide.

    • kmsContext

      public final String kmsContext()

      If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

      Returns:
      If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

    • toBuilder

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

    • builder

      public static Encryption.Builder builder()

    • serializableBuilderClass

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