Package software.amazon.awscdk.services.medialive

Class CfnCluster

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.CfnCluster
All Implemented Interfaces:
IInspectable, ITaggableV2, IClusterRef, 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.156Z") @Stability(Stable) public class CfnCluster extends CfnResource implements IInspectable, IClusterRef, ITaggableV2
Definition of AWS::MediaLive::Cluster Resource Type.

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.*;
 CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
         .clusterType("clusterType")
         .instanceRoleArn("instanceRoleArn")
         .name("name")
         .networkSettings(ClusterNetworkSettingsProperty.builder()
                 .defaultRoute("defaultRoute")
                 .interfaceMappings(List.of(InterfaceMappingProperty.builder()
                         .logicalInterfaceName("logicalInterfaceName")
                         .networkId("networkId")
                         .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

    • CfnCluster

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

    • CfnCluster

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

    • CfnCluster

      @Stability(Stable) public CfnCluster(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnClusterProps 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.

    • CfnCluster

      @Stability(Stable) public CfnCluster(@NotNull software.constructs.Construct scope, @NotNull 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.

  • Method Details

    • fromClusterArn

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

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

    • fromClusterId

      @Stability(Stable) @NotNull public static IClusterRef fromClusterId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String clusterId)
      Creates a new IClusterRef from a clusterId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      clusterId - 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 ARN of the Cluster.

    • getAttrChannelIds

      @Stability(Stable) @NotNull public List<String> getAttrChannelIds()
      The MediaLive Channels that are currently running on Nodes in this Cluster.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique ID of the Cluster.

    • getAttrState

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

    • 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

    • getClusterRef

      @Stability(Stable) @NotNull public ClusterReference getClusterRef()
      A reference to a Cluster resource.
      Specified by:
      getClusterRef in interface IClusterRef

    • getClusterType

      @Stability(Stable) @Nullable public String getClusterType()
      The hardware type for the cluster.

    • setClusterType

      @Stability(Stable) public void setClusterType(@Nullable String value)
      The hardware type for the cluster.

    • getInstanceRoleArn

      @Stability(Stable) @Nullable public String getInstanceRoleArn()
      The IAM role your nodes will use.

    • setInstanceRoleArn

      @Stability(Stable) public void setInstanceRoleArn(@Nullable String value)
      The IAM role your nodes will use.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The user-specified name of the Cluster to be created.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The user-specified name of the Cluster to be created.

    • getNetworkSettings

      @Stability(Stable) @Nullable public Object getNetworkSettings()
      On premises settings which will have the interface network mappings and default Output logical interface.

      Returns union: either IResolvable or CfnCluster.ClusterNetworkSettingsProperty

    • setNetworkSettings

      @Stability(Stable) public void setNetworkSettings(@Nullable IResolvable value)
      On premises settings which will have the interface network mappings and default Output logical interface.

    • setNetworkSettings

      @Stability(Stable) public void setNetworkSettings(@Nullable CfnCluster.ClusterNetworkSettingsProperty value)
      On premises settings which will have the interface network mappings and default Output logical interface.

    • 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.