Interface CfnFlow.ISourceProperty
The details of the sources of the flow.
Namespace: Amazon.CDK.AWS.MediaConnect
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ISourceProperty
Syntax (vb)
Public Interface ISourceProperty
Remarks
If you are creating a flow with a VPC source, you must first create the flow with a temporary standard source by doing the following:
ExampleMetadata: fixture=_generated
Examples
// 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 sourceProperty = new SourceProperty {
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"
},
Description = "description",
EntitlementArn = "entitlementArn",
GatewayBridgeSource = new GatewayBridgeSourceProperty {
BridgeArn = "bridgeArn",
// the properties below are optional
VpcInterfaceAttachment = new VpcInterfaceAttachmentProperty {
VpcInterfaceName = "vpcInterfaceName"
}
},
IngestIp = "ingestIp",
IngestPort = 123,
MaxBitrate = 123,
MaxLatency = 123,
MaxSyncBuffer = 123,
MediaStreamSourceConfigurations = new [] { new MediaStreamSourceConfigurationProperty {
EncodingName = "encodingName",
MediaStreamName = "mediaStreamName",
// the properties below are optional
InputConfigurations = new [] { new InputConfigurationProperty {
InputPort = 123,
Interface = new InterfaceProperty {
Name = "name"
}
} }
} },
MinLatency = 123,
Name = "name",
Protocol = "protocol",
SenderControlPort = 123,
SenderIpAddress = "senderIpAddress",
SourceArn = "sourceArn",
SourceIngestPort = "sourceIngestPort",
SourceListenerAddress = "sourceListenerAddress",
SourceListenerPort = 123,
StreamId = "streamId",
VpcInterfaceName = "vpcInterfaceName",
WhitelistCidr = "whitelistCidr"
};
Synopsis
Properties
Decryption | The type of encryption that is used on the content ingested from the source. |
Description | A description of the source. |
EntitlementArn | The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. |
GatewayBridgeSource | The source configuration for cloud flows receiving a stream from a bridge. |
IngestIp | The IP address that the flow listens on for incoming content. |
IngestPort | The port that the flow listens on for incoming content. |
MaxBitrate | The maximum bitrate for RIST, RTP, and RTP-FEC streams. |
MaxLatency | The maximum latency in milliseconds for a RIST or Zixi-based source. |
MaxSyncBuffer | The size of the buffer (in milliseconds) to use to sync incoming source data. |
MediaStreamSourceConfigurations | The media stream that is associated with the source, and the parameters for that association. |
MinLatency | The minimum latency in milliseconds for SRT-based streams. |
Name | The name of the source. |
Protocol | The protocol that is used by the source. |
SenderControlPort | The port that the flow uses to send outbound requests to initiate connection with the sender. |
SenderIpAddress | The IP address that the flow communicates with to initiate connection with the sender. |
SourceArn | The ARN of the source. |
SourceIngestPort | The port that the flow listens on for incoming content. |
SourceListenerAddress | Source IP or domain name for SRT-caller protocol. |
SourceListenerPort | Source port for SRT-caller protocol. |
StreamId | The stream ID that you want to use for the transport. |
VpcInterfaceName | The name of the VPC interface that the source content comes from. |
WhitelistCidr | The range of IP addresses that are allowed to contribute content to your source. |
Properties
Decryption
The type of encryption that is used on the content ingested from the source.
virtual object Decryption { get; }
Property Value
System.Object
Remarks
Description
A description of the source.
virtual string Description { get; }
Property Value
System.String
Remarks
This description is not visible outside of the current AWS account.
EntitlementArn
The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account.
virtual string EntitlementArn { get; }
Property Value
System.String
Remarks
The entitlement is set by the content originator and the ARN is generated as part of the originator’s flow.
GatewayBridgeSource
The source configuration for cloud flows receiving a stream from a bridge.
virtual object GatewayBridgeSource { get; }
Property Value
System.Object
Remarks
IngestIp
The IP address that the flow listens on for incoming content.
virtual string IngestIp { get; }
Property Value
System.String
Remarks
IngestPort
The port that the flow listens on for incoming content.
virtual Nullable<double> IngestPort { get; }
Property Value
System.Nullable<System.Double>
Remarks
If the protocol of the source is Zixi, the port must be set to 2088.
MaxBitrate
The maximum bitrate for RIST, RTP, and RTP-FEC streams.
virtual Nullable<double> MaxBitrate { get; }
Property Value
System.Nullable<System.Double>
Remarks
MaxLatency
The maximum latency in milliseconds for a RIST or Zixi-based source.
virtual Nullable<double> MaxLatency { get; }
Property Value
System.Nullable<System.Double>
Remarks
MaxSyncBuffer
The size of the buffer (in milliseconds) to use to sync incoming source data.
virtual Nullable<double> MaxSyncBuffer { get; }
Property Value
System.Nullable<System.Double>
Remarks
MediaStreamSourceConfigurations
The media stream that is associated with the source, and the parameters for that association.
virtual object MediaStreamSourceConfigurations { get; }
Property Value
System.Object
Remarks
MinLatency
The minimum latency in milliseconds for SRT-based streams.
virtual Nullable<double> MinLatency { get; }
Property Value
System.Nullable<System.Double>
Remarks
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.
Default: - 2000
Name
The name of the source.
virtual string Name { get; }
Property Value
System.String
Remarks
Protocol
The protocol that is used by the source.
virtual string Protocol { get; }
Property Value
System.String
Remarks
AWS CloudFormation does not currently support CDI or ST 2110 JPEG XS source protocols.
SenderControlPort
The port that the flow uses to send outbound requests to initiate connection with the sender.
virtual Nullable<double> SenderControlPort { get; }
Property Value
System.Nullable<System.Double>
Remarks
SenderIpAddress
The IP address that the flow communicates with to initiate connection with the sender.
virtual string SenderIpAddress { get; }
Property Value
System.String
Remarks
SourceArn
The ARN of the source.
virtual string SourceArn { get; }
Property Value
System.String
Remarks
SourceIngestPort
The port that the flow listens on for incoming content.
virtual string SourceIngestPort { get; }
Property Value
System.String
Remarks
If the protocol of the source is Zixi, the port must be set to 2088.
SourceListenerAddress
Source IP or domain name for SRT-caller protocol.
virtual string SourceListenerAddress { get; }
Property Value
System.String
Remarks
SourceListenerPort
Source port for SRT-caller protocol.
virtual Nullable<double> SourceListenerPort { get; }
Property Value
System.Nullable<System.Double>
Remarks
StreamId
The stream ID that you want to use for the transport.
virtual string StreamId { get; }
Property Value
System.String
Remarks
This parameter applies only to Zixi-based streams.
VpcInterfaceName
The name of the VPC interface that the source content comes from.
virtual string VpcInterfaceName { get; }
Property Value
System.String
Remarks
WhitelistCidr
The range of IP addresses that are allowed to contribute content to your source.
virtual string WhitelistCidr { get; }
Property Value
System.String
Remarks
Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.