bridges

Creates, updates, deletes or gets a bridge resource or lists bridges in a region

Overview

Name	bridges
Type	Resource
Description	Resource schema for AWS::MediaConnect::Bridge
Id	awscc.mediaconnect.bridges

Fields

get (all properties)

Name	Datatype	Description
name	string	The name of the bridge.
bridge_arn	string	The Amazon Resource Number (ARN) of the bridge.
placement_arn	string	The placement Amazon Resource Number (ARN) of the bridge.
bridge_state	string
▶source_failover_config	object	The settings for source failover
▶outputs	array	The outputs on this bridge.
▶sources	array	The sources on this bridge.
▶ingress_gateway_bridge	object
▶egress_gateway_bridge	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
bridge_arn	string	The Amazon Resource Number (ARN) of the bridge.
region	string	AWS region.

For more information, see AWS::MediaConnect::Bridge.

Methods

Name	Resource	Accessible by	Required Params
create_resource	bridges	INSERT	Name, PlacementArn, Sources, region
delete_resource	bridges	DELETE	Identifier, region
update_resource	bridges	UPDATE	Identifier, PatchDocument, region
list_resources	bridges_list_only	SELECT	region
get_resource	bridges	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual bridge.

SELECT
  region,
  name,
  bridge_arn,
  placement_arn,
  bridge_state,
  source_failover_config,
  outputs,
  sources,
  ingress_gateway_bridge,
  egress_gateway_bridge
FROM awscc.mediaconnect.bridges
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ bridge_arn }}';

list (identifiers only)

Lists all bridges in a region.

SELECT
  region,
  bridge_arn
FROM awscc.mediaconnect.bridges_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new bridge resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.mediaconnect.bridges (
  Name,
  PlacementArn,
  Sources,
  region
)
SELECT
  '{{ name }}',
  '{{ placement_arn }}',
  '{{ sources }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.mediaconnect.bridges (
  Name,
  PlacementArn,
  SourceFailoverConfig,
  Outputs,
  Sources,
  IngressGatewayBridge,
  EgressGatewayBridge,
  region
)
SELECT
  '{{ name }}',
  '{{ placement_arn }}',
  '{{ source_failover_config }}',
  '{{ outputs }}',
  '{{ sources }}',
  '{{ ingress_gateway_bridge }}',
  '{{ egress_gateway_bridge }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: bridge
    props:
      - name: name
        value: '{{ name }}'
      - name: placement_arn
        value: '{{ placement_arn }}'
      - name: source_failover_config
        value:
          state: '{{ state }}'
          recovery_window: '{{ recovery_window }}'
          failover_mode: '{{ failover_mode }}'
          source_priority:
            primary_source: '{{ primary_source }}'
      - name: outputs
        value:
          - bridge_arn: '{{ bridge_arn }}'
            network_output:
              protocol: '{{ protocol }}'
              ip_address: '{{ ip_address }}'
              port: '{{ port }}'
              network_name: '{{ network_name }}'
              ttl: '{{ ttl }}'
            name: '{{ name }}'
      - name: sources
        value:
          - name: '{{ name }}'
            bridge_arn: '{{ bridge_arn }}'
            flow_source:
              flow_arn: '{{ flow_arn }}'
              flow_vpc_interface_attachment:
                vpc_interface_name: '{{ vpc_interface_name }}'
            network_source:
              protocol: '{{ protocol }}'
              multicast_ip: '{{ multicast_ip }}'
              multicast_source_settings:
                multicast_source_ip: '{{ multicast_source_ip }}'
              port: '{{ port }}'
              network_name: '{{ network_name }}'
      - name: ingress_gateway_bridge
        value:
          max_bitrate: '{{ max_bitrate }}'
          max_outputs: '{{ max_outputs }}'
      - name: egress_gateway_bridge
        value:
          max_bitrate: '{{ max_bitrate }}'

UPDATE example

Use the following StackQL query and manifest file to update a bridge resource, using stack-deploy.

/*+ update */
UPDATE awscc.mediaconnect.bridges
SET PatchDocument = string('{{ {
    "Name": name,
    "PlacementArn": placement_arn,
    "SourceFailoverConfig": source_failover_config,
    "Outputs": outputs,
    "Sources": sources,
    "IngressGatewayBridge": ingress_gateway_bridge,
    "EgressGatewayBridge": egress_gateway_bridge
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ bridge_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.mediaconnect.bridges
WHERE
  Identifier = '{{ bridge_arn }}' AND
  region = 'us-east-1';

Permissions

To operate on the bridges resource, the following permissions are required:

Create

mediaconnect:CreateBridge,
mediaconnect:DescribeBridge,
mediaconnect:AddBridgeOutputs,
mediaconnect:AddBridgeSources

Read

mediaconnect:DescribeBridge

Update

mediaconnect:DescribeBridge,
mediaconnect:UpdateBridge

Delete

mediaconnect:DescribeBridge,
mediaconnect:DeleteBridge,
mediaconnect:RemoveBridgeOutput,
mediaconnect:RemoveBridgeSource

List

mediaconnect:ListBridges