Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MediaConvert.Types.HlsEncryptionSettings

Description

Synopsis

Documentation

data HlsEncryptionSettings Source #

Settings for HLS encryption

See: newHlsEncryptionSettings smart constructor.

Constructors

HlsEncryptionSettings'

Fields

constantInitializationVector :: Maybe Text
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 :: Maybe HlsEncryptionType
Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.
initializationVectorInManifest :: Maybe HlsInitializationVectorInManifest
The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.
offlineEncrypted :: Maybe HlsOfflineEncrypted
Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection.
spekeKeyProvider :: Maybe 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.
staticKeyProvider :: Maybe StaticKeyProvider
Use these settings to set up encryption with a static key provider.
type' :: Maybe HlsKeyProviderType
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.

Instances

Instances details

FromJSON HlsEncryptionSettings Source #
Instance details Defined in Amazonka.MediaConvert.Types.HlsEncryptionSettings Methods parseJSON :: Value -> Parser HlsEncryptionSettings # parseJSONList :: Value -> Parser [HlsEncryptionSettings] #
ToJSON HlsEncryptionSettings Source #
Instance details Defined in Amazonka.MediaConvert.Types.HlsEncryptionSettings Methods toJSON :: HlsEncryptionSettings -> Value # toEncoding :: HlsEncryptionSettings -> Encoding # toJSONList :: [HlsEncryptionSettings] -> Value # toEncodingList :: [HlsEncryptionSettings] -> Encoding #
Generic HlsEncryptionSettings Source #
Instance details Defined in Amazonka.MediaConvert.Types.HlsEncryptionSettings Associated Types type Rep HlsEncryptionSettings :: Type -> Type # Methods from :: HlsEncryptionSettings -> Rep HlsEncryptionSettings x # to :: Rep HlsEncryptionSettings x -> HlsEncryptionSettings #
Read HlsEncryptionSettings Source #
Instance details Defined in Amazonka.MediaConvert.Types.HlsEncryptionSettings Methods readsPrec :: Int -> ReadS HlsEncryptionSettings # readList :: ReadS [HlsEncryptionSettings] # readPrec :: ReadPrec HlsEncryptionSettings # readListPrec :: ReadPrec [HlsEncryptionSettings] #
Show HlsEncryptionSettings Source #
Instance details Defined in Amazonka.MediaConvert.Types.HlsEncryptionSettings Methods showsPrec :: Int -> HlsEncryptionSettings -> ShowS # show :: HlsEncryptionSettings -> String # showList :: [HlsEncryptionSettings] -> ShowS #
NFData HlsEncryptionSettings Source #
Instance details Defined in Amazonka.MediaConvert.Types.HlsEncryptionSettings Methods rnf :: HlsEncryptionSettings -> () #
Eq HlsEncryptionSettings Source #
Instance details Defined in Amazonka.MediaConvert.Types.HlsEncryptionSettings Methods (==) :: HlsEncryptionSettings -> HlsEncryptionSettings -> Bool # (/=) :: HlsEncryptionSettings -> HlsEncryptionSettings -> Bool #
Hashable HlsEncryptionSettings Source #
Instance details Defined in Amazonka.MediaConvert.Types.HlsEncryptionSettings Methods hashWithSalt :: Int -> HlsEncryptionSettings -> Int # hash :: HlsEncryptionSettings -> Int #
type Rep HlsEncryptionSettings Source #
Instance details Defined in Amazonka.MediaConvert.Types.HlsEncryptionSettings type Rep HlsEncryptionSettings = D1 ('MetaData "HlsEncryptionSettings" "Amazonka.MediaConvert.Types.HlsEncryptionSettings" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "HlsEncryptionSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "constantInitializationVector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "encryptionMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HlsEncryptionType)) :: S1 ('MetaSel ('Just "initializationVectorInManifest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HlsInitializationVectorInManifest)))) :: ((S1 ('MetaSel ('Just "offlineEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HlsOfflineEncrypted)) :: S1 ('MetaSel ('Just "spekeKeyProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SpekeKeyProvider))) :: (S1 ('MetaSel ('Just "staticKeyProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StaticKeyProvider)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HlsKeyProviderType))))))

newHlsEncryptionSettings :: HlsEncryptionSettings Source #

Create a value of HlsEncryptionSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:constantInitializationVector:HlsEncryptionSettings', hlsEncryptionSettings_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.

$sel:encryptionMethod:HlsEncryptionSettings', hlsEncryptionSettings_encryptionMethod - Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.

$sel:initializationVectorInManifest:HlsEncryptionSettings', hlsEncryptionSettings_initializationVectorInManifest - The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.

$sel:offlineEncrypted:HlsEncryptionSettings', hlsEncryptionSettings_offlineEncrypted - Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection.

$sel:spekeKeyProvider:HlsEncryptionSettings', hlsEncryptionSettings_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.

$sel:staticKeyProvider:HlsEncryptionSettings', hlsEncryptionSettings_staticKeyProvider - Use these settings to set up encryption with a static key provider.

$sel:type':HlsEncryptionSettings', hlsEncryptionSettings_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.

hlsEncryptionSettings_constantInitializationVector :: Lens' HlsEncryptionSettings (Maybe Text) Source #

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.

hlsEncryptionSettings_encryptionMethod :: Lens' HlsEncryptionSettings (Maybe HlsEncryptionType) Source #

Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.

hlsEncryptionSettings_initializationVectorInManifest :: Lens' HlsEncryptionSettings (Maybe HlsInitializationVectorInManifest) Source #

The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.

hlsEncryptionSettings_offlineEncrypted :: Lens' HlsEncryptionSettings (Maybe HlsOfflineEncrypted) Source #

Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection.

hlsEncryptionSettings_spekeKeyProvider :: Lens' HlsEncryptionSettings (Maybe SpekeKeyProvider) Source #

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.

hlsEncryptionSettings_staticKeyProvider :: Lens' HlsEncryptionSettings (Maybe StaticKeyProvider) Source #

Use these settings to set up encryption with a static key provider.

hlsEncryptionSettings_type :: Lens' HlsEncryptionSettings (Maybe HlsKeyProviderType) Source #

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.