interface EcsParametersProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Events.CfnRule.EcsParametersProperty`
Java	`software.amazon.awscdk.services.events.CfnRule.EcsParametersProperty`
Python	`aws_cdk.aws_events.CfnRule.EcsParametersProperty`
TypeScript	`@aws-cdk/aws-events` » `CfnRule` » `EcsParametersProperty`

The custom parameters to be used when the target is an Amazon ECS task.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as events from '@aws-cdk/aws-events';
const ecsParametersProperty: events.CfnRule.EcsParametersProperty = {
  taskDefinitionArn: 'taskDefinitionArn',

  // the properties below are optional
  capacityProviderStrategy: [{
    capacityProvider: 'capacityProvider',

    // the properties below are optional
    base: 123,
    weight: 123,
  }],
  enableEcsManagedTags: false,
  enableExecuteCommand: false,
  group: 'group',
  launchType: 'launchType',
  networkConfiguration: {
    awsVpcConfiguration: {
      subnets: ['subnets'],

      // the properties below are optional
      assignPublicIp: 'assignPublicIp',
      securityGroups: ['securityGroups'],
    },
  },
  placementConstraints: [{
    expression: 'expression',
    type: 'type',
  }],
  placementStrategies: [{
    field: 'field',
    type: 'type',
  }],
  platformVersion: 'platformVersion',
  propagateTags: 'propagateTags',
  referenceId: 'referenceId',
  tagList: [{
    key: 'key',
    value: 'value',
  }],
  taskCount: 123,
};

Properties

Name	Type	Description
taskDefinitionArn	`string`	The ARN of the task definition to use if the event target is an Amazon ECS task.
capacityProviderStrategy?	`IResolvable` `\|` `IResolvable` `\|` `CapacityProviderStrategyItemProperty[]`	The capacity provider strategy to use for the task.
enableEcsManagedTags?	`boolean \|` `IResolvable`	Specifies whether to enable Amazon ECS managed tags for the task.
enableExecuteCommand?	`boolean \|` `IResolvable`	Whether or not to enable the execute command functionality for the containers in this task.
group?	`string`	Specifies an ECS task group for the task.
launchType?	`string`	Specifies the launch type on which your task is running.
networkConfiguration?	`IResolvable` `\|` `NetworkConfigurationProperty`	Use this structure if the Amazon ECS task uses the `awsvpc` network mode.
placementConstraints?	`IResolvable` `\|` `IResolvable` `\|` `PlacementConstraintProperty[]`	An array of placement constraint objects to use for the task.
placementStrategies?	`IResolvable` `\|` `IResolvable` `\|` `PlacementStrategyProperty[]`	The placement strategy objects to use for the task.
platformVersion?	`string`	Specifies the platform version for the task.
propagateTags?	`string`	Specifies whether to propagate the tags from the task definition to the task.
referenceId?	`string`	The reference ID to use for the task.
tagList?	`IResolvable` `\|` `IResolvable` `\|` `CfnTag[]`	The metadata that you apply to the task to help you categorize and organize them.
taskCount?	`number`	The number of tasks to create based on `TaskDefinition` .

taskDefinitionArn

Type: string

The ARN of the task definition to use if the event target is an Amazon ECS task.

capacityProviderStrategy?

Type: IResolvable | IResolvable | CapacityProviderStrategyItemProperty[] (optional)

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

enableEcsManagedTags?

Type: boolean | IResolvable (optional)

Specifies whether to enable Amazon ECS managed tags for the task.

For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

enableExecuteCommand?

Type: boolean | IResolvable (optional)

Whether or not to enable the execute command functionality for the containers in this task.

If true, this enables execute command functionality on all containers in the task.

group?

Type: string (optional)

Specifies an ECS task group for the task.

The maximum length is 255 characters.

launchType?

Type: string (optional)

Specifies the launch type on which your task is running.

The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide .

networkConfiguration?

Type: IResolvable | NetworkConfigurationProperty (optional)

Use this structure if the Amazon ECS task uses the awsvpc network mode.

This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

placementConstraints?

Type: IResolvable | IResolvable | PlacementConstraintProperty[] (optional)

An array of placement constraint objects to use for the task.

You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).

placementStrategies?

Type: IResolvable | IResolvable | PlacementStrategyProperty[] (optional)

The placement strategy objects to use for the task.

You can specify a maximum of five strategy rules per task.

platformVersion?

Type: string (optional)

Specifies the platform version for the task.

Specify only the numeric portion of the platform version, such as 1.1.0 .

This structure is used only if LaunchType is FARGATE . For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .

propagateTags?

Type: string (optional)

Specifies whether to propagate the tags from the task definition to the task.

If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

referenceId?

Type: string (optional)

The reference ID to use for the task.

tagList?

Type: IResolvable | IResolvable | CfnTag[] (optional)

The metadata that you apply to the task to help you categorize and organize them.

Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.

taskCount?

Type: number (optional)

The number of tasks to create based on TaskDefinition .

The default is 1.