aws-cdk-lib.aws_ecs.CfnService.PlacementStrategyProperty

interface PlacementStrategyProperty

LanguageType name
.NETAmazon.CDK.AWS.ECS.CfnService.PlacementStrategyProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsecs#CfnService_PlacementStrategyProperty
Javasoftware.amazon.awscdk.services.ecs.CfnService.PlacementStrategyProperty
Pythonaws_cdk.aws_ecs.CfnService.PlacementStrategyProperty
TypeScript aws-cdk-lib » aws_ecs » CfnService » PlacementStrategyProperty

The PlacementStrategy property specifies the task placement strategy for a task or service.

For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const placementStrategyProperty: ecs.CfnService.PlacementStrategyProperty = {
  type: 'type',

  // the properties below are optional
  field: 'field',
};

Properties

NameTypeDescription
typestringThe type of placement strategy.
field?stringThe field to apply the placement strategy against.

type

Type: string

The type of placement strategy.

The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that's specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.


field?

Type: string (optional)

The field to apply the placement strategy against.

For the spread placement strategy, valid values are instanceId (or host , which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone . For the binpack placement strategy, valid values are CPU and MEMORY . For the random placement strategy, this field is not used.