Class CfnFlowSourceProps.Builder
java.lang.Object
software.amazon.awscdk.services.mediaconnect.CfnFlowSourceProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnFlowSourceProps>
- Enclosing interface:
CfnFlowSourceProps
@Stability(Stable)
public static final class CfnFlowSourceProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnFlowSourceProps>
A builder for
CfnFlowSourceProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.decryption
(IResolvable decryption) Sets the value ofCfnFlowSourceProps.getDecryption()
decryption
(CfnFlowSource.EncryptionProperty decryption) Sets the value ofCfnFlowSourceProps.getDecryption()
description
(String description) Sets the value ofCfnFlowSourceProps.getDescription()
entitlementArn
(String entitlementArn) Sets the value ofCfnFlowSourceProps.getEntitlementArn()
Sets the value ofCfnFlowSourceProps.getFlowArn()
gatewayBridgeSource
(IResolvable gatewayBridgeSource) Sets the value ofCfnFlowSourceProps.getGatewayBridgeSource()
gatewayBridgeSource
(CfnFlowSource.GatewayBridgeSourceProperty gatewayBridgeSource) Sets the value ofCfnFlowSourceProps.getGatewayBridgeSource()
ingestPort
(Number ingestPort) Sets the value ofCfnFlowSourceProps.getIngestPort()
maxBitrate
(Number maxBitrate) Sets the value ofCfnFlowSourceProps.getMaxBitrate()
maxLatency
(Number maxLatency) Sets the value ofCfnFlowSourceProps.getMaxLatency()
minLatency
(Number minLatency) Sets the value ofCfnFlowSourceProps.getMinLatency()
Sets the value ofCfnFlowSourceProps.getName()
Sets the value ofCfnFlowSourceProps.getProtocol()
senderControlPort
(Number senderControlPort) Sets the value ofCfnFlowSourceProps.getSenderControlPort()
senderIpAddress
(String senderIpAddress) Sets the value ofCfnFlowSourceProps.getSenderIpAddress()
sourceListenerAddress
(String sourceListenerAddress) Sets the value ofCfnFlowSourceProps.getSourceListenerAddress()
sourceListenerPort
(Number sourceListenerPort) Sets the value ofCfnFlowSourceProps.getSourceListenerPort()
Sets the value ofCfnFlowSourceProps.getStreamId()
vpcInterfaceName
(String vpcInterfaceName) Sets the value ofCfnFlowSourceProps.getVpcInterfaceName()
whitelistCidr
(String whitelistCidr) Sets the value ofCfnFlowSourceProps.getWhitelistCidr()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
description
Sets the value ofCfnFlowSourceProps.getDescription()
- Parameters:
description
- A description of the source. This parameter is required. This description is not visible outside of the current AWS account.- Returns:
this
-
name
Sets the value ofCfnFlowSourceProps.getName()
- Parameters:
name
- The name of the source. This parameter is required.- Returns:
this
-
decryption
Sets the value ofCfnFlowSourceProps.getDecryption()
- Parameters:
decryption
- The type of encryption that is used on the content ingested from the source.- Returns:
this
-
decryption
@Stability(Stable) public CfnFlowSourceProps.Builder decryption(CfnFlowSource.EncryptionProperty decryption) Sets the value ofCfnFlowSourceProps.getDecryption()
- Parameters:
decryption
- The type of encryption that is used on the content ingested from the source.- Returns:
this
-
entitlementArn
Sets the value ofCfnFlowSourceProps.getEntitlementArn()
- Parameters:
entitlementArn
- 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.- Returns:
this
-
flowArn
Sets the value ofCfnFlowSourceProps.getFlowArn()
- Parameters:
flowArn
- The Amazon Resource Name (ARN) of the flow this source is connected to. The flow must have Failover enabled to add an additional source.- Returns:
this
-
gatewayBridgeSource
@Stability(Stable) public CfnFlowSourceProps.Builder gatewayBridgeSource(IResolvable gatewayBridgeSource) Sets the value ofCfnFlowSourceProps.getGatewayBridgeSource()
- Parameters:
gatewayBridgeSource
- The source configuration for cloud flows receiving a stream from a bridge.- Returns:
this
-
gatewayBridgeSource
@Stability(Stable) public CfnFlowSourceProps.Builder gatewayBridgeSource(CfnFlowSource.GatewayBridgeSourceProperty gatewayBridgeSource) Sets the value ofCfnFlowSourceProps.getGatewayBridgeSource()
- Parameters:
gatewayBridgeSource
- The source configuration for cloud flows receiving a stream from a bridge.- Returns:
this
-
ingestPort
Sets the value ofCfnFlowSourceProps.getIngestPort()
- Parameters:
ingestPort
- 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.- Returns:
this
-
maxBitrate
Sets the value ofCfnFlowSourceProps.getMaxBitrate()
- Parameters:
maxBitrate
- The maximum bitrate for RIST, RTP, and RTP-FEC streams.- Returns:
this
-
maxLatency
Sets the value ofCfnFlowSourceProps.getMaxLatency()
- Parameters:
maxLatency
- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.- Returns:
this
-
minLatency
Sets the value ofCfnFlowSourceProps.getMinLatency()
- Parameters:
minLatency
- 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.- Returns:
this
-
protocol
Sets the value ofCfnFlowSourceProps.getProtocol()
- Parameters:
protocol
- 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 toFAILOVER
. TheFailoverMode
property is found in theFailoverConfig
resource of the same flow ARN you used for the source'sFlowArn
property. SRT caller/listener does not support merge mode failover.- Returns:
this
-
senderControlPort
Sets the value ofCfnFlowSourceProps.getSenderControlPort()
- Parameters:
senderControlPort
- The port that the flow uses to send outbound requests to initiate connection with the sender.- Returns:
this
-
senderIpAddress
Sets the value ofCfnFlowSourceProps.getSenderIpAddress()
- Parameters:
senderIpAddress
- The IP address that the flow communicates with to initiate connection with the sender.- Returns:
this
-
sourceListenerAddress
@Stability(Stable) public CfnFlowSourceProps.Builder sourceListenerAddress(String sourceListenerAddress) Sets the value ofCfnFlowSourceProps.getSourceListenerAddress()
- Parameters:
sourceListenerAddress
- Source IP or domain name for SRT-caller protocol.- Returns:
this
-
sourceListenerPort
Sets the value ofCfnFlowSourceProps.getSourceListenerPort()
- Parameters:
sourceListenerPort
- Source port for SRT-caller protocol.- Returns:
this
-
streamId
Sets the value ofCfnFlowSourceProps.getStreamId()
- Parameters:
streamId
- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.- Returns:
this
-
vpcInterfaceName
Sets the value ofCfnFlowSourceProps.getVpcInterfaceName()
- Parameters:
vpcInterfaceName
- The name of the VPC interface that you want to send your output to.- Returns:
this
-
whitelistCidr
Sets the value ofCfnFlowSourceProps.getWhitelistCidr()
- Parameters:
whitelistCidr
- 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.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnFlowSourceProps>
- Returns:
- a new instance of
CfnFlowSourceProps
- Throws:
NullPointerException
- if any required attribute was not provided
-