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

Fields

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.

Methods

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

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 aws.mediaconnect.flow_sources
WHERE region = 'us-east-1';

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

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 aws.mediaconnect.flow_sources (
 Description,
 Name,
 region
)
SELECT 
'{{ Description }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.mediaconnect.flow_sources (
 FlowArn,
 Decryption,
 Description,
 EntitlementArn,
 GatewayBridgeSource,
 IngestPort,
 MaxBitrate,
 MaxLatency,
 MinLatency,
 Name,
 Protocol,
 SenderIpAddress,
 SenderControlPort,
 StreamId,
 SourceListenerAddress,
 SourceListenerPort,
 VpcInterfaceName,
 WhitelistCidr,
 region
)
SELECT 
 '{{ FlowArn }}',
 '{{ Decryption }}',
 '{{ Description }}',
 '{{ EntitlementArn }}',
 '{{ GatewayBridgeSource }}',
 '{{ IngestPort }}',
 '{{ MaxBitrate }}',
 '{{ MaxLatency }}',
 '{{ MinLatency }}',
 '{{ Name }}',
 '{{ Protocol }}',
 '{{ SenderIpAddress }}',
 '{{ SenderControlPort }}',
 '{{ StreamId }}',
 '{{ SourceListenerAddress }}',
 '{{ SourceListenerPort }}',
 '{{ VpcInterfaceName }}',
 '{{ WhitelistCidr }}',
 '{{ 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: FlowArn
        value: '{{ FlowArn }}'
      - name: Decryption
        value:
          Algorithm: '{{ Algorithm }}'
          ConstantInitializationVector: '{{ ConstantInitializationVector }}'
          DeviceId: '{{ DeviceId }}'
          KeyType: '{{ KeyType }}'
          Region: '{{ Region }}'
          ResourceId: '{{ ResourceId }}'
          RoleArn: '{{ RoleArn }}'
          SecretArn: '{{ SecretArn }}'
          Url: '{{ Url }}'
      - name: Description
        value: '{{ Description }}'
      - name: EntitlementArn
        value: '{{ EntitlementArn }}'
      - name: GatewayBridgeSource
        value:
          BridgeArn: '{{ BridgeArn }}'
          VpcInterfaceAttachment:
            VpcInterfaceName: '{{ VpcInterfaceName }}'
      - name: IngestPort
        value: '{{ IngestPort }}'
      - name: MaxBitrate
        value: '{{ MaxBitrate }}'
      - name: MaxLatency
        value: '{{ MaxLatency }}'
      - name: MinLatency
        value: '{{ MinLatency }}'
      - name: Name
        value: '{{ Name }}'
      - name: Protocol
        value: '{{ Protocol }}'
      - name: SenderIpAddress
        value: '{{ SenderIpAddress }}'
      - name: SenderControlPort
        value: '{{ SenderControlPort }}'
      - name: StreamId
        value: '{{ StreamId }}'
      - name: SourceListenerAddress
        value: '{{ SourceListenerAddress }}'
      - name: SourceListenerPort
        value: '{{ SourceListenerPort }}'
      - name: VpcInterfaceName
        value: '{{ VpcInterfaceName }}'
      - name: WhitelistCidr
        value: '{{ WhitelistCidr }}'

DELETE example

/*+ delete */
DELETE FROM aws.mediaconnect.flow_sources
WHERE data__Identifier = '<SourceArn>'
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