software.amazon.awscdk.services.mediaconnect

Interface CfnFlowSource.EncryptionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlowSource.EncryptionProperty.Jsii$Proxy

Enclosing class:

CfnFlowSource

@Stability(value=Stable)
public static interface CfnFlowSource.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()
         .algorithm("algorithm")
         .roleArn("roleArn")
         // the properties below are optional
         .constantInitializationVector("constantInitializationVector")
         .deviceId("deviceId")
         .keyType("keyType")
         .region("region")
         .resourceId("resourceId")
         .secretArn("secretArn")
         .url("url")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnFlowSource.EncryptionProperty.Builder	builder()
String	getAlgorithm() The type of algorithm that is used for the 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 Detail

getAlgorithm

@Stability(value=Stable)
 @NotNull
String getAlgorithm()

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

getRoleArn

@Stability(value=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).

getConstantInitializationVector

@Stability(value=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.

getDeviceId

@Stability(value=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.

getKeyType

@Stability(value=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 ).

getRegion

@Stability(value=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.

getResourceId

@Stability(value=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.

getSecretArn

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

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

getUrl

@Stability(value=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.

builder

@Stability(value=Stable)
static CfnFlowSource.EncryptionProperty.Builder builder()

Returns:

a CfnFlowSource.EncryptionProperty.Builder of CfnFlowSource.EncryptionProperty