Package software.amazon.awssdk.services.mediaconnect.model

Class Encryption

java.lang.Object
software.amazon.awssdk.services.mediaconnect.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>
Information about the encryption of the flow.
See Also:

  • Method Details

    • algorithm

      public final Algorithm algorithm()
      The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

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

      Returns:
      The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
      See Also:

    • algorithmAsString

      public final String algorithmAsString()
      The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

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

      Returns:
      The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
      See Also:

    • constantInitializationVector

      public final String constantInitializationVector()
      A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
      Returns:
      A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.

    • deviceId

      public final String deviceId()
      The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      Returns:
      The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.

    • keyType

      public final KeyType keyType()
      The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

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

      Returns:
      The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      See Also:

    • keyTypeAsString

      public final String keyTypeAsString()
      The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

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

      Returns:
      The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      See Also:

    • region

      public final String region()
      The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      Returns:
      The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.

    • resourceId

      public final String resourceId()
      An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      Returns:
      An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.

    • roleArn

      public final String roleArn()
      The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
      Returns:
      The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

    • secretArn

      public final String secretArn()
      The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
      Returns:
      The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.

    • url

      public final String url()
      The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      Returns:
      The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

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