Package software.amazon.awscdk.services.mediaconnect

Class CfnFlowMediaStream.Builder

java.lang.Object

software.amazon.awscdk.services.mediaconnect.CfnFlowMediaStream.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFlowMediaStream>

Enclosing class:

CfnFlowMediaStream

@Stability(Stable)
public static final class CfnFlowMediaStream.Builder
extends Object
implements software.amazon.jsii.Builder<CfnFlowMediaStream>

A fluent builder for CfnFlowMediaStream.

Method Summary

Modifier and Type	Method	Description
CfnFlowMediaStream.Builder	attributes(IResolvable attributes)	Attributes that are related to the media stream.
CfnFlowMediaStream.Builder	attributes(CfnFlowMediaStream.MediaStreamAttributesProperty attributes)	Attributes that are related to the media stream.
CfnFlowMediaStream	build()
CfnFlowMediaStream.Builder	clockRate(Number clockRate)	The sample rate (in Hz) for the stream.
static CfnFlowMediaStream.Builder	create(software.constructs.Construct scope, String id)
CfnFlowMediaStream.Builder	description(String description)	A description that can help you quickly identify what your media stream is used for.
CfnFlowMediaStream.Builder	flowArn(String flowArn)	The Amazon Resource Name (ARN) of the flow that the media stream belongs to.
CfnFlowMediaStream.Builder	mediaStreamId(Number mediaStreamId)	A unique identifier for the media stream.
CfnFlowMediaStream.Builder	mediaStreamName(String mediaStreamName)	A name that helps you distinguish one media stream from another.
CfnFlowMediaStream.Builder	mediaStreamType(String mediaStreamType)	The type of media stream.
CfnFlowMediaStream.Builder	tags(List<? extends CfnTag> tags)	The key-value pairs that can be used to tag and organize the media stream.
CfnFlowMediaStream.Builder	videoFormat(String videoFormat)	The resolution of the video.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnFlowMediaStream.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnFlowMediaStream.Builder.

flowArn

@Stability(Stable)
public CfnFlowMediaStream.Builder flowArn(String flowArn)

The Amazon Resource Name (ARN) of the flow that the media stream belongs to.

Parameters:

flowArn - The Amazon Resource Name (ARN) of the flow that the media stream belongs to. This parameter is required.

Returns:

this

See Also:

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

mediaStreamId

@Stability(Stable)
public CfnFlowMediaStream.Builder mediaStreamId(Number mediaStreamId)

A unique identifier for the media stream.

Parameters:

mediaStreamId - A unique identifier for the media stream. This parameter is required.

Returns:

this

See Also:

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

mediaStreamName

@Stability(Stable)
public CfnFlowMediaStream.Builder mediaStreamName(String mediaStreamName)

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

Parameters:

mediaStreamName - A name that helps you distinguish one media stream from another. This parameter is required.

Returns:

this

See Also:

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

mediaStreamType

@Stability(Stable)
public CfnFlowMediaStream.Builder mediaStreamType(String mediaStreamType)

The type of media stream.

Parameters:

mediaStreamType - The type of media stream. This parameter is required.

Returns:

this

See Also:

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

attributes

@Stability(Stable)
public CfnFlowMediaStream.Builder attributes(IResolvable attributes)

Attributes that are related to the media stream.

Parameters:

attributes - Attributes that are related to the media stream. This parameter is required.

Returns:

this

See Also:

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

attributes

@Stability(Stable)
public CfnFlowMediaStream.Builder attributes(CfnFlowMediaStream.MediaStreamAttributesProperty attributes)

Attributes that are related to the media stream.

Parameters:

attributes - Attributes that are related to the media stream. This parameter is required.

Returns:

this

See Also:

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

clockRate

@Stability(Stable)
public CfnFlowMediaStream.Builder clockRate(Number clockRate)

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.

Parameters:

clockRate - The sample rate (in Hz) for the stream. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnFlowMediaStream.Builder description(String description)

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

Parameters:

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

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnFlowMediaStream.Builder tags(List<? extends CfnTag> tags)

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

Parameters:

tags - The key-value pairs that can be used to tag and organize the media stream. This parameter is required.

Returns:

this

See Also:

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

videoFormat

@Stability(Stable)
public CfnFlowMediaStream.Builder videoFormat(String videoFormat)

The resolution of the video.

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

Parameters:

videoFormat - The resolution of the video. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnFlowMediaStream build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnFlowMediaStream>

Returns:

a newly built instance of CfnFlowMediaStream.