Class SpekeKeyProviderCmaf
- java.lang.Object
-
- software.amazon.awssdk.services.mediaconvert.model.SpekeKeyProviderCmaf
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SpekeKeyProviderCmaf.Builder,SpekeKeyProviderCmaf>
@Generated("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 Description static interface
SpekeKeyProviderCmaf.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.EncryptionContractConfiguration
encryptionContractConfiguration()
Specify the SPEKE version, either v1.0 or v2.0, that MediaConvert uses when encrypting your output.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasDashSignaledSystemIds()
For responses, this returns true if the service returned a value for the DashSignaledSystemIds property.int
hashCode()
boolean
hasHlsSignaledSystemIds()
For responses, this returns true if the service returned a value for the HlsSignaledSystemIds property.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.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends SpekeKeyProviderCmaf.Builder>
serializableBuilderClass()
SpekeKeyProviderCmaf.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.
-
hasDashSignaledSystemIds
public final boolean hasDashSignaledSystemIds()
For responses, this returns true if the service returned a value for the DashSignaledSystemIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
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.
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
hasDashSignaledSystemIds()
method.- 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/.
-
encryptionContractConfiguration
public final EncryptionContractConfiguration encryptionContractConfiguration()
Specify the SPEKE version, either v1.0 or v2.0, that MediaConvert uses when encrypting your output. For more information, see: https://docs.aws.amazon.com/speke/latest/documentation/speke-api-specification.html To use SPEKE v1.0: Leave blank. To use SPEKE v2.0: Specify a SPEKE v2.0 video preset and a SPEKE v2.0 audio preset.- Returns:
- Specify the SPEKE version, either v1.0 or v2.0, that MediaConvert uses when encrypting your output. For more information, see: https://docs.aws.amazon.com/speke/latest/documentation/speke-api-specification.html To use SPEKE v1.0: Leave blank. To use SPEKE v2.0: Specify a SPEKE v2.0 video preset and a SPEKE v2.0 audio preset.
-
hasHlsSignaledSystemIds
public final boolean hasHlsSignaledSystemIds()
For responses, this returns true if the service returned a value for the HlsSignaledSystemIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
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.
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
hasHlsSignaledSystemIds()
method.- 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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<SpekeKeyProviderCmaf.Builder,SpekeKeyProviderCmaf>
-
builder
public static SpekeKeyProviderCmaf.Builder builder()
-
serializableBuilderClass
public static Class<? extends SpekeKeyProviderCmaf.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-