class Cluster (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.MediaLive.Alpha.Cluster
Go	github.com/aws/aws-cdk-go/awsmedialivealpha/v2#Cluster
Java	software.amazon.awscdk.services.medialive.alpha.Cluster
Python	aws_cdk.aws_medialive_alpha.Cluster
TypeScript (source)	@aws-cdk/aws-medialive-alpha » Cluster

Implements IConstruct, IDependable, IResource, IEnvironmentAware, ICluster, IClusterRef

Defines an AWS Elemental MediaLive Cluster.

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

Example

declare const stack: Stack;
declare const instanceRole: iam.IRole;

const cluster = new medialive.Cluster(stack, 'Cluster', {
  clusterName: 'on-prem-cluster',
  clusterType: medialive.ClusterType.ON_PREMISES,
  instanceRole,
});

Initializer

new Cluster(scope: Construct, id: string, props: ClusterProps)

Parameters

• scope Construct
• id string
• props ClusterProps

Construct Props

Name	Type	Description
instanceRole🔹	IRole	The IAM role for nodes in the cluster.
clusterName?🔹	string	The name of the cluster.
clusterType?🔹	ClusterType	The hardware type for the cluster.
networkSettings?🔹	ClusterNetworkSettings	Network settings for the cluster - only required if your networking setup requires it.
tags?🔹	{ [string]: string }	Tags to add to the cluster.

---

instanceRole🔹

Type: IRole

The IAM role for nodes in the cluster.

[disable-awslint:prefer-ref-interface]

---

clusterName?🔹

Type: string (optional, default: auto-generated name)

The name of the cluster.

---

clusterType?🔹

Type: ClusterType (optional, default: ClusterType.ON_PREMISES)

The hardware type for the cluster.

---

networkSettings?🔹

Type: ClusterNetworkSettings (optional, default: no network settings)

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

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

---

tags?🔹

Type: { [string]: string } (optional, default: no tags)

Tags to add to the cluster.

Properties

Name	Type	Description
clusterArn🔹	string	The ARN of the cluster.
clusterId🔹	string	The ID of the cluster.
clusterRef🔹	ClusterReference	A reference to this Cluster resource.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
clusterChannelIds?🔹	string[]	The IDs of channels running on this cluster.
clusterState?🔹	string	The current state of the cluster.
static PROPERTY_INJECTION_ID🔹	string	Uniquely identifies this class.

---

clusterArn🔹

Type: string

The ARN of the cluster.

---

clusterId🔹

Type: string

The ID of the cluster.

---

clusterRef🔹

Type: ClusterReference

A reference to this Cluster resource.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

clusterChannelIds?🔹

Type: string[] (optional)

The IDs of channels running on this cluster.

---

clusterState?🔹

Type: string (optional)

The current state of the cluster.

---

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyCrossStackReferenceStrength(strength)🔹	Override the cross-stack reference strength for this resource.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
with(...mixins)🔹	Applies one or more mixins to this construct.
static fromClusterArn(scope, id, clusterArn)🔹	Import an existing cluster by its ARN.

---

applyCrossStackReferenceStrength(strength)🔹

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

Parameters

• strength ReferenceStrength — - The reference strength to use for this resource.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)🔹

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

---

static fromClusterArn(scope, id, clusterArn)🔹

public static fromClusterArn(scope: Construct, id: string, clusterArn: string): ICluster

Parameters

• scope Construct
• id string
• clusterArn string

Returns

• ICluster

Import an existing cluster by its ARN.

The id is parsed out of the ARN.