AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Details of a task definition.

Inheritance Hierarchy

System.Object
  Amazon.ECS.Model.TaskDefinition

Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

C#
public class TaskDefinition

The TaskDefinition type exposes the following members

Constructors

NameDescription
Public Method TaskDefinition()

Properties

NameTypeDescription
Public Property ContainerDefinitions System.Collections.Generic.List<Amazon.ECS.Model.ContainerDefinition>

Gets and sets the property ContainerDefinitions.

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.

Public Property Family System.String

Gets and sets the property Family.

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

Public Property NetworkMode Amazon.ECS.NetworkMode

Gets and sets the property NetworkMode.

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

If the network mode is none, the containers do not have external connectivity. The default Docker network mode is bridge. The host network mode offers the highest networking performance for containers because it uses the host network stack instead of the virtualized network stack provided by the bridge mode.

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

Public Property PlacementConstraints System.Collections.Generic.List<Amazon.ECS.Model.TaskDefinitionPlacementConstraint>

Gets and sets the property PlacementConstraints.

An array of placement constraint objects to use for tasks.

Public Property RequiresAttributes System.Collections.Generic.List<Amazon.ECS.Model.Attribute>

Gets and sets the property RequiresAttributes.

The container instance attributes required by your task.

Public Property Revision System.Int32

Gets and sets the property Revision.

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

Public Property Status Amazon.ECS.TaskDefinitionStatus

Gets and sets the property Status.

The status of the task definition.

Public Property TaskDefinitionArn System.String

Gets and sets the property TaskDefinitionArn.

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

Public Property TaskRoleArn System.String

Gets and sets the property TaskRoleArn.

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.

Public Property Volumes System.Collections.Generic.List<Amazon.ECS.Model.Volume>

Gets and sets the property Volumes.

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.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms