Interface CfnFlowSource.IEncryptionProperty
Information about the encryption of the flow.
Namespace: Amazon.CDK.AWS.MediaConnect
Assembly: Amazon.CDK.AWS.MediaConnect.dll
Syntax (csharp)
public interface IEncryptionProperty
Syntax (vb)
Public Interface IEncryptionProperty
Remarks
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 {
RoleArn = "roleArn",
// the properties below are optional
Algorithm = "algorithm",
ConstantInitializationVector = "constantInitializationVector",
DeviceId = "deviceId",
KeyType = "keyType",
Region = "region",
ResourceId = "resourceId",
SecretArn = "secretArn",
Url = "url"
};
Synopsis
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 Amazon Resource Name (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. |
Properties
Algorithm
The type of algorithm that is used for static key encryption (such as aes128, aes192, or aes256).
virtual string Algorithm { get; }
Property Value
System.String
Remarks
If you are using SPEKE or SRT-password encryption, this property must be left blank.
ConstantInitializationVector
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content.
virtual string ConstantInitializationVector { get; }
Property Value
System.String
Remarks
This parameter is not valid for static key encryption.
DeviceId
The value of one of the devices that you configured with your digital rights management (DRM) platform key provider.
virtual string DeviceId { get; }
Property Value
System.String
Remarks
This parameter is required for SPEKE encryption and is not valid for static key encryption.
KeyType
The type of key that is used for the encryption.
virtual string KeyType { get; }
Property Value
System.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
.
Region
The AWS Region that the API Gateway proxy endpoint was created in.
virtual string Region { get; }
Property Value
System.String
Remarks
This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId
An identifier for the content.
virtual string ResourceId { get; }
Property Value
System.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.
RoleArn
The Amazon Resource Name (ARN) of the role that you created during setup (when you set up MediaConnect as a trusted entity).
string RoleArn { get; }
Property Value
System.String
Remarks
SecretArn
The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
virtual string SecretArn { get; }
Property Value
System.String
Remarks
Url
The URL from the API Gateway proxy that you set up to talk to your key server.
virtual string Url { get; }
Property Value
System.String
Remarks
This parameter is required for SPEKE encryption and is not valid for static key encryption.