This product is not supported for your selected
Datadog site. (
).
This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project,
feel free to reach out to us!account_id
Type: STRING
flow
Type: STRUCT
Provider name: Flow
Description: The flow that you requested a description of.
availability_zone
Type: STRING
Provider name: AvailabilityZone
Description: The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region.
description
Type: STRING
Provider name: Description
Description: A description of the flow. This value is not used or seen outside of the current MediaConnect account.
egress_ip
Type: STRING
Provider name: EgressIp
Description: The IP address from which video will be sent to output destinations.
entitlements
Type: UNORDERED_LIST_STRUCT
Provider name: Entitlements
Description: The entitlements in this flow.
data_transfer_subscriber_fee_percent
Type: INT32
Provider name: DataTransferSubscriberFeePercent
Description: Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
description
Type: STRING
Provider name: Description
Description: A description of the entitlement.
encryption
Type: STRUCT
Provider name: Encryption
Description: The type of encryption that will be used on the output that is associated with this entitlement.
algorithm
Type: STRING
Provider name: Algorithm
Description: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
constant_initialization_vector
Type: STRING
Provider name: ConstantInitializationVector
Description: 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.
device_id
Type: STRING
Provider name: DeviceId
Description: 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.
key_type
Type: STRING
Provider name: KeyType
Description: 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
Type: STRING
Provider name: Region
Description: The Amazon Web Services 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.
resource_id
Type: STRING
Provider name: ResourceId
Description: 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.
role_arn
Type: STRING
Provider name: RoleArn
Description: The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
secret_arn
Type: STRING
Provider name: SecretArn
Description: The ARN of the secret that you created in Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
url
Type: STRING
Provider name: Url
Description: 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.
entitlement_arn
Type: STRING
Provider name: EntitlementArn
Description: The ARN of the entitlement.
entitlement_status
Type: STRING
Provider name: EntitlementStatus
Description: An indication of whether the entitlement is enabled.
name
Type: STRING
Provider name: Name
Description: The name of the entitlement.
subscribers
Type: UNORDERED_LIST_STRING
Provider name: Subscribers
Description: The Amazon Web Services account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
flow_arn
Type: STRING
Provider name: FlowArn
Description: The Amazon Resource Name (ARN) of the flow.
flow_size
Type: STRING
Provider name: FlowSize
Description: Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.
maintenance
Type: STRUCT
Provider name: Maintenance
Description: The maintenance settings for the flow.
maintenance_day
Type: STRING
Provider name: MaintenanceDay
Description: A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
maintenance_deadline
Type: STRING
Provider name: MaintenanceDeadline
Description: The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
maintenance_scheduled_date
Type: STRING
Provider name: MaintenanceScheduledDate
Description: A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
maintenance_start_hour
Type: STRING
Provider name: MaintenanceStartHour
Description: UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
media_streams
Type: UNORDERED_LIST_STRUCT
Provider name: MediaStreams
Description: The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
attributes
Type: STRUCT
Provider name: Attributes
Description: Attributes that are related to the media stream.
fmtp
Type: STRUCT
Provider name: Fmtp
Description: The settings that you want to use to define the media stream.
channel_order
Type: STRING
Provider name: ChannelOrder
Description: The format of the audio channel.
colorimetry
Type: STRING
Provider name: Colorimetry
Description: The format used for the representation of color.
exact_framerate
Type: STRING
Provider name: ExactFramerate
Description: The frame rate for the video stream, in frames/second. For example: 60000/1001.
par
Type: STRING
Provider name: Par
Description: The pixel aspect ratio (PAR) of the video.
range
Type: STRING
Provider name: Range
Description: The encoding range of the video.
scan_mode
Type: STRING
Provider name: ScanMode
Description: The type of compression that was used to smooth the video’s appearance.
tcs
Type: STRING
Provider name: Tcs
Description: The transfer characteristic system (TCS) that is used in the video.
lang
Type: STRING
Provider name: Lang
Description: The audio language, in a format that is recognized by the receiver.
clock_rate
Type: INT32
Provider name: ClockRate
Description: The sample rate for the stream. This value is measured in Hz.
description
Type: STRING
Provider name: Description
Description: A description that can help you quickly identify what your media stream is used for.
fmt
Type: INT32
Provider name: Fmt
Description: The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
media_stream_id
Type: INT32
Provider name: MediaStreamId
Description: A unique identifier for the media stream.
media_stream_name
Type: STRING
Provider name: MediaStreamName
Description: A name that helps you distinguish one media stream from another.
media_stream_type
Type: STRING
Provider name: MediaStreamType
Description: The type of media stream.
video_format
Type: STRING
Provider name: VideoFormat
Description: The resolution of the video.
name
Type: STRING
Provider name: Name
Description: The name of the flow.
ndi_config
Type: STRUCT
Provider name: NdiConfig
Description: Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
machine_name
Type: STRING
Provider name: MachineName
Description: A prefix for the names of the NDI sources that the flow creates. If a custom name isn’t specified, MediaConnect generates a unique 12-character ID as the prefix.
ndi_discovery_servers
Type: UNORDERED_LIST_STRUCT
Provider name: NdiDiscoveryServers
Description: A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly.
discovery_server_address
Type: STRING
Provider name: DiscoveryServerAddress
Description: The unique network address of the NDI discovery server.
discovery_server_port
Type: INT32
Provider name: DiscoveryServerPort
Description: The port for the NDI discovery server. Defaults to 5959 if a custom port isn’t specified.
vpc_interface_adapter
Type: STRING
Provider name: VpcInterfaceAdapter
Description: The identifier for the Virtual Private Cloud (VPC) network interface used by the flow.
ndi_state
Type: STRING
Provider name: NdiState
Description: A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED.
outputs
Type: UNORDERED_LIST_STRUCT
Provider name: Outputs
Description: The outputs in this flow.
bridge_arn
Type: STRING
Provider name: BridgeArn
Description: The ARN of the bridge added to this output.
bridge_ports
Type: UNORDERED_LIST_INT32
Provider name: BridgePorts
Description: The bridge output ports currently in use.
data_transfer_subscriber_fee_percent
Type: INT32
Provider name: DataTransferSubscriberFeePercent
Description: Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
description
Type: STRING
Provider name: Description
Description: A description of the output.
destination
Type: STRING
Provider name: Destination
Description: The address where you want to send the output.
encryption
Type: STRUCT
Provider name: Encryption
Description: The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
algorithm
Type: STRING
Provider name: Algorithm
Description: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
constant_initialization_vector
Type: STRING
Provider name: ConstantInitializationVector
Description: 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.
device_id
Type: STRING
Provider name: DeviceId
Description: 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.
key_type
Type: STRING
Provider name: KeyType
Description: 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
Type: STRING
Provider name: Region
Description: The Amazon Web Services 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.
resource_id
Type: STRING
Provider name: ResourceId
Description: 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.
role_arn
Type: STRING
Provider name: RoleArn
Description: The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
secret_arn
Type: STRING
Provider name: SecretArn
Description: The ARN of the secret that you created in Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
url
Type: STRING
Provider name: Url
Description: 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.
entitlement_arn
Type: STRING
Provider name: EntitlementArn
Description: The ARN of the entitlement on the originator’’s flow. This value is relevant only on entitled flows.
listener_address
Type: STRING
Provider name: ListenerAddress
Description: The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
media_live_input_arn
Type: STRING
Provider name: MediaLiveInputArn
Description: The input ARN of the MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
media_stream_output_configurations
Type: UNORDERED_LIST_STRUCT
Provider name: MediaStreamOutputConfigurations
Description: The configuration for each media stream that is associated with the output.
destination_configurations
Type: UNORDERED_LIST_STRUCT
Provider name: DestinationConfigurations
Description: The transport parameters that are associated with each outbound media stream.
destination_ip
Type: STRING
Provider name: DestinationIp
Description: The IP address where you want MediaConnect to send contents of the media stream.
destination_port
Type: INT32
Provider name: DestinationPort
Description: The port that you want MediaConnect to use when it distributes the media stream to the output.
interface
Type: STRUCT
Provider name: Interface
Description: The VPC interface that you want to use for the media stream associated with the output.
name
Type: STRING
Provider name: Name
Description: The name of the VPC interface.
outbound_ip
Type: STRING
Provider name: OutboundIp
Description: The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS or protocol.
encoding_name
Type: STRING
Provider name: EncodingName
Description: The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
encoding_parameters
Type: STRUCT
Provider name: EncodingParameters
Description: A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
compression_factor
Type: DOUBLE
Provider name: CompressionFactor
Description: A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
encoder_profile
Type: STRING
Provider name: EncoderProfile
Description: A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
media_stream_name
Type: STRING
Provider name: MediaStreamName
Description: The name of the media stream.
name
Type: STRING
Provider name: Name
Description: The name of the output. This value must be unique within the current flow.
output_arn
Type: STRING
Provider name: OutputArn
Description: The ARN of the output.
output_status
Type: STRING
Provider name: OutputStatus
Description: An indication of whether the output is transmitting data or not.
peer_ip_address
Type: STRING
Provider name: PeerIpAddress
Description: The IP address of the device that is currently receiving content from this output. - For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.
- For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver.
- Peer IP addresses aren’t available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs.
- The peer IP address might not be visible for flows that haven’t been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.
port
Type: INT32
Provider name: Port
Description: The port to use when content is distributed to this output.
transport
Type: STRUCT
Provider name: Transport
Description: Attributes related to the transport stream that are used in the output.
cidr_allow_list
Type: UNORDERED_LIST_STRING
Provider name: CidrAllowList
Description: The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
max_bitrate
Type: INT32
Provider name: MaxBitrate
Description: The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
max_latency
Type: INT32
Provider name: MaxLatency
Description: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
max_sync_buffer
Type: INT32
Provider name: MaxSyncBuffer
Description: The size of the buffer (in milliseconds) to use to sync incoming source data.
min_latency
Type: INT32
Provider name: MinLatency
Description: 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.
ndi_program_name
Type: STRING
Provider name: NdiProgramName
Description: A suffix for the names of the NDI sources that the flow creates. If a custom name isn’t specified, MediaConnect uses the output name.
ndi_speed_hq_quality
Type: INT32
Provider name: NdiSpeedHqQuality
Description: A quality setting for the NDI Speed HQ encoder.
protocol
Type: STRING
Provider name: Protocol
Description: The protocol that is used by the source or output. Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
remote_id
Type: STRING
Provider name: RemoteId
Description: The remote ID for the Zixi-pull stream.
sender_control_port
Type: INT32
Provider name: SenderControlPort
Description: The port that the flow uses to send outbound requests to initiate connection with the sender.
sender_ip_address
Type: STRING
Provider name: SenderIpAddress
Description: The IP address that the flow communicates with to initiate connection with the sender.
smoothing_latency
Type: INT32
Provider name: SmoothingLatency
Description: The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
source_listener_address
Type: STRING
Provider name: SourceListenerAddress
Description: Source IP or domain name for SRT-caller protocol.
source_listener_port
Type: INT32
Provider name: SourceListenerPort
Description: Source port for SRT-caller protocol.
stream_id
Type: STRING
Provider name: StreamId
Description: The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
vpc_interface_attachment
Type: STRUCT
Provider name: VpcInterfaceAttachment
Description: The name of the VPC interface attachment to use for this output.
vpc_interface_name
Type: STRING
Provider name: VpcInterfaceName
Description: The name of the VPC interface to use for this resource.
source
Type: STRUCT
Provider name: Source
Description: The source for the flow.
data_transfer_subscriber_fee_percent
Type: INT32
Provider name: DataTransferSubscriberFeePercent
Description: Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
decryption
Type: STRUCT
Provider name: Decryption
Description: The type of encryption that is used on the content ingested from this source.
algorithm
Type: STRING
Provider name: Algorithm
Description: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
constant_initialization_vector
Type: STRING
Provider name: ConstantInitializationVector
Description: 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.
device_id
Type: STRING
Provider name: DeviceId
Description: 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.
key_type
Type: STRING
Provider name: KeyType
Description: 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
Type: STRING
Provider name: Region
Description: The Amazon Web Services 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.
resource_id
Type: STRING
Provider name: ResourceId
Description: 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.
role_arn
Type: STRING
Provider name: RoleArn
Description: The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
secret_arn
Type: STRING
Provider name: SecretArn
Description: The ARN of the secret that you created in Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
url
Type: STRING
Provider name: Url
Description: 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.
description
Type: STRING
Provider name: Description
Description: A description for the source. This value is not used or seen outside of the current MediaConnect account.
entitlement_arn
Type: STRING
Provider name: EntitlementArn
Description: The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services account. The entitlement is set by the content originator and the ARN is generated as part of the originator’s flow.
gateway_bridge_source
Type: STRUCT
Provider name: GatewayBridgeSource
Description: The source configuration for cloud flows receiving a stream from a bridge.
bridge_arn
Type: STRING
Provider name: BridgeArn
Description: The ARN of the bridge feeding this flow.
vpc_interface_attachment
Type: STRUCT
Provider name: VpcInterfaceAttachment
Description: The name of the VPC interface attachment to use for this bridge source.
vpc_interface_name
Type: STRING
Provider name: VpcInterfaceName
Description: The name of the VPC interface to use for this resource.
ingest_ip
Type: STRING
Provider name: IngestIp
Description: The IP address that the flow will be listening on for incoming content.
ingest_port
Type: INT32
Provider name: IngestPort
Description: The port that the flow will be listening on for incoming content.
media_stream_source_configurations
Type: UNORDERED_LIST_STRUCT
Provider name: MediaStreamSourceConfigurations
Description: The media streams that are associated with the source, and the parameters for those associations.
encoding_name
Type: STRING
Provider name: EncodingName
Description: The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
input_configurations
Type: UNORDERED_LIST_STRUCT
Provider name: InputConfigurations
Description: The media streams that you want to associate with the source.
input_ip
Type: STRING
Provider name: InputIp
Description: The IP address that the flow listens on for incoming content for a media stream.
input_port
Type: INT32
Provider name: InputPort
Description: The port that the flow listens on for an incoming media stream.
interface
Type: STRUCT
Provider name: Interface
Description: The VPC interface where the media stream comes in from.
name
Type: STRING
Provider name: Name
Description: The name of the VPC interface.
media_stream_name
Type: STRING
Provider name: MediaStreamName
Description: A name that helps you distinguish one media stream from another.
name
Type: STRING
Provider name: Name
Description: The name of the source.
peer_ip_address
Type: STRING
Provider name: PeerIpAddress
Description: The IP address of the device that is currently sending content to this source. - For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address.
- For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender.
- Peer IP addresses aren’t available for entitlements and CDI/ST2110 sources.
- The peer IP address might not be visible for flows that haven’t been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.
sender_control_port
Type: INT32
Provider name: SenderControlPort
Description: The IP address that the flow communicates with to initiate connection with the sender.
sender_ip_address
Type: STRING
Provider name: SenderIpAddress
Description: The port that the flow uses to send outbound requests to initiate connection with the sender.
source_arn
Type: STRING
Provider name: SourceArn
Description: The ARN of the source.
transport
Type: STRUCT
Provider name: Transport
Description: Attributes related to the transport stream that are used in the source.
cidr_allow_list
Type: UNORDERED_LIST_STRING
Provider name: CidrAllowList
Description: The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
max_bitrate
Type: INT32
Provider name: MaxBitrate
Description: The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
max_latency
Type: INT32
Provider name: MaxLatency
Description: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
max_sync_buffer
Type: INT32
Provider name: MaxSyncBuffer
Description: The size of the buffer (in milliseconds) to use to sync incoming source data.
min_latency
Type: INT32
Provider name: MinLatency
Description: 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.
ndi_program_name
Type: STRING
Provider name: NdiProgramName
Description: A suffix for the names of the NDI sources that the flow creates. If a custom name isn’t specified, MediaConnect uses the output name.
ndi_speed_hq_quality
Type: INT32
Provider name: NdiSpeedHqQuality
Description: A quality setting for the NDI Speed HQ encoder.
protocol
Type: STRING
Provider name: Protocol
Description: The protocol that is used by the source or output. Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
remote_id
Type: STRING
Provider name: RemoteId
Description: The remote ID for the Zixi-pull stream.
sender_control_port
Type: INT32
Provider name: SenderControlPort
Description: The port that the flow uses to send outbound requests to initiate connection with the sender.
sender_ip_address
Type: STRING
Provider name: SenderIpAddress
Description: The IP address that the flow communicates with to initiate connection with the sender.
smoothing_latency
Type: INT32
Provider name: SmoothingLatency
Description: The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
source_listener_address
Type: STRING
Provider name: SourceListenerAddress
Description: Source IP or domain name for SRT-caller protocol.
source_listener_port
Type: INT32
Provider name: SourceListenerPort
Description: Source port for SRT-caller protocol.
stream_id
Type: STRING
Provider name: StreamId
Description: The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
vpc_interface_name
Type: STRING
Provider name: VpcInterfaceName
Description: The name of the VPC interface that is used for this source.
whitelist_cidr
Type: STRING
Provider name: WhitelistCidr
Description: 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.
source_failover_config
Type: STRUCT
Provider name: SourceFailoverConfig
Description: The settings for the source failover.
failover_mode
Type: STRING
Provider name: FailoverMode
Description: The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
recovery_window
Type: INT32
Provider name: RecoveryWindow
Description: Search window time to look for dash-7 packets.
source_priority
Type: STRUCT
Provider name: SourcePriority
Description: The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
primary_source
Type: STRING
Provider name: PrimarySource
Description: The name of the source you choose as the primary source for this flow.
state
Type: STRING
Provider name: State
Description: The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
source_monitoring_config
Type: STRUCT
Provider name: SourceMonitoringConfig
Description: The settings for source monitoring.
audio_monitoring_settings
Type: UNORDERED_LIST_STRUCT
Provider name: AudioMonitoringSettings
Description: Contains the settings for audio stream metrics monitoring.
silent_audio
Type: STRUCT
Provider name: SilentAudio
Description: Detects periods of silence.
state
Type: STRING
Provider name: State
Description: Indicates whether the SilentAudio metric is enabled or disabled.
threshold_seconds
Type: INT32
Provider name: ThresholdSeconds
Description: Specifies the number of consecutive seconds of silence that triggers an event or alert.
content_quality_analysis_state
Type: STRING
Provider name: ContentQualityAnalysisState
Description: Indicates whether content quality analysis is enabled or disabled.
thumbnail_state
Type: STRING
Provider name: ThumbnailState
Description: Indicates whether thumbnails are enabled or disabled.
video_monitoring_settings
Type: UNORDERED_LIST_STRUCT
Provider name: VideoMonitoringSettings
Description: Contains the settings for video stream metrics monitoring.
black_frames
Type: STRUCT
Provider name: BlackFrames
Description: Detects video frames that are black.
state
Type: STRING
Provider name: State
Description: Indicates whether the BlackFrames metric is enabled or disabled..
threshold_seconds
Type: INT32
Provider name: ThresholdSeconds
Description: Specifies the number of consecutive seconds of black frames that triggers an event or alert.
frozen_frames
Type: STRUCT
Provider name: FrozenFrames
Description: Detects video frames that have not changed.
state
Type: STRING
Provider name: State
Description: Indicates whether the FrozenFrames metric is enabled or disabled.
threshold_seconds
Type: INT32
Provider name: ThresholdSeconds
Description: Specifies the number of consecutive seconds of a static image that triggers an event or alert.
sources
Type: UNORDERED_LIST_STRUCT
Provider name: Sources
Description: The settings for the sources that are assigned to the flow.
data_transfer_subscriber_fee_percent
Type: INT32
Provider name: DataTransferSubscriberFeePercent
Description: Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
decryption
Type: STRUCT
Provider name: Decryption
Description: The type of encryption that is used on the content ingested from this source.
algorithm
Type: STRING
Provider name: Algorithm
Description: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
constant_initialization_vector
Type: STRING
Provider name: ConstantInitializationVector
Description: 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.
device_id
Type: STRING
Provider name: DeviceId
Description: 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.
key_type
Type: STRING
Provider name: KeyType
Description: 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
Type: STRING
Provider name: Region
Description: The Amazon Web Services 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.
resource_id
Type: STRING
Provider name: ResourceId
Description: 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.
role_arn
Type: STRING
Provider name: RoleArn
Description: The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
secret_arn
Type: STRING
Provider name: SecretArn
Description: The ARN of the secret that you created in Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
url
Type: STRING
Provider name: Url
Description: 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.
description
Type: STRING
Provider name: Description
Description: A description for the source. This value is not used or seen outside of the current MediaConnect account.
entitlement_arn
Type: STRING
Provider name: EntitlementArn
Description: The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services account. The entitlement is set by the content originator and the ARN is generated as part of the originator’s flow.
gateway_bridge_source
Type: STRUCT
Provider name: GatewayBridgeSource
Description: The source configuration for cloud flows receiving a stream from a bridge.
bridge_arn
Type: STRING
Provider name: BridgeArn
Description: The ARN of the bridge feeding this flow.
vpc_interface_attachment
Type: STRUCT
Provider name: VpcInterfaceAttachment
Description: The name of the VPC interface attachment to use for this bridge source.
vpc_interface_name
Type: STRING
Provider name: VpcInterfaceName
Description: The name of the VPC interface to use for this resource.
ingest_ip
Type: STRING
Provider name: IngestIp
Description: The IP address that the flow will be listening on for incoming content.
ingest_port
Type: INT32
Provider name: IngestPort
Description: The port that the flow will be listening on for incoming content.
media_stream_source_configurations
Type: UNORDERED_LIST_STRUCT
Provider name: MediaStreamSourceConfigurations
Description: The media streams that are associated with the source, and the parameters for those associations.
encoding_name
Type: STRING
Provider name: EncodingName
Description: The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
input_configurations
Type: UNORDERED_LIST_STRUCT
Provider name: InputConfigurations
Description: The media streams that you want to associate with the source.
input_ip
Type: STRING
Provider name: InputIp
Description: The IP address that the flow listens on for incoming content for a media stream.
input_port
Type: INT32
Provider name: InputPort
Description: The port that the flow listens on for an incoming media stream.
interface
Type: STRUCT
Provider name: Interface
Description: The VPC interface where the media stream comes in from.
name
Type: STRING
Provider name: Name
Description: The name of the VPC interface.
media_stream_name
Type: STRING
Provider name: MediaStreamName
Description: A name that helps you distinguish one media stream from another.
name
Type: STRING
Provider name: Name
Description: The name of the source.
peer_ip_address
Type: STRING
Provider name: PeerIpAddress
Description: The IP address of the device that is currently sending content to this source. - For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address.
- For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender.
- Peer IP addresses aren’t available for entitlements and CDI/ST2110 sources.
- The peer IP address might not be visible for flows that haven’t been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.
sender_control_port
Type: INT32
Provider name: SenderControlPort
Description: The IP address that the flow communicates with to initiate connection with the sender.
sender_ip_address
Type: STRING
Provider name: SenderIpAddress
Description: The port that the flow uses to send outbound requests to initiate connection with the sender.
source_arn
Type: STRING
Provider name: SourceArn
Description: The ARN of the source.
transport
Type: STRUCT
Provider name: Transport
Description: Attributes related to the transport stream that are used in the source.
cidr_allow_list
Type: UNORDERED_LIST_STRING
Provider name: CidrAllowList
Description: The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16
max_bitrate
Type: INT32
Provider name: MaxBitrate
Description: The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
max_latency
Type: INT32
Provider name: MaxLatency
Description: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
max_sync_buffer
Type: INT32
Provider name: MaxSyncBuffer
Description: The size of the buffer (in milliseconds) to use to sync incoming source data.
min_latency
Type: INT32
Provider name: MinLatency
Description: 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.
ndi_program_name
Type: STRING
Provider name: NdiProgramName
Description: A suffix for the names of the NDI sources that the flow creates. If a custom name isn’t specified, MediaConnect uses the output name.
ndi_speed_hq_quality
Type: INT32
Provider name: NdiSpeedHqQuality
Description: A quality setting for the NDI Speed HQ encoder.
protocol
Type: STRING
Provider name: Protocol
Description: The protocol that is used by the source or output. Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
remote_id
Type: STRING
Provider name: RemoteId
Description: The remote ID for the Zixi-pull stream.
sender_control_port
Type: INT32
Provider name: SenderControlPort
Description: The port that the flow uses to send outbound requests to initiate connection with the sender.
sender_ip_address
Type: STRING
Provider name: SenderIpAddress
Description: The IP address that the flow communicates with to initiate connection with the sender.
smoothing_latency
Type: INT32
Provider name: SmoothingLatency
Description: The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
source_listener_address
Type: STRING
Provider name: SourceListenerAddress
Description: Source IP or domain name for SRT-caller protocol.
source_listener_port
Type: INT32
Provider name: SourceListenerPort
Description: Source port for SRT-caller protocol.
stream_id
Type: STRING
Provider name: StreamId
Description: The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
vpc_interface_name
Type: STRING
Provider name: VpcInterfaceName
Description: The name of the VPC interface that is used for this source.
whitelist_cidr
Type: STRING
Provider name: WhitelistCidr
Description: 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.
status
Type: STRING
Provider name: Status
Description: The current status of the flow.
vpc_interfaces
Type: UNORDERED_LIST_STRUCT
Provider name: VpcInterfaces
Description: The VPC Interfaces for this flow.
name
Type: STRING
Provider name: Name
Description: Immutable and has to be a unique against other VpcInterfaces in this Flow.
network_interface_ids
Type: UNORDERED_LIST_STRING
Provider name: NetworkInterfaceIds
Description: IDs of the network interfaces created in customer’s account by MediaConnect.
network_interface_type
Type: STRING
Provider name: NetworkInterfaceType
Description: The type of network interface.
role_arn
Type: STRING
Provider name: RoleArn
Description: A role Arn MediaConnect can assume to create ENIs in your account.
security_group_ids
Type: UNORDERED_LIST_STRING
Provider name: SecurityGroupIds
Description: Security Group IDs to be used on ENI.
subnet_id
Type: STRING
Provider name: SubnetId
Description: Subnet must be in the AZ of the Flow.
messages
Type: STRUCT
Provider name: Messages
Description: Any errors that apply currently to the flow. If there are no errors, MediaConnect will not include this field in the response.
errors
Type: UNORDERED_LIST_STRING
Provider name: Errors
Description: A list of errors that might have been generated from processes on this flow.
Type: UNORDERED_LIST_STRING
