Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MediaConnect.Types.Encryption

Description

Synopsis

data Encryption = Encryption' {
- keyType :: Maybe KeyType
- resourceId :: Maybe Text
- url :: Maybe Text
- algorithm :: Maybe Algorithm
- constantInitializationVector :: Maybe Text
- deviceId :: Maybe Text
- region :: Maybe Text
- secretArn :: Maybe Text
- roleArn :: Text
}
newEncryption :: Text -> Encryption
encryption_keyType :: Lens' Encryption (Maybe KeyType)
encryption_resourceId :: Lens' Encryption (Maybe Text)
encryption_url :: Lens' Encryption (Maybe Text)
encryption_algorithm :: Lens' Encryption (Maybe Algorithm)
encryption_constantInitializationVector :: Lens' Encryption (Maybe Text)
encryption_deviceId :: Lens' Encryption (Maybe Text)
encryption_region :: Lens' Encryption (Maybe Text)
encryption_secretArn :: Lens' Encryption (Maybe Text)
encryption_roleArn :: Lens' Encryption Text

Documentation

data Encryption Source #

Information about the encryption of the flow.

See: newEncryption smart constructor.

Constructors

Encryption'

Fields

keyType :: Maybe KeyType
The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
resourceId :: Maybe Text
An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
url :: Maybe Text
The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
algorithm :: Maybe Algorithm
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
constantInitializationVector :: Maybe Text
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
deviceId :: Maybe Text
The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
region :: Maybe Text
The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
secretArn :: Maybe Text
The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
roleArn :: Text
The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

Instances

Instances details

Eq Encryption Source #
Instance details Defined in Amazonka.MediaConnect.Types.Encryption Methods (==) :: Encryption -> Encryption -> Bool # (/=) :: Encryption -> Encryption -> Bool #
Read Encryption Source #
Instance details Defined in Amazonka.MediaConnect.Types.Encryption Methods readsPrec :: Int -> ReadS Encryption # readList :: ReadS [Encryption] # readPrec :: ReadPrec Encryption # readListPrec :: ReadPrec [Encryption] #
Show Encryption Source #
Instance details Defined in Amazonka.MediaConnect.Types.Encryption Methods showsPrec :: Int -> Encryption -> ShowS # show :: Encryption -> String # showList :: [Encryption] -> ShowS #
Generic Encryption Source #
Instance details Defined in Amazonka.MediaConnect.Types.Encryption Associated Types type Rep Encryption :: Type -> Type # Methods from :: Encryption -> Rep Encryption x # to :: Rep Encryption x -> Encryption #
NFData Encryption Source #
Instance details Defined in Amazonka.MediaConnect.Types.Encryption Methods rnf :: Encryption -> () #
Hashable Encryption Source #
Instance details Defined in Amazonka.MediaConnect.Types.Encryption Methods hashWithSalt :: Int -> Encryption -> Int # hash :: Encryption -> Int #
ToJSON Encryption Source #
Instance details Defined in Amazonka.MediaConnect.Types.Encryption Methods toJSON :: Encryption -> Value # toEncoding :: Encryption -> Encoding # toJSONList :: [Encryption] -> Value # toEncodingList :: [Encryption] -> Encoding #
FromJSON Encryption Source #
Instance details Defined in Amazonka.MediaConnect.Types.Encryption Methods parseJSON :: Value -> Parser Encryption # parseJSONList :: Value -> Parser [Encryption] #
type Rep Encryption Source #
Instance details Defined in Amazonka.MediaConnect.Types.Encryption type Rep Encryption = D1 ('MetaData "Encryption" "Amazonka.MediaConnect.Types.Encryption" "libZSservicesZSamazonka-mediaconnectZSamazonka-mediaconnect" 'False) (C1 ('MetaCons "Encryption'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "keyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyType)) :: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "algorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Algorithm)))) :: ((S1 ('MetaSel ('Just "constantInitializationVector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newEncryption Source #

Arguments

:: Text	`$sel:roleArn:Encryption'`
-> Encryption

Create a value of Encryption 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:keyType:Encryption', encryption_keyType - The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

$sel:resourceId:Encryption', encryption_resourceId - An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.

$sel:url:Encryption', encryption_url - The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

$sel:algorithm:Encryption', encryption_algorithm - The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

$sel:constantInitializationVector:Encryption', encryption_constantInitializationVector - A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.

$sel:deviceId:Encryption', encryption_deviceId - The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.

$sel:region:Encryption', encryption_region - The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.

$sel:secretArn:Encryption', encryption_secretArn - The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.

$sel:roleArn:Encryption', encryption_roleArn - The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

encryption_keyType :: Lens' Encryption (Maybe KeyType) Source #

The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

encryption_resourceId :: Lens' Encryption (Maybe Text) Source #

An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.

encryption_url :: Lens' Encryption (Maybe Text) Source #

The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

encryption_algorithm :: Lens' Encryption (Maybe Algorithm) Source #

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

encryption_constantInitializationVector :: Lens' Encryption (Maybe Text) Source #

A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.

encryption_deviceId :: Lens' Encryption (Maybe Text) Source #

The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.

encryption_region :: Lens' Encryption (Maybe Text) Source #

The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.

encryption_secretArn :: Lens' Encryption (Maybe Text) Source #

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.

encryption_roleArn :: Lens' Encryption Text Source #

The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).