interface EncryptionProperty

Language	Type name
.NET	`Amazon.CDK.AWS.MediaConnect.CfnFlow.EncryptionProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmediaconnect#CfnFlow_EncryptionProperty`
Java	`software.amazon.awscdk.services.mediaconnect.CfnFlow.EncryptionProperty`
Python	`aws_cdk.aws_mediaconnect.CfnFlow.EncryptionProperty`
TypeScript	`aws-cdk-lib` » `aws_mediaconnect` » `CfnFlow` » `EncryptionProperty`

Information about the encryption of the flow.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediaconnect as mediaconnect } from 'aws-cdk-lib';
const encryptionProperty: mediaconnect.CfnFlow.EncryptionProperty = {
  roleArn: 'roleArn',

  // the properties below are optional
  algorithm: 'algorithm',
  constantInitializationVector: 'constantInitializationVector',
  deviceId: 'deviceId',
  keyType: 'keyType',
  region: 'region',
  resourceId: 'resourceId',
  secretArn: 'secretArn',
  url: 'url',
};

Properties

Name	Type	Description
roleArn	`string`	The Amazon Resource Name (ARN) of the role that you created during setup (when you set up MediaConnect as a trusted entity).
algorithm?	`string`	The type of algorithm that is used for static key encryption (such as aes128, aes192, or aes256).
constantInitializationVector?	`string`	A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content.
deviceId?	`string`	The value of one of the devices that you configured with your digital rights management (DRM) platform key provider.
keyType?	`string`	The type of key that is used for the encryption.
region?	`string`	The AWS Region that the API Gateway proxy endpoint was created in.
resourceId?	`string`	An identifier for the content.
secretArn?	`string`	The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
url?	`string`	The URL from the API Gateway proxy that you set up to talk to your key server.

roleArn

Type: string

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

algorithm?

Type: string (optional)

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

If you are using SPEKE or SRT-password encryption, this property must be left blank.

constantInitializationVector?

Type: string (optional)

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?

Type: string (optional)

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.

keyType?

Type: string (optional, default: "static-key")

The type of key that is used for the encryption.

If you don't specify a keyType value, the service uses the default setting ( static-key ). Valid key types are: static-key , speke , and srt-password .

region?

Type: string (optional)

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.

resourceId?

Type: string (optional)

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.

secretArn?

Type: string (optional)

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.

url?

Type: string (optional)

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.