software.amazon.awscdk.services.mediaconnect

Interface CfnFlowSourceProps

All Known Implementing Classes:

CfnFlowSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:55.794Z")
public interface CfnFlowSourceProps

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 java.lang.Object	getDecryption() The type of encryption that is used on the content ingested from the source.
java.lang.String	getDescription() A description of the source.
default java.lang.String	getEntitlementArn() The ARN of the entitlement that allows you to subscribe to the flow.
default java.lang.String	getFlowArn() The Amazon Resource Name (ARN) of the flow.
default java.lang.Number	getIngestPort() The port that the flow listens on for incoming content.
default java.lang.Number	getMaxBitrate() The maximum bitrate for RIST, RTP, and RTP-FEC streams.
default java.lang.Number	getMaxLatency() The maximum latency in milliseconds.
java.lang.String	getName() The name of the source.
default java.lang.String	getProtocol() The protocol that the source uses to deliver the content to MediaConnect.
default java.lang.String	getStreamId() The stream ID that you want to use for the transport.
default java.lang.String	getVpcInterfaceName() The name of the VPC interface that you want to send your output to.
default java.lang.String	getWhitelistCidr() The range of IP addresses that are allowed to contribute content to your source.

Method Detail

getDescription

java.lang.String getDescription()

A description of the source.

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

getName

java.lang.String getName()

The name of the source.

getDecryption

default java.lang.Object getDecryption()

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

getEntitlementArn

default java.lang.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

default java.lang.String getFlowArn()

The Amazon Resource Name (ARN) of the flow.

getIngestPort

default java.lang.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

default java.lang.Number getMaxBitrate()

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

getMaxLatency

default java.lang.Number getMaxLatency()

The maximum latency in milliseconds.

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

getProtocol

default java.lang.String getProtocol()

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

getStreamId

default java.lang.String getStreamId()

The stream ID that you want to use for the transport.

This parameter applies only to Zixi-based streams.

getVpcInterfaceName

default java.lang.String getVpcInterfaceName()

The name of the VPC interface that you want to send your output to.

getWhitelistCidr

default java.lang.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

static CfnFlowSourceProps.Builder builder()

Returns:

a CfnFlowSourceProps.Builder of CfnFlowSourceProps