Package software.amazon.awscdk.services.mediaconnect

Interface CfnFlowMediaStreamProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlowMediaStreamProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:04:55.637Z")
@Stability(Stable)
public interface CfnFlowMediaStreamProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFlowMediaStream.

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.*;
 CfnFlowMediaStreamProps cfnFlowMediaStreamProps = CfnFlowMediaStreamProps.builder()
         .flowArn("flowArn")
         .mediaStreamId(123)
         .mediaStreamName("mediaStreamName")
         .mediaStreamType("mediaStreamType")
         // the properties below are optional
         .attributes(MediaStreamAttributesProperty.builder()
                 .fmtp(FmtpProperty.builder()
                         .channelOrder("channelOrder")
                         .colorimetry("colorimetry")
                         .exactFramerate("exactFramerate")
                         .par("par")
                         .range("range")
                         .scanMode("scanMode")
                         .tcs("tcs")
                         .build())
                 .lang("lang")
                 .build())
         .clockRate(123)
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .videoFormat("videoFormat")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlowMediaStreamProps.Builder	builder()
default Object	getAttributes()	Attributes that are related to the media stream.
default Number	getClockRate()	The sample rate (in Hz) for the stream.
default String	getDescription()	A description that can help you quickly identify what your media stream is used for.
String	getFlowArn()	The Amazon Resource Name (ARN) of the flow that the media stream belongs to.
Number	getMediaStreamId()	A unique identifier for the media stream.
String	getMediaStreamName()	A name that helps you distinguish one media stream from another.
String	getMediaStreamType()	The type of media stream.
default List<CfnTag>	getTags()	The key-value pairs that can be used to tag and organize the media stream.
default String	getVideoFormat()	The resolution of the video.

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 that the media stream belongs to.

See Also:

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

getMediaStreamId

@Stability(Stable)
@NotNull
Number getMediaStreamId()

A unique identifier for the media stream.

See Also:

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

getMediaStreamName

@Stability(Stable)
@NotNull
String getMediaStreamName()

A name that helps you distinguish one media stream from another.

See Also:

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

getMediaStreamType

@Stability(Stable)
@NotNull
String getMediaStreamType()

The type of media stream.

See Also:

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

getAttributes

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

Attributes that are related to the media stream.

Returns union: either IResolvable or CfnFlowMediaStream.MediaStreamAttributesProperty

See Also:

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

getClockRate

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

The sample rate (in Hz) for the stream.

If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.

See Also:

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

getDescription

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

A description that can help you quickly identify what your media stream is used for.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The key-value pairs that can be used to tag and organize the media stream.

See Also:

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

getVideoFormat

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

The resolution of the video.

Required for a video media stream and rejected for other media stream types.

See Also:

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

builder

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

Returns:

a CfnFlowMediaStreamProps.Builder of CfnFlowMediaStreamProps