Package software.amazon.awscdk.services.ecs

Interface ICluster

All Superinterfaces:

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

All Known Subinterfaces:

ICluster.Jsii$Default

All Known Implementing Classes:

Cluster, ICluster.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T10:47:19.875Z")
@Stability(Stable)
public interface ICluster
extends software.amazon.jsii.JsiiSerializable, IResource, IClusterRef

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ICluster.Jsii$Default	Internal default implementation for ICluster.
static final class	ICluster.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
default IAutoScalingGroup	getAutoscalingGroup()	The autoscaling group added to the cluster if capacity is associated to the cluster.
String	getClusterArn()	The Amazon Resource Name (ARN) that identifies the cluster.
String	getClusterName()	The name of the cluster.
Connections	getConnections()	Manage the allowed network connections for the cluster with Security Groups.
default INamespace	getDefaultCloudMapNamespace()	The AWS Cloud Map namespace to associate with the cluster.
ResourceEnvironment	getEnv()	The environment this resource belongs to.
default ExecuteCommandConfiguration	getExecuteCommandConfiguration()	The execute command configuration for the cluster.
Boolean	getHasEc2Capacity()	Specifies whether the cluster has EC2 instance capacity.
software.constructs.Node	getNode()	The tree node.
IVpc	getVpc()	The VPC associated with the cluster.

Methods inherited from interface software.amazon.awscdk.interfaces.ecs.IClusterRef

getClusterRef

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClusterArn

@Stability(Stable)
@NotNull
String getClusterArn()

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

getClusterName

@Stability(Stable)
@NotNull
String getClusterName()

The name of the cluster.

getConnections

@Stability(Stable)
@NotNull
Connections getConnections()

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

getHasEc2Capacity

@Stability(Stable)
@NotNull
Boolean getHasEc2Capacity()

Specifies whether the cluster has EC2 instance capacity.

getVpc

@Stability(Stable)
@NotNull
IVpc getVpc()

The VPC associated with the cluster.

getAutoscalingGroup

@Stability(Stable)
@Nullable
default IAutoScalingGroup getAutoscalingGroup()

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

getDefaultCloudMapNamespace

@Stability(Stable)
@Nullable
default INamespace getDefaultCloudMapNamespace()

The AWS Cloud Map namespace to associate with the cluster.

getExecuteCommandConfiguration

@Stability(Stable)
@Nullable
default ExecuteCommandConfiguration getExecuteCommandConfiguration()

The execute command configuration for the cluster.

getNode

@Stability(Stable)
@NotNull
software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

getEnv

@Stability(Stable)
@NotNull
ResourceEnvironment getEnv()

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.

Specified by:

getEnv in interface IEnvironmentAware