Package software.amazon.awssdk.services.mediapackage.model

Class SpekeKeyProvider

java.lang.Object

software.amazon.awssdk.services.mediapackage.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>

A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

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()	An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
EncryptionContractConfiguration	encryptionContractConfiguration()	Returns the value of the EncryptionContractConfiguration property for this object.
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()	The resource ID to include in key requests.
String	roleArn()	An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
List<SdkField<?>>	sdkFields()
static Class<? extends SpekeKeyProvider.Builder>	serializableBuilderClass()
List<String>	systemIds()	The system IDs to include in key requests.
SpekeKeyProvider.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	url()	The URL of the external key provider service.

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()

An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.

Returns:

An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.

encryptionContractConfiguration

public final EncryptionContractConfiguration encryptionContractConfiguration()

Returns the value of the EncryptionContractConfiguration property for this object.

Returns:

The value of the EncryptionContractConfiguration property for this object.

resourceId

public final String resourceId()

The resource ID to include in key requests.

Returns:

The resource ID to include in key requests.

roleArn

public final String roleArn()

An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.

Returns:

An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.

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()

The system IDs to include in key requests.

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:

The system IDs to include in key requests.

url

public final String url()

The URL of the external key provider service.

Returns:

The URL of the external key provider service.

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