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	aws.mediaconnect.bridges

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, PlacementArn, Sources, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all bridges in a region.

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

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 aws.mediaconnect.bridges
WHERE region = 'us-east-1' AND data__Identifier = '<BridgeArn>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.mediaconnect.bridges (
 Name,
 PlacementArn,
 SourceFailoverConfig,
 Outputs,
 Sources,
 IngressGatewayBridge,
 EgressGatewayBridge,
 region
)
SELECT 
 '{{ Name }}',
 '{{ PlacementArn }}',
 '{{ SourceFailoverConfig }}',
 '{{ Outputs }}',
 '{{ Sources }}',
 '{{ IngressGatewayBridge }}',
 '{{ EgressGatewayBridge }}',
 '{{ 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: PlacementArn
        value: '{{ PlacementArn }}'
      - name: SourceFailoverConfig
        value:
          State: '{{ State }}'
          RecoveryWindow: '{{ RecoveryWindow }}'
          FailoverMode: '{{ FailoverMode }}'
          SourcePriority:
            PrimarySource: '{{ PrimarySource }}'
      - name: Outputs
        value:
          - BridgeArn: '{{ BridgeArn }}'
            NetworkOutput:
              Protocol: '{{ Protocol }}'
              IpAddress: '{{ IpAddress }}'
              Port: '{{ Port }}'
              NetworkName: '{{ NetworkName }}'
              Ttl: '{{ Ttl }}'
            Name: '{{ Name }}'
      - name: Sources
        value:
          - Name: '{{ Name }}'
            BridgeArn: '{{ BridgeArn }}'
            FlowSource:
              FlowArn: '{{ FlowArn }}'
              FlowVpcInterfaceAttachment:
                VpcInterfaceName: '{{ VpcInterfaceName }}'
            NetworkSource:
              Protocol: '{{ Protocol }}'
              MulticastIp: '{{ MulticastIp }}'
              Port: '{{ Port }}'
              NetworkName: '{{ NetworkName }}'
      - name: IngressGatewayBridge
        value:
          MaxBitrate: '{{ MaxBitrate }}'
          MaxOutputs: '{{ MaxOutputs }}'
      - name: EgressGatewayBridge
        value:
          MaxBitrate: '{{ MaxBitrate }}'

DELETE example

/*+ delete */
DELETE FROM aws.mediaconnect.bridges
WHERE data__Identifier = '<BridgeArn>'
AND region = 'us-east-1';

Permissions

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

Create

mediaconnect:CreateBridge,
mediaconnect:DescribeBridge

Read

mediaconnect:DescribeBridge

Update

mediaconnect:DescribeBridge,
mediaconnect:UpdateBridge

Delete

mediaconnect:DescribeBridge,
mediaconnect:DeleteBridge

List

mediaconnect:ListBridges