Package software.amazon.awscdk.services.mediaconnect

Interface CfnFlowOutputProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlowOutputProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:33.933Z")
@Stability(Stable)
public interface CfnFlowOutputProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFlowOutput.

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.*;
 CfnFlowOutputProps cfnFlowOutputProps = CfnFlowOutputProps.builder()
         .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)
         .mediaStreamOutputConfigurations(List.of(MediaStreamOutputConfigurationProperty.builder()
                 .encodingName("encodingName")
                 .mediaStreamName("mediaStreamName")
                 // the properties below are optional
                 .destinationConfigurations(List.of(DestinationConfigurationProperty.builder()
                         .destinationIp("destinationIp")
                         .destinationPort(123)
                         .interface(InterfaceProperty.builder()
                                 .name("name")
                                 .build())
                         .build()))
                 .encodingParameters(EncodingParametersProperty.builder()
                         .compressionFactor(123)
                         // the properties below are optional
                         .encoderProfile("encoderProfile")
                         .build())
                 .build()))
         .minLatency(123)
         .name("name")
         .outputStatus("outputStatus")
         .port(123)
         .remoteId("remoteId")
         .smoothingLatency(123)
         .streamId("streamId")
         .vpcInterfaceAttachment(VpcInterfaceAttachmentProperty.builder()
                 .vpcInterfaceName("vpcInterfaceName")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlowOutputProps.Builder	builder()
default List<String>	getCidrAllowList()	The range of IP addresses that are allowed to initiate output requests to this flow.
default String	getDescription()	A description of the output.
default String	getDestination()	The IP address where you want to send the output.
default Object	getEncryption()	The encryption credentials that you want to use for the output.
String	getFlowArn()	The Amazon Resource Name (ARN) of the flow this output is attached to.
default Number	getMaxLatency()	The maximum latency in milliseconds.
default Object	getMediaStreamOutputConfigurations()	The definition for each media stream that is associated with the output.
default Number	getMinLatency()	The minimum latency in milliseconds for SRT-based streams.
default String	getName()	The name of the output.
default String	getOutputStatus()	An indication of whether the new output should be enabled or disabled as soon as it is created.
default Number	getPort()	The port to use when MediaConnect distributes content to the output.
String	getProtocol()	The protocol to use for the output.
default String	getRemoteId()	The identifier that is assigned to the Zixi receiver.
default Number	getSmoothingLatency()	The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
default String	getStreamId()	The stream ID that you want to use for this transport.
default Object	getVpcInterfaceAttachment()	The VPC interface that you want to send your output to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFlowArn

@Stability(Stable)
@NotNull
String getFlowArn()

The Amazon Resource Name (ARN) of the flow this output is attached to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-flowarn

getProtocol

@Stability(Stable)
@NotNull
String getProtocol()

The protocol to use for the output.

AWS Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-protocol

getCidrAllowList

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-cidrallowlist

getDescription

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-description

getDestination

@Stability(Stable)
@Nullable
default String getDestination()

The IP address where you want to send the output.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-destination

getEncryption

@Stability(Stable)
@Nullable
default Object getEncryption()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-encryption

getMaxLatency

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

The maximum latency in milliseconds.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-maxlatency

getMediaStreamOutputConfigurations

@Stability(Stable)
@Nullable
default Object getMediaStreamOutputConfigurations()

The definition for each media stream that is associated with the output.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-mediastreamoutputconfigurations

getMinLatency

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-minlatency

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the output.

This value must be unique within the current flow.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-name

getOutputStatus

@Stability(Stable)
@Nullable
default String getOutputStatus()

An indication of whether the new output should be enabled or disabled as soon as it is created.

If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-outputstatus

getPort

@Stability(Stable)
@Nullable
default Number getPort()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-port

getRemoteId

@Stability(Stable)
@Nullable
default String getRemoteId()

The identifier that is assigned to the Zixi receiver.

This parameter applies only to outputs that use Zixi pull.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-remoteid

getSmoothingLatency

@Stability(Stable)
@Nullable
default Number getSmoothingLatency()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-smoothinglatency

getStreamId

@Stability(Stable)
@Nullable
default String getStreamId()

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

This parameter applies only to Zixi and SRT caller-based streams.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-streamid

getVpcInterfaceAttachment

@Stability(Stable)
@Nullable
default Object getVpcInterfaceAttachment()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-vpcinterfaceattachment

builder

@Stability(Stable)
static CfnFlowOutputProps.Builder builder()

Returns:

a CfnFlowOutputProps.Builder of CfnFlowOutputProps