Package software.amazon.awscdk.services.mediaconnect

Interface CfnFlow.EncryptionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.EncryptionProperty.Jsii$Proxy

Enclosing class:

CfnFlow

@Stability(Stable)
public static interface CfnFlow.EncryptionProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.mediaconnect.*;
 EncryptionProperty encryptionProperty = EncryptionProperty.builder()
         .roleArn("roleArn")
         // the properties below are optional
         .algorithm("algorithm")
         .constantInitializationVector("constantInitializationVector")
         .deviceId("deviceId")
         .keyType("keyType")
         .region("region")
         .resourceId("resourceId")
         .secretArn("secretArn")
         .url("url")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFlow.EncryptionProperty.Builder	A builder for CfnFlow.EncryptionProperty
static final class	CfnFlow.EncryptionProperty.Jsii$Proxy	An implementation for CfnFlow.EncryptionProperty

Method Summary

Modifier and Type	Method	Description
static CfnFlow.EncryptionProperty.Builder	builder()
default String	getAlgorithm()	The type of algorithm that is used for static key encryption (such as aes128, aes192, or aes256).
default String	getConstantInitializationVector()	A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content.
default String	getDeviceId()	The value of one of the devices that you configured with your digital rights management (DRM) platform key provider.
default String	getKeyType()	The type of key that is used for the encryption.
default String	getRegion()	The AWS Region that the API Gateway proxy endpoint was created in.
default String	getResourceId()	An identifier for the content.
String	getRoleArn()	The Amazon Resource Name (ARN) of the role that you created during setup (when you set up MediaConnect as a trusted entity).
default String	getSecretArn()	The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
default String	getUrl()	The URL from the API Gateway proxy that you set up to talk to your key server.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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

See Also:

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

getAlgorithm

@Stability(Stable)
@Nullable
default String getAlgorithm()

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.

See Also:

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

getConstantInitializationVector

@Stability(Stable)
@Nullable
default String getConstantInitializationVector()

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.

See Also:

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

getDeviceId

@Stability(Stable)
@Nullable
default String getDeviceId()

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.

See Also:

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

getKeyType

@Stability(Stable)
@Nullable
default String getKeyType()

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 .

Default: - "static-key"

See Also:

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

getRegion

@Stability(Stable)
@Nullable
default String getRegion()

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.

See Also:

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

getResourceId

@Stability(Stable)
@Nullable
default String getResourceId()

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.

See Also:

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

getSecretArn

@Stability(Stable)
@Nullable
default String getSecretArn()

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

See Also:

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

getUrl

@Stability(Stable)
@Nullable
default String getUrl()

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.

See Also:

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

builder

@Stability(Stable)
static CfnFlow.EncryptionProperty.Builder builder()

Returns:

a CfnFlow.EncryptionProperty.Builder of CfnFlow.EncryptionProperty