aws-cdk-lib.aws_scheduler.CfnSchedule.EcsParametersProperty

EcsParametersProperty Struct

The templated target type for the Amazon ECS RunTask API operation.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_scheduler as scheduler } from 'aws-cdk-lib';

declare const tags: any;
const ecsParametersProperty: scheduler.CfnSchedule.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',
  }],
  placementStrategy: [{
    field: 'field',
    type: 'type',
  }],
  platformVersion: 'platformVersion',
  propagateTags: 'propagateTags',
  referenceId: 'referenceId',
  tags: tags,
  taskCount: 123,
};

Properties

capacityProviderStrategyIResolvable | IResolvable | CfnSchedule.CapacityProviderStrategyItemProperty[]capacity_provider_strategytyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CapacityProviderStrategyItemProperty]]]capacityProviderStrategyIResolvableCapacityProviderStrategyIResolvableCapacityProviderStrategyinterface{}#

The capacity provider strategy to use for the task.

enableEcsManagedTagsboolean | IResolvableenable_ecs_managed_tagstyping.Union[bool, IResolvable]enableEcsManagedTagsBooleanEnableEcsManagedTagsboolEnableEcsManagedTagsinterface{}#

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

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

enableExecuteCommandboolean | IResolvableenable_execute_commandtyping.Union[bool, IResolvable]enableExecuteCommandBooleanEnableExecuteCommandboolEnableExecuteCommandinterface{}#

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.

groupstringgroupstrgroupStringGroupstringGroup*string#

Specifies an Amazon ECS task group for the task.

The maximum length is 255 characters.

launchTypestringlaunch_typestrlaunchTypeStringLaunchTypestringLaunchType*string#

Specifies the launch type on which your task is running.

notes

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 Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide .

networkConfigurationIResolvable | CfnSchedule.NetworkConfigurationPropertynetwork_configurationtyping.Union[IResolvable, NetworkConfigurationProperty]networkConfigurationIResolvableNetworkConfigurationIResolvableNetworkConfigurationinterface{}#

This structure specifies the network configuration for an ECS task.

placementConstraintsIResolvable | IResolvable | CfnSchedule.PlacementConstraintProperty[]placement_constraintstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PlacementConstraintProperty]]]placementConstraintsIResolvablePlacementConstraintsIResolvablePlacementConstraintsinterface{}#

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

placementStrategyIResolvable | IResolvable | CfnSchedule.PlacementStrategyProperty[]placement_strategytyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PlacementStrategyProperty]]]placementStrategyIResolvablePlacementStrategyIResolvablePlacementStrategyinterface{}#

The task placement strategy for a task or service.

platformVersionstringplatform_versionstrplatformVersionStringPlatformVersionstringPlatformVersion*string#

Specifies the platform version for the task.

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

propagateTagsstringpropagate_tagsstrpropagateTagsStringPropagateTagsstringPropagateTags*string#

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

notes

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 Amazon ECS TagResource API action.

referenceIdstringreference_idstrreferenceIdStringReferenceIdstringReferenceId*string#

The reference ID to use for the task.

tagsanytagsAnytagsObjectTagsobjectTagsinterface{}#

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. For more information, see RunTask in the Amazon ECS API Reference .

taskCountnumbertask_countint | floattaskCountNumberTaskCountdoubleTaskCount*float64#

The number of tasks to create based on `TaskDefinition` .

The default is 1 .

taskDefinitionArnstringtask_definition_arnstrtaskDefinitionArnStringTaskDefinitionArnstringTaskDefinitionArn*stringrequired#

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