Skip to content

CreateFlowRequest

Source code in docs_src/capo_mediaconnect/types/create_flow_request.py
class CreateFlowRequest(TypedDict, closed=True):
    availability_zone: NotRequired["str"]
    """<p> 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.</p>"""
    entitlements: NotRequired[
        "capo_mediaconnect.types.__list_of_grant_entitlement_request.__listOfGrantEntitlementRequest"
    ]
    """<p> The entitlements that you want to grant on a flow.</p>"""
    media_streams: NotRequired[
        "capo_mediaconnect.types.__list_of_add_media_stream_request.__listOfAddMediaStreamRequest"
    ]
    """<p> The media streams that you want to add to the flow. You can associate these media streams with sources and outputs on the flow.</p>"""
    name: NotRequired["str"]
    """<p> The name of the flow.</p>"""
    outputs: NotRequired[
        "capo_mediaconnect.types.__list_of_add_output_request.__listOfAddOutputRequest"
    ]
    """<p> The outputs that you want to add to this flow.</p>"""
    source: NotRequired["capo_mediaconnect.types.set_source_request.SetSourceRequest"]
    """<p> The settings for the source that you want to use for the new flow. </p>"""
    source_failover_config: NotRequired[
        "capo_mediaconnect.types.failover_config.FailoverConfig"
    ]
    """<p> The settings for source failover. </p>"""
    sources: NotRequired[
        "capo_mediaconnect.types.__list_of_set_source_request.__listOfSetSourceRequest"
    ]
    """<p>The sources that are assigned to the flow. </p>"""
    vpc_interfaces: NotRequired[
        "capo_mediaconnect.types.__list_of_vpc_interface_request.__listOfVpcInterfaceRequest"
    ]
    """<p> The VPC interfaces you want on the flow.</p>"""
    maintenance: NotRequired["capo_mediaconnect.types.add_maintenance.AddMaintenance"]
    """<p> The maintenance settings you want to use for the flow. </p>"""
    source_monitoring_config: NotRequired[
        "capo_mediaconnect.types.monitoring_config.MonitoringConfig"
    ]
    """<p> The settings for source monitoring. </p>"""
    flow_size: NotRequired["capo_mediaconnect.types.flow_size.FlowSize"]
    """<p> Determines the processing capacity and feature set of the flow. Set this optional parameter to <code>LARGE</code> if you want to enable NDI sources or outputs on the flow. </p>"""
    ndi_config: NotRequired["capo_mediaconnect.types.ndi_config.NdiConfig"]
    """<p> Specifies the configuration settings for a flow's NDI source or output. Required when the flow includes an NDI source or output. </p>"""
    encoding_config: NotRequired[
        "capo_mediaconnect.types.encoding_config.EncodingConfig"
    ]
    flow_tags: NotRequired["capo_mediaconnect.types.__map_of_string.__mapOfString"]
    """<p> The key-value pairs that can be used to tag and organize the flow. </p>"""

availability_zone instance-attribute

availability_zone: NotRequired[str]

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.

encoding_config instance-attribute

encoding_config: NotRequired[EncodingConfig]

entitlements instance-attribute

entitlements: NotRequired[__listOfGrantEntitlementRequest]

The entitlements that you want to grant on a flow.

flow_size instance-attribute

flow_size: NotRequired[FlowSize]

Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI sources or outputs on the flow.

flow_tags instance-attribute

flow_tags: NotRequired[__mapOfString]

The key-value pairs that can be used to tag and organize the flow.

maintenance instance-attribute

maintenance: NotRequired[AddMaintenance]

The maintenance settings you want to use for the flow.

media_streams instance-attribute

media_streams: NotRequired[__listOfAddMediaStreamRequest]

The media streams that you want to add to the flow. You can associate these media streams with sources and outputs on the flow.

name instance-attribute

name: NotRequired[str]

The name of the flow.

ndi_config instance-attribute

ndi_config: NotRequired[NdiConfig]

Specifies the configuration settings for a flow's NDI source or output. Required when the flow includes an NDI source or output.

outputs instance-attribute

outputs: NotRequired[__listOfAddOutputRequest]

The outputs that you want to add to this flow.

source instance-attribute

source: NotRequired[SetSourceRequest]

The settings for the source that you want to use for the new flow.

source_failover_config instance-attribute

source_failover_config: NotRequired[FailoverConfig]

The settings for source failover.

source_monitoring_config instance-attribute

source_monitoring_config: NotRequired[MonitoringConfig]

The settings for source monitoring.

sources instance-attribute

sources: NotRequired[__listOfSetSourceRequest]

The sources that are assigned to the flow.

vpc_interfaces instance-attribute

vpc_interfaces: NotRequired[__listOfVpcInterfaceRequest]

The VPC interfaces you want on the flow.