Package software.amazon.awscdk.services.mediaconnect

Class CfnFlowMediaStream

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.mediaconnect.CfnFlowMediaStream
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IFlowMediaStreamRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:55.635Z") @Stability(Stable) public class CfnFlowMediaStream extends CfnResource implements IInspectable, IFlowMediaStreamRef, ITaggableV2
Resource schema for AWS::MediaConnect::FlowMediaStream.

A media stream represents a single track or stream of media containing video, audio, or ancillary data that is transported using the SMPTE 2110 JPEG XS or CDI protocol.

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.*;
 CfnFlowMediaStream cfnFlowMediaStream = CfnFlowMediaStream.Builder.create(this, "MyCfnFlowMediaStream")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFlowMediaStream

      protected CfnFlowMediaStream(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFlowMediaStream

      protected CfnFlowMediaStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFlowMediaStream

      @Stability(Stable) public CfnFlowMediaStream(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFlowMediaStreamProps props)
      Create a new AWS::MediaConnect::FlowMediaStream.

      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.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForFlowMediaStream

      @Stability(Stable) @NotNull public static String arnForFlowMediaStream(@NotNull IFlowMediaStreamRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnFlowMediaStream

      @Stability(Stable) @NotNull public static Boolean isCfnFlowMediaStream(@NotNull Object x)
      Checks whether the given object is a CfnFlowMediaStream.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the media stream, composed of the flow ARN followed by /mediaStream/ and the media stream name.

    • getAttrFmt

      @Stability(Stable) @NotNull public Number getAttrFmt()
      The format type number (sometimes referred to as RTP payload type) of the media stream.

      MediaConnect assigns this value to the media stream.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getFlowMediaStreamRef

      @Stability(Stable) @NotNull public FlowMediaStreamReference getFlowMediaStreamRef()
      A reference to a FlowMediaStream resource.
      Specified by:
      getFlowMediaStreamRef in interface IFlowMediaStreamRef

    • getFlowArn

      @Stability(Stable) @NotNull public String getFlowArn()
      The Amazon Resource Name (ARN) of the flow that the media stream belongs to.

    • setFlowArn

      @Stability(Stable) public void setFlowArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the flow that the media stream belongs to.

    • getMediaStreamId

      @Stability(Stable) @NotNull public Number getMediaStreamId()
      A unique identifier for the media stream.

    • setMediaStreamId

      @Stability(Stable) public void setMediaStreamId(@NotNull Number value)
      A unique identifier for the media stream.

    • getMediaStreamName

      @Stability(Stable) @NotNull public String getMediaStreamName()
      A name that helps you distinguish one media stream from another.

    • setMediaStreamName

      @Stability(Stable) public void setMediaStreamName(@NotNull String value)
      A name that helps you distinguish one media stream from another.

    • getMediaStreamType

      @Stability(Stable) @NotNull public String getMediaStreamType()
      The type of media stream.

    • setMediaStreamType

      @Stability(Stable) public void setMediaStreamType(@NotNull String value)
      The type of media stream.

    • getAttributes

      @Stability(Stable) @Nullable public Object getAttributes()
      Attributes that are related to the media stream.

      Returns union: either IResolvable or CfnFlowMediaStream.MediaStreamAttributesProperty

    • setAttributes

      @Stability(Stable) public void setAttributes(@Nullable IResolvable value)
      Attributes that are related to the media stream.

    • setAttributes

      @Stability(Stable) public void setAttributes(@Nullable CfnFlowMediaStream.MediaStreamAttributesProperty value)
      Attributes that are related to the media stream.

    • getClockRate

      @Stability(Stable) @Nullable public Number getClockRate()
      The sample rate (in Hz) for the stream.

    • setClockRate

      @Stability(Stable) public void setClockRate(@Nullable Number value)
      The sample rate (in Hz) for the stream.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description that can help you quickly identify what your media stream is used for.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description that can help you quickly identify what your media stream is used for.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The key-value pairs that can be used to tag and organize the media stream.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The key-value pairs that can be used to tag and organize the media stream.

    • getVideoFormat

      @Stability(Stable) @Nullable public String getVideoFormat()
      The resolution of the video.

    • setVideoFormat

      @Stability(Stable) public void setVideoFormat(@Nullable String value)
      The resolution of the video.