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

Class: Aws::ECS::Types::TaskDefinition

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#compatibilitiesArray<String>

The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Returns:

  • (Array<String>)

    The launch type to use with your task.

#container_definitionsArray<Types::ContainerDefinition>

A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

Returns:

  • (Array<Types::ContainerDefinition>)

    A list of container definitions in JSON format that describe the different containers that make up your task.

#cpuString

The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:

  • 256 (.25 vCPU) - Available memory values: 512MB, 1GB, 2GB

  • 512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB

  • 1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB

  • 2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments

  • 4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments

Returns:

  • (String)

    The number of cpu units used by the task.

#execution_role_arnString

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

#familyString

The family of your task definition, used as the definition name.

Returns:

  • (String)

    The family of your task definition, used as the definition name.

#memoryString

The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

  • 512MB, 1GB, 2GB - Available cpu values: 256 (.25 vCPU)

  • 1GB, 2GB, 3GB, 4GB - Available cpu values: 512 (.5 vCPU)

  • 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available cpu values: 1024 (1 vCPU)

  • Between 4GB and 16GB in 1GB increments - Available cpu values: 2048 (2 vCPU)

  • Between 8GB and 30GB in 1GB increments - Available cpu values: 4096 (4 vCPU)

Returns:

  • (String)

    The amount (in MiB) of memory used by the task.

#network_modeString

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If using the Fargate launch type, the awsvpc network mode is required. If using the EC2 launch type, any network mode can be used. If the network mode is set to none, you can\'t specify port mappings in your container definitions, and the task\'s containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

If the network mode is host, you can\'t run multiple instantiations of the same task on a single container instance when port mappings are used.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

For more information, see Network settings in the Docker run reference.

Returns:

  • (String)

    The Docker networking mode to use for the containers in the task.

#placement_constraintsArray<Types::TaskDefinitionPlacementConstraint>

An array of placement constraint objects to use for tasks. This field is not valid if using the Fargate launch type for your task.

Returns:

#requires_attributesArray<Types::Attribute>

The container instance attributes required by your task. This field is not valid if using the Fargate launch type for your task.

Returns:

  • (Array<Types::Attribute>)

    The container instance attributes required by your task.

#requires_compatibilitiesArray<String>

The launch type the task is using.

Returns:

  • (Array<String>)

    The launch type the task is using.

#revisionInteger

The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1; each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family).

Returns:

  • (Integer)

    The revision of the task in a particular family.

#statusString

The status of the task definition.

Possible values:

  • ACTIVE
  • INACTIVE

Returns:

  • (String)

    The status of the task definition.

#task_definition_arnString

The full Amazon Resource Name (ARN) of the task definition.

Returns:

  • (String)

    The full Amazon Resource Name (ARN) of the task definition.

#task_role_arnString

The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

Returns:

  • (String)

    The ARN of the IAM role that containers in this task can assume.

#volumesArray<Types::Volume>

The list of volumes in a task.

If you are using the Fargate launch type, the host and sourcePath parameters are not supported.

For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

Returns: