AmazonECSClient.RegisterTaskDefinition Method (RegisterTaskDefinitionRequest)

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

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

You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. If you specify the awsvpc network mode, 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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to RegisterTaskDefinitionAsync.

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

Syntax

public virtual RegisterTaskDefinitionResponse RegisterTaskDefinition(
         RegisterTaskDefinitionRequest request
)

Parameters

request: Type: Amazon.ECS.Model.RegisterTaskDefinitionRequest

Container for the necessary parameters to execute the RegisterTaskDefinition service method.

Return Value

Type: RegisterTaskDefinitionResponse

The response from the RegisterTaskDefinition service method, as returned by ECS.

Exceptions

Exception	Condition
ClientException	These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
InvalidParameterException	The specified parameter isn't valid. Review the available parameters for the API request. For more information about service event errors, see Amazon ECS service event messages.
ServerException	These errors are usually caused by a server issue.

Examples

This example registers a task definition to the specified family.

To register a task definition


var client = new AmazonECSClient();
var response = client.RegisterTaskDefinition(new RegisterTaskDefinitionRequest 
{
    ContainerDefinitions = new List<ContainerDefinition> {
        new ContainerDefinition {
            Name = "sleep",
            Command = new List<string> {
                "sleep",
                "360"
            },
            Cpu = 10,
            Essential = true,
            Image = "public.ecr.aws/docker/library/busybox:latest",
            Memory = 10
        }
    },
    Family = "sleep360",
    TaskRoleArn = "",
    Volumes = new List<Volume> {
                    
    }
});

TaskDefinition taskDefinition = response.TaskDefinition;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonECSClient.RegisterTaskDefinition (RegisterTaskDefinitionRequest)

Method