Class Encryption

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

The encryption settings, if any, that are used for decrypting your input files or encrypting your output files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file, otherwise you must specify the mode you want Elastic Transcoder to use to encrypt your output files.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    Encryption.Builder
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Encryption.Builder
    builder()
     
    final boolean
    equals(Object obj)
     
    final boolean
    equalsBySdkFields(Object obj)
    Indicates whether some other object is "equal to" this one by SDK fields.
    final <T> Optional<T>
    getValueForField(String fieldName, Class<T> clazz)
     
    final int
    hashCode()
     
    final String
    initializationVector()
    The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files.
    final String
    key()
    The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file.
    final String
    keyMd5()
    The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file.
    final String
    mode()
    The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files.
    final List<SdkField<?>>
    sdkFields()
     
    static Class<? extends Encryption.Builder>
    serializableBuilderClass()
     
    Encryption.Builder
    toBuilder()
    Take this object and create a builder that contains all of the current property values of this object.
    final String
    toString()
    Returns a string representation of this object.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

    copy

  • Method Details

    • mode

      public final String mode()

      The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options:

      • s3: Amazon S3 creates and manages the keys used for encrypting your files.

      • s3-aws-kms: Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify s3-aws-kms and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline.

      • aes-cbc-pkcs7: A padded cipher-block mode of operation originally used for HLS files.

      • aes-ctr: AES Counter Mode.

      • aes-gcm: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with fails the decryption process.

      For all three AES options, you must provide the following settings, which must be base64-encoded:

      • Key

      • Key MD5

      • Initialization Vector

      For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.

      Returns:
      The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options:

      • s3: Amazon S3 creates and manages the keys used for encrypting your files.

      • s3-aws-kms: Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify s3-aws-kms and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline.

      • aes-cbc-pkcs7: A padded cipher-block mode of operation originally used for HLS files.

      • aes-ctr: AES Counter Mode.

      • aes-gcm: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with fails the decryption process.

      For all three AES options, you must provide the following settings, which must be base64-encoded:

      • Key

      • Key MD5

      • Initialization Vector

      For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.

    • key

      public final String key()

      The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded:

      128, 192, or 256.

      The key must also be encrypted by using the Amazon Key Management Service.

      Returns:
      The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded:

      128, 192, or 256.

      The key must also be encrypted by using the Amazon Key Management Service.

    • keyMd5

      public final String keyMd5()

      The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.

      Returns:
      The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.

    • initializationVector

      public final String initializationVector()

      The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.

      Returns:
      The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.

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