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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass CreateTaskSetRequest data as a 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
  capacity_provider_strategy: [
    {
      capacity_provider: "String", # required
      weight: 1,
      base: 1,
    },
  ],
  platform_version: "String",
  scale: {
    value: 1.0,
    unit: "PERCENT", # accepts PERCENT
  },
  client_token: "String",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

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

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.



3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3125

class CreateTaskSetRequest < Struct.new(
  :service,
  :cluster,
  :external_id,
  :task_definition,
  :network_configuration,
  :load_balancers,
  :service_registries,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :scale,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3125

class CreateTaskSetRequest < Struct.new(
  :service,
  :cluster,
  :external_id,
  :task_definition,
  :network_configuration,
  :load_balancers,
  :service_registries,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :scale,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3125

class CreateTaskSetRequest < Struct.new(
  :service,
  :cluster,
  :external_id,
  :task_definition,
  :network_configuration,
  :load_balancers,
  :service_registries,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :scale,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3125

class CreateTaskSetRequest < Struct.new(
  :service,
  :cluster,
  :external_id,
  :task_definition,
  :network_configuration,
  :load_balancers,
  :service_registries,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :scale,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Returns:

  • (String)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3125

class CreateTaskSetRequest < Struct.new(
  :service,
  :cluster,
  :external_id,
  :task_definition,
  :network_configuration,
  :load_balancers,
  :service_registries,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :scale,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#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:



3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3125

class CreateTaskSetRequest < Struct.new(
  :service,
  :cluster,
  :external_id,
  :task_definition,
  :network_configuration,
  :load_balancers,
  :service_registries,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :scale,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#network_configurationTypes::NetworkConfiguration

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



3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3125

class CreateTaskSetRequest < Struct.new(
  :service,
  :cluster,
  :external_id,
  :task_definition,
  :network_configuration,
  :load_balancers,
  :service_registries,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :scale,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3125

class CreateTaskSetRequest < Struct.new(
  :service,
  :cluster,
  :external_id,
  :task_definition,
  :network_configuration,
  :load_balancers,
  :service_registries,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :scale,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#scaleTypes::Scale

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

Returns:



3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3125

class CreateTaskSetRequest < Struct.new(
  :service,
  :cluster,
  :external_id,
  :task_definition,
  :network_configuration,
  :load_balancers,
  :service_registries,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :scale,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#serviceString

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

Returns:

  • (String)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3125

class CreateTaskSetRequest < Struct.new(
  :service,
  :cluster,
  :external_id,
  :task_definition,
  :network_configuration,
  :load_balancers,
  :service_registries,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :scale,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#service_registriesArray<Types::ServiceRegistry>

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

Returns:



3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3125

class CreateTaskSetRequest < Struct.new(
  :service,
  :cluster,
  :external_id,
  :task_definition,
  :network_configuration,
  :load_balancers,
  :service_registries,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :scale,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Returns:



3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3125

class CreateTaskSetRequest < Struct.new(
  :service,
  :cluster,
  :external_id,
  :task_definition,
  :network_configuration,
  :load_balancers,
  :service_registries,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :scale,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#task_definitionString

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

Returns:

  • (String)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3125

class CreateTaskSetRequest < Struct.new(
  :service,
  :cluster,
  :external_id,
  :task_definition,
  :network_configuration,
  :load_balancers,
  :service_registries,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :scale,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end