You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatchevents/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
  network_configuration: {
    awsvpc_configuration: {
      subnets: ["String"], # required
      security_groups: ["String"],
      assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
  platform_version: "String",
  group: "String",
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#groupString

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

Returns:

  • (String)


712
713
714
715
716
717
718
719
720
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 712

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group)
  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 AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Returns:

  • (String)


712
713
714
715
716
717
718
719
720
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 712

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group)
  include Aws::Structure
end

#network_configurationTypes::NetworkConfiguration

Use this structure if the 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 doesn't use the awsvpc network mode, the task fails.



712
713
714
715
716
717
718
719
720
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 712

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group)
  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 AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Returns:

  • (String)


712
713
714
715
716
717
718
719
720
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 712

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group)
  include Aws::Structure
end

#task_countInteger

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

Returns:

  • (Integer)


712
713
714
715
716
717
718
719
720
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 712

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group)
  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)


712
713
714
715
716
717
718
719
720
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 712

class EcsParameters < Struct.new(
  :task_definition_arn,
  :task_count,
  :launch_type,
  :network_configuration,
  :platform_version,
  :group)
  include Aws::Structure
end