Skip to content
v2.278.0

EncryptionProperty Struct ​

Encryption information.

Example ​

ts
// 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.CfnFlowOutput.EncryptionProperty = {
  roleArn: 'roleArn',
  secretArn: 'secretArn',

  // the properties below are optional
  algorithm: 'algorithm',
  keyType: 'keyType',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediaconnect as mediaconnect

encryption_property = mediaconnect.CfnFlowOutput.EncryptionProperty(
    role_arn="roleArn",
    secret_arn="secretArn",

    # the properties below are optional
    algorithm="algorithm",
    key_type="keyType"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.mediaconnect.*;

EncryptionProperty encryptionProperty = EncryptionProperty.builder()
        .roleArn("roleArn")
        .secretArn("secretArn")

        // the properties below are optional
        .algorithm("algorithm")
        .keyType("keyType")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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",
    SecretArn = "secretArn",

    // the properties below are optional
    Algorithm = "algorithm",
    KeyType = "keyType"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

encryptionProperty := &EncryptionProperty{
	RoleArn: jsii.String("roleArn"),
	SecretArn: jsii.String("secretArn"),

	// the properties below are optional
	Algorithm: jsii.String("algorithm"),
	KeyType: jsii.String("keyType"),
}

Properties ​

algorithmoptionalstringalgorithmoptionalstralgorithmoptionalStringAlgorithmoptionalstringAlgorithmoptional*string #
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.

keyTypeoptionalstringkey_typeoptionalstrkeyTypeoptionalStringKeyTypeoptionalstringKeyTypeoptional*string = "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 .

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*string required #
The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
secretArnstringsecret_arnstrsecretArnStringSecretArnstringSecretArn*string required #
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.