CreateBridge
Creates a new bridge. The request must include one source.
Request Syntax
POST /v1/bridges HTTP/1.1
Content-type: application/json
{
"egressGatewayBridge": {
"maxBitrate": number
},
"ingressGatewayBridge": {
"maxBitrate": number,
"maxOutputs": number
},
"name": "string",
"outputs": [
{
"networkOutput": {
"ipAddress": "string",
"name": "string",
"networkName": "string",
"port": number,
"protocol": "string",
"ttl": number
}
}
],
"placementArn": "string",
"sourceFailoverConfig": {
"failoverMode": "string",
"recoveryWindow": number,
"sourcePriority": {
"primarySource": "string"
},
"state": "string"
},
"sources": [
{
"flowSource": {
"flowArn": "string",
"flowVpcInterfaceAttachment": {
"vpcInterfaceName": "string"
},
"name": "string"
},
"networkSource": {
"multicastIp": "string",
"multicastSourceSettings": {
"multicastSourceIp": "string"
},
"name": "string",
"networkName": "string",
"port": number,
"protocol": "string"
}
}
]
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- egressGatewayBridge
-
An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
Type: AddEgressGatewayBridgeRequest object
Required: No
- ingressGatewayBridge
-
An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
Type: AddIngressGatewayBridgeRequest object
Required: No
- name
-
The name of the bridge. This name can not be modified after the bridge is created.
Type: String
Required: Yes
- outputs
-
The outputs that you want to add to this bridge.
Type: Array of AddBridgeOutputRequest objects
Required: No
- placementArn
-
The bridge placement Amazon Resource Number (ARN).
Type: String
Required: Yes
- sourceFailoverConfig
-
The settings for source failover.
Type: FailoverConfig object
Required: No
- sources
-
The sources that you want to add to this bridge.
Type: Array of AddBridgeSourceRequest objects
Required: Yes
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"bridge": {
"bridgeArn": "string",
"bridgeMessages": [
{
"code": "string",
"message": "string",
"resourceName": "string"
}
],
"bridgeState": "string",
"egressGatewayBridge": {
"instanceId": "string",
"maxBitrate": number
},
"ingressGatewayBridge": {
"instanceId": "string",
"maxBitrate": number,
"maxOutputs": number
},
"name": "string",
"outputs": [
{
"flowOutput": {
"flowArn": "string",
"flowSourceArn": "string",
"name": "string"
},
"networkOutput": {
"ipAddress": "string",
"name": "string",
"networkName": "string",
"port": number,
"protocol": "string",
"ttl": number
}
}
],
"placementArn": "string",
"sourceFailoverConfig": {
"failoverMode": "string",
"recoveryWindow": number,
"sourcePriority": {
"primarySource": "string"
},
"state": "string"
},
"sources": [
{
"flowSource": {
"flowArn": "string",
"flowVpcInterfaceAttachment": {
"vpcInterfaceName": "string"
},
"name": "string",
"outputArn": "string"
},
"networkSource": {
"multicastIp": "string",
"multicastSourceSettings": {
"multicastSourceIp": "string"
},
"name": "string",
"networkName": "string",
"port": number,
"protocol": "string"
}
}
]
}
}Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
HTTP Status Code: 400
- ConflictException
-
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
HTTP Status Code: 409
- CreateBridge420Exception
-
Exception raised by AWS Elemental MediaConnect when creating the bridge. See the error message for the operation for more information on the cause of this exception.
HTTP Status Code: 420
- ForbiddenException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerErrorException
-
The server encountered an internal error and is unable to complete the request.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is currently unavailable or busy.
HTTP Status Code: 503
- TooManyRequestsException
-
The request was denied due to request throttling.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
