flow_outputs

Creates, updates, deletes or gets a flow_output resource or lists flow_outputs in a region

Overview

Name	flow_outputs
Type	Resource
Description	Resource schema for AWS::MediaConnect::FlowOutput
Id	aws.mediaconnect.flow_outputs

Fields

Name	Datatype	Description
flow_arn	string	The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
output_arn	string	The ARN of the output.
cidr_allow_list	array	The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
encryption	object	The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
description	string	A description of the output.
destination	string	The address where you want to send the output.
max_latency	integer	The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
min_latency	integer	The minimum latency in milliseconds.
name	string	The name of the output. This value must be unique within the current flow.
port	integer	The port to use when content is distributed to this output.
protocol	string	The protocol that is used by the source or output.
remote_id	string	The remote ID for the Zixi-pull stream.
smoothing_latency	integer	The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
stream_id	string	The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
vpc_interface_attachment	object	The name of the VPC interface attachment to use for this output.
media_stream_output_configurations	array	The definition for each media stream that is associated with the output.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	FlowArn, Protocol, 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 flow_outputs in a region.

SELECT
region,
flow_arn,
output_arn,
cidr_allow_list,
encryption,
description,
destination,
max_latency,
min_latency,
name,
port,
protocol,
remote_id,
smoothing_latency,
stream_id,
vpc_interface_attachment,
media_stream_output_configurations
FROM aws.mediaconnect.flow_outputs
WHERE region = 'us-east-1';

Gets all properties from an individual flow_output.

SELECT
region,
flow_arn,
output_arn,
cidr_allow_list,
encryption,
description,
destination,
max_latency,
min_latency,
name,
port,
protocol,
remote_id,
smoothing_latency,
stream_id,
vpc_interface_attachment,
media_stream_output_configurations
FROM aws.mediaconnect.flow_outputs
WHERE region = 'us-east-1' AND data__Identifier = '<OutputArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.mediaconnect.flow_outputs (
 FlowArn,
 Protocol,
 region
)
SELECT 
'{{ FlowArn }}',
 '{{ Protocol }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.mediaconnect.flow_outputs (
 FlowArn,
 CidrAllowList,
 Encryption,
 Description,
 Destination,
 MaxLatency,
 MinLatency,
 Name,
 Port,
 Protocol,
 RemoteId,
 SmoothingLatency,
 StreamId,
 VpcInterfaceAttachment,
 MediaStreamOutputConfigurations,
 region
)
SELECT 
 '{{ FlowArn }}',
 '{{ CidrAllowList }}',
 '{{ Encryption }}',
 '{{ Description }}',
 '{{ Destination }}',
 '{{ MaxLatency }}',
 '{{ MinLatency }}',
 '{{ Name }}',
 '{{ Port }}',
 '{{ Protocol }}',
 '{{ RemoteId }}',
 '{{ SmoothingLatency }}',
 '{{ StreamId }}',
 '{{ VpcInterfaceAttachment }}',
 '{{ MediaStreamOutputConfigurations }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: flow_output
    props:
      - name: FlowArn
        value: '{{ FlowArn }}'
      - name: CidrAllowList
        value:
          - '{{ CidrAllowList[0] }}'
      - name: Encryption
        value:
          Algorithm: '{{ Algorithm }}'
          ConstantInitializationVector: '{{ ConstantInitializationVector }}'
          DeviceId: '{{ DeviceId }}'
          KeyType: '{{ KeyType }}'
          Region: '{{ Region }}'
          ResourceId: '{{ ResourceId }}'
          RoleArn: '{{ RoleArn }}'
          SecretArn: '{{ SecretArn }}'
          Url: '{{ Url }}'
      - name: Description
        value: '{{ Description }}'
      - name: Destination
        value: '{{ Destination }}'
      - name: MaxLatency
        value: '{{ MaxLatency }}'
      - name: MinLatency
        value: '{{ MinLatency }}'
      - name: Name
        value: '{{ Name }}'
      - name: Port
        value: '{{ Port }}'
      - name: Protocol
        value: '{{ Protocol }}'
      - name: RemoteId
        value: '{{ RemoteId }}'
      - name: SmoothingLatency
        value: '{{ SmoothingLatency }}'
      - name: StreamId
        value: '{{ StreamId }}'
      - name: VpcInterfaceAttachment
        value:
          VpcInterfaceName: '{{ VpcInterfaceName }}'
      - name: MediaStreamOutputConfigurations
        value:
          - EncodingName: '{{ EncodingName }}'
            DestinationConfigurations:
              - DestinationIp: '{{ DestinationIp }}'
                DestinationPort: '{{ DestinationPort }}'
                Interface:
                  Name: '{{ Name }}'
            MediaStreamName: '{{ MediaStreamName }}'
            EncodingParameters:
              CompressionFactor: null
              EncoderProfile: '{{ EncoderProfile }}'

DELETE example

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

Permissions

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

Create

iam:PassRole,
mediaconnect:AddFlowOutputs

Read

mediaconnect:DescribeFlow

Update

mediaconnect:DescribeFlow,
mediaconnect:UpdateFlowOutput

Delete

mediaconnect:DescribeFlow,
mediaconnect:RemoveFlowOutput

List

mediaconnect:DescribeFlow