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.

Container for the parameters to the RegisterTaskDefinition operation. Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon EC2 Container Service Developer Guide.

You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ECS.AmazonECSRequest
      Amazon.ECS.Model.RegisterTaskDefinitionRequest

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

Syntax

C#
public class RegisterTaskDefinitionRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The RegisterTaskDefinitionRequest type exposes the following members

Constructors

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.

Public Property Family System.String

Gets and sets the property Family.

You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

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.

The default Docker network mode is bridge. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host network mode offers the highest networking performance for containers because they use the host network stack instead of the virtualized network stack provided by the bridge mode; however, exposed container ports are mapped directly to the corresponding host port, so you cannot take advantage of dynamic host port mappings or run multiple instantiations of the same task on a single container instance if port mappings are used.

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 the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).

Public Property TaskRoleArn System.String

Gets and sets the property TaskRoleArn.

The short name or full 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. For more information, see IAM Roles for Tasks in the Amazon EC2 Container Service Developer Guide.

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

Gets and sets the property Volumes.

A list of volume definitions in JSON format that containers in your task may use.

Examples

This example registers a task definition to the specified family.

To register a task definition


var response = client.RegisterTaskDefinition(new RegisterTaskDefinitionRequest 
{
    ContainerDefinitions = new List {
        new ContainerDefinition {
            Name = "sleep",
            Command = new List {
                "sleep",
                "360"
            },
            Cpu = 10,
            Essential = true,
            Image = "busybox",
            Memory = 10
        }
    },
    Family = "sleep360",
    TaskRoleArn = "",
    Volumes = new List {
                    
    }
});

TaskDefinition taskDefinition = response.TaskDefinition;

            

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