Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-mediaconnect-flowsource.json
Parent schema serverless-framework-configuration
Type: object

Properties

Description string | Aws_CF_FunctionString required

A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

Name string | Aws_CF_FunctionString required

The name of the source.

FlowArn string | Aws_CF_FunctionString

The ARN of the flow.

Decryption object

Information about the encryption of the flow.

9 nested properties
RoleArn string | Aws_CF_FunctionString required

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

Algorithm string | Aws_CF_FunctionString

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

ConstantInitializationVector string | Aws_CF_FunctionString

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.

DeviceId string | Aws_CF_FunctionString

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.

KeyType string | Aws_CF_FunctionString

The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

Region string | Aws_CF_FunctionString

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.

ResourceId string | Aws_CF_FunctionString

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.

SecretArn string | Aws_CF_FunctionString

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.

Url string | Aws_CF_FunctionString

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.

EntitlementArn string | Aws_CF_FunctionString

The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.

IngestPort integer

The port that the flow will be listening on for incoming content.

MaxBitrate integer

The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.

MaxLatency integer

The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.

Default: 2000
MinLatency integer

The minimum latency in milliseconds.

Default: 2000
Protocol string | Aws_CF_FunctionString

The protocol that is used by the source.

SenderIpAddress string | Aws_CF_FunctionString

The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.

SenderControlPort integer

The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.

StreamId string | Aws_CF_FunctionString

The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.

SourceListenerAddress string | Aws_CF_FunctionString

Source IP or domain name for SRT-caller protocol.

SourceListenerPort integer

Source port for SRT-caller protocol.

VpcInterfaceName string | Aws_CF_FunctionString

The name of the VPC Interface this Source is configured with.

WhitelistCidr string | Aws_CF_FunctionString

The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

Definitions

Encryption object

Information about the encryption of the flow.

RoleArn string | Aws_CF_FunctionString required

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

Algorithm string | Aws_CF_FunctionString

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

ConstantInitializationVector string | Aws_CF_FunctionString

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.

DeviceId string | Aws_CF_FunctionString

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.

KeyType string | Aws_CF_FunctionString

The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

Region string | Aws_CF_FunctionString

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.

ResourceId string | Aws_CF_FunctionString

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.

SecretArn string | Aws_CF_FunctionString

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.

Url string | Aws_CF_FunctionString

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.