Package software.amazon.awscdk.services.mediaconnect

Interface CfnFlow.SourceProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnFlow.SourceProperty.Jsii$Proxy
Enclosing class:
CfnFlow
@Stability(Stable) public static interface CfnFlow.SourceProperty extends software.amazon.jsii.JsiiSerializable
The details of the sources of the flow.

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:

  • Use CloudFormation to create a flow with a standard source that uses the flow’s public IP address.
  • Use CloudFormation to create the VPC interface to add to this flow. This can also be done as part of the previous step.
  • After CloudFormation has created the flow and the VPC interface, update the source to point to the VPC interface that you created.

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.*;
 SourceProperty sourceProperty = SourceProperty.builder()
         .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())
         .description("description")
         .entitlementArn("entitlementArn")
         .ingestIp("ingestIp")
         .ingestPort(123)
         .maxBitrate(123)
         .maxLatency(123)
         .minLatency(123)
         .name("name")
         .protocol("protocol")
         .senderControlPort(123)
         .senderIpAddress("senderIpAddress")
         .sourceArn("sourceArn")
         .sourceIngestPort("sourceIngestPort")
         .sourceListenerAddress("sourceListenerAddress")
         .sourceListenerPort(123)
         .streamId("streamId")
         .vpcInterfaceName("vpcInterfaceName")
         .whitelistCidr("whitelistCidr")
         .build();

  • Method Details

    • getDecryption

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

    • getDescription

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

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

    • getEntitlementArn

      @Stability(Stable) @Nullable default String getEntitlementArn()
      The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account.

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

    • getIngestIp

      @Stability(Stable) @Nullable default String getIngestIp()
      The IP address that the flow listens on for incoming content.

    • 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 for a RIST or Zixi-based source.

    • 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.

    • getName

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

    • getProtocol

      @Stability(Stable) @Nullable default String getProtocol()
      The protocol that is used by the source.

      AWS CloudFormation does not currently support CDI or ST 2110 JPEG XS source protocols.

    • 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.

    • getSourceArn

      @Stability(Stable) @Nullable default String getSourceArn()
      The ARN of the source.

    • getSourceIngestPort

      @Stability(Stable) @Nullable default String getSourceIngestPort()
      The port that the flow will be listening on for incoming content.

    • 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 the transport.

      This parameter applies only to Zixi-based streams.

    • getVpcInterfaceName

      @Stability(Stable) @Nullable default String getVpcInterfaceName()
      The name of the VPC interface that the source content comes from.

    • 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 CfnFlow.SourceProperty.Builder builder()
      Returns:
      a CfnFlow.SourceProperty.Builder of CfnFlow.SourceProperty