Class TaskDefinition

Manages a revision of an ECS task definition to be used in aws.ecs.Service.

Inheritance

System.Object

Resource

CustomResource

TaskDefinition

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Ecs

Assembly: Pulumi.Aws.dll

Syntax

public class TaskDefinition : CustomResource

Constructors

TaskDefinition(String, TaskDefinitionArgs, CustomResourceOptions)

Create a TaskDefinition resource with the given unique name, arguments, and options.

Declaration

public TaskDefinition(string name, TaskDefinitionArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
TaskDefinitionArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

Full ARN of the Task Definition (including both family and revision).

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

ContainerDefinitions

A list of valid [container definitions] (http://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html) provided as a single valid JSON document. Please note that you should only provide values that are part of the container definition document. For a detailed description of what parameters are available, see the [Task Definition Parameters] (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) section from the official Developer Guide.

Declaration

public Output<string> ContainerDefinitions { get; }

Property Value

Type	Description
Output<System.String>

Cpu

The number of cpu units used by the task. If the requires_compatibilities is FARGATE this field is required.

Declaration

public Output<string> Cpu { get; }

Property Value

Type	Description
Output<System.String>

ExecutionRoleArn

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

Declaration

public Output<string> ExecutionRoleArn { get; }

Property Value

Type	Description
Output<System.String>

Family

A unique name for your task definition.

Declaration

public Output<string> Family { get; }

Property Value

Type	Description
Output<System.String>

InferenceAccelerators

Configuration block(s) with Inference Accelerators settings. Detailed below.

Declaration

public Output<ImmutableArray<TaskDefinitionInferenceAccelerator>> InferenceAccelerators { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<TaskDefinitionInferenceAccelerator>>

IpcMode

The IPC resource namespace to be used for the containers in the task The valid values are host, task, and none.

Declaration

public Output<string> IpcMode { get; }

Property Value

Type	Description
Output<System.String>

Memory

The amount (in MiB) of memory used by the task. If the requires_compatibilities is FARGATE this field is required.

Declaration

public Output<string> Memory { get; }

Property Value

Type	Description
Output<System.String>

NetworkMode

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

Declaration

public Output<string> NetworkMode { get; }

Property Value

Type	Description
Output<System.String>

PidMode

The process namespace to use for the containers in the task. The valid values are host and task.

Declaration

public Output<string> PidMode { get; }

Property Value

Type	Description
Output<System.String>

PlacementConstraints

A set of placement constraints rules that are taken into consideration during task placement. Maximum number of placement_constraints is 10.

Declaration

public Output<ImmutableArray<TaskDefinitionPlacementConstraint>> PlacementConstraints { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<TaskDefinitionPlacementConstraint>>

ProxyConfiguration

The proxy configuration details for the App Mesh proxy.

Declaration

public Output<TaskDefinitionProxyConfiguration> ProxyConfiguration { get; }

Property Value

Type	Description
Output<TaskDefinitionProxyConfiguration>

RequiresCompatibilities

A set of launch types required by the task. The valid values are EC2 and FARGATE.

Declaration

public Output<ImmutableArray<string>> RequiresCompatibilities { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Revision

The revision of the task in a particular family.

Declaration

public Output<int> Revision { get; }

Property Value

Type	Description
Output<System.Int32>

Tags

Key-value map of resource tags

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

TaskRoleArn

The ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.

Declaration

public Output<string> TaskRoleArn { get; }

Property Value

Type	Description
Output<System.String>

Volumes

A set of volume blocks that containers in your task may use.

Declaration

public Output<ImmutableArray<TaskDefinitionVolume>> Volumes { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<TaskDefinitionVolume>>

Methods

Get(String, Input<String>, TaskDefinitionState, CustomResourceOptions)

Get an existing TaskDefinition resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static TaskDefinition Get(string name, Input<string> id, TaskDefinitionState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
TaskDefinitionState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
TaskDefinition