software.amazon.awscdk.services.ecs

Class Cluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.ecs.Cluster

All Implemented Interfaces:

IDependable, IResource, ICluster, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:07.345Z")
 @Stability(value=Experimental)
public class Cluster
extends Resource
implements ICluster

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

Example:

 Vpc vpc = Vpc.Builder.create(this, "Vpc").maxAzs(1).build();
 Cluster cluster = Cluster.Builder.create(this, "EcsCluster").vpc(vpc).build();
 SecurityGroup securityGroup = SecurityGroup.Builder.create(this, "SG").vpc(vpc).build();
 ScheduledFargateTask scheduledFargateTask = ScheduledFargateTask.Builder.create(this, "ScheduledFargateTask")
         .cluster(cluster)
         .scheduledFargateTaskImageOptions(ScheduledFargateTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .memoryLimitMiB(512)
                 .build())
         .schedule(Schedule.expression("rate(1 minute)"))
         .securityGroups(List.of(securityGroup))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cluster.Builder (experimental) A fluent builder for Cluster.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.ICluster

ICluster.Jsii$Default, ICluster.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Cluster(software.constructs.Construct scope, String id) (experimental) Constructs a new instance of the Cluster class.
	Cluster(software.constructs.Construct scope, String id, ClusterProps props) (experimental) Constructs a new instance of the Cluster class.
protected	Cluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Cluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addAsgCapacityProvider(AsgCapacityProvider provider) (experimental) This method adds an Auto Scaling Group Capacity Provider to a cluster.
void	addAsgCapacityProvider(AsgCapacityProvider provider, AddAutoScalingGroupCapacityOptions options) (experimental) This method adds an Auto Scaling Group Capacity Provider to a cluster.
void	addAutoScalingGroup(AutoScalingGroup autoScalingGroup) Deprecated. Use Cluster.addAsgCapacityProvider instead.
void	addAutoScalingGroup(AutoScalingGroup autoScalingGroup, AddAutoScalingGroupCapacityOptions options) Deprecated. Use Cluster.addAsgCapacityProvider instead.
AutoScalingGroup	addCapacity(String id, AddCapacityOptions options) (experimental) It is highly recommended to use Cluster.addAsgCapacityProvider instead of this method.
void	addCapacityProvider(String provider) Deprecated. Use enableFargateCapacityProviders instead.
INamespace	addDefaultCloudMapNamespace(CloudMapNamespaceOptions options) (experimental) Add an AWS Cloud Map DNS namespace for this cluster.
void	enableFargateCapacityProviders() (experimental) Enable the Fargate capacity providers for this cluster.
static ICluster	fromClusterAttributes(software.constructs.Construct scope, String id, ClusterAttributes attrs) (experimental) Import an existing cluster to the stack from its attributes.
IAutoScalingGroup	getAutoscalingGroup() (experimental) Getter for autoscaling group added to cluster.
String	getClusterArn() (experimental) The Amazon Resource Name (ARN) that identifies the cluster.
String	getClusterName() (experimental) The name of the cluster.
Connections	getConnections() (experimental) Manage the allowed network connections for the cluster with Security Groups.
INamespace	getDefaultCloudMapNamespace() (experimental) Getter for namespace added to cluster.
ExecuteCommandConfiguration	getExecuteCommandConfiguration() (experimental) Getter for execute command configuration associated with the cluster.
Boolean	getHasEc2Capacity() (experimental) Whether the cluster has EC2 capacity associated with it.
IVpc	getVpc() (experimental) The VPC associated with the cluster.
Metric	metric(String metricName) (experimental) This method returns the specifed CloudWatch metric for this cluster.
Metric	metric(String metricName, MetricOptions props) (experimental) This method returns the specifed CloudWatch metric for this cluster.
Metric	metricCpuReservation() (experimental) This method returns the CloudWatch metric for this clusters CPU reservation.
Metric	metricCpuReservation(MetricOptions props) (experimental) This method returns the CloudWatch metric for this clusters CPU reservation.
Metric	metricCpuUtilization() (experimental) This method returns the CloudWatch metric for this clusters CPU utilization.
Metric	metricCpuUtilization(MetricOptions props) (experimental) This method returns the CloudWatch metric for this clusters CPU utilization.
Metric	metricMemoryReservation() (experimental) This method returns the CloudWatch metric for this clusters memory reservation.
Metric	metricMemoryReservation(MetricOptions props) (experimental) This method returns the CloudWatch metric for this clusters memory reservation.
Metric	metricMemoryUtilization() (experimental) This method returns the CloudWatch metric for this clusters memory utilization.
Metric	metricMemoryUtilization(MetricOptions props) (experimental) This method returns the CloudWatch metric for this clusters memory utilization.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Cluster

protected Cluster(software.amazon.jsii.JsiiObjectRef objRef)

Cluster

protected Cluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Cluster

@Stability(value=Experimental)
public Cluster(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @Nullable
                                              ClusterProps props)

(experimental) Constructs a new instance of the Cluster class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Cluster

@Stability(value=Experimental)
public Cluster(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id)

(experimental) Constructs a new instance of the Cluster class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromClusterAttributes

@Stability(value=Experimental)
 @NotNull
public static ICluster fromClusterAttributes(@NotNull
                                                                                      software.constructs.Construct scope,
                                                                                      @NotNull
                                                                                      String id,
                                                                                      @NotNull
                                                                                      ClusterAttributes attrs)

(experimental) Import an existing cluster to the stack from its attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addAsgCapacityProvider

@Stability(value=Experimental)
public void addAsgCapacityProvider(@NotNull
                                                                  AsgCapacityProvider provider,
                                                                  @Nullable
                                                                  AddAutoScalingGroupCapacityOptions options)

(experimental) This method adds an Auto Scaling Group Capacity Provider to a cluster.

Parameters:

provider - the capacity provider to add to this cluster. This parameter is required.

options -

addAsgCapacityProvider

@Stability(value=Experimental)
public void addAsgCapacityProvider(@NotNull
                                                                  AsgCapacityProvider provider)

(experimental) This method adds an Auto Scaling Group Capacity Provider to a cluster.

Parameters:

provider - the capacity provider to add to this cluster. This parameter is required.

addAutoScalingGroup

@Stability(value=Deprecated)
 @Deprecated
public void addAutoScalingGroup(@NotNull
                                                                          AutoScalingGroup autoScalingGroup,
                                                                          @Nullable
                                                                          AddAutoScalingGroupCapacityOptions options)

Deprecated. Use Cluster.addAsgCapacityProvider instead.

(deprecated) This method adds compute capacity to a cluster using the specified AutoScalingGroup.

Parameters:

autoScalingGroup - the ASG to add to this cluster. This parameter is required.

options -

addAutoScalingGroup

@Stability(value=Deprecated)
 @Deprecated
public void addAutoScalingGroup(@NotNull
                                                                          AutoScalingGroup autoScalingGroup)

Deprecated. Use Cluster.addAsgCapacityProvider instead.

(deprecated) This method adds compute capacity to a cluster using the specified AutoScalingGroup.

Parameters:

autoScalingGroup - the ASG to add to this cluster. This parameter is required.

addCapacity

@Stability(value=Experimental)
 @NotNull
public AutoScalingGroup addCapacity(@NotNull
                                                                             String id,
                                                                             @NotNull
                                                                             AddCapacityOptions options)

(experimental) It is highly recommended to use Cluster.addAsgCapacityProvider instead of this method.

This method adds compute capacity to a cluster by creating an AutoScalingGroup with the specified options.

Returns the AutoScalingGroup so you can add autoscaling settings to it.

Parameters:

id - This parameter is required.

options - This parameter is required.

addCapacityProvider

@Stability(value=Deprecated)
 @Deprecated
public void addCapacityProvider(@NotNull
                                                                          String provider)

Deprecated. Use enableFargateCapacityProviders instead.

(deprecated) This method enables the Fargate or Fargate Spot capacity providers on the cluster.

Parameters:

provider - the capacity provider to add to this cluster. This parameter is required.

See Also:

addAsgCapacityProvider} to add an Auto Scaling Group capacity provider to the cluster.

addDefaultCloudMapNamespace

@Stability(value=Experimental)
 @NotNull
public INamespace addDefaultCloudMapNamespace(@NotNull
                                                                                       CloudMapNamespaceOptions options)

(experimental) Add an AWS Cloud Map DNS namespace for this cluster.

NOTE: HttpNamespaces are not supported, as ECS always requires a DNSConfig when registering an instance to a Cloud Map service.

Parameters:

options - This parameter is required.

enableFargateCapacityProviders

@Stability(value=Experimental)
public void enableFargateCapacityProviders()

(experimental) Enable the Fargate capacity providers for this cluster.

metric

@Stability(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName,
                                                              @Nullable
                                                              MetricOptions props)

(experimental) This method returns the specifed CloudWatch metric for this cluster.

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName)

(experimental) This method returns the specifed CloudWatch metric for this cluster.

Parameters:

metricName - This parameter is required.

metricCpuReservation

@Stability(value=Experimental)
 @NotNull
public Metric metricCpuReservation(@Nullable
                                                                            MetricOptions props)

(experimental) This method returns the CloudWatch metric for this clusters CPU reservation.

Default: average over 5 minutes

Parameters:

props -

metricCpuReservation

@Stability(value=Experimental)
 @NotNull
public Metric metricCpuReservation()

(experimental) This method returns the CloudWatch metric for this clusters CPU reservation.

Default: average over 5 minutes

metricCpuUtilization

@Stability(value=Experimental)
 @NotNull
public Metric metricCpuUtilization(@Nullable
                                                                            MetricOptions props)

(experimental) This method returns the CloudWatch metric for this clusters CPU utilization.

Default: average over 5 minutes

Parameters:

props -

metricCpuUtilization

@Stability(value=Experimental)
 @NotNull
public Metric metricCpuUtilization()

(experimental) This method returns the CloudWatch metric for this clusters CPU utilization.

Default: average over 5 minutes

metricMemoryReservation

@Stability(value=Experimental)
 @NotNull
public Metric metricMemoryReservation(@Nullable
                                                                               MetricOptions props)

(experimental) This method returns the CloudWatch metric for this clusters memory reservation.

Default: average over 5 minutes

Parameters:

props -

metricMemoryReservation

@Stability(value=Experimental)
 @NotNull
public Metric metricMemoryReservation()

(experimental) This method returns the CloudWatch metric for this clusters memory reservation.

Default: average over 5 minutes

metricMemoryUtilization

@Stability(value=Experimental)
 @NotNull
public Metric metricMemoryUtilization(@Nullable
                                                                               MetricOptions props)

(experimental) This method returns the CloudWatch metric for this clusters memory utilization.

Default: average over 5 minutes

Parameters:

props -

metricMemoryUtilization

@Stability(value=Experimental)
 @NotNull
public Metric metricMemoryUtilization()

(experimental) This method returns the CloudWatch metric for this clusters memory utilization.

Default: average over 5 minutes

getClusterArn

@Stability(value=Experimental)
 @NotNull
public String getClusterArn()

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

Specified by:

getClusterArn in interface ICluster

getClusterName

@Stability(value=Experimental)
 @NotNull
public String getClusterName()

(experimental) The name of the cluster.

Specified by:

getClusterName in interface ICluster

getConnections

@Stability(value=Experimental)
 @NotNull
public Connections getConnections()

(experimental) Manage the allowed network connections for the cluster with Security Groups.

Specified by:

getConnections in interface ICluster

getHasEc2Capacity

@Stability(value=Experimental)
 @NotNull
public Boolean getHasEc2Capacity()

(experimental) Whether the cluster has EC2 capacity associated with it.

Specified by:

getHasEc2Capacity in interface ICluster

getVpc

@Stability(value=Experimental)
 @NotNull
public IVpc getVpc()

(experimental) The VPC associated with the cluster.

Specified by:

getVpc in interface ICluster

getAutoscalingGroup

@Stability(value=Experimental)
 @Nullable
public IAutoScalingGroup getAutoscalingGroup()

(experimental) Getter for autoscaling group added to cluster.

Specified by:

getAutoscalingGroup in interface ICluster

getDefaultCloudMapNamespace

@Stability(value=Experimental)
 @Nullable
public INamespace getDefaultCloudMapNamespace()

(experimental) Getter for namespace added to cluster.

Specified by:

getDefaultCloudMapNamespace in interface ICluster

getExecuteCommandConfiguration

@Stability(value=Experimental)
 @Nullable
public ExecuteCommandConfiguration getExecuteCommandConfiguration()

(experimental) Getter for execute command configuration associated with the cluster.

Specified by:

getExecuteCommandConfiguration in interface ICluster