software.amazon.awscdk.services.ecs

Class PlacementConstraint

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.PlacementConstraint

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:37:00.434Z")
public class PlacementConstraint
extends software.amazon.jsii.JsiiObject

The placement constraints to use for tasks in the service. For more information, see [Amazon ECS Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html).

Tasks will only be placed on instances that match these rules.

Example:

 IVpc vpc = Vpc.fromLookup(this, "Vpc", VpcLookupOptions.builder()
         .isDefault(true)
         .build());
 Cluster cluster = Cluster.Builder.create(this, "Ec2Cluster").vpc(vpc).build();
 cluster.addCapacity("DefaultAutoScalingGroup", AddCapacityOptions.builder()
         .instanceType(new InstanceType("t2.micro"))
         .vpcSubnets(SubnetSelection.builder().subnetType(SubnetType.PUBLIC).build())
         .build());
 TaskDefinition taskDefinition = TaskDefinition.Builder.create(this, "TD")
         .compatibility(Compatibility.EC2)
         .build();
 taskDefinition.addContainer("TheContainer", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("foo/bar"))
         .memoryLimitMiB(256)
         .build());
 EcsRunTask runTask = EcsRunTask.Builder.create(this, "Run")
         .integrationPattern(IntegrationPattern.RUN_JOB)
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .launchTarget(EcsEc2LaunchTarget.Builder.create()
                 .placementStrategies(List.of(PlacementStrategy.spreadAcrossInstances(), PlacementStrategy.packedByCpu(), PlacementStrategy.randomly()))
                 .placementConstraints(List.of(PlacementConstraint.memberOf("blieptuut")))
                 .build())
         .build();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PlacementConstraint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	PlacementConstraint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static PlacementConstraint	distinctInstances() Use distinctInstance to ensure that each task in a particular group is running on a different container instance.
static PlacementConstraint	memberOf(java.lang.String... expressions) Use memberOf to restrict the selection to a group of valid candidates specified by a query expression.
java.util.List<CfnService.PlacementConstraintProperty>	toJson() Return the placement JSON.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlacementConstraint

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

PlacementConstraint

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

Method Detail

distinctInstances

public static PlacementConstraint distinctInstances()

Use distinctInstance to ensure that each task in a particular group is running on a different container instance.

memberOf

public static PlacementConstraint memberOf(java.lang.String... expressions)

Use memberOf to restrict the selection to a group of valid candidates specified by a query expression.

Multiple expressions can be specified. For more information, see Cluster Query Language.

You can specify multiple expressions in one call. The tasks will only be placed on instances matching all expressions.

Parameters:

expressions - This parameter is required.

See Also:

https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html

toJson

public java.util.List<CfnService.PlacementConstraintProperty> toJson()

Return the placement JSON.