class CfnFlowSource (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.MediaConnect.CfnFlowSource`
Java	`software.amazon.awscdk.services.mediaconnect.CfnFlowSource`
Python	`aws_cdk.aws_mediaconnect.CfnFlowSource`
TypeScript	`@aws-cdk/aws-mediaconnect` » `CfnFlowSource`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::MediaConnect::FlowSource.

The AWS::MediaConnect::FlowSource resource is used to add additional sources to an existing flow. Adding an additional source requires Failover to be enabled. When you enable Failover, the additional source must use the same protocol as the existing source. A source is the external video content that includes configuration information (encryption and source type) and a network address. Each flow has at least one source. A standard source comes from a source other than another AWS Elemental MediaConnect flow, such as an on-premises encoder.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as mediaconnect from '@aws-cdk/aws-mediaconnect';
const cfnFlowSource = new mediaconnect.CfnFlowSource(this, 'MyCfnFlowSource', {
  description: 'description',
  name: 'name',

  // the properties below are optional
  decryption: {
    roleArn: 'roleArn',

    // the properties below are optional
    algorithm: 'algorithm',
    constantInitializationVector: 'constantInitializationVector',
    deviceId: 'deviceId',
    keyType: 'keyType',
    region: 'region',
    resourceId: 'resourceId',
    secretArn: 'secretArn',
    url: 'url',
  },
  entitlementArn: 'entitlementArn',
  flowArn: 'flowArn',
  ingestPort: 123,
  maxBitrate: 123,
  maxLatency: 123,
  minLatency: 123,
  protocol: 'protocol',
  senderControlPort: 123,
  senderIpAddress: 'senderIpAddress',
  sourceListenerAddress: 'sourceListenerAddress',
  sourceListenerPort: 123,
  streamId: 'streamId',
  vpcInterfaceName: 'vpcInterfaceName',
  whitelistCidr: 'whitelistCidr',
});

Initializer

new CfnFlowSource(scope: Construct, id: string, props: CfnFlowSourceProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnFlowSourceProps — - resource properties.

Create a new AWS::MediaConnect::FlowSource.

Construct Props

Name	Type	Description
description	`string`	A description of the source.
name	`string`	The name of the source.
decryption?	`IResolvable` `\|` `EncryptionProperty`	The type of encryption that is used on the content ingested from the source.
entitlementArn?	`string`	The ARN of the entitlement that allows you to subscribe to the flow.
flowArn?	`string`	The Amazon Resource Name (ARN) of the flow this source is connected to.
ingestPort?	`number`	The port that the flow listens on for incoming content.
maxBitrate?	`number`	The maximum bitrate for RIST, RTP, and RTP-FEC streams.
maxLatency?	`number`	The maximum latency in milliseconds.
minLatency?	`number`	The minimum latency in milliseconds for SRT-based streams.
protocol?	`string`	The protocol that the source uses to deliver the content to MediaConnect.
senderControlPort?	`number`	The port that the flow uses to send outbound requests to initiate connection with the sender.
senderIpAddress?	`string`	The IP address that the flow communicates with to initiate connection with the sender.
sourceListenerAddress?	`string`	Source IP or domain name for SRT-caller protocol.
sourceListenerPort?	`number`	Source port for SRT-caller protocol.
streamId?	`string`	The stream ID that you want to use for this transport.
vpcInterfaceName?	`string`	The name of the VPC interface that you want to send your output to.
whitelistCidr?	`string`	The range of IP addresses that are allowed to contribute content to your source.

description

Type: string

A description of the source.

This description is not visible outside of the current AWS account.

name

Type: string

The name of the source.

decryption?

Type: IResolvable | EncryptionProperty (optional)

The type of encryption that is used on the content ingested from the source.

entitlementArn?

Type: string (optional)

The ARN of the entitlement that allows you to subscribe to the flow.

The entitlement is set by the content originator, and the ARN is generated as part of the originator's flow.

flowArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the flow this source is connected to.

The flow must have Failover enabled to add an additional source.

ingestPort?

Type: number (optional)

The port that the flow listens on for incoming content.

If the protocol of the source is Zixi, the port must be set to 2088.

maxBitrate?

Type: number (optional)

The maximum bitrate for RIST, RTP, and RTP-FEC streams.

maxLatency?

Type: number (optional)

The maximum latency in milliseconds.

This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.

minLatency?

Type: number (optional)

The minimum latency in milliseconds for SRT-based streams.

In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.

protocol?

Type: string (optional)

The protocol that the source uses to deliver the content to MediaConnect.

Adding additional sources to an existing flow requires Failover to be enabled. When you enable Failover, the additional source must use the same protocol as the existing source. Only the following protocols support failover: Zixi-push, RTP-FEC, RTP, RIST and SRT protocols.

If you use failover with SRT caller or listener, the FailoverMode property must be set to FAILOVER . The FailoverMode property is found in the FailoverConfig resource of the same flow ARN you used for the source's FlowArn property. SRT caller/listener does not support merge mode failover.

senderControlPort?

Type: number (optional)

The port that the flow uses to send outbound requests to initiate connection with the sender.

senderIpAddress?

Type: string (optional)

The IP address that the flow communicates with to initiate connection with the sender.

sourceListenerAddress?

Type: string (optional)

Source IP or domain name for SRT-caller protocol.

sourceListenerPort?

Type: number (optional)

Source port for SRT-caller protocol.

streamId?

Type: string (optional)

The stream ID that you want to use for this transport.

This parameter applies only to Zixi and SRT caller-based streams.

vpcInterfaceName?

Type: string (optional)

The name of the VPC interface that you want to send your output to.

whitelistCidr?

Type: string (optional)

The range of IP addresses that are allowed to contribute content to your source.

Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

Properties

Name	Type	Description
attrIngestIp	`string`	The IP address that the flow listens on for incoming content.
attrSourceArn	`string`	The ARN of the source.
attrSourceIngestPort	`string`
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
description	`string`	A description of the source.
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	The name of the source.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
decryption?	`IResolvable` `\|` `EncryptionProperty`	The type of encryption that is used on the content ingested from the source.
entitlementArn?	`string`	The ARN of the entitlement that allows you to subscribe to the flow.
flowArn?	`string`	The Amazon Resource Name (ARN) of the flow this source is connected to.
ingestPort?	`number`	The port that the flow listens on for incoming content.
maxBitrate?	`number`	The maximum bitrate for RIST, RTP, and RTP-FEC streams.
maxLatency?	`number`	The maximum latency in milliseconds.
minLatency?	`number`	The minimum latency in milliseconds for SRT-based streams.
protocol?	`string`	The protocol that the source uses to deliver the content to MediaConnect.
senderControlPort?	`number`	The port that the flow uses to send outbound requests to initiate connection with the sender.
senderIpAddress?	`string`	The IP address that the flow communicates with to initiate connection with the sender.
sourceListenerAddress?	`string`	Source IP or domain name for SRT-caller protocol.
sourceListenerPort?	`number`	Source port for SRT-caller protocol.
streamId?	`string`	The stream ID that you want to use for this transport.
vpcInterfaceName?	`string`	The name of the VPC interface that you want to send your output to.
whitelistCidr?	`string`	The range of IP addresses that are allowed to contribute content to your source.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrIngestIp

Type: string

The IP address that the flow listens on for incoming content.

attrSourceArn

Type: string

The ARN of the source.

attrSourceIngestPort

Type: string

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

description

Type: string

A description of the source.

This description is not visible outside of the current AWS account.

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name

Type: string

The name of the source.

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

decryption?

Type: IResolvable | EncryptionProperty (optional)

The type of encryption that is used on the content ingested from the source.

entitlementArn?

Type: string (optional)

The ARN of the entitlement that allows you to subscribe to the flow.

The entitlement is set by the content originator, and the ARN is generated as part of the originator's flow.

flowArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the flow this source is connected to.

The flow must have Failover enabled to add an additional source.

ingestPort?

Type: number (optional)

The port that the flow listens on for incoming content.

If the protocol of the source is Zixi, the port must be set to 2088.

maxBitrate?

Type: number (optional)

The maximum bitrate for RIST, RTP, and RTP-FEC streams.

maxLatency?

Type: number (optional)

The maximum latency in milliseconds.

This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.

minLatency?

Type: number (optional)

The minimum latency in milliseconds for SRT-based streams.

protocol?

Type: string (optional)

The protocol that the source uses to deliver the content to MediaConnect.

senderControlPort?

Type: number (optional)

The port that the flow uses to send outbound requests to initiate connection with the sender.

senderIpAddress?

Type: string (optional)

The IP address that the flow communicates with to initiate connection with the sender.

sourceListenerAddress?

Type: string (optional)

Source IP or domain name for SRT-caller protocol.

sourceListenerPort?

Type: number (optional)

Source port for SRT-caller protocol.

streamId?

Type: string (optional)

The stream ID that you want to use for this transport.

This parameter applies only to Zixi and SRT caller-based streams.

vpcInterfaceName?

Type: string (optional)

The name of the VPC interface that you want to send your output to.

whitelistCidr?

Type: string (optional)

The range of IP addresses that are allowed to contribute content to your source.

Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }