software.amazon.awssdk.services.mediapackagev2.model

Class SpekeKeyProvider

java.lang.Object

software.amazon.awssdk.services.mediapackagev2.model.SpekeKeyProvider

All Implemented Interfaces:

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

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

The parameters for the SPEKE key provider.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SpekeKeyProvider.Builder

Method Summary

Modifier and Type	Method and Description
static SpekeKeyProvider.Builder	builder()
List<DrmSystem>	drmSystems() The DRM solution provider you're using to protect your content during distribution.
List<String>	drmSystemsAsStrings() The DRM solution provider you're using to protect your content during distribution.
EncryptionContractConfiguration	encryptionContractConfiguration() Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDrmSystems() For responses, this returns true if the service returned a value for the DrmSystems property.
int	hashCode()
String	resourceId() The unique identifier for the content.
String	roleArn() The ARN for the IAM role granted by the key provider that provides access to the key provider API.
List<SdkField<?>>	sdkFields()
static Class<? extends SpekeKeyProvider.Builder>	serializableBuilderClass()
SpekeKeyProvider.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	url() The URL of the API Gateway proxy that you set up to talk to your key server.

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

encryptionContractConfiguration

public final EncryptionContractConfiguration 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.

Returns:

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.

resourceId

public final String resourceId()

The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

The following example shows a resource ID: MovieNight20171126093045

Returns:

The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

The following example shows a resource ID: MovieNight20171126093045

drmSystems

public final List<DrmSystem> drmSystems()

The DRM solution provider you're using to protect your content during distribution.

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 hasDrmSystems() method.

Returns:

The DRM solution provider you're using to protect your content during distribution.

hasDrmSystems

public final boolean hasDrmSystems()

For responses, this returns true if the service returned a value for the DrmSystems 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.

drmSystemsAsStrings

public final List<String> drmSystemsAsStrings()

The DRM solution provider you're using to protect your content during distribution.

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 hasDrmSystems() method.

Returns:

The DRM solution provider you're using to protect your content during distribution.

roleArn

public final String roleArn()

The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess

Returns:

The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess

url

public final String url()

The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection

Returns:

The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection

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