Class: Aws::CloudWatchEvents::Types::EcsParameters

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudwatchevents/types.rb

Overview

Note:

When making an API call, you may pass EcsParameters data as a hash:

{
  task_definition_arn: "Arn", # required
  task_count: 1,
  launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
  network_configuration: {
    awsvpc_configuration: {
      subnets: ["String"], # required
      security_groups: ["String"],
      assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
  platform_version: "String",
  group: "String",
  capacity_provider_strategy: [
    {
      capacity_provider: "CapacityProvider", # required
      weight: 1,
      base: 1,
    },
  ],
  enable_ecs_managed_tags: false,
  enable_execute_command: false,
  placement_constraints: [
    {
      type: "distinctInstance", # accepts distinctInstance, memberOf
      expression: "PlacementConstraintExpression",
    },
  ],
  placement_strategy: [
    {
      type: "random", # accepts random, spread, binpack
      field: "PlacementStrategyField",
    },
  ],
  propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
  reference_id: "ReferenceId",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_provider_strategyArray<Types::CapacityProviderStrategyItem>

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.


2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2404

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group,
  :capacity_provider_strategy,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :placement_constraints,
  :placement_strategy,
  :propagate_tags,
  :reference_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#enable_ecs_managed_tagsBoolean

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.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html

Returns:

  • (Boolean)

2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2404

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group,
  :capacity_provider_strategy,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :placement_constraints,
  :placement_strategy,
  :propagate_tags,
  :reference_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#enable_execute_commandBoolean

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.

Returns:

  • (Boolean)

2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2404

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group,
  :capacity_provider_strategy,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :placement_constraints,
  :placement_strategy,
  :propagate_tags,
  :reference_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#groupString

Specifies an ECS task group for the task. The maximum length is 255 characters.

Returns:

  • (String)

2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2404

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group,
  :capacity_provider_strategy,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :placement_constraints,
  :placement_strategy,
  :propagate_tags,
  :reference_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#launch_typeString

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 Fargate witt Amazon ECS is supported. For more information, see [Fargate on Amazon ECS] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html

Returns:

  • (String)

2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2404

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group,
  :capacity_provider_strategy,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :placement_constraints,
  :placement_strategy,
  :propagate_tags,
  :reference_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#network_configurationTypes::NetworkConfiguration

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.


2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2404

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group,
  :capacity_provider_strategy,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :placement_constraints,
  :placement_strategy,
  :propagate_tags,
  :reference_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#placement_constraintsArray<Types::PlacementConstraint>

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

Returns:


2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2404

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group,
  :capacity_provider_strategy,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :placement_constraints,
  :placement_strategy,
  :propagate_tags,
  :reference_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#placement_strategyArray<Types::PlacementStrategy>

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Returns:


2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2404

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group,
  :capacity_provider_strategy,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :placement_constraints,
  :placement_strategy,
  :propagate_tags,
  :reference_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#platform_versionString

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 [Fargate Platform Versions] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html

Returns:

  • (String)

2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2404

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group,
  :capacity_provider_strategy,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :placement_constraints,
  :placement_strategy,
  :propagate_tags,
  :reference_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#propagate_tagsString

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.

Returns:

  • (String)

2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2404

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group,
  :capacity_provider_strategy,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :placement_constraints,
  :placement_strategy,
  :propagate_tags,
  :reference_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#reference_idString

The reference ID to use for the task.

Returns:

  • (String)

2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2404

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group,
  :capacity_provider_strategy,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :placement_constraints,
  :placement_strategy,
  :propagate_tags,
  :reference_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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.

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags

Returns:


2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2404

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group,
  :capacity_provider_strategy,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :placement_constraints,
  :placement_strategy,
  :propagate_tags,
  :reference_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#task_countInteger

The number of tasks to create based on `TaskDefinition`. The default is 1.

Returns:

  • (Integer)

2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2404

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group,
  :capacity_provider_strategy,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :placement_constraints,
  :placement_strategy,
  :propagate_tags,
  :reference_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#task_definition_arnString

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

Returns:

  • (String)

2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2404

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group,
  :capacity_provider_strategy,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :placement_constraints,
  :placement_strategy,
  :propagate_tags,
  :reference_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end