interface ICluster

Language	Type name
.NET	Amazon.CDK.AWS.ECS.ICluster
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsecs#ICluster
Java	software.amazon.awscdk.services.ecs.ICluster
Python	aws_cdk.aws_ecs.ICluster
TypeScript (source)	aws-cdk-lib » aws_ecs » ICluster

Implemented by Cluster

Obtainable from Cluster.fromClusterArn(), Cluster.fromClusterAttributes()

A regional grouping of one or more container instances on which you can run tasks and services.

Properties

Name	Type	Description
clusterArn	string	The Amazon Resource Name (ARN) that identifies the cluster.
clusterName	string	The name of the cluster.
connections	Connections	Manage the allowed network connections for the cluster with Security Groups.
env	ResourceEnvironment	The environment this resource belongs to.
hasEc2Capacity	boolean	Specifies whether the cluster has EC2 instance capacity.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
vpc	IVpc	The VPC associated with the cluster.
autoscalingGroup?	IAutoScalingGroup	The autoscaling group added to the cluster if capacity is associated to the cluster.
defaultCloudMapNamespace?	INamespace	The AWS Cloud Map namespace to associate with the cluster.
executeCommandConfiguration?	ExecuteCommandConfiguration	The execute command configuration for the cluster.

---

clusterArn

Type: string

The Amazon Resource Name (ARN) that identifies the cluster.

---

clusterName

Type: string

The name of the cluster.

---

connections

Type: Connections

Manage the allowed network connections for the cluster with Security Groups.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

hasEc2Capacity

Type: boolean

Specifies whether the cluster has EC2 instance capacity.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

---

vpc

Type: IVpc

The VPC associated with the cluster.

---

autoscalingGroup?

Type: IAutoScalingGroup (optional)

The autoscaling group added to the cluster if capacity is associated to the cluster.

---

defaultCloudMapNamespace?

Type: INamespace (optional)

The AWS Cloud Map namespace to associate with the cluster.

---

executeCommandConfiguration?

Type: ExecuteCommandConfiguration (optional)

The execute command configuration for the cluster.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

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