flow_sources

Creates, updates, deletes or gets a flow_source resource or lists flow_sources in a region

Overview

Name	flow_sources
Type	Resource
Description	Resource schema for AWS::MediaConnect::FlowSource
Id	awscc.mediaconnect.flow_sources

Fields

get (all properties)

Name	Datatype	Description
flow_arn	string	The ARN of the flow.
source_arn	string	The ARN of the source.
▶decryption	object	The type of encryption that is used on the content ingested from this source.
description	string	A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
entitlement_arn	string	The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
▶gateway_bridge_source	object	The source configuration for cloud flows receiving a stream from a bridge.
ingest_ip	string	The IP address that the flow will be listening on for incoming content.
ingest_port	integer	The port that the flow will be listening on for incoming content.
max_bitrate	integer	The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
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 source.
protocol	string	The protocol that is used by the source.
sender_ip_address	string	The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.
sender_control_port	integer	The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.
stream_id	string	The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
source_ingest_port	string	The port that the flow will be listening on for incoming content.(ReadOnly)
source_listener_address	string	Source IP or domain name for SRT-caller protocol.
source_listener_port	integer	Source port for SRT-caller protocol.
vpc_interface_name	string	The name of the VPC Interface this Source is configured with.
whitelist_cidr	string	The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
source_arn	string	The ARN of the source.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	flow_sources	INSERT	Name, Description, region
delete_resource	flow_sources	DELETE	Identifier, region
update_resource	flow_sources	UPDATE	Identifier, PatchDocument, region
list_resources	flow_sources_list_only	SELECT	region
get_resource	flow_sources	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual flow_source.

SELECT
  region,
  flow_arn,
  source_arn,
  decryption,
  description,
  entitlement_arn,
  gateway_bridge_source,
  ingest_ip,
  ingest_port,
  max_bitrate,
  max_latency,
  min_latency,
  name,
  protocol,
  sender_ip_address,
  sender_control_port,
  stream_id,
  source_ingest_port,
  source_listener_address,
  source_listener_port,
  vpc_interface_name,
  whitelist_cidr
FROM awscc.mediaconnect.flow_sources
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ source_arn }}';

list (identifiers only)

Lists all flow_sources in a region.

SELECT
  region,
  source_arn
FROM awscc.mediaconnect.flow_sources_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.mediaconnect.flow_sources (
  Description,
  Name,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.mediaconnect.flow_sources (
  FlowArn,
  Decryption,
  Description,
  EntitlementArn,
  GatewayBridgeSource,
  IngestPort,
  MaxBitrate,
  MaxLatency,
  MinLatency,
  Name,
  Protocol,
  SenderIpAddress,
  SenderControlPort,
  StreamId,
  SourceListenerAddress,
  SourceListenerPort,
  VpcInterfaceName,
  WhitelistCidr,
  region
)
SELECT
  '{{ flow_arn }}',
  '{{ decryption }}',
  '{{ description }}',
  '{{ entitlement_arn }}',
  '{{ gateway_bridge_source }}',
  '{{ ingest_port }}',
  '{{ max_bitrate }}',
  '{{ max_latency }}',
  '{{ min_latency }}',
  '{{ name }}',
  '{{ protocol }}',
  '{{ sender_ip_address }}',
  '{{ sender_control_port }}',
  '{{ stream_id }}',
  '{{ source_listener_address }}',
  '{{ source_listener_port }}',
  '{{ vpc_interface_name }}',
  '{{ whitelist_cidr }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: flow_source
    props:
      - name: flow_arn
        value: '{{ flow_arn }}'
      - name: decryption
        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: entitlement_arn
        value: '{{ entitlement_arn }}'
      - name: gateway_bridge_source
        value:
          bridge_arn: '{{ bridge_arn }}'
          vpc_interface_attachment:
            vpc_interface_name: '{{ vpc_interface_name }}'
      - name: ingest_port
        value: '{{ ingest_port }}'
      - name: max_bitrate
        value: '{{ max_bitrate }}'
      - name: max_latency
        value: '{{ max_latency }}'
      - name: min_latency
        value: '{{ min_latency }}'
      - name: name
        value: '{{ name }}'
      - name: protocol
        value: '{{ protocol }}'
      - name: sender_ip_address
        value: '{{ sender_ip_address }}'
      - name: sender_control_port
        value: '{{ sender_control_port }}'
      - name: stream_id
        value: '{{ stream_id }}'
      - name: source_listener_address
        value: '{{ source_listener_address }}'
      - name: source_listener_port
        value: '{{ source_listener_port }}'
      - name: vpc_interface_name
        value: '{{ vpc_interface_name }}'
      - name: whitelist_cidr
        value: '{{ whitelist_cidr }}'

UPDATE example

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

/*+ update */
UPDATE awscc.mediaconnect.flow_sources
SET PatchDocument = string('{{ {
    "FlowArn": flow_arn,
    "Decryption": decryption,
    "Description": description,
    "EntitlementArn": entitlement_arn,
    "GatewayBridgeSource": gateway_bridge_source,
    "IngestPort": ingest_port,
    "MaxBitrate": max_bitrate,
    "MaxLatency": max_latency,
    "MinLatency": min_latency,
    "Protocol": protocol,
    "SenderIpAddress": sender_ip_address,
    "SenderControlPort": sender_control_port,
    "StreamId": stream_id,
    "SourceListenerAddress": source_listener_address,
    "SourceListenerPort": source_listener_port,
    "VpcInterfaceName": vpc_interface_name,
    "WhitelistCidr": whitelist_cidr
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ source_arn }}';

DELETE example

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

Permissions

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

Create

mediaconnect:CreateFlow,
mediaconnect:DescribeFlow,
mediaconnect:AddFlowSources,
iam:PassRole

Read

mediaconnect:DescribeFlow

Update

mediaconnect:DescribeFlow,
mediaconnect:UpdateFlowSource

Delete

mediaconnect:DescribeFlow,
mediaconnect:RemoveFlowSource

List

mediaconnect:DescribeFlow,
mediaconnect:ListFlows