Package software.amazon.awssdk.services.mediaconvert.model

Class SpekeKeyProvider

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.SpekeKeyProvider

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SpekeKeyProvider.Builder

Method Summary

Modifier and Type	Method	Description
static SpekeKeyProvider.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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSystemIds()	For responses, this returns true if the service returned a value for the SystemIds property.
String	resourceId()	Specify the resource ID that your SPEKE-compliant key provider uses to identify this content.
List<SdkField<?>>	sdkFields()
static Class<? extends SpekeKeyProvider.Builder>	serializableBuilderClass()
List<String>	systemIds()	Relates to SPEKE implementation.
SpekeKeyProvider.Builder	toBuilder()
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

clone, finalize, 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.

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.

hasSystemIds

public final boolean hasSystemIds()

For responses, this returns true if the service returned a value for the SystemIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

systemIds

public final List<String> systemIds()

Relates to SPEKE implementation. DRM system identifiers. DASH output groups support a max of two system ids. Other group types support one system id. See https://dashif.org/identifiers/content_protection/ for more details.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSystemIds() method.

Returns:

Relates to SPEKE implementation. DRM system identifiers. DASH output groups support a max of two system ids. Other group types support one system id. See https://dashif.org/identifiers/content_protection/ for more details.

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 SpekeKeyProvider.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SpekeKeyProvider.Builder,SpekeKeyProvider>

builder

public static SpekeKeyProvider.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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