software.amazon.awssdk.services.mediaconvert.model

Class SpekeKeyProviderCmaf

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.SpekeKeyProviderCmaf

All Implemented Interfaces:

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

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

If your output group type is CMAF, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is HLS, DASH, or Microsoft Smooth, use the SpekeKeyProvider settings instead.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SpekeKeyProviderCmaf.Builder

Method Summary

Modifier and Type	Method and Description
static SpekeKeyProviderCmaf.Builder	builder()
String	certificateArn() If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with a master key using AWS Certificate Manager.
List<String>	dashSignaledSystemIds() Specify the DRM system IDs that you want signaled in the DASH manifest that MediaConvert creates as part of this CMAF package.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDashSignaledSystemIds() Returns true if the DashSignaledSystemIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasHlsSignaledSystemIds() Returns true if the HlsSignaledSystemIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	hlsSignaledSystemIds() Specify the DRM system ID that you want signaled in the HLS manifest that MediaConvert creates as part of this CMAF package.
String	resourceId() Specify the resource ID that your SPEKE-compliant key provider uses to identify this content.
List<SdkField<?>>	sdkFields()
static Class<? extends SpekeKeyProviderCmaf.Builder>	serializableBuilderClass()
SpekeKeyProviderCmaf.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	url() Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content.

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 Detail

certificateArn

public final String certificateArn()

If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here.

Returns:

If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here.

hasDashSignaledSystemIds

public final boolean hasDashSignaledSystemIds()

Returns true if the DashSignaledSystemIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

dashSignaledSystemIds

public final List<String> dashSignaledSystemIds()

Specify the DRM system IDs that you want signaled in the DASH manifest that MediaConvert creates as part of this CMAF package. The DASH manifest can currently signal up to three system IDs. For more information, see https://dashif.org/identifiers/content_protection/.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDashSignaledSystemIds() to see if a value was sent in this field.

Returns:

Specify the DRM system IDs that you want signaled in the DASH manifest that MediaConvert creates as part of this CMAF package. The DASH manifest can currently signal up to three system IDs. For more information, see https://dashif.org/identifiers/content_protection/.

hasHlsSignaledSystemIds

public final boolean hasHlsSignaledSystemIds()

Returns true if the HlsSignaledSystemIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

hlsSignaledSystemIds

public final List<String> hlsSignaledSystemIds()

Specify the DRM system ID that you want signaled in the HLS manifest that MediaConvert creates as part of this CMAF package. The HLS manifest can currently signal only one system ID. For more information, see https://dashif.org/identifiers/content_protection/.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasHlsSignaledSystemIds() to see if a value was sent in this field.

Returns:

Specify the DRM system ID that you want signaled in the HLS manifest that MediaConvert creates as part of this CMAF package. The HLS manifest can currently signal only one system ID. For more information, see https://dashif.org/identifiers/content_protection/.

resourceId

public final String resourceId()

Specify the resource ID that your SPEKE-compliant key provider uses to identify this content.

Returns:

Specify the resource ID that your SPEKE-compliant key provider uses to identify this content.

url

public final String url()

Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content.

Returns:

Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content.

toBuilder

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

Returns:

a builder for type T

builder

public static SpekeKeyProviderCmaf.Builder builder()

serializableBuilderClass

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