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(value=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")
         .sourceArn("sourceArn")
         .sourceIngestPort("sourceIngestPort")
         .streamId("streamId")
         .vpcInterfaceName("vpcInterfaceName")
         .whitelistCidr("whitelistCidr")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnFlow.SourceProperty.Builder A builder for CfnFlow.SourceProperty
static class	CfnFlow.SourceProperty.Jsii$Proxy An implementation for CfnFlow.SourceProperty

Method Summary

Modifier and Type	Method and Description
static CfnFlow.SourceProperty.Builder	builder()
default Object	getDecryption() The type of encryption that is used on the content ingested from the source.
default String	getDescription() A description of the source.
default String	getEntitlementArn() The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account.
default String	getIngestIp() The IP address that the flow listens on for incoming content.
default Number	getIngestPort() The port that the flow listens on for incoming content.
default Number	getMaxBitrate() The maximum bitrate for RIST, RTP, and RTP-FEC streams.
default Number	getMaxLatency() The maximum latency in milliseconds for a RIST or Zixi-based source.
default Number	getMinLatency() The minimum latency in milliseconds for SRT-based streams.
default String	getName() The name of the source.
default String	getProtocol() The protocol that is used by the source.
default String	getSourceArn() The ARN of the source.
default String	getSourceIngestPort() The port that the flow will be listening on for incoming content.
default String	getStreamId() The stream ID that you want to use for the transport.
default String	getVpcInterfaceName() The name of the VPC interface that the source content comes from.
default String	getWhitelistCidr() The range of IP addresses that are allowed to contribute content to your source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDecryption

@Stability(value=Stable)
 @Nullable
default Object getDecryption()

The type of encryption that is used on the content ingested from the source.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A description of the source.

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

getEntitlementArn

@Stability(value=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(value=Stable)
 @Nullable
default String getIngestIp()

The IP address that the flow listens on for incoming content.

getIngestPort

@Stability(value=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(value=Stable)
 @Nullable
default Number getMaxBitrate()

The maximum bitrate for RIST, RTP, and RTP-FEC streams.

getMaxLatency

@Stability(value=Stable)
 @Nullable
default Number getMaxLatency()

The maximum latency in milliseconds for a RIST or Zixi-based source.

getMinLatency

@Stability(value=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(value=Stable)
 @Nullable
default String getName()

The name of the source.

getProtocol

@Stability(value=Stable)
 @Nullable
default String getProtocol()

The protocol that is used by the source.

For a full list of available protocols, see: Source protocols in the AWS Elemental MediaConnect API Reference .

getSourceArn

@Stability(value=Stable)
 @Nullable
default String getSourceArn()

The ARN of the source.

getSourceIngestPort

@Stability(value=Stable)
 @Nullable
default String getSourceIngestPort()

The port that the flow will be listening on for incoming content.

getStreamId

@Stability(value=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(value=Stable)
 @Nullable
default String getVpcInterfaceName()

The name of the VPC interface that the source content comes from.

getWhitelistCidr

@Stability(value=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(value=Stable)
static CfnFlow.SourceProperty.Builder builder()

Returns:

a CfnFlow.SourceProperty.Builder of CfnFlow.SourceProperty