MediaConnect / Client / create_bridge

create_bridge¶

MediaConnect.Client.create_bridge(**kwargs)¶

Creates a new bridge. The request must include one source.

Request Syntax

response = client.create_bridge(
    EgressGatewayBridge={
        'MaxBitrate': 123
    },
    IngressGatewayBridge={
        'MaxBitrate': 123,
        'MaxOutputs': 123
    },
    Name='string',
    Outputs=[
        {
            'NetworkOutput': {
                'IpAddress': 'string',
                'Name': 'string',
                'NetworkName': 'string',
                'Port': 123,
                'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
                'Ttl': 123
            }
        },
    ],
    PlacementArn='string',
    SourceFailoverConfig={
        'FailoverMode': 'MERGE'|'FAILOVER',
        'RecoveryWindow': 123,
        'SourcePriority': {
            'PrimarySource': 'string'
        },
        'State': 'ENABLED'|'DISABLED'
    },
    Sources=[
        {
            'FlowSource': {
                'FlowArn': 'string',
                'FlowVpcInterfaceAttachment': {
                    'VpcInterfaceName': 'string'
                },
                'Name': 'string'
            },
            'NetworkSource': {
                'MulticastIp': 'string',
                'MulticastSourceSettings': {
                    'MulticastSourceIp': 'string'
                },
                'Name': 'string',
                'NetworkName': 'string',
                'Port': 123,
                'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq'
            }
        },
    ]
)

Parameters:

EgressGatewayBridge (dict) –
An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
- MaxBitrate (integer) – [REQUIRED]
  
  The maximum expected bitrate (in bps) of the egress bridge.
IngressGatewayBridge (dict) –
An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
- MaxBitrate (integer) – [REQUIRED]
  
  The maximum expected bitrate (in bps) of the ingress bridge.
- MaxOutputs (integer) – [REQUIRED]
  
  The maximum number of expected outputs on the ingress bridge.
Name (string) –
[REQUIRED]

The name of the bridge. This name can not be modified after the bridge is created.
Outputs (list) –
The outputs that you want to add to this bridge.
- (dict) –
  
  Add outputs to the specified bridge.
  - NetworkOutput (dict) –
    
    The network output of the bridge. A network output is delivered to your premises.
    - IpAddress (string) – [REQUIRED]
      
      The network output IP Address.
    - Name (string) – [REQUIRED]
      
      The network output name. This name is used to reference the output and must be unique among outputs in this bridge.
    - NetworkName (string) – [REQUIRED]
      
      The network output’s gateway network name.
    - Port (integer) – [REQUIRED]
      
      The network output port.
    - Protocol (string) – [REQUIRED]
      
      The network output protocol.
      
      Note
      Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
    - Ttl (integer) – [REQUIRED]
      
      The network output TTL.
PlacementArn (string) –
[REQUIRED]

The bridge placement Amazon Resource Number (ARN).
SourceFailoverConfig (dict) –
The settings for source failover.
- FailoverMode (string) –
  
  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.
- RecoveryWindow (integer) –
  
  Search window time to look for dash-7 packets.
- SourcePriority (dict) –
  
  The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
  - PrimarySource (string) –
    
    The name of the source you choose as the primary source for this flow.
- State (string) –
  
  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.
Sources (list) –
[REQUIRED]

The sources that you want to add to this bridge.
- (dict) –
  
  Add an output to a bridge.
  - FlowSource (dict) –
    
    The source of the flow.
    - FlowArn (string) – [REQUIRED]
      
      The Amazon Resource Number (ARN) of the flow to use as a source of this bridge.
    - FlowVpcInterfaceAttachment (dict) –
      
      The name of the VPC interface attachment to use for this source.
      - VpcInterfaceName (string) –
        
        The name of the VPC interface to use for this resource.
    - Name (string) – [REQUIRED]
      
      The name of the flow source. This name is used to reference the source and must be unique among sources in this bridge.
  - NetworkSource (dict) –
    
    The source of the network.
    - MulticastIp (string) – [REQUIRED]
      
      The network source multicast IP.
    - MulticastSourceSettings (dict) –
      
      The settings related to the multicast source.
      - MulticastSourceIp (string) –
        
        The IP address of the source for source-specific multicast (SSM).
    - Name (string) – [REQUIRED]
      
      The name of the network source. This name is used to reference the source and must be unique among sources in this bridge.
    - NetworkName (string) – [REQUIRED]
      
      The network source’s gateway network name.
    - Port (integer) – [REQUIRED]
      
      The network source port.
    - Protocol (string) – [REQUIRED]
      
      The network source protocol.
      
      Note
      Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.

Return type:

dict

Returns:

Response Syntax

{
    'Bridge': {
        'BridgeArn': 'string',
        'BridgeMessages': [
            {
                'Code': 'string',
                'Message': 'string',
                'ResourceName': 'string'
            },
        ],
        'BridgeState': 'CREATING'|'STANDBY'|'STARTING'|'DEPLOYING'|'ACTIVE'|'STOPPING'|'DELETING'|'DELETED'|'START_FAILED'|'START_PENDING'|'STOP_FAILED'|'UPDATING',
        'EgressGatewayBridge': {
            'InstanceId': 'string',
            'MaxBitrate': 123
        },
        'IngressGatewayBridge': {
            'InstanceId': 'string',
            'MaxBitrate': 123,
            'MaxOutputs': 123
        },
        'Name': 'string',
        'Outputs': [
            {
                'FlowOutput': {
                    'FlowArn': 'string',
                    'FlowSourceArn': 'string',
                    'Name': 'string'
                },
                'NetworkOutput': {
                    'IpAddress': 'string',
                    'Name': 'string',
                    'NetworkName': 'string',
                    'Port': 123,
                    'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq',
                    'Ttl': 123
                }
            },
        ],
        'PlacementArn': 'string',
        'SourceFailoverConfig': {
            'FailoverMode': 'MERGE'|'FAILOVER',
            'RecoveryWindow': 123,
            'SourcePriority': {
                'PrimarySource': 'string'
            },
            'State': 'ENABLED'|'DISABLED'
        },
        'Sources': [
            {
                'FlowSource': {
                    'FlowArn': 'string',
                    'FlowVpcInterfaceAttachment': {
                        'VpcInterfaceName': 'string'
                    },
                    'Name': 'string',
                    'OutputArn': 'string'
                },
                'NetworkSource': {
                    'MulticastIp': 'string',
                    'MulticastSourceSettings': {
                        'MulticastSourceIp': 'string'
                    },
                    'Name': 'string',
                    'NetworkName': 'string',
                    'Port': 123,
                    'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'|'ndi-speed-hq'
                }
            },
        ]
    }
}

Response Structure

(dict) –
- Bridge (dict) –
  
  The name of the bridge that was created.
  - BridgeArn (string) –
    
    The Amazon Resource Number (ARN) of the bridge.
  - BridgeMessages (list) –
    
    Messages with details about the bridge.
    - (dict) –
      
      The details of an error message.
      - Code (string) –
        
        The error code.
      - Message (string) –
        
        The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
      - ResourceName (string) –
        
        The name of the resource.
  - BridgeState (string) –
    
    The state of the bridge.
  - EgressGatewayBridge (dict) –
    
    An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
    - InstanceId (string) –
      
      The ID of the instance running this bridge.
    - MaxBitrate (integer) –
      
      The maximum expected bitrate (in bps) of the egress bridge.
  - IngressGatewayBridge (dict) –
    
    An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
    - InstanceId (string) –
      
      The ID of the instance running this bridge.
    - MaxBitrate (integer) –
      
      The maximum expected bitrate (in bps) of the ingress bridge.
    - MaxOutputs (integer) –
      
      The maximum number of outputs on the ingress bridge.
  - Name (string) –
    
    The name of the bridge.
  - Outputs (list) –
    
    The outputs on this bridge.
    - (dict) –
      
      The output of the bridge.
      - FlowOutput (dict) –
        
        The output of the associated flow.
        
        FlowArn (string) –
        
        The Amazon Resource Number (ARN) of the cloud flow.
        
        FlowSourceArn (string) –
        
        The Amazon Resource Number (ARN) of the flow source.
        
        Name (string) –
        
        The name of the bridge’s output.
      - NetworkOutput (dict) –
        
        The network output for the bridge.
        
        IpAddress (string) –
        
        The network output IP address.
        
        Name (string) –
        
        The network output name.
        
        NetworkName (string) –
        
        The network output’s gateway network name.
        
        Port (integer) –
        
        The network output’s port.
        
        Protocol (string) –
        
        The network output protocol.
        
        Note
        Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
        
        Ttl (integer) –
        
        The network output TTL.
  - PlacementArn (string) –
    
    The placement Amazon Resource Number (ARN) of the bridge.
  - SourceFailoverConfig (dict) –
    
    The settings for source failover.
    - FailoverMode (string) –
      
      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.
    - RecoveryWindow (integer) –
      
      Search window time to look for dash-7 packets.
    - SourcePriority (dict) –
      
      The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
      - PrimarySource (string) –
        
        The name of the source you choose as the primary source for this flow.
    - State (string) –
      
      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.
  - Sources (list) –
    
    The sources on this bridge.
    - (dict) –
      
      The bridge’s source.
      - FlowSource (dict) –
        
        The source of the associated flow.
        
        FlowArn (string) –
        
        The ARN of the cloud flow used as a source of this bridge.
        
        FlowVpcInterfaceAttachment (dict) –
        
        The name of the VPC interface attachment to use for this source.
        
        VpcInterfaceName (string) –
        
        The name of the VPC interface to use for this resource.
        
        Name (string) –
        
        The name of the flow source.
        
        OutputArn (string) –
        
        The Amazon Resource Number (ARN) of the output.
      - NetworkSource (dict) –
        
        The network source for the bridge.
        
        MulticastIp (string) –
        
        The network source multicast IP.
        
        MulticastSourceSettings (dict) –
        
        The settings related to the multicast source.
        
        MulticastSourceIp (string) –
        
        The IP address of the source for source-specific multicast (SSM).
        
        Name (string) –
        
        The name of the network source.
        
        NetworkName (string) –
        
        The network source’s gateway network name.
        
        Port (integer) –
        
        The network source port.
        
        Protocol (string) –
        
        The network source protocol.
        
        Note
        Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.

Exceptions

MediaConnect.Client.exceptions.BadRequestException
MediaConnect.Client.exceptions.CreateBridge420Exception
MediaConnect.Client.exceptions.TooManyRequestsException
MediaConnect.Client.exceptions.ConflictException
MediaConnect.Client.exceptions.InternalServerErrorException
MediaConnect.Client.exceptions.ForbiddenException
MediaConnect.Client.exceptions.ServiceUnavailableException