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

Class: Aws::ECS::Types::CreateTaskSetRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateTaskSetRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  service: "String", # required
  cluster: "String", # required
  external_id: "String",
  task_definition: "String", # required
  network_configuration: {
    awsvpc_configuration: {
      subnets: ["String"], # required
      security_groups: ["String"],
      assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
  load_balancers: [
    {
      target_group_arn: "String",
      load_balancer_name: "String",
      container_name: "String",
      container_port: 1,
    },
  ],
  service_registries: [
    {
      registry_arn: "String",
      port: 1,
      container_name: "String",
      container_port: 1,
    },
  ],
  launch_type: "EC2", # accepts EC2, FARGATE
  platform_version: "String",
  scale: {
    value: 1.0,
    unit: "PERCENT", # accepts PERCENT
  },
  client_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Returns:

  • (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

#clusterString

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

Returns:

  • (String)

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

#external_idString

An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.

Returns:

  • (String)

    An optional non-unique tag that identifies this task set in external systems.

#launch_typeString

The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Returns:

  • (String)

    The launch type that new tasks in the task set will use.

#load_balancersArray<Types::LoadBalancer>

A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

Returns:

  • (Array<Types::LoadBalancer>)

    A load balancer object representing the load balancer to use with the task set.

#network_configurationTypes::NetworkConfiguration

An object representing the network configuration for a task or service.

Returns:

#platform_versionString

The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn\'t specified, the LATEST platform version is used by default.

Returns:

  • (String)

    The platform version that the tasks in the task set should use.

#scaleTypes::Scale

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

Returns:

  • (Types::Scale)

    A floating-point percentage of the desired number of tasks to place and keep running in the task set.

    .

#serviceString

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

Returns:

  • (String)

    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

#service_registriesArray<Types::ServiceRegistry>

The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.

Returns:

  • (Array<Types::ServiceRegistry>)

    The details of the service discovery registries to assign to this task set.

#task_definitionString

The task definition for the tasks in the task set to use.

Returns:

  • (String)

    The task definition for the tasks in the task set to use.