Class EncryptionContractConfiguration

java.lang.Object

software.amazon.awssdk.services.mediapackagev2.model.EncryptionContractConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EncryptionContractConfiguration.Builder,EncryptionContractConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class EncryptionContractConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EncryptionContractConfiguration.Builder,EncryptionContractConfiguration>

Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EncryptionContractConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static EncryptionContractConfiguration.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 PresetSpeke20Audio	presetSpeke20Audio()	A collection of audio encryption presets.
final String	presetSpeke20AudioAsString()	A collection of audio encryption presets.
final PresetSpeke20Video	presetSpeke20Video()	A collection of video encryption presets.
final String	presetSpeke20VideoAsString()	A collection of video encryption presets.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends EncryptionContractConfiguration.Builder>	serializableBuilderClass()
EncryptionContractConfiguration.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

presetSpeke20Audio

public final PresetSpeke20Audio presetSpeke20Audio()

A collection of audio encryption presets.

Value description:

• PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.

• PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.

• PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.

• SHARED - Use the same content key for all of the audio and video tracks in your stream.

• UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.

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

Returns:

A collection of audio encryption presets.

Value description:

• PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.

• PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.

• PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.

• SHARED - Use the same content key for all of the audio and video tracks in your stream.

• UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.

See Also:

• PresetSpeke20Audio

presetSpeke20AudioAsString

public final String presetSpeke20AudioAsString()

A collection of audio encryption presets.

Value description:

• PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.

• PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.

• PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.

• SHARED - Use the same content key for all of the audio and video tracks in your stream.

• UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.

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

Returns:

A collection of audio encryption presets.

Value description:

• PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.

• PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.

• PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.

• SHARED - Use the same content key for all of the audio and video tracks in your stream.

• UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.

See Also:

• PresetSpeke20Audio

presetSpeke20Video

public final PresetSpeke20Video presetSpeke20Video()

A collection of video encryption presets.

Value description:

• PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.

• PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.

• PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.

• PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

• PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

• PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

• PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

• PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

• SHARED - Use the same content key for all of the video and audio tracks in your stream.

• UNENCRYPTED - Don't encrypt any of the video tracks in your stream.

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

Returns:

A collection of video encryption presets.

Value description:

• PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.

• PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.

• PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.

• PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

• PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

• PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

• PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

• PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

• SHARED - Use the same content key for all of the video and audio tracks in your stream.

• UNENCRYPTED - Don't encrypt any of the video tracks in your stream.

See Also:

• PresetSpeke20Video

presetSpeke20VideoAsString

public final String presetSpeke20VideoAsString()

A collection of video encryption presets.

Value description:

• PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.

• PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.

• PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.

• PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

• PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

• PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

• PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

• PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

• SHARED - Use the same content key for all of the video and audio tracks in your stream.

• UNENCRYPTED - Don't encrypt any of the video tracks in your stream.

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

Returns:

A collection of video encryption presets.

Value description:

• PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.

• PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.

• PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.

• PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

• PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

• PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

• PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

• PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

• SHARED - Use the same content key for all of the video and audio tracks in your stream.

• UNENCRYPTED - Don't encrypt any of the video tracks in your stream.

See Also:

• PresetSpeke20Video

toBuilder

public EncryptionContractConfiguration.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<EncryptionContractConfiguration.Builder,EncryptionContractConfiguration>

Returns:

a builder for type T

builder

public static EncryptionContractConfiguration.Builder builder()

serializableBuilderClass

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