Package software.amazon.awscdk.services.mediaconnect

Interface CfnFlowSourceProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnFlowSourceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.895Z") @Stability(Stable) public interface CfnFlowSourceProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnFlowSource.

Example: 

 // 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")
         .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")
         .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")
         .build();

  • Method Details

    • getDescription

      @Stability(Stable) @NotNull String getDescription()
      A description of the source.

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

    • getName

      @Stability(Stable) @NotNull String getName()
      The name of the source.

    • getDecryption

      @Stability(Stable) @Nullable default Object getDecryption()
      The type of encryption that is used on the content ingested from the source.

    • getEntitlementArn

      @Stability(Stable) @Nullable default String getEntitlementArn()
      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.

    • getFlowArn

      @Stability(Stable) @Nullable default String getFlowArn()
      The Amazon Resource Name (ARN) of the flow this source is connected to.

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

    • getIngestPort

      @Stability(Stable) @Nullable default Number getIngestPort()
      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.

    • getMaxBitrate

      @Stability(Stable) @Nullable default Number getMaxBitrate()
      The maximum bitrate for RIST, RTP, and RTP-FEC streams.

    • getMaxLatency

      @Stability(Stable) @Nullable default Number getMaxLatency()
      The maximum latency in milliseconds.

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

    • getMinLatency

      @Stability(Stable) @Nullable default Number getMinLatency()
      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.

    • getProtocol

      @Stability(Stable) @Nullable default String getProtocol()
      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.

    • getSenderControlPort

      @Stability(Stable) @Nullable default Number getSenderControlPort()
      The port that the flow uses to send outbound requests to initiate connection with the sender.

    • getSenderIpAddress

      @Stability(Stable) @Nullable default String getSenderIpAddress()
      The IP address that the flow communicates with to initiate connection with the sender.

    • getSourceListenerAddress

      @Stability(Stable) @Nullable default String getSourceListenerAddress()
      Source IP or domain name for SRT-caller protocol.

    • getSourceListenerPort

      @Stability(Stable) @Nullable default Number getSourceListenerPort()
      Source port for SRT-caller protocol.

    • getStreamId

      @Stability(Stable) @Nullable default String getStreamId()
      The stream ID that you want to use for this transport.

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

    • getVpcInterfaceName

      @Stability(Stable) @Nullable default String getVpcInterfaceName()
      The name of the VPC interface that you want to send your output to.

    • getWhitelistCidr

      @Stability(Stable) @Nullable default String getWhitelistCidr()
      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.

    • builder

      @Stability(Stable) static CfnFlowSourceProps.Builder builder()
      Returns:
      a CfnFlowSourceProps.Builder of CfnFlowSourceProps