Skip to content

Source

Source code in docs_src/capo_mediaconnect/types/source.py
class Source(TypedDict, closed=True):
    data_transfer_subscriber_fee_percent: NotRequired["int"]
    """<p> Percentage from 0-100 of the data transfer cost to be billed to the subscriber.</p>"""
    decryption: NotRequired["capo_mediaconnect.types.encryption.Encryption"]
    """<p> The type of encryption that is used on the content ingested from this source.</p>"""
    description: NotRequired["str"]
    """<p> A description for the source. This value is not used or seen outside of the current MediaConnect account.</p>"""
    entitlement_arn: NotRequired["str"]
    """<p> 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.</p>"""
    ingest_ip: NotRequired["str"]
    """<p> The IP address that the flow will be listening on for incoming content.</p>"""
    ingest_port: NotRequired["int"]
    """<p> The port that the flow will be listening on for incoming content.</p>"""
    media_stream_source_configurations: NotRequired[
        "capo_mediaconnect.types.__list_of_media_stream_source_configuration.__listOfMediaStreamSourceConfiguration"
    ]
    """<p> The media streams that are associated with the source, and the parameters for those associations.</p>"""
    name: NotRequired["str"]
    """<p> The name of the source.</p>"""
    sender_control_port: NotRequired["int"]
    """<p> The port that the flow uses to send outbound requests to initiate connection with the sender.</p>"""
    sender_ip_address: NotRequired["str"]
    """<p> The IP address that the flow communicates with to initiate connection with the sender.</p>"""
    source_arn: NotRequired["str"]
    """<p> The ARN of the source.</p>"""
    transport: NotRequired["capo_mediaconnect.types.transport.Transport"]
    """<p> Attributes related to the transport stream that are used in the source.</p>"""
    vpc_interface_name: NotRequired["str"]
    """<p> The name of the VPC interface that is used for this source.</p>"""
    whitelist_cidr: NotRequired["str"]
    """<p> 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.</p>"""
    gateway_bridge_source: NotRequired[
        "capo_mediaconnect.types.gateway_bridge_source.GatewayBridgeSource"
    ]
    """<p> The source configuration for cloud flows receiving a stream from a bridge.</p>"""
    peer_ip_address: NotRequired["str"]
    """<p>The IP address of the device that is currently sending content to this source. </p> <note> <ul> <li> <p>For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address. </p> </li> <li> <p>For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender. </p> </li> <li> <p>Peer IP addresses aren't available for entitlements and CDI/ST2110 sources.</p> </li> <li> <p>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.</p> </li> </ul> </note>"""
    router_integration_state: NotRequired["capo_mediaconnect.types.state.State"]
    """<p>Indicates if router integration is enabled or disabled on the flow source.</p>"""
    router_integration_transit_decryption: NotRequired[
        "capo_mediaconnect.types.flow_transit_encryption.FlowTransitEncryption"
    ]
    """<p>The decryption configuration for the flow source when router integration is enabled.</p>"""
    connected_router_output_arn: NotRequired["str"]
    """<p>The ARN of the router output that's currently connected to this source.</p>"""

connected_router_output_arn instance-attribute

connected_router_output_arn: NotRequired[str]

The ARN of the router output that's currently connected to this source.

data_transfer_subscriber_fee_percent instance-attribute

data_transfer_subscriber_fee_percent: NotRequired[int]

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

decryption instance-attribute

decryption: NotRequired[Encryption]

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

description instance-attribute

description: NotRequired[str]

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

entitlement_arn instance-attribute

entitlement_arn: NotRequired[str]

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 instance-attribute

gateway_bridge_source: NotRequired[GatewayBridgeSource]

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

ingest_ip instance-attribute

ingest_ip: NotRequired[str]

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

ingest_port instance-attribute

ingest_port: NotRequired[int]

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

media_stream_source_configurations instance-attribute

media_stream_source_configurations: NotRequired[__listOfMediaStreamSourceConfiguration]

The media streams that are associated with the source, and the parameters for those associations.

name instance-attribute

name: NotRequired[str]

The name of the source.

peer_ip_address instance-attribute

peer_ip_address: NotRequired[str]

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.

router_integration_state instance-attribute

router_integration_state: NotRequired[State]

Indicates if router integration is enabled or disabled on the flow source.

router_integration_transit_decryption instance-attribute

router_integration_transit_decryption: NotRequired[FlowTransitEncryption]

The decryption configuration for the flow source when router integration is enabled.

sender_control_port instance-attribute

sender_control_port: NotRequired[int]

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

sender_ip_address instance-attribute

sender_ip_address: NotRequired[str]

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

source_arn instance-attribute

source_arn: NotRequired[str]

The ARN of the source.

transport instance-attribute

transport: NotRequired[Transport]

Attributes related to the transport stream that are used in the source.

vpc_interface_name instance-attribute

vpc_interface_name: NotRequired[str]

The name of the VPC interface that is used for this source.

whitelist_cidr instance-attribute

whitelist_cidr: NotRequired[str]

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.