Skip to content
v2.274.0

CfnFlowMediaStreamProps Struct ​

Properties for defining a CfnFlowMediaStream.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediaconnect as mediaconnect } from 'aws-cdk-lib';
const cfnFlowMediaStreamProps: mediaconnect.CfnFlowMediaStreamProps = {
  flowArn: 'flowArn',
  mediaStreamId: 123,
  mediaStreamName: 'mediaStreamName',
  mediaStreamType: 'mediaStreamType',

  // the properties below are optional
  attributes: {
    fmtp: {
      channelOrder: 'channelOrder',
      colorimetry: 'colorimetry',
      exactFramerate: 'exactFramerate',
      par: 'par',
      range: 'range',
      scanMode: 'scanMode',
      tcs: 'tcs',
    },
    lang: 'lang',
  },
  clockRate: 123,
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  videoFormat: 'videoFormat',
};

Properties ​

Attributes that are related to the media stream.
clockRatenumberclock_rateint | floatclockRateNumberClockRatedoubleClockRate*float64#
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.

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
A description that can help you quickly identify what your media stream is used for.
flowArnstringflow_arnstrflowArnStringFlowArnstringFlowArn*stringrequired#
The Amazon Resource Name (ARN) of the flow that the media stream belongs to.
mediaStreamIdnumbermedia_stream_idint | floatmediaStreamIdNumberMediaStreamIddoubleMediaStreamId*float64required#
A unique identifier for the media stream.
mediaStreamNamestringmedia_stream_namestrmediaStreamNameStringMediaStreamNamestringMediaStreamName*stringrequired#
A name that helps you distinguish one media stream from another.
mediaStreamTypestringmedia_stream_typestrmediaStreamTypeStringMediaStreamTypestringMediaStreamType*stringrequired#
The type of media stream.
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
The key-value pairs that can be used to tag and organize the media stream.
videoFormatstringvideo_formatstrvideoFormatStringVideoFormatstringVideoFormat*string#
The resolution of the video.

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