CfnFlowSourceProps Struct
Properties for defining a CfnFlowSource.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediaconnect as mediaconnect } from 'aws-cdk-lib';
const cfnFlowSourceProps: mediaconnect.CfnFlowSourceProps = {
description: 'description',
flowArn: 'flowArn',
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',
gatewayBridgeSource: {
bridgeArn: 'bridgeArn',
// the properties below are optional
vpcInterfaceAttachment: {
vpcInterfaceName: 'vpcInterfaceName',
},
},
ingestPort: 123,
maxBitrate: 123,
maxLatency: 123,
minLatency: 123,
protocol: 'protocol',
senderControlPort: 123,
senderIpAddress: 'senderIpAddress',
sourceListenerAddress: 'sourceListenerAddress',
sourceListenerPort: 123,
streamId: 'streamId',
tags: [{
key: 'key',
value: 'value',
}],
vpcInterfaceName: 'vpcInterfaceName',
whitelistCidr: 'whitelistCidr',
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediaconnect as mediaconnect
cfn_flow_source_props = mediaconnect.CfnFlowSourceProps(
description="description",
flow_arn="flowArn",
name="name",
# the properties below are optional
decryption=mediaconnect.CfnFlowSource.EncryptionProperty(
role_arn="roleArn",
# the properties below are optional
algorithm="algorithm",
constant_initialization_vector="constantInitializationVector",
device_id="deviceId",
key_type="keyType",
region="region",
resource_id="resourceId",
secret_arn="secretArn",
url="url"
),
entitlement_arn="entitlementArn",
gateway_bridge_source=mediaconnect.CfnFlowSource.GatewayBridgeSourceProperty(
bridge_arn="bridgeArn",
# the properties below are optional
vpc_interface_attachment=mediaconnect.CfnFlowSource.VpcInterfaceAttachmentProperty(
vpc_interface_name="vpcInterfaceName"
)
),
ingest_port=123,
max_bitrate=123,
max_latency=123,
min_latency=123,
protocol="protocol",
sender_control_port=123,
sender_ip_address="senderIpAddress",
source_listener_address="sourceListenerAddress",
source_listener_port=123,
stream_id="streamId",
tags=[CfnTag(
key="key",
value="value"
)],
vpc_interface_name="vpcInterfaceName",
whitelist_cidr="whitelistCidr"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.mediaconnect.*;
CfnFlowSourceProps cfnFlowSourceProps = CfnFlowSourceProps.builder()
.description("description")
.flowArn("flowArn")
.name("name")
// the properties below are optional
.decryption(EncryptionProperty.builder()
.roleArn("roleArn")
// the properties below are optional
.algorithm("algorithm")
.constantInitializationVector("constantInitializationVector")
.deviceId("deviceId")
.keyType("keyType")
.region("region")
.resourceId("resourceId")
.secretArn("secretArn")
.url("url")
.build())
.entitlementArn("entitlementArn")
.gatewayBridgeSource(GatewayBridgeSourceProperty.builder()
.bridgeArn("bridgeArn")
// the properties below are optional
.vpcInterfaceAttachment(VpcInterfaceAttachmentProperty.builder()
.vpcInterfaceName("vpcInterfaceName")
.build())
.build())
.ingestPort(123)
.maxBitrate(123)
.maxLatency(123)
.minLatency(123)
.protocol("protocol")
.senderControlPort(123)
.senderIpAddress("senderIpAddress")
.sourceListenerAddress("sourceListenerAddress")
.sourceListenerPort(123)
.streamId("streamId")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.vpcInterfaceName("vpcInterfaceName")
.whitelistCidr("whitelistCidr")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaConnect;
var cfnFlowSourceProps = new CfnFlowSourceProps {
Description = "description",
FlowArn = "flowArn",
Name = "name",
// the properties below are optional
Decryption = new EncryptionProperty {
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",
GatewayBridgeSource = new GatewayBridgeSourceProperty {
BridgeArn = "bridgeArn",
// the properties below are optional
VpcInterfaceAttachment = new VpcInterfaceAttachmentProperty {
VpcInterfaceName = "vpcInterfaceName"
}
},
IngestPort = 123,
MaxBitrate = 123,
MaxLatency = 123,
MinLatency = 123,
Protocol = "protocol",
SenderControlPort = 123,
SenderIpAddress = "senderIpAddress",
SourceListenerAddress = "sourceListenerAddress",
SourceListenerPort = 123,
StreamId = "streamId",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcInterfaceName = "vpcInterfaceName",
WhitelistCidr = "whitelistCidr"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnFlowSourceProps := &CfnFlowSourceProps{
Description: jsii.String("description"),
FlowArn: jsii.String("flowArn"),
Name: jsii.String("name"),
// the properties below are optional
Decryption: &EncryptionProperty{
RoleArn: jsii.String("roleArn"),
// the properties below are optional
Algorithm: jsii.String("algorithm"),
ConstantInitializationVector: jsii.String("constantInitializationVector"),
DeviceId: jsii.String("deviceId"),
KeyType: jsii.String("keyType"),
Region: jsii.String("region"),
ResourceId: jsii.String("resourceId"),
SecretArn: jsii.String("secretArn"),
Url: jsii.String("url"),
},
EntitlementArn: jsii.String("entitlementArn"),
GatewayBridgeSource: &GatewayBridgeSourceProperty{
BridgeArn: jsii.String("bridgeArn"),
// the properties below are optional
VpcInterfaceAttachment: &VpcInterfaceAttachmentProperty{
VpcInterfaceName: jsii.String("vpcInterfaceName"),
},
},
IngestPort: jsii.Number(123),
MaxBitrate: jsii.Number(123),
MaxLatency: jsii.Number(123),
MinLatency: jsii.Number(123),
Protocol: jsii.String("protocol"),
SenderControlPort: jsii.Number(123),
SenderIpAddress: jsii.String("senderIpAddress"),
SourceListenerAddress: jsii.String("sourceListenerAddress"),
SourceListenerPort: jsii.Number(123),
StreamId: jsii.String("streamId"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
VpcInterfaceName: jsii.String("vpcInterfaceName"),
WhitelistCidr: jsii.String("whitelistCidr"),
}
Properties
decryptionoptionalIResolvable | CfnFlowSource.EncryptionPropertydecryptionoptionaltyping.Union[IResolvable, EncryptionProperty]decryptionoptionalIResolvableDecryptionoptionalIResolvableDecryptionoptionalinterface{}#The type of encryption that is used on the content ingested from this source.
Allowable encryption types: static-key.
A description for the source.
This value is not used or seen outside of the current MediaConnect account.
entitlementArnoptionalstringentitlement_arnoptionalstrentitlementArnoptionalStringEntitlementArnoptionalstringEntitlementArnoptional*stringdeprecated#this property has been deprecated
The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
The Amazon Resource Name (ARN) of the flow this source is connected to.
The flow must have Failover enabled to add an additional source.
gatewayBridgeSourceoptionalIResolvable | CfnFlowSource.GatewayBridgeSourcePropertygateway_bridge_sourceoptionaltyping.Union[IResolvable, GatewayBridgeSourceProperty]gatewayBridgeSourceoptionalIResolvableGatewayBridgeSourceoptionalIResolvableGatewayBridgeSourceoptionalinterface{}#The bridge's source.
ingestPortoptionalnumberingest_portoptionalint | floatingestPortoptionalNumberIngestPortoptionaldoubleIngestPortoptional*float64#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.
maxBitrateoptionalnumbermax_bitrateoptionalint | floatmaxBitrateoptionalNumberMaxBitrateoptionaldoubleMaxBitrateoptional*float64#The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
maxLatencyoptionalnumbermax_latencyoptionalint | floatmaxLatencyoptionalNumberMaxLatencyoptionaldoubleMaxLatencyoptional*float64#The maximum latency in milliseconds.
This parameter applies only to RIST-based and Zixi-based streams.
minLatencyoptionalnumbermin_latencyoptionalint | floatminLatencyoptionalNumberMinLatencyoptionaldoubleMinLatencyoptional*float64#The minimum latency in milliseconds for SRT-based streams.
notes
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.
The name of the source.
protocoloptionalstringprotocoloptionalstrprotocoloptionalStringProtocoloptionalstringProtocoloptional*string#The protocol that the source uses to deliver the content to MediaConnect.
notes
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.
senderControlPortoptionalnumbersender_control_portoptionalint | floatsenderControlPortoptionalNumberSenderControlPortoptionaldoubleSenderControlPortoptional*float64deprecated#this property has been deprecated
senderIpAddressoptionalstringsender_ip_addressoptionalstrsenderIpAddressoptionalStringSenderIpAddressoptionalstringSenderIpAddressoptional*stringdeprecated#this property has been deprecated
sourceListenerAddressoptionalstringsource_listener_addressoptionalstrsourceListenerAddressoptionalStringSourceListenerAddressoptionalstringSourceListenerAddressoptional*string#Source IP or domain name for SRT-caller protocol.
sourceListenerPortoptionalnumbersource_listener_portoptionalint | floatsourceListenerPortoptionalNumberSourceListenerPortoptionaldoubleSourceListenerPortoptional*float64#Source port for SRT-caller protocol.
streamIdoptionalstringstream_idoptionalstrstreamIdoptionalStringStreamIdoptionalstringStreamIdoptional*string#The stream ID that you want to use for this transport.
This parameter applies only to Zixi and SRT caller-based streams.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#Key-value pairs that can be used to tag and organize this flow source.
vpcInterfaceNameoptionalstringvpc_interface_nameoptionalstrvpcInterfaceNameoptionalStringVpcInterfaceNameoptionalstringVpcInterfaceNameoptional*string#The name of the VPC interface to use for this source.
whitelistCidroptionalstringwhitelist_cidroptionalstrwhitelistCidroptionalStringWhitelistCidroptionalstringWhitelistCidroptional*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.