Class Encryption

java.lang.Object
software.amazon.awssdk.services.mediapackagev2.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 parameters for encrypting content.

See Also:

  • Method Details

    • constantInitializationVector

      public final String constantInitializationVector()

      A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).

      Returns:
      A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).

    • encryptionMethod

      public final EncryptionMethod encryptionMethod()

      The encryption method to use.

      Returns:
      The encryption method to use.

    • keyRotationIntervalSeconds

      public final Integer keyRotationIntervalSeconds()

      The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

      The following example setting causes the service to rotate keys every thirty minutes: 1800

      Returns:
      The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

      The following example setting causes the service to rotate keys every thirty minutes: 1800

    • cmafExcludeSegmentDrmMetadata

      public final Boolean cmafExcludeSegmentDrmMetadata()

      Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.

      When set to true, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.

      Important considerations:

      • This setting only affects CMAF container formats

      • Key rotation can still be handled through media playlist signaling

      • PSSH and TENC boxes remain unaffected

      • Default behavior is preserved when this setting is disabled

      Valid values: true | false

      Default: false

      Returns:
      Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.

      When set to true, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.

      Important considerations:

      • This setting only affects CMAF container formats

      • Key rotation can still be handled through media playlist signaling

      • PSSH and TENC boxes remain unaffected

      • Default behavior is preserved when this setting is disabled

      Valid values: true | false

      Default: false

    • spekeKeyProvider

      public final SpekeKeyProvider spekeKeyProvider()

      The parameters for the SPEKE key provider.

      Returns:
      The parameters for the SPEKE key provider.

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.