interface PlacementStrategyProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Events.CfnRule.PlacementStrategyProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnRule_PlacementStrategyProperty`
Java	`software.amazon.awscdk.services.events.CfnRule.PlacementStrategyProperty`
Python	`aws_cdk.aws_events.CfnRule.PlacementStrategyProperty`
TypeScript	`aws-cdk-lib` » `aws_events` » `CfnRule` » `PlacementStrategyProperty`

The task placement strategy for a task or service.

To learn more, see Task Placement Strategies in the Amazon Elastic Container Service 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_events as events } from 'aws-cdk-lib';
const placementStrategyProperty: events.CfnRule.PlacementStrategyProperty = {
  field: 'field',
  type: 'type',
};

Properties

Name	Type	Description
field?	`string`	The field to apply the placement strategy against.
type?	`string`	The type of placement strategy.

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.

type?

Type: string (optional)

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 is 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).