aws-cdk-lib.aws_ecs.ICluster

ICluster Interface

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

ICluster

extends

• IResource,
• IClusterRef

implemented by

• Cluster

Source

aws-ecs/lib/cluster.ts

Type last changed

v2.227.0 · 21 Nov 2025

Properties

autoscalingGroup?may be undefinedIAutoScalingGroupautoscaling_group?may be undefinedIAutoScalingGroupautoscalingGroup?may be undefinedIAutoScalingGroupAutoscalingGroup?may be undefinedIAutoScalingGroupAutoscalingGroup?may be undefinedIAutoScalingGroup#

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

clusterArnstringcluster_arnstrclusterArnStringClusterArnstringClusterArn*string#

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

clusterNamestringcluster_namestrclusterNameStringClusterNamestringClusterName*string#

The name of the cluster.

clusterRefClusterReferencecluster_refClusterReferenceclusterRefClusterReferenceClusterRefClusterReferenceClusterRefClusterReference#

A reference to a Cluster resource.

connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnections#

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

defaultCloudMapNamespace?may be undefinedINamespacedefault_cloud_map_namespace?may be undefinedINamespacedefaultCloudMapNamespace?may be undefinedINamespaceDefaultCloudMapNamespace?may be undefinedINamespaceDefaultCloudMapNamespace?may be undefinedINamespace#

The AWS Cloud Map namespace to associate with the cluster.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

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.

executeCommandConfiguration?may be undefinedExecuteCommandConfigurationexecute_command_configuration?may be undefinedExecuteCommandConfigurationexecuteCommandConfiguration?may be undefinedExecuteCommandConfigurationExecuteCommandConfiguration?may be undefinedExecuteCommandConfigurationExecuteCommandConfiguration?may be undefinedExecuteCommandConfiguration#

The execute command configuration for the cluster.

hasEc2Capacitybooleanhas_ec2_capacityboolhasEc2CapacityBooleanHasEc2CapacityboolHasEc2Capacity*bool#

Specifies whether the cluster has EC2 instance capacity.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

vpcIVpcvpcIVpcvpcIVpcVpcIVpcVpcIVpc#

The VPC associated with the cluster.

Methods

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) 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.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining