Package software.amazon.awscdk.services.medialive

Class CfnMultiplex

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.medialive.CfnMultiplex
All Implemented Interfaces:
IInspectable, ITaggableV2, IMultiplexRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:42.189Z") @Stability(Stable) public class CfnMultiplex extends CfnResource implements IInspectable, IMultiplexRef, ITaggableV2
The multiplex object.

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.medialive.*;
 CfnMultiplex cfnMultiplex = CfnMultiplex.Builder.create(this, "MyCfnMultiplex")
         .availabilityZones(List.of("availabilityZones"))
         .multiplexSettings(MultiplexSettingsProperty.builder()
                 .transportStreamBitrate(123)
                 .transportStreamId(123)
                 // the properties below are optional
                 .maximumVideoBufferDelayMilliseconds(123)
                 .transportStreamReservedBitrate(123)
                 .build())
         .name("name")
         // the properties below are optional
         .destinations(List.of(MultiplexOutputDestinationProperty.builder()
                 .multiplexMediaConnectOutputDestinationSettings(MultiplexMediaConnectOutputDestinationSettingsProperty.builder()
                         .entitlementArn("entitlementArn")
                         .build())
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnMultiplex

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

    • CfnMultiplex

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

    • CfnMultiplex

      @Stability(Stable) public CfnMultiplex(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMultiplexProps props)
      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

    • fromMultiplexArn

      @Stability(Stable) @NotNull public static IMultiplexRef fromMultiplexArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IMultiplexRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromMultiplexId

      @Stability(Stable) @NotNull public static IMultiplexRef fromMultiplexId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String multiplexId)
      Creates a new IMultiplexRef from a multiplexId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      multiplexId - 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 unique arn of the multiplex.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique id of the multiplex.

    • getAttrPipelinesRunningCount

      @Stability(Stable) @NotNull public Number getAttrPipelinesRunningCount()
      The number of currently healthy pipelines.

    • getAttrProgramCount

      @Stability(Stable) @NotNull public Number getAttrProgramCount()
      The number of programs in the multiplex.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The current state of the multiplex.

    • 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

    • getMultiplexRef

      @Stability(Stable) @NotNull public MultiplexReference getMultiplexRef()
      A reference to a Multiplex resource.
      Specified by:
      getMultiplexRef in interface IMultiplexRef

    • getAvailabilityZones

      @Stability(Stable) @NotNull public List<String> getAvailabilityZones()
      A list of availability zones for the multiplex.

    • setAvailabilityZones

      @Stability(Stable) public void setAvailabilityZones(@NotNull List<String> value)
      A list of availability zones for the multiplex.

    • getMultiplexSettings

      @Stability(Stable) @NotNull public Object getMultiplexSettings()
      Configuration for a multiplex event.

      Returns union: either IResolvable or CfnMultiplex.MultiplexSettingsProperty

    • setMultiplexSettings

      @Stability(Stable) public void setMultiplexSettings(@NotNull IResolvable value)
      Configuration for a multiplex event.

    • setMultiplexSettings

      @Stability(Stable) public void setMultiplexSettings(@NotNull CfnMultiplex.MultiplexSettingsProperty value)
      Configuration for a multiplex event.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the multiplex.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the multiplex.

    • getDestinations

      @Stability(Stable) @Nullable public Object getDestinations()
      A list of the multiplex output destinations.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMultiplex.MultiplexOutputDestinationProperty>

    • setDestinations

      @Stability(Stable) public void setDestinations(@Nullable IResolvable value)
      A list of the multiplex output destinations.

    • setDestinations

      @Stability(Stable) public void setDestinations(@Nullable List<Object> value)
      A list of the multiplex output destinations.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A collection of key-value pairs.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A collection of key-value pairs.