bridge_outputs

Creates, updates, deletes or gets a bridge_output resource or lists bridge_outputs in a region

Overview

Name	bridge_outputs
Type	Resource
Description	Resource schema for AWS::MediaConnect::BridgeOutput
Id	awscc.mediaconnect.bridge_outputs

Fields

Name	Datatype	Description
bridge_arn	string	The Amazon Resource Number (ARN) of the bridge.
▶network_output	object	The output of the bridge.
name	string	The network output name.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	BridgeArn, Name, NetworkOutput, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual bridge_output.

SELECT
  region,
  bridge_arn,
  network_output,
  name
FROM awscc.mediaconnect.bridge_outputs
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ bridge_arn }}|{{ name }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.mediaconnect.bridge_outputs (
  BridgeArn,
  NetworkOutput,
  Name,
  region
)
SELECT
  '{{ bridge_arn }}',
  '{{ network_output }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.mediaconnect.bridge_outputs (
  BridgeArn,
  NetworkOutput,
  Name,
  region
)
SELECT
  '{{ bridge_arn }}',
  '{{ network_output }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: bridge_output
  props:
    - name: bridge_arn
      value: '{{ bridge_arn }}'
    - name: network_output
      value:
        protocol: '{{ protocol }}'
        ip_address: '{{ ip_address }}'
        port: '{{ port }}'
        network_name: '{{ network_name }}'
        ttl: '{{ ttl }}'
    - name: name
      value: '{{ name }}'

UPDATE example

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

/*+ update */
UPDATE awscc.mediaconnect.bridge_outputs
SET PatchDocument = string('{{ {
    "NetworkOutput": network_output
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ bridge_arn }}|{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.mediaconnect.bridge_outputs
WHERE
  Identifier = '{{ bridge_arn }}|{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

mediaconnect:AddBridgeOutputs,
mediaconnect:DescribeBridge

Read

mediaconnect:DescribeBridge

Update

mediaconnect:DescribeBridge,
mediaconnect:UpdateBridgeOutput

Delete

mediaconnect:RemoveBridgeOutput