2.272.0

interface CfnFlowMediaStreamProps

LanguageType name
.NETAmazon.CDK.AWS.MediaConnect.CfnFlowMediaStreamProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsmediaconnect#CfnFlowMediaStreamProps
Javasoftware.amazon.awscdk.services.mediaconnect.CfnFlowMediaStreamProps
Pythonaws_cdk.aws_mediaconnect.CfnFlowMediaStreamProps
TypeScript aws-cdk-lib » aws_mediaconnect » CfnFlowMediaStreamProps

Properties for defining a CfnFlowMediaStream.

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

Example

// 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

NameTypeDescription
flowArnstringThe Amazon Resource Name (ARN) of the flow that the media stream belongs to.
mediaStreamIdnumberA unique identifier for the media stream.
mediaStreamNamestringA name that helps you distinguish one media stream from another.
mediaStreamTypestringThe type of media stream.
attributes?IResolvable | MediaStreamAttributesPropertyAttributes that are related to the media stream.
clockRate?numberThe sample rate (in Hz) for the stream.
description?stringA description that can help you quickly identify what your media stream is used for.
tags?CfnTag[]The key-value pairs that can be used to tag and organize the media stream.
videoFormat?stringThe resolution of the video.

flowArn

Type: string

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

mediaStreamId

Type: number

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

mediaStreamName

Type: string

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

mediaStreamType

Type: string

The type of media stream.

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

attributes?

Type: IResolvable | MediaStreamAttributesProperty (optional)

Attributes that are related to the media stream.

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

clockRate?

Type: number (optional)

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

description?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

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

videoFormat?

Type: string (optional)

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

← PreviousNext →