software.amazon.awscdk.services.mediaconnect

Class CfnFlowOutput

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

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.970Z")
 @Stability(value=Stable)
public class CfnFlowOutput
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MediaConnect::FlowOutput`.

The AWS::MediaConnect::FlowOutput resource defines the destination address, protocol, and port that AWS Elemental MediaConnect sends the ingested video to. Each flow can have up to 50 outputs. An output can have the same protocol or a different protocol from the source.

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.*;
 CfnFlowOutput cfnFlowOutput = CfnFlowOutput.Builder.create(this, "MyCfnFlowOutput")
         .flowArn("flowArn")
         .protocol("protocol")
         // the properties below are optional
         .cidrAllowList(List.of("cidrAllowList"))
         .description("description")
         .destination("destination")
         .encryption(EncryptionProperty.builder()
                 .roleArn("roleArn")
                 .secretArn("secretArn")
                 // the properties below are optional
                 .algorithm("algorithm")
                 .keyType("keyType")
                 .build())
         .maxLatency(123)
         .minLatency(123)
         .name("name")
         .port(123)
         .remoteId("remoteId")
         .smoothingLatency(123)
         .streamId("streamId")
         .vpcInterfaceAttachment(VpcInterfaceAttachmentProperty.builder()
                 .vpcInterfaceName("vpcInterfaceName")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnFlowOutput.Builder A fluent builder for CfnFlowOutput.
static interface	CfnFlowOutput.EncryptionProperty Information about the encryption of the flow.
static interface	CfnFlowOutput.VpcInterfaceAttachmentProperty The VPC interface that you want to send your output to.

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
	CfnFlowOutput(Construct scope, String id, CfnFlowOutputProps props) Create a new `AWS::MediaConnect::FlowOutput`.
protected	CfnFlowOutput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFlowOutput(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrOutputArn() The ARN of the output.
protected Map<String,Object>	getCfnProperties()
List<String>	getCidrAllowList() The range of IP addresses that are allowed to initiate output requests to this flow.
String	getDescription() A description of the output.
String	getDestination() The IP address where you want to send the output.
Object	getEncryption() The encryption credentials that you want to use for the output.
String	getFlowArn() The Amazon Resource Name (ARN) of the flow.
Number	getMaxLatency() The maximum latency in milliseconds for Zixi-based streams.
Number	getMinLatency() The minimum latency in milliseconds for SRT-based streams.
String	getName() The name of the VPC interface.
Number	getPort() The port to use when MediaConnect distributes content to the output.
String	getProtocol() The protocol to use for the output.
String	getRemoteId() The identifier that is assigned to the Zixi receiver.
Number	getSmoothingLatency() The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
String	getStreamId() The stream ID that you want to use for the transport.
Object	getVpcInterfaceAttachment() The VPC interface that you want to send your output to.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCidrAllowList(List<String> value) The range of IP addresses that are allowed to initiate output requests to this flow.
void	setDescription(String value) A description of the output.
void	setDestination(String value) The IP address where you want to send the output.
void	setEncryption(CfnFlowOutput.EncryptionProperty value) The encryption credentials that you want to use for the output.
void	setEncryption(IResolvable value) The encryption credentials that you want to use for the output.
void	setFlowArn(String value) The Amazon Resource Name (ARN) of the flow.
void	setMaxLatency(Number value) The maximum latency in milliseconds for Zixi-based streams.
void	setMinLatency(Number value) The minimum latency in milliseconds for SRT-based streams.
void	setName(String value) The name of the VPC interface.
void	setPort(Number value) The port to use when MediaConnect distributes content to the output.
void	setProtocol(String value) The protocol to use for the output.
void	setRemoteId(String value) The identifier that is assigned to the Zixi receiver.
void	setSmoothingLatency(Number value) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
void	setStreamId(String value) The stream ID that you want to use for the transport.
void	setVpcInterfaceAttachment(CfnFlowOutput.VpcInterfaceAttachmentProperty value) The VPC interface that you want to send your output to.
void	setVpcInterfaceAttachment(IResolvable value) The VPC interface that you want to send your output to.

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

CfnFlowOutput

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

CfnFlowOutput

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

CfnFlowOutput

@Stability(value=Stable)
public CfnFlowOutput(@NotNull
                                              Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnFlowOutputProps props)

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

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.

getAttrOutputArn

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

The ARN of the output.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getFlowArn

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

The Amazon Resource Name (ARN) of the flow.

setFlowArn

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

The Amazon Resource Name (ARN) of the flow.

getProtocol

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

The protocol to use for the output.

setProtocol

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

The protocol to use for the output.

getCidrAllowList

@Stability(value=Stable)
 @Nullable
public List<String> getCidrAllowList()

The range of IP addresses that are allowed to initiate output requests to this flow.

Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

setCidrAllowList

@Stability(value=Stable)
public void setCidrAllowList(@Nullable
                                                      List<String> value)

The range of IP addresses that are allowed to initiate output requests to this flow.

Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

getDescription

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

A description of the output.

This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.

setDescription

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

A description of the output.

This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.

getDestination

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

The IP address where you want to send the output.

setDestination

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

The IP address where you want to send the output.

getEncryption

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

The encryption credentials that you want to use for the output.

setEncryption

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

The encryption credentials that you want to use for the output.

setEncryption

@Stability(value=Stable)
public void setEncryption(@Nullable
                                                   CfnFlowOutput.EncryptionProperty value)

The encryption credentials that you want to use for the output.

getMaxLatency

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

The maximum latency in milliseconds for Zixi-based streams.

setMaxLatency

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

The maximum latency in milliseconds for Zixi-based streams.

getMinLatency

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

setMinLatency

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

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

The name of the VPC interface.

setName

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

The name of the VPC interface.

getPort

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

The port to use when MediaConnect distributes content to the output.

setPort

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

The port to use when MediaConnect distributes content to the output.

getRemoteId

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

The identifier that is assigned to the Zixi receiver.

This parameter applies only to outputs that use Zixi pull.

setRemoteId

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

The identifier that is assigned to the Zixi receiver.

This parameter applies only to outputs that use Zixi pull.

getSmoothingLatency

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

The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

setSmoothingLatency

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

The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

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.

getVpcInterfaceAttachment

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

The VPC interface that you want to send your output to.

setVpcInterfaceAttachment

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

The VPC interface that you want to send your output to.

setVpcInterfaceAttachment

@Stability(value=Stable)
public void setVpcInterfaceAttachment(@Nullable
                                                               CfnFlowOutput.VpcInterfaceAttachmentProperty value)

The VPC interface that you want to send your output to.