1.204.0

interface SourceProperty

LanguageType name
.NETAmazon.CDK.AWS.MediaConnect.CfnFlow.SourceProperty
Javasoftware.amazon.awscdk.services.mediaconnect.CfnFlow.SourceProperty
Pythonaws_cdk.aws_mediaconnect.CfnFlow.SourceProperty
TypeScript @aws-cdk/aws-mediaconnect » CfnFlow » SourceProperty

The details of the sources of the flow.

If you are creating a flow with a VPC source, you must first create the flow with a temporary standard source by doing the following:

  • Use CloudFormation to create a flow with a standard source that uses the flow’s public IP address.
  • Use CloudFormation to create the VPC interface to add to this flow. This can also be done as part of the previous step.
  • After CloudFormation has created the flow and the VPC interface, update the source to point to the VPC interface that you created.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as mediaconnect from '@aws-cdk/aws-mediaconnect';
const sourceProperty: mediaconnect.CfnFlow.SourceProperty = {
  decryption: {
    roleArn: 'roleArn',

    // the properties below are optional
    algorithm: 'algorithm',
    constantInitializationVector: 'constantInitializationVector',
    deviceId: 'deviceId',
    keyType: 'keyType',
    region: 'region',
    resourceId: 'resourceId',
    secretArn: 'secretArn',
    url: 'url',
  },
  description: 'description',
  entitlementArn: 'entitlementArn',
  ingestIp: 'ingestIp',
  ingestPort: 123,
  maxBitrate: 123,
  maxLatency: 123,
  minLatency: 123,
  name: 'name',
  protocol: 'protocol',
  senderControlPort: 123,
  senderIpAddress: 'senderIpAddress',
  sourceArn: 'sourceArn',
  sourceIngestPort: 'sourceIngestPort',
  sourceListenerAddress: 'sourceListenerAddress',
  sourceListenerPort: 123,
  streamId: 'streamId',
  vpcInterfaceName: 'vpcInterfaceName',
  whitelistCidr: 'whitelistCidr',
};

Properties

NameTypeDescription
decryption?IResolvable | EncryptionPropertyThe type of encryption that is used on the content ingested from the source.
description?stringA description of the source.
entitlementArn?stringThe ARN of the entitlement that allows you to subscribe to content that comes from another AWS account.
ingestIp?stringThe IP address that the flow listens on for incoming content.
ingestPort?numberThe port that the flow listens on for incoming content.
maxBitrate?numberThe maximum bitrate for RIST, RTP, and RTP-FEC streams.
maxLatency?numberThe maximum latency in milliseconds for a RIST or Zixi-based source.
minLatency?numberThe minimum latency in milliseconds for SRT-based streams.
name?stringThe name of the source.
protocol?stringThe protocol that is used by the source.
senderControlPort?numberThe port that the flow uses to send outbound requests to initiate connection with the sender.
senderIpAddress?stringThe IP address that the flow communicates with to initiate connection with the sender.
sourceArn?stringThe ARN of the source.
sourceIngestPort?stringThe port that the flow will be listening on for incoming content.
sourceListenerAddress?stringSource IP or domain name for SRT-caller protocol.
sourceListenerPort?numberSource port for SRT-caller protocol.
streamId?stringThe stream ID that you want to use for the transport.
vpcInterfaceName?stringThe name of the VPC interface that the source content comes from.
whitelistCidr?stringThe range of IP addresses that are allowed to contribute content to your source.

decryption?

Type: IResolvable | EncryptionProperty (optional)

The type of encryption that is used on the content ingested from the source.

description?

Type: string (optional)

A description of the source.

This description is not visible outside of the current AWS account.

entitlementArn?

Type: string (optional)

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.

ingestIp?

Type: string (optional)

The IP address that the flow listens on for incoming content.

ingestPort?

Type: number (optional)

The port that the flow listens on for incoming content.

If the protocol of the source is Zixi, the port must be set to 2088.

maxBitrate?

Type: number (optional)

The maximum bitrate for RIST, RTP, and RTP-FEC streams.

maxLatency?

Type: number (optional)

The maximum latency in milliseconds for a RIST or Zixi-based source.

minLatency?

Type: number (optional)

The minimum latency in milliseconds for SRT-based streams.

In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.

name?

Type: string (optional)

The name of the source.

protocol?

Type: string (optional)

The protocol that is used by the source.

AWS CloudFormation does not currently support CDI or ST 2110 JPEG XS source protocols.

senderControlPort?

Type: number (optional)

The port that the flow uses to send outbound requests to initiate connection with the sender.

senderIpAddress?

Type: string (optional)

The IP address that the flow communicates with to initiate connection with the sender.

sourceArn?

Type: string (optional)

The ARN of the source.

sourceIngestPort?

Type: string (optional)

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

sourceListenerAddress?

Type: string (optional)

Source IP or domain name for SRT-caller protocol.

sourceListenerPort?

Type: number (optional)

Source port for SRT-caller protocol.

streamId?

Type: string (optional)

The stream ID that you want to use for the transport.

This parameter applies only to Zixi-based streams.

vpcInterfaceName?

Type: string (optional)

The name of the VPC interface that the source content comes from.

whitelistCidr?

Type: string (optional)

The range of IP addresses that are allowed to contribute content to your source.

Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

← PreviousNext →