Class CfnFlowEntitlement.EncryptionProperty

Information about the encryption of the flow.

Inheritance
object
CfnFlowEntitlement.EncryptionProperty
Inherited Members
Namespace: Amazon.CDK.AWS.MediaConnect
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFlowEntitlement.EncryptionProperty : CfnFlowEntitlement.IEncryptionProperty
Syntax (vb)
Public Class CfnFlowEntitlement.EncryptionProperty Implements CfnFlowEntitlement.IEncryptionProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.MediaConnect;

             var encryptionProperty = new EncryptionProperty {
                 Algorithm = "algorithm",
                 RoleArn = "roleArn",

                 // the properties below are optional
                 ConstantInitializationVector = "constantInitializationVector",
                 DeviceId = "deviceId",
                 KeyType = "keyType",
                 Region = "region",
                 ResourceId = "resourceId",
                 SecretArn = "secretArn",
                 Url = "url"
             };

Synopsis

Constructors

EncryptionProperty()

Information about the encryption of the flow.

Properties

Algorithm

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

A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content.
DeviceId

The value of one of the devices that you configured with your digital rights management (DRM) platform key provider.
KeyType

The type of key that is used for the encryption.
Region

The AWS Region that the API Gateway proxy endpoint was created in.
ResourceId

An identifier for the content.
RoleArn

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

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

The URL from the API Gateway proxy that you set up to talk to your key server.

Constructors

EncryptionProperty()

Information about the encryption of the flow.

public EncryptionProperty()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.MediaConnect;

             var encryptionProperty = new EncryptionProperty {
                 Algorithm = "algorithm",
                 RoleArn = "roleArn",

                 // the properties below are optional
                 ConstantInitializationVector = "constantInitializationVector",
                 DeviceId = "deviceId",
                 KeyType = "keyType",
                 Region = "region",
                 ResourceId = "resourceId",
                 SecretArn = "secretArn",
                 Url = "url"
             };

Properties

Algorithm

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

public string Algorithm { get; set; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-algorithm

ConstantInitializationVector

A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content.

public string? ConstantInitializationVector { get; set; }
Property Value

string

Remarks

This parameter is not valid for static key encryption.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-constantinitializationvector

DeviceId

The value of one of the devices that you configured with your digital rights management (DRM) platform key provider.

public string? DeviceId { get; set; }
Property Value

string

Remarks

This parameter is required for SPEKE encryption and is not valid for static key encryption.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-deviceid

KeyType

The type of key that is used for the encryption.

public string? KeyType { get; set; }
Property Value

string

Remarks

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 .

Default: - "static-key"

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-keytype

Region

The AWS Region that the API Gateway proxy endpoint was created in.

public string? Region { get; set; }
Property Value

string

Remarks

This parameter is required for SPEKE encryption and is not valid for static key encryption.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-region

ResourceId

An identifier for the content.

public string? ResourceId { get; set; }
Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-resourceid

RoleArn

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

public string RoleArn { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-rolearn

SecretArn

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

public string? SecretArn { get; set; }
Property Value

string

Remarks

This parameter is required for static key encryption and is not valid for SPEKE encryption.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-secretarn

Url

The URL from the API Gateway proxy that you set up to talk to your key server.

public string? Url { get; set; }
Property Value

string

Remarks

This parameter is required for SPEKE encryption and is not valid for static key encryption.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowentitlement-encryption.html#cfn-mediaconnect-flowentitlement-encryption-url

Implements