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

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

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

Overview

Details of a task definition.

Instance Attribute Summary collapse

Instance Attribute Details

#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 EC2 Container Service Developer Guide.

Returns:



4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4396

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints)
  include Aws::Structure
end

#familyString

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

Returns:

  • (String)


4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4396

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints)
  include Aws::Structure
end

#network_modeString

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host.

If the network mode is none, the containers do not have external connectivity. The default Docker network mode is bridge. If the network mode is awsvpc, the task is allocated an Elastic Network Interface. 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.

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

Returns:

  • (String)


4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4396

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints)
  include Aws::Structure
end

#placement_constraintsArray<Types::TaskDefinitionPlacementConstraint>

An array of placement constraint objects to use for tasks.



4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4396

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints)
  include Aws::Structure
end

#requires_attributesArray<Types::Attribute>

The container instance attributes required by your task.

Returns:



4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4396

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints)
  include Aws::Structure
end

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


4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4396

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints)
  include Aws::Structure
end

#statusString

The status of the task definition.

Returns:

  • (String)


4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4396

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints)
  include Aws::Structure
end

#task_definition_arnString

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

Returns:

  • (String)


4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4396

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints)
  include Aws::Structure
end

#task_role_arnString

The Amazon Resource Name (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.

Returns:

  • (String)


4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4396

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints)
  include Aws::Structure
end

#volumesArray<Types::Volume>

The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

Returns:



4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4396

class TaskDefinition < Struct.new(
  :task_definition_arn,
  :container_definitions,
  :family,
  :task_role_arn,
  :network_mode,
  :revision,
  :volumes,
  :status,
  :requires_attributes,
  :placement_constraints)
  include Aws::Structure
end