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

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::CreateTaskSetRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ecs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #capacity_provider_strategy ⇒ Array<Types::CapacityProviderStrategyItem>

  The capacity provider strategy to use for the task set.

• #client_token ⇒ String

  An identifier that you provide to ensure the idempotency of the request.

• #cluster ⇒ String

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

• #external_id ⇒ String

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

• #launch_type ⇒ String

  The launch type that new tasks in the task set uses.

• #load_balancers ⇒ Array<Types::LoadBalancer>

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

• #network_configuration ⇒ Types::NetworkConfiguration

  An object representing the network configuration for a task set.

• #platform_version ⇒ String

  The platform version that the tasks in the task set uses.

• #scale ⇒ Types::Scale

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

• #service ⇒ String

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

• #service_registries ⇒ Array<Types::ServiceRegistry>

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

• #tags ⇒ Array<Types::Tag>

  The metadata that you apply to the task set to help you categorize and organize them.

• #task_definition ⇒ String

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

Instance Attribute Details

#capacity_provider_strategy ⇒ Array<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 [CreateCapacityProviderProvider]API operation.

To use a Fargate capacity provider, specify either the ‘FARGATE` or `FARGATE_SPOT` capacity providers. The 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.

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html [2]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProviderProvider.html

Returns:

• (Array<Types::CapacityProviderStrategyItem>)

# File 'lib/aws-sdk-ecs/types.rb', line 3200

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_token ⇒ String

An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 3200

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

#cluster ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 3200

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_id ⇒ String

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` Cloud Map attribute set to the provided value.

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 3200

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_type ⇒ String

The launch type that new tasks in the task set uses. 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.

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

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 3200

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_balancers ⇒ Array<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>)

# File 'lib/aws-sdk-ecs/types.rb', line 3200

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_configuration ⇒ Types::NetworkConfiguration

An object representing the network configuration for a task set.

Returns:

• (Types::NetworkConfiguration)

# File 'lib/aws-sdk-ecs/types.rb', line 3200

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_version ⇒ String

The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn’t specified, the ‘LATEST` platform version is used.

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 3200

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

#scale ⇒ Types::Scale

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

Returns:

• (Types::Scale)

# File 'lib/aws-sdk-ecs/types.rb', line 3200

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 ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 3200

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_registries ⇒ Array<Types::ServiceRegistry>

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

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html

Returns:

• (Array<Types::ServiceRegistry>)

# File 'lib/aws-sdk-ecs/types.rb', line 3200

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

#tags ⇒ Array<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. You define both. When a service is deleted, the tags are deleted.

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 Amazon Web Services 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:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-ecs/types.rb', line 3200

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_definition ⇒ String

The task definition for the tasks in the task set to use. If a revision isn’t specified, the latest ‘ACTIVE` revision is used.

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 3200

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