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	awscc.mediaconnect.flow_outputs

Fields

get (all properties)

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.
output_status	string	An indication of whether the output should transmit data or not.
ndi_program_name	string	A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
ndi_speed_hq_quality	integer	A quality setting for the NDI Speed HQ encoder.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
output_arn	string	The ARN of the output.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	flow_outputs	INSERT	FlowArn, Protocol, region
delete_resource	flow_outputs	DELETE	Identifier, region
update_resource	flow_outputs	UPDATE	Identifier, PatchDocument, region
list_resources	flow_outputs_list_only	SELECT	region
get_resource	flow_outputs	SELECT	Identifier, region

SELECT examples

get (all properties)

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,
  output_status,
  ndi_program_name,
  ndi_speed_hq_quality
FROM awscc.mediaconnect.flow_outputs
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ output_arn }}';

list (identifiers only)

Lists all flow_outputs in a region.

SELECT
  region,
  output_arn
FROM awscc.mediaconnect.flow_outputs_list_only
WHERE
  region = '{{ region }}';

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 awscc.mediaconnect.flow_outputs (
  FlowArn,
  Protocol,
  region
)
SELECT
  '{{ flow_arn }}',
  '{{ protocol }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.mediaconnect.flow_outputs (
  FlowArn,
  CidrAllowList,
  Encryption,
  Description,
  Destination,
  MaxLatency,
  MinLatency,
  Name,
  Port,
  Protocol,
  RemoteId,
  SmoothingLatency,
  StreamId,
  VpcInterfaceAttachment,
  MediaStreamOutputConfigurations,
  OutputStatus,
  NdiProgramName,
  NdiSpeedHqQuality,
  region
)
SELECT
  '{{ flow_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 }}',
  '{{ output_status }}',
  '{{ ndi_program_name }}',
  '{{ ndi_speed_hq_quality }}',
  '{{ 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: flow_output
  props:
    - name: flow_arn
      value: '{{ flow_arn }}'
    - name: cidr_allow_list
      value:
        - '{{ cidr_allow_list[0] }}'
    - name: encryption
      value:
        algorithm: '{{ algorithm }}'
        constant_initialization_vector: '{{ constant_initialization_vector }}'
        device_id: '{{ device_id }}'
        key_type: '{{ key_type }}'
        region: '{{ region }}'
        resource_id: '{{ resource_id }}'
        role_arn: '{{ role_arn }}'
        secret_arn: '{{ secret_arn }}'
        url: '{{ url }}'
    - name: description
      value: '{{ description }}'
    - name: destination
      value: '{{ destination }}'
    - name: max_latency
      value: '{{ max_latency }}'
    - name: min_latency
      value: '{{ min_latency }}'
    - name: name
      value: '{{ name }}'
    - name: port
      value: '{{ port }}'
    - name: protocol
      value: '{{ protocol }}'
    - name: remote_id
      value: '{{ remote_id }}'
    - name: smoothing_latency
      value: '{{ smoothing_latency }}'
    - name: stream_id
      value: '{{ stream_id }}'
    - name: vpc_interface_attachment
      value:
        vpc_interface_name: '{{ vpc_interface_name }}'
    - name: media_stream_output_configurations
      value:
        - encoding_name: '{{ encoding_name }}'
          destination_configurations:
            - destination_ip: '{{ destination_ip }}'
              destination_port: '{{ destination_port }}'
              interface:
                name: '{{ name }}'
          media_stream_name: '{{ media_stream_name }}'
          encoding_parameters:
            compression_factor: null
            encoder_profile: '{{ encoder_profile }}'
    - name: output_status
      value: '{{ output_status }}'
    - name: ndi_program_name
      value: '{{ ndi_program_name }}'
    - name: ndi_speed_hq_quality
      value: '{{ ndi_speed_hq_quality }}'

UPDATE example

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

/*+ update */
UPDATE awscc.mediaconnect.flow_outputs
SET PatchDocument = string('{{ {
    "FlowArn": flow_arn,
    "CidrAllowList": cidr_allow_list,
    "Encryption": encryption,
    "Description": description,
    "Destination": destination,
    "MaxLatency": max_latency,
    "MinLatency": min_latency,
    "Port": port,
    "Protocol": protocol,
    "RemoteId": remote_id,
    "SmoothingLatency": smoothing_latency,
    "StreamId": stream_id,
    "VpcInterfaceAttachment": vpc_interface_attachment,
    "MediaStreamOutputConfigurations": media_stream_output_configurations,
    "OutputStatus": output_status,
    "NdiProgramName": ndi_program_name,
    "NdiSpeedHqQuality": ndi_speed_hq_quality
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ output_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.mediaconnect.flow_outputs
WHERE
  Identifier = '{{ output_arn }}' 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 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,
mediaconnect:ListFlows