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

Interface ClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:41.013Z")
@Stability(Experimental)
public interface ClusterProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for creating a MediaLive Cluster.

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	Interface	Description
static final class	ClusterProps.Builder	A builder for ClusterProps
static final class	ClusterProps.Jsii$Proxy	An implementation for ClusterProps

Method Summary

Modifier and Type	Method	Description
static ClusterProps.Builder	builder()
default String	getClusterName()	(experimental) The name of the cluster.
default ClusterType	getClusterType()	(experimental) The hardware type for the cluster.
IRole	getInstanceRole()	(experimental) The IAM role for nodes in the cluster.
default ClusterNetworkSettings	getNetworkSettings()	(experimental) Network settings for the cluster - only required if your networking setup requires it.
default Map<String,String>	getTags()	(experimental) Tags to add to the cluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceRole

@Stability(Experimental)
@NotNull
IRole getInstanceRole()

(experimental) The IAM role for nodes in the cluster.

[disable-awslint:prefer-ref-interface]

getClusterName

@Stability(Experimental)
@Nullable
default String getClusterName()

(experimental) The name of the cluster.

Default: - auto-generated name

getClusterType

@Stability(Experimental)
@Nullable
default ClusterType getClusterType()

(experimental) The hardware type for the cluster.

Default: ClusterType.ON_PREMISES

getNetworkSettings

@Stability(Experimental)
@Nullable
default ClusterNetworkSettings getNetworkSettings()

(experimental) Network settings for the cluster - only required if your networking setup requires it.

Default: - no network settings

See Also:

• https://docs.aws.amazon.com/medialive/latest/ug/emla-deploy-identify-network-requirements.html

getTags

@Stability(Experimental)
@Nullable
default Map<String,String> getTags()

(experimental) Tags to add to the cluster.

Default: - no tags

builder

@Stability(Experimental)
static ClusterProps.Builder builder()

Returns:

a ClusterProps.Builder of ClusterProps