Package software.amazon.awscdk.services.medialive.alpha

Class Cluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.medialive.alpha.Cluster

All Implemented Interfaces:

IEnvironmentAware, IClusterRef, IResource, ICluster, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:41.010Z")
@Stability(Experimental)
public class Cluster
extends Resource
implements ICluster

(experimental) Defines an AWS Elemental MediaLive Cluster.

A cluster represents a group of on-premises hardware nodes used by MediaLive Anywhere.

Example:

 Stack stack;
 IRole instanceRole;
 Cluster cluster = Cluster.Builder.create(stack, "Cluster")
         .clusterName("on-prem-cluster")
         .clusterType(ClusterType.ON_PREMISES)
         .instanceRole(instanceRole)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Cluster.Builder	(experimental) A fluent builder for Cluster.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.medialive.alpha.ICluster

ICluster.Jsii$Default, ICluster.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Cluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Cluster(software.amazon.jsii.JsiiObjectRef objRef)
	Cluster(software.constructs.Construct scope, String id, ClusterProps props)

Method Summary

Modifier and Type	Method	Description
static ICluster	fromClusterArn(software.constructs.Construct scope, String id, String clusterArn)	(experimental) Import an existing cluster by its ARN.
String	getClusterArn()	(experimental) The ARN of the cluster.
List<String>	getClusterChannelIds()	(experimental) The IDs of channels running on this cluster.
String	getClusterId()	(experimental) The ID of the cluster.
ClusterReference	getClusterRef()	(experimental) A reference to this Cluster resource.
String	getClusterState()	(experimental) The current state of the cluster.

Methods inherited from class software.amazon.awscdk.Resource

applyCrossStackReferenceStrength, applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Experimental)
public static final String PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

Constructor Details

Cluster

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

Cluster

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

Cluster

@Stability(Experimental)
public Cluster(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 ClusterProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromClusterArn

@Stability(Experimental)
@NotNull
public static ICluster fromClusterArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String clusterArn)

(experimental) Import an existing cluster by its ARN.

The id is parsed out of the ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

clusterArn - This parameter is required.

getClusterArn

@Stability(Experimental)
@NotNull
public String getClusterArn()

(experimental) The ARN of the cluster.

Specified by:

getClusterArn in interface ICluster

getClusterId

@Stability(Experimental)
@NotNull
public String getClusterId()

(experimental) The ID of the cluster.

Specified by:

getClusterId in interface ICluster

getClusterRef

@Stability(Experimental)
@NotNull
public ClusterReference getClusterRef()

(experimental) A reference to this Cluster resource.

Specified by:

getClusterRef in interface IClusterRef

getClusterChannelIds

@Stability(Experimental)
@Nullable
public List<String> getClusterChannelIds()

(experimental) The IDs of channels running on this cluster.

Specified by:

getClusterChannelIds in interface ICluster

getClusterState

@Stability(Experimental)
@Nullable
public String getClusterState()

(experimental) The current state of the cluster.

Specified by:

getClusterState in interface ICluster