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.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.975Z")
 @Stability(value=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()
                 .algorithm("algorithm")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .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)
         .protocol("protocol")
         .streamId("streamId")
         .vpcInterfaceName("vpcInterfaceName")
         .whitelistCidr("whitelistCidr")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnFlowSourceProps.Builder	builder()
default Object	getDecryption() The type of encryption that is used on the content ingested from the source.
String	getDescription() A description of the source.
default String	getEntitlementArn() The ARN of the entitlement that allows you to subscribe to the flow.
default String	getFlowArn() The Amazon Resource Name (ARN) of the flow.
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.
String	getName() The name of the source.
default String	getProtocol() The protocol that the source uses to deliver the content to MediaConnect.
default String	getStreamId() The stream ID that you want to use for the transport.
default String	getVpcInterfaceName() The name of the VPC interface that you want to send your output to.
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

getDescription

@Stability(value=Stable)
 @NotNull
String getDescription()

A description of the source.

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

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the source.

getDecryption

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

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

getEntitlementArn

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

The Amazon Resource Name (ARN) of the flow.

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.

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

getProtocol

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

The protocol that the source uses to deliver the content to MediaConnect.

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 you want to send your output to.

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 CfnFlowSourceProps.Builder builder()

Returns:

a CfnFlowSourceProps.Builder of CfnFlowSourceProps