bridges

Creates, updates, deletes, gets or lists a bridges resource.

Overview

Name	bridges
Type	Resource
Id	aws.mediaconnect.bridges

Fields

The following fields are returned by SELECT queries:

describe_bridge

Name	Datatype	Description
bridge_arn	string	The Amazon Resource Number (ARN) of the bridge.
bridge_messages	array	Messages with details about the bridge.
bridge_state	string	The state of the bridge. (CREATING, STANDBY, STARTING, DEPLOYING, ACTIVE, STOPPING, DELETING, DELETED, START_FAILED, START_PENDING, STOP_FAILED, UPDATING)
egress_gateway_bridge	object	An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
ingress_gateway_bridge	object	An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
name	string	The name of the bridge.
outputs	array	The outputs on this bridge.
placement_arn	string	The placement Amazon Resource Number (ARN) of the bridge.
source_failover_config	object	The settings for source failover.
sources	array	The sources on this bridge.

list_bridges

Name	Datatype	Description
bridge_arn	string	The ARN of the bridge.
bridge_state	string	The state of the bridge. (CREATING, STANDBY, STARTING, DEPLOYING, ACTIVE, STOPPING, DELETING, DELETED, START_FAILED, START_PENDING, STOP_FAILED, UPDATING)
bridge_type	string	The type of the bridge.
name	string	The name of the bridge.
placement_arn	string	The ARN of the gateway associated with the bridge.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_bridge	select	bridge_arn, region		Displays the details of a bridge.
list_bridges	select	region	filterArn, maxResults, nextToken	Displays a list of bridges that are associated with this account and an optionally specified Amazon Resource Name (ARN). This request returns a paginated result.
create_bridge	insert	region, PlacementArn		Creates a new bridge. The request must include one source.
remove_bridge_output	update	bridge_arn, output_name, region		Removes an output from a bridge.
remove_bridge_source	update	bridge_arn, source_name, region		Removes a source from a bridge.
update_bridge_state	update	bridge_arn, region, DesiredState		Updates the bridge state.
update_bridge	update	bridge_arn, region		Updates the bridge.
delete_bridge	delete	bridge_arn, region		Deletes a bridge. Before you can delete a bridge, you must stop the bridge.
add_bridge_outputs	exec	bridge_arn, region		Adds outputs to an existing bridge.
add_bridge_sources	exec	bridge_arn, region		Adds sources to an existing bridge.
update_bridge_output	exec	bridge_arn, output_name, region		Updates an existing bridge output.
update_bridge_source	exec	bridge_arn, source_name, region		Updates an existing bridge source.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bridge_arn	string	The Amazon Resource Name (ARN) of the bridge that you want to update.
output_name	string	Tname of the output that you want to update.
region	string	AWS region (default: us-east-1)
source_name	string	The name of the source that you want to update.
filterArn	string	Filter the list results to display only the bridges associated with the selected ARN.
maxResults	integer	The maximum number of results to return per API request. For example, you submit a ListBridges request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
nextToken	string	The token that identifies the batch of results that you want to see. For example, you submit a ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value.

SELECT examples

describe_bridge

Displays the details of a bridge.

SELECT
bridge_arn,
bridge_messages,
bridge_state,
egress_gateway_bridge,
ingress_gateway_bridge,
name,
outputs,
placement_arn,
source_failover_config,
sources
FROM aws.mediaconnect.bridges
WHERE bridge_arn = '{{ bridge_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_bridges

Displays a list of bridges that are associated with this account and an optionally specified Amazon Resource Name (ARN). This request returns a paginated result.

SELECT
bridge_arn,
bridge_state,
bridge_type,
name,
placement_arn
FROM aws.mediaconnect.bridges
WHERE region = '{{ region }}' -- required
AND filterArn = '{{ filterArn }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_bridge

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

INSERT INTO aws.mediaconnect.bridges (
EgressGatewayBridge,
IngressGatewayBridge,
Name,
Outputs,
PlacementArn,
SourceFailoverConfig,
Sources,
region
)
SELECT 
'{{ EgressGatewayBridge }}',
'{{ IngressGatewayBridge }}',
'{{ Name }}',
'{{ Outputs }}',
'{{ PlacementArn }}' /* required */,
'{{ SourceFailoverConfig }}',
'{{ Sources }}',
'{{ region }}'
RETURNING
bridge
;

Manifest

# Description fields are for documentation purposes
- name: bridges
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the bridges resource.
  - name: EgressGatewayBridge
    description: |
      Create a bridge with the egress bridge type. An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
    value:
      MaxBitrate: {{ MaxBitrate }}
  - name: IngressGatewayBridge
    description: |
      Create a bridge with the ingress bridge type. An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
    value:
      MaxBitrate: {{ MaxBitrate }}
      MaxOutputs: {{ MaxOutputs }}
  - name: Name
    value: "{{ Name }}"
  - name: Outputs
    value:
      - NetworkOutput:
          IpAddress: "{{ IpAddress }}"
          Name: "{{ Name }}"
          NetworkName: "{{ NetworkName }}"
          Port: {{ Port }}
          Protocol: "{{ Protocol }}"
          Ttl: {{ Ttl }}
  - name: PlacementArn
    value: "{{ PlacementArn }}"
  - name: SourceFailoverConfig
    description: |
      The settings for source failover.
    value:
      FailoverMode: "{{ FailoverMode }}"
      RecoveryWindow: {{ RecoveryWindow }}
      SourcePriority:
        PrimarySource: "{{ PrimarySource }}"
      State: "{{ State }}"
  - name: Sources
    value:
      - FlowSource:
          FlowArn: "{{ FlowArn }}"
          FlowVpcInterfaceAttachment:
            VpcInterfaceName: "{{ VpcInterfaceName }}"
          Name: "{{ Name }}"
        NetworkSource:
          MulticastIp: "{{ MulticastIp }}"
          MulticastSourceSettings:
            MulticastSourceIp: "{{ MulticastSourceIp }}"
          Name: "{{ Name }}"
          NetworkName: "{{ NetworkName }}"
          Port: {{ Port }}
          Protocol: "{{ Protocol }}"

UPDATE examples

remove_bridge_output

Removes an output from a bridge.

UPDATE aws.mediaconnect.bridges
SET 
-- No updatable properties
WHERE 
bridge_arn = '{{ bridge_arn }}' --required
AND output_name = '{{ output_name }}' --required
AND region = '{{ region }}' --required
RETURNING
bridge_arn,
output_name;

remove_bridge_source

Removes a source from a bridge.

UPDATE aws.mediaconnect.bridges
SET 
-- No updatable properties
WHERE 
bridge_arn = '{{ bridge_arn }}' --required
AND source_name = '{{ source_name }}' --required
AND region = '{{ region }}' --required
RETURNING
bridge_arn,
source_name;

update_bridge_state

Updates the bridge state.

UPDATE aws.mediaconnect.bridges
SET 
DesiredState = '{{ DesiredState }}'
WHERE 
bridge_arn = '{{ bridge_arn }}' --required
AND region = '{{ region }}' --required
AND DesiredState = '{{ DesiredState }}' --required
RETURNING
bridge_arn,
desired_state;

update_bridge

Updates the bridge.

UPDATE aws.mediaconnect.bridges
SET 
EgressGatewayBridge = '{{ EgressGatewayBridge }}',
IngressGatewayBridge = '{{ IngressGatewayBridge }}',
SourceFailoverConfig = '{{ SourceFailoverConfig }}'
WHERE 
bridge_arn = '{{ bridge_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
bridge;

DELETE examples

delete_bridge

Deletes a bridge. Before you can delete a bridge, you must stop the bridge.

DELETE FROM aws.mediaconnect.bridges
WHERE bridge_arn = '{{ bridge_arn }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

add_bridge_outputs

Adds outputs to an existing bridge.

EXEC aws.mediaconnect.bridges.add_bridge_outputs 
@bridge_arn='{{ bridge_arn }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Outputs": "{{ Outputs }}"
}'
;

add_bridge_sources

Adds sources to an existing bridge.

EXEC aws.mediaconnect.bridges.add_bridge_sources 
@bridge_arn='{{ bridge_arn }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Sources": "{{ Sources }}"
}'
;

update_bridge_output

Updates an existing bridge output.

EXEC aws.mediaconnect.bridges.update_bridge_output 
@bridge_arn='{{ bridge_arn }}' --required, 
@output_name='{{ output_name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"NetworkOutput": "{{ NetworkOutput }}"
}'
;

update_bridge_source

Updates an existing bridge source.

EXEC aws.mediaconnect.bridges.update_bridge_source 
@bridge_arn='{{ bridge_arn }}' --required, 
@source_name='{{ source_name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"FlowSource": "{{ FlowSource }}", 
"NetworkSource": "{{ NetworkSource }}"
}'
;