java.lang.Object
- software.amazon.awssdk.services.mediaconvert.model.CmafEncryptionSettings

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<CmafEncryptionSettings.Builder,CmafEncryptionSettings>

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

Settings for CMAF encryption

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CmafEncryptionSettings.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CmafEncryptionSettings.Builder`	`builder()`
`String`	`constantInitializationVector()`	This is a 128-bit, 16-byte hex value represented by a 32-character text string.
`CmafEncryptionType`	`encryptionMethod()`	Specify the encryption scheme that you want the service to use when encrypting your CMAF segments.
`String`	`encryptionMethodAsString()`	Specify the encryption scheme that you want the service to use when encrypting your CMAF segments.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`CmafInitializationVectorInManifest`	`initializationVectorInManifest()`	When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests.
`String`	`initializationVectorInManifestAsString()`	When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CmafEncryptionSettings.Builder>`	`serializableBuilderClass()`
`SpekeKeyProviderCmaf`	`spekeKeyProvider()`	If your output group type is CMAF, use these settings when doing DRM encryption with a SPEKE-compliant key provider.
`StaticKeyProvider`	`staticKeyProvider()`	Use these settings to set up encryption with a static key provider.
`CmafEncryptionSettings.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`CmafKeyProviderType`	`type()`	Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard.
`String`	`typeAsString()`	Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard.

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
  - constantInitializationVector
```
public final String constantInitializationVector()
```
    This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default.
    
    Returns:
    
    This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default.
  - encryptionMethod
```
public final CmafEncryptionType encryptionMethod()
```
    Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample or AES_CTR.
    If the service returns an enum value that is not available in the current SDK version, encryptionMethod will return CmafEncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionMethodAsString().
    
    Returns:
    
    Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample or AES_CTR.
    
    See Also:
    
    CmafEncryptionType
  - encryptionMethodAsString
```
public final String encryptionMethodAsString()
```
    Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample or AES_CTR.
    If the service returns an enum value that is not available in the current SDK version, encryptionMethod will return CmafEncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionMethodAsString().
    
    Returns:
    
    Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample or AES_CTR.
    
    See Also:
    
    CmafEncryptionType
  - initializationVectorInManifest
```
public final CmafInitializationVectorInManifest initializationVectorInManifest()
```
    When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests.
    If the service returns an enum value that is not available in the current SDK version, initializationVectorInManifest will return CmafInitializationVectorInManifest.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from initializationVectorInManifestAsString().
    
    Returns:
    
    When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests.
    
    See Also:
    
    CmafInitializationVectorInManifest
  - initializationVectorInManifestAsString
```
public final String initializationVectorInManifestAsString()
```
    When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests.
    If the service returns an enum value that is not available in the current SDK version, initializationVectorInManifest will return CmafInitializationVectorInManifest.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from initializationVectorInManifestAsString().
    
    Returns:
    
    When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests.
    
    See Also:
    
    CmafInitializationVectorInManifest
  - spekeKeyProvider
```
public final SpekeKeyProviderCmaf spekeKeyProvider()
```
    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.
    
    Returns:
    
    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.
  - staticKeyProvider
```
public final StaticKeyProvider staticKeyProvider()
```
    Use these settings to set up encryption with a static key provider.
    
    Returns:
    
    Use these settings to set up encryption with a static key provider.
  - type
```
public final CmafKeyProviderType type()
```
    Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.
    If the service returns an enum value that is not available in the current SDK version, type will return CmafKeyProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.
    
    See Also:
    
    CmafKeyProviderType
  - typeAsString
```
public final String typeAsString()
```
    Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.
    If the service returns an enum value that is not available in the current SDK version, type will return CmafKeyProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.
    
    See Also:
    
    CmafKeyProviderType
  - toBuilder
```
public CmafEncryptionSettings.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CmafEncryptionSettings.Builder,CmafEncryptionSettings>
  - builder
```
public static CmafEncryptionSettings.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CmafEncryptionSettings.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CmafEncryptionSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

constantInitializationVector

encryptionMethod

encryptionMethodAsString

initializationVectorInManifest

initializationVectorInManifestAsString

spekeKeyProvider

staticKeyProvider

type

typeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField