Package software.amazon.awscdk.services.ecs

Interface ClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:40.877Z")
@Stability(Stable)
public interface ClusterProps
extends software.amazon.jsii.JsiiSerializable

The properties used to define an ECS cluster.

Example:

 Vpc vpc;
 Cluster cluster = Cluster.Builder.create(this, "Cluster")
         .vpc(vpc)
         .build();
 AutoScalingGroup autoScalingGroup = AutoScalingGroup.Builder.create(this, "ASG")
         .vpc(vpc)
         .instanceType(new InstanceType("t2.micro"))
         .machineImage(EcsOptimizedImage.amazonLinux2())
         .minCapacity(0)
         .maxCapacity(100)
         .build();
 AsgCapacityProvider capacityProvider = AsgCapacityProvider.Builder.create(this, "AsgCapacityProvider")
         .autoScalingGroup(autoScalingGroup)
         .instanceWarmupPeriod(300)
         .build();
 cluster.addAsgCapacityProvider(capacityProvider);
 Ec2TaskDefinition taskDefinition = new Ec2TaskDefinition(this, "TaskDef");
 taskDefinition.addContainer("web", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
         .memoryReservationMiB(256)
         .build());
 Ec2Service.Builder.create(this, "EC2Service")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .minHealthyPercent(100)
         .capacityProviderStrategies(List.of(CapacityProviderStrategy.builder()
                 .capacityProvider(capacityProvider.getCapacityProviderName())
                 .weight(1)
                 .build()))
         .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 AddCapacityOptions	getCapacity()	The ec2 capacity to add to the cluster.
default String	getClusterName()	The name for the cluster.
default Boolean	getContainerInsights()	Deprecated. See invalid reference containerInsightsV2
default ContainerInsights	getContainerInsightsV2()	The CloudWatch Container Insights configuration for the cluster.
default CloudMapNamespaceOptions	getDefaultCloudMapNamespace()	The service discovery namespace created in this cluster.
default Boolean	getEnableFargateCapacityProviders()	Whether to enable Fargate Capacity Providers.
default ExecuteCommandConfiguration	getExecuteCommandConfiguration()	The execute command configuration for the cluster.
default ManagedStorageConfiguration	getManagedStorageConfiguration()	Encryption configuration for ECS Managed storage.
default IVpc	getVpc()	The VPC where your ECS instances will be running or your ENIs will be deployed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCapacity

@Stability(Stable)
@Nullable
default AddCapacityOptions getCapacity()

The ec2 capacity to add to the cluster.

Default: - no EC2 capacity will be added, you can use `addCapacity` to add capacity later.

getClusterName

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

The name for the cluster.

Default: CloudFormation-generated name

getContainerInsights

@Stability(Deprecated)
@Deprecated
@Nullable
default Boolean getContainerInsights()

Deprecated.

See

invalid reference

containerInsightsV2

(deprecated) If true CloudWatch Container Insights will be enabled for the cluster.

Default: - Container Insights will be disabled for this cluster.

getContainerInsightsV2

@Stability(Stable)
@Nullable
default ContainerInsights getContainerInsightsV2()

The CloudWatch Container Insights configuration for the cluster.

Default:

invalid reference

ContainerInsights.DISABLED

This may be overridden by ECS account level settings.

getDefaultCloudMapNamespace

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

The service discovery namespace created in this cluster.

Default: - no service discovery namespace created, you can use `addDefaultCloudMapNamespace` to add a default service discovery namespace later.

getEnableFargateCapacityProviders

@Stability(Stable)
@Nullable
default Boolean getEnableFargateCapacityProviders()

Whether to enable Fargate Capacity Providers.

Default: false

getExecuteCommandConfiguration

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

The execute command configuration for the cluster.

Default: - no configuration will be provided.

getManagedStorageConfiguration

@Stability(Stable)
@Nullable
default ManagedStorageConfiguration getManagedStorageConfiguration()

Encryption configuration for ECS Managed storage.

Default: - no encryption will be applied.

getVpc

@Stability(Stable)
@Nullable
default IVpc getVpc()

The VPC where your ECS instances will be running or your ENIs will be deployed.

Default: - creates a new VPC with two AZs

builder

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

Returns:

a ClusterProps.Builder of ClusterProps