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

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

Overview

Details of a task definition.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#compatibilities ⇒ Array<String>

The launch type to use with your task. For more information, see

Amazon ECS Launch Types][1

in the *Amazon Elastic Container

Service Developer Guide*.

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

Returns:

  • (Array<String>) 


6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#container_definitions ⇒ Array<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*.

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

Returns:



6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#cpu ⇒ String

The number of ‘cpu` units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are 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: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

  • 512 (.5 vCPU) - Available ‘memory` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

  • 1024 (1 vCPU) - Available ‘memory` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

  • 2048 (2 vCPU) - Available ‘memory` values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

  • 4096 (4 vCPU) - Available ‘memory` values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

Returns:

  • (String) 


6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#execution_role_arn ⇒ String

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

Returns:

  • (String) 


6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#family ⇒ String

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

Returns:

  • (String) 


6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#ipc_mode ⇒ String

The IPC resource namespace to use for the containers in the task. The valid values are ‘host`, `task`, or `none`. If `host` is specified, then all containers within the tasks that specified the `host` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If `task` is specified, all containers within the specified task share the same IPC resources. If `none` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings] in the *Docker run reference*.

If the ‘host` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security].

If you are setting namespaced kernel parameters using ‘systemControls` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see

System Controls][3

in the *Amazon Elastic Container Service

Developer Guide*.

  • For tasks that use the ‘host` IPC mode, IPC namespace related `systemControls` are not supported.

  • For tasks that use the ‘task` IPC mode, IPC namespace related `systemControls` will apply to all containers within a task.

<note markdown=“1”> This parameter is not supported for Windows containers or tasks using the Fargate launch type.

</note>

[1]: docs.docker.com/engine/reference/run/#ipc-settings—ipc [2]: docs.docker.com/engine/security/security/ [3]: docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html

Returns:

  • (String) 


6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#memory ⇒ String

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:

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ‘cpu` values: 256 (.25 vCPU)

  • 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ‘cpu` values: 512 (.5 vCPU)

  • 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ‘cpu` values: 1024 (1 vCPU)

  • Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

    • Available ‘cpu` values: 2048 (2 vCPU)

  • Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

    • Available ‘cpu` values: 4096 (4 vCPU)

Returns:

  • (String) 


6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#network_mode ⇒ String

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 you are using the Fargate launch type, the `awsvpc` network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to `none`, you cannot specify port mappings in your container definitions, and the tasks 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 value 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*.

<note markdown=“1”> Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ‘ecs-init` package, or AWS Fargate infrastructure support the `awsvpc` network mode.

</note>

If the network mode is ‘host`, you cannot 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*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html [2]: docs.docker.com/engine/reference/run/#network-settings

Returns:

  • (String) 


6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#pid_mode ⇒ String

The process namespace to use for the containers in the task. The valid values are ‘host` or `task`. If `host` is specified, then all containers within the tasks that specified the `host` PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If `task` is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see [PID settings] in the *Docker run reference*.

If the ‘host` PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see [Docker security].

<note markdown=“1”> This parameter is not supported for Windows containers or tasks using the Fargate launch type.

</note>

[1]: docs.docker.com/engine/reference/run/#pid-settings—pid [2]: docs.docker.com/engine/security/security/

Returns:

  • (String) 


6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#placement_constraints ⇒ Array<Types::TaskDefinitionPlacementConstraint>

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

Returns:



6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#requires_attributes ⇒ Array<Types::Attribute>

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

Returns:



6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#requires_compatibilities ⇒ Array<String>

The launch type that the task is using.

Returns:

  • (Array<String>) 


6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#revision ⇒ Integer

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


6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#status ⇒ String

The status of the task definition.

Returns:

  • (String) 


6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#task_definition_arn ⇒ String

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

Returns:

  • (String) 


6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#task_role_arn ⇒ String

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

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

Returns:

  • (String) 


6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end

#volumes ⇒ Array<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*.

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

Returns:



6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
 
# File 'lib/aws-sdk-ecs/types.rb', line 6948

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :execution_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints,
  :compatibilities,
  :requires_compatibilities,
  :cpu,
  :memory,
  :pid_mode,
  :ipc_mode)
  include Aws::Structure
end