software.amazon.awscdk.services.mediaconnect

Class CfnFlowSource

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.mediaconnect.CfnFlowSource

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.973Z")
 @Stability(value=Stable)
public class CfnFlowSource
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MediaConnect::FlowSource`.

The AWS::MediaConnect::FlowSource resource is the external video content that includes configuration information (encryption and source type) and a network address. Each flow has at least one source. A standard source comes from a source other than another AWS Elemental MediaConnect flow, such as an on-premises encoder. An entitled source comes from a MediaConnect flow that is owned by another AWS account and has granted an entitlement to your account.

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.*;
 CfnFlowSource cfnFlowSource = CfnFlowSource.Builder.create(this, "MyCfnFlowSource")
         .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	Class and Description
static class	CfnFlowSource.Builder A fluent builder for CfnFlowSource.
static interface	CfnFlowSource.EncryptionProperty Information about the encryption of the flow.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFlowSource(Construct scope, String id, CfnFlowSourceProps props) Create a new `AWS::MediaConnect::FlowSource`.
protected	CfnFlowSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFlowSource(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrIngestIp() The IP address that the flow listens on for incoming content.
String	getAttrSourceArn() The ARN of the source.
String	getAttrSourceIngestPort()
protected Map<String,Object>	getCfnProperties()
Object	getDecryption() The type of encryption that is used on the content ingested from the source.
String	getDescription() A description of the source.
String	getEntitlementArn() The ARN of the entitlement that allows you to subscribe to the flow.
String	getFlowArn() The Amazon Resource Name (ARN) of the flow.
Number	getIngestPort() The port that the flow listens on for incoming content.
Number	getMaxBitrate() The maximum bitrate for RIST, RTP, and RTP-FEC streams.
Number	getMaxLatency() The maximum latency in milliseconds.
String	getName() The name of the source.
String	getProtocol() The protocol that the source uses to deliver the content to MediaConnect.
String	getStreamId() The stream ID that you want to use for the transport.
String	getVpcInterfaceName() The name of the VPC interface that you want to send your output to.
String	getWhitelistCidr() The range of IP addresses that are allowed to contribute content to your source.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDecryption(CfnFlowSource.EncryptionProperty value) The type of encryption that is used on the content ingested from the source.
void	setDecryption(IResolvable value) The type of encryption that is used on the content ingested from the source.
void	setDescription(String value) A description of the source.
void	setEntitlementArn(String value) The ARN of the entitlement that allows you to subscribe to the flow.
void	setFlowArn(String value) The Amazon Resource Name (ARN) of the flow.
void	setIngestPort(Number value) The port that the flow listens on for incoming content.
void	setMaxBitrate(Number value) The maximum bitrate for RIST, RTP, and RTP-FEC streams.
void	setMaxLatency(Number value) The maximum latency in milliseconds.
void	setName(String value) The name of the source.
void	setProtocol(String value) The protocol that the source uses to deliver the content to MediaConnect.
void	setStreamId(String value) The stream ID that you want to use for the transport.
void	setVpcInterfaceName(String value) The name of the VPC interface that you want to send your output to.
void	setWhitelistCidr(String value) The range of IP addresses that are allowed to contribute content to your source.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFlowSource

protected CfnFlowSource(software.amazon.jsii.JsiiObjectRef objRef)

CfnFlowSource

protected CfnFlowSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFlowSource

@Stability(value=Stable)
public CfnFlowSource(@NotNull
                                              Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnFlowSourceProps props)

Create a new `AWS::MediaConnect::FlowSource`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrIngestIp

@Stability(value=Stable)
 @NotNull
public String getAttrIngestIp()

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

getAttrSourceArn

@Stability(value=Stable)
 @NotNull
public String getAttrSourceArn()

The ARN of the source.

getAttrSourceIngestPort

@Stability(value=Stable)
 @NotNull
public String getAttrSourceIngestPort()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDescription

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

A description of the source.

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

setDescription

@Stability(value=Stable)
public void setDescription(@NotNull
                                                    String value)

A description of the source.

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

getName

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

The name of the source.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the source.

getDecryption

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

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

setDecryption

@Stability(value=Stable)
public void setDecryption(@Nullable
                                                   IResolvable value)

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

setDecryption

@Stability(value=Stable)
public void setDecryption(@Nullable
                                                   CfnFlowSource.EncryptionProperty value)

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

getEntitlementArn

@Stability(value=Stable)
 @Nullable
public 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.

setEntitlementArn

@Stability(value=Stable)
public void setEntitlementArn(@Nullable
                                                       String value)

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
public String getFlowArn()

The Amazon Resource Name (ARN) of the flow.

setFlowArn

@Stability(value=Stable)
public void setFlowArn(@Nullable
                                                String value)

The Amazon Resource Name (ARN) of the flow.

getIngestPort

@Stability(value=Stable)
 @Nullable
public 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.

setIngestPort

@Stability(value=Stable)
public void setIngestPort(@Nullable
                                                   Number value)

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
public Number getMaxBitrate()

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

setMaxBitrate

@Stability(value=Stable)
public void setMaxBitrate(@Nullable
                                                   Number value)

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

getMaxLatency

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

The maximum latency in milliseconds.

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

setMaxLatency

@Stability(value=Stable)
public void setMaxLatency(@Nullable
                                                   Number value)

The maximum latency in milliseconds.

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

getProtocol

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

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

setProtocol

@Stability(value=Stable)
public void setProtocol(@Nullable
                                                 String value)

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

getStreamId

@Stability(value=Stable)
 @Nullable
public String getStreamId()

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

This parameter applies only to Zixi-based streams.

setStreamId

@Stability(value=Stable)
public void setStreamId(@Nullable
                                                 String value)

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

This parameter applies only to Zixi-based streams.

getVpcInterfaceName

@Stability(value=Stable)
 @Nullable
public String getVpcInterfaceName()

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

setVpcInterfaceName

@Stability(value=Stable)
public void setVpcInterfaceName(@Nullable
                                                         String value)

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

getWhitelistCidr

@Stability(value=Stable)
 @Nullable
public 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.

setWhitelistCidr

@Stability(value=Stable)
public void setWhitelistCidr(@Nullable
                                                      String value)

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.