SourceConfiguration

class aws_cdk.aws_mediaconnect_alpha.SourceConfiguration(*args: Any, **kwargs)

Bases: object

(experimental) Configurations for sources.

Stability:: experimental
ExampleMetadata:: infused

Example:

# stack: Stack
# security_group: ec2.ISecurityGroup
# subnet: ec2.ISubnet
# role: iam.IRole


vpc_interface = VpcInterface.define(
    vpc_interface_name="my-vpc-interface",
    role=role,
    security_groups=[security_group],
    subnet=subnet
)

flow = Flow(stack, "MyFlow",
    source=SourceConfiguration.rist(
        flow_source_name="vpc-source",
        description="VPC-based source",
        port=5000,
        max_latency=Duration.millis(2000),
        network=NetworkConfiguration.vpc(vpc_interface)
    ),
    vpc_interfaces=[vpc_interface]
)

Attributes

flow_source_name

(experimental) The name of this source, if one was set on the configuration.

Stability:: experimental

Static Methods

classmethod cdi(*, max_sync_buffer, media_stream_source_configurations, port, vpc_interface, flow_source_name=None)

(experimental) Source option for CDI input.

Parameters:

max_sync_buffer (Union[int, float]) – (experimental) The size of the buffer (in ms) to use to sync incoming source data. Required by the MediaConnect service for CDI sources.
media_stream_source_configurations (Sequence[Union[MediaStreamSourceConfigurationCdi, Dict[str, Any]]]) – (experimental) The media stream that is associated with the source, and the parameters for that association.
port (Union[int, float]) – (experimental) The port that the flow will be listening on for incoming content.
vpc_interface (Union[VpcInterfaceConfig, Dict[str, Any]]) – (experimental) The VPC interface attachment to use for this bridge source.
flow_source_name (Optional[str]) – (experimental) The name of the source. Default: - a name is generated automatically

Stability:

experimental

Return type:

SourceConfiguration

classmethod entitlement(*, entitlement, decryption=None)

(experimental) 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.

Parameters:

entitlement (IFlowEntitlement) – (experimental) The entitlement that allows you to subscribe to content that comes from another AWS account.
decryption (Union[StaticKeyEncryption, Dict[str, Any], None]) – (experimental) Options to decrypt incoming feed. Default: - no decryption

Stability:

experimental

Remarks:

Return type:

SourceConfiguration

The entitlement must be imported using FlowEntitlement.fromFlowEntitlementArn() as entitlements are created by the content originator in a different AWS account.

classmethod gateway_bridge(*, bridge, vpc_interface=None)

(experimental) The source configuration for cloud flows receiving a stream from a bridge.

Parameters:

bridge (IBridge) – (experimental) The bridge feeding this flow.
vpc_interface (Union[VpcInterfaceConfig, Dict[str, Any], None]) – (experimental) The VPC interface attachment to use for this bridge source. Default: - no VPC interface

Stability:

experimental

Return type:

SourceConfiguration

classmethod jpeg_xs(*, media_stream_source_configurations, flow_source_name=None, max_sync_buffer=None, vpc_interface=None)

(experimental) Source option for Jpeg-XS input.

Parameters:

media_stream_source_configurations (Sequence[Union[MediaStreamSourceConfigurationJpegXs, Dict[str, Any]]]) – (experimental) The media stream that is associated with the source, and the parameters for that association.
flow_source_name (Optional[str]) – (experimental) The name of the source. Default: - a name is generated automatically
max_sync_buffer (Union[int, float, None]) – (experimental) The size of the buffer (in ms) to use to sync incoming source data. Default: 100
vpc_interface (Optional[Sequence[Union[VpcInterfaceConfig, Dict[str, Any]]]]) – (experimental) The VPC interface attachment to use for this bridge source. Default: - no VPC interface

Stability:

experimental

Return type:

SourceConfiguration

classmethod ndi(*, description=None, flow_source_name=None, source_name=None)

(experimental) Source option for NDI (SpeedHQ) input.

The flow must be configured with flowSize: FlowSize.LARGE and ndiConfig.ndiState = State.ENABLED with at least one NDI discovery server.

Parameters:

description (Optional[str]) – (experimental) A description of the source. This description appears only on the MediaConnect console and will not be seen by the end user. Default: - no description
flow_source_name (Optional[str]) – (experimental) The name of the source. Default: - a name is generated automatically
source_name (Optional[str]) – (experimental) The exact name of an existing NDI sender that’s registered with your discovery server. If included, the format of this name must be MACHINENAME (ProgramName). If not specified, you can select the upstream NDI sender from the console after starting the flow. Default: - select the NDI sender after starting the flow

Stability:

experimental

Return type:

SourceConfiguration

classmethod rist(*, network, port, max_bitrate=None, max_latency=None, description=None, flow_source_name=None)

(experimental) Source option for RIST input.

Parameters:

network (NetworkConfiguration) – (experimental) Defines networking configuration.
port (Union[int, float]) – (experimental) The port that the flow will be listening on for incoming content.
max_bitrate (Optional[Bitrate]) – (experimental) The maximum bitrate for RIST, RTP, and RTP-FEC streams. Default: - no maximum bitrate
max_latency (Optional[Duration]) – (experimental) The maximum latency in milliseconds for a RIST or Zixi-based source. Default: - undefined; when omitted, MediaConnect applies its service default maximum latency
description (Optional[str]) – (experimental) A description of the source. This description appears only on the MediaConnect console and will not be seen by the end user. Default: - no description
flow_source_name (Optional[str]) – (experimental) The name of the source. Default: - a name is generated automatically

Stability:

experimental

Return type:

SourceConfiguration

classmethod router(*, decryption=None, router_output=None)

(experimental) The source configuration for flows receiving a stream from router.

Parameters:

decryption (Union[TransitEncryption, Dict[str, Any], None]) – (experimental) Options to decrypt incoming feed. Default: - no decryption
router_output (Optional[IRouterOutput]) – (experimental) The router output that feeds this flow source. Default: - no router output connected

Stability:

experimental

Return type:

SourceConfiguration

classmethod rtp(*, network, port, max_bitrate=None, description=None, flow_source_name=None)

(experimental) Source option for RTP input.

Parameters:

network (NetworkConfiguration) – (experimental) Defines networking configuration.
port (Union[int, float]) – (experimental) The port that the flow will be listening on for incoming content.
max_bitrate (Optional[Bitrate]) – (experimental) The maximum bitrate for RIST, RTP, and RTP-FEC streams. Default: - no maximum bitrate
description (Optional[str]) – (experimental) A description of the source. This description appears only on the MediaConnect console and will not be seen by the end user. Default: - no description
flow_source_name (Optional[str]) – (experimental) The name of the source. Default: - a name is generated automatically

Stability:

experimental

Return type:

SourceConfiguration

classmethod rtp_fec(*, network, port, max_bitrate=None, description=None, flow_source_name=None)

(experimental) Source option for RTP-FEC input.

Parameters:

network (NetworkConfiguration) – (experimental) Defines networking configuration.
port (Union[int, float]) – (experimental) The port that the flow will be listening on for incoming content.
max_bitrate (Optional[Bitrate]) – (experimental) The maximum bitrate for RIST, RTP, and RTP-FEC streams. Default: - no maximum bitrate
description (Optional[str]) – (experimental) A description of the source. This description appears only on the MediaConnect console and will not be seen by the end user. Default: - no description
flow_source_name (Optional[str]) – (experimental) The name of the source. Default: - a name is generated automatically

Stability:

experimental

Return type:

SourceConfiguration

classmethod srt_caller(*, source_listener_address, source_listener_port, decryption=None, max_bitrate=None, max_latency=None, min_latency=None, stream_id=None, vpc_interface=None, description=None, flow_source_name=None)

(experimental) Source option for SRT Caller input.

Parameters:

source_listener_address (str) – (experimental) Source IP or domain name for SRT-caller protocol.
source_listener_port (Union[int, float]) – (experimental) Source port for SRT-caller protocol. Valid range: 1024–65535. Ports 2077 and 2088 are reserved by MediaConnect for Zixi traffic and cannot be used for SRT Caller.
decryption (Union[SrtPasswordEncryption, Dict[str, Any], None]) – (experimental) SRT Decryption options. Default: - no decryption
max_bitrate (Optional[Bitrate]) – (experimental) The maximum bitrate for streams. Default: - no maximum bitrate
max_latency (Optional[Duration]) – (experimental) The maximum latency in milliseconds for SRT-based streams. Default: - no maximum latency
min_latency (Optional[Duration]) – (experimental) The minimum latency in milliseconds for SRT-based streams. The value you set on your MediaConnect source represents the minimal potential latency of that connection. The latency of the stream is set to the higher of the sender’s minimum latency and the receiver’s minimum latency. Default: - no minimum latency
stream_id (Optional[str]) – (experimental) The stream ID that you want to use for the transport. Default: - no stream ID
vpc_interface (Union[VpcInterfaceConfig, Dict[str, Any], None]) – (experimental) Optional VPC interface for the outbound SRT Caller connection. SRT Caller initiates the connection to the configured sourceListenerAddress and sourceListenerPort, so no CIDR allow list is needed. Default: - outbound connection via the public internet; no VPC interface
description (Optional[str]) – (experimental) A description of the source. This description appears only on the MediaConnect console and will not be seen by the end user. Default: - no description
flow_source_name (Optional[str]) – (experimental) The name of the source. Default: - a name is generated automatically

Stability:

experimental

Return type:

SourceConfiguration

classmethod srt_listener(*, network, port, decryption=None, max_bitrate=None, min_latency=None, description=None, flow_source_name=None)

(experimental) Source option for SRT Listener input.

Parameters:

network (NetworkConfiguration) – (experimental) Defines networking configuration.
port (Union[int, float]) – (experimental) The port that the flow listens on for incoming content. Valid range: 1024–65535. Ports 2077 and 2088 are reserved by MediaConnect for Zixi traffic and cannot be used for SRT Listener.
decryption (Union[SrtPasswordEncryption, Dict[str, Any], None]) – (experimental) SRT Decryption options. Default: - no decryption
max_bitrate (Optional[Bitrate]) – (experimental) The maximum bitrate for streams. Default: - no maximum bitrate
min_latency (Optional[Duration]) – (experimental) The minimum latency in milliseconds for SRT-based streams. The value you set on your MediaConnect source represents the minimal potential latency of that connection. The latency of the stream is set to the higher of the sender’s minimum latency and the receiver’s minimum latency. Default: - no minimum latency
description (Optional[str]) – (experimental) A description of the source. This description appears only on the MediaConnect console and will not be seen by the end user. Default: - no description
flow_source_name (Optional[str]) – (experimental) The name of the source. Default: - a name is generated automatically

Stability:

experimental

Return type:

SourceConfiguration

classmethod zixi_push(*, network, decryption=None, max_latency=None, stream_id=None, description=None, flow_source_name=None)

(experimental) Source option for Zixi Push input.

Parameters:

network (NetworkConfiguration) – (experimental) Defines networking configuration.
decryption (Union[StaticKeyEncryption, Dict[str, Any], None]) – (experimental) Decrypt source with static keys. Default: - no decryption
max_latency (Optional[Duration]) – (experimental) The maximum latency in milliseconds for a Zixi-based source. Default: - chosen by MediaConnect
stream_id (Optional[str]) – (experimental) The stream ID that you want to use for the transport. This parameter applies only to Zixi-based streams. Default: - no stream ID
description (Optional[str]) – (experimental) A description of the source. This description appears only on the MediaConnect console and will not be seen by the end user. Default: - no description
flow_source_name (Optional[str]) – (experimental) The name of the source. Default: - a name is generated automatically

Stability:

experimental

Return type:

SourceConfiguration