1. Packages
  2. AWS
  3. API Docs
  4. ecs
  5. getTaskDefinition
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

aws.ecs.getTaskDefinition

Explore with Pulumi AI

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

The ECS task definition data source allows access to details of a specific AWS ECS task definition.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const mongoTaskDefinition = new aws.ecs.TaskDefinition("mongo", {
    family: "mongodb",
    containerDefinitions: `[
  {
    "cpu": 128,
    "environment": [{
      "name": "SECRET",
      "value": "KEY"
    }],
    "essential": true,
    "image": "mongo:latest",
    "memory": 128,
    "memoryReservation": 64,
    "name": "mongodb"
  }
]
`,
});
// Simply specify the family to find the latest ACTIVE revision in that family.
const mongo = aws.ecs.getTaskDefinitionOutput({
    taskDefinition: mongoTaskDefinition.family,
});
const foo = new aws.ecs.Cluster("foo", {name: "foo"});
const mongoService = new aws.ecs.Service("mongo", {
    name: "mongo",
    cluster: foo.id,
    desiredCount: 2,
    taskDefinition: mongo.apply(mongo => mongo.arn),
});
Copy
import pulumi
import pulumi_aws as aws

mongo_task_definition = aws.ecs.TaskDefinition("mongo",
    family="mongodb",
    container_definitions="""[
  {
    "cpu": 128,
    "environment": [{
      "name": "SECRET",
      "value": "KEY"
    }],
    "essential": true,
    "image": "mongo:latest",
    "memory": 128,
    "memoryReservation": 64,
    "name": "mongodb"
  }
]
""")
# Simply specify the family to find the latest ACTIVE revision in that family.
mongo = aws.ecs.get_task_definition_output(task_definition=mongo_task_definition.family)
foo = aws.ecs.Cluster("foo", name="foo")
mongo_service = aws.ecs.Service("mongo",
    name="mongo",
    cluster=foo.id,
    desired_count=2,
    task_definition=mongo.arn)
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ecs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		mongoTaskDefinition, err := ecs.NewTaskDefinition(ctx, "mongo", &ecs.TaskDefinitionArgs{
			Family: pulumi.String("mongodb"),
			ContainerDefinitions: pulumi.String(`[
  {
    "cpu": 128,
    "environment": [{
      "name": "SECRET",
      "value": "KEY"
    }],
    "essential": true,
    "image": "mongo:latest",
    "memory": 128,
    "memoryReservation": 64,
    "name": "mongodb"
  }
]
`),
		})
		if err != nil {
			return err
		}
		// Simply specify the family to find the latest ACTIVE revision in that family.
		mongo := ecs.LookupTaskDefinitionOutput(ctx, ecs.GetTaskDefinitionOutputArgs{
			TaskDefinition: mongoTaskDefinition.Family,
		}, nil)
		foo, err := ecs.NewCluster(ctx, "foo", &ecs.ClusterArgs{
			Name: pulumi.String("foo"),
		})
		if err != nil {
			return err
		}
		_, err = ecs.NewService(ctx, "mongo", &ecs.ServiceArgs{
			Name:         pulumi.String("mongo"),
			Cluster:      foo.ID(),
			DesiredCount: pulumi.Int(2),
			TaskDefinition: pulumi.String(mongo.ApplyT(func(mongo ecs.GetTaskDefinitionResult) (*string, error) {
				return &mongo.Arn, nil
			}).(pulumi.StringPtrOutput)),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var mongoTaskDefinition = new Aws.Ecs.TaskDefinition("mongo", new()
    {
        Family = "mongodb",
        ContainerDefinitions = @"[
  {
    ""cpu"": 128,
    ""environment"": [{
      ""name"": ""SECRET"",
      ""value"": ""KEY""
    }],
    ""essential"": true,
    ""image"": ""mongo:latest"",
    ""memory"": 128,
    ""memoryReservation"": 64,
    ""name"": ""mongodb""
  }
]
",
    });

    // Simply specify the family to find the latest ACTIVE revision in that family.
    var mongo = Aws.Ecs.GetTaskDefinition.Invoke(new()
    {
        TaskDefinition = mongoTaskDefinition.Family,
    });

    var foo = new Aws.Ecs.Cluster("foo", new()
    {
        Name = "foo",
    });

    var mongoService = new Aws.Ecs.Service("mongo", new()
    {
        Name = "mongo",
        Cluster = foo.Id,
        DesiredCount = 2,
        TaskDefinition = mongo.Apply(getTaskDefinitionResult => getTaskDefinitionResult.Arn),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ecs.TaskDefinition;
import com.pulumi.aws.ecs.TaskDefinitionArgs;
import com.pulumi.aws.ecs.EcsFunctions;
import com.pulumi.aws.ecs.inputs.GetTaskDefinitionArgs;
import com.pulumi.aws.ecs.Cluster;
import com.pulumi.aws.ecs.ClusterArgs;
import com.pulumi.aws.ecs.Service;
import com.pulumi.aws.ecs.ServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mongoTaskDefinition = new TaskDefinition("mongoTaskDefinition", TaskDefinitionArgs.builder()
            .family("mongodb")
            .containerDefinitions("""
[
  {
    "cpu": 128,
    "environment": [{
      "name": "SECRET",
      "value": "KEY"
    }],
    "essential": true,
    "image": "mongo:latest",
    "memory": 128,
    "memoryReservation": 64,
    "name": "mongodb"
  }
]
            """)
            .build());

        // Simply specify the family to find the latest ACTIVE revision in that family.
        final var mongo = EcsFunctions.getTaskDefinition(GetTaskDefinitionArgs.builder()
            .taskDefinition(mongoTaskDefinition.family())
            .build());

        var foo = new Cluster("foo", ClusterArgs.builder()
            .name("foo")
            .build());

        var mongoService = new Service("mongoService", ServiceArgs.builder()
            .name("mongo")
            .cluster(foo.id())
            .desiredCount(2)
            .taskDefinition(mongo.applyValue(getTaskDefinitionResult -> getTaskDefinitionResult).applyValue(mongo -> mongo.applyValue(getTaskDefinitionResult -> getTaskDefinitionResult.arn())))
            .build());

    }
}
Copy
resources:
  foo:
    type: aws:ecs:Cluster
    properties:
      name: foo
  mongoTaskDefinition:
    type: aws:ecs:TaskDefinition
    name: mongo
    properties:
      family: mongodb
      containerDefinitions: |
        [
          {
            "cpu": 128,
            "environment": [{
              "name": "SECRET",
              "value": "KEY"
            }],
            "essential": true,
            "image": "mongo:latest",
            "memory": 128,
            "memoryReservation": 64,
            "name": "mongodb"
          }
        ]        
  mongoService:
    type: aws:ecs:Service
    name: mongo
    properties:
      name: mongo
      cluster: ${foo.id}
      desiredCount: 2 # Track the latest ACTIVE revision
      taskDefinition: ${mongo.arn}
variables:
  # Simply specify the family to find the latest ACTIVE revision in that family.
  mongo:
    fn::invoke:
      function: aws:ecs:getTaskDefinition
      arguments:
        taskDefinition: ${mongoTaskDefinition.family}
Copy

Using getTaskDefinition

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getTaskDefinition(args: GetTaskDefinitionArgs, opts?: InvokeOptions): Promise<GetTaskDefinitionResult>
function getTaskDefinitionOutput(args: GetTaskDefinitionOutputArgs, opts?: InvokeOptions): Output<GetTaskDefinitionResult>
Copy
def get_task_definition(task_definition: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetTaskDefinitionResult
def get_task_definition_output(task_definition: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetTaskDefinitionResult]
Copy
func LookupTaskDefinition(ctx *Context, args *LookupTaskDefinitionArgs, opts ...InvokeOption) (*LookupTaskDefinitionResult, error)
func LookupTaskDefinitionOutput(ctx *Context, args *LookupTaskDefinitionOutputArgs, opts ...InvokeOption) LookupTaskDefinitionResultOutput
Copy

> Note: This function is named LookupTaskDefinition in the Go SDK.

public static class GetTaskDefinition 
{
    public static Task<GetTaskDefinitionResult> InvokeAsync(GetTaskDefinitionArgs args, InvokeOptions? opts = null)
    public static Output<GetTaskDefinitionResult> Invoke(GetTaskDefinitionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTaskDefinitionResult> getTaskDefinition(GetTaskDefinitionArgs args, InvokeOptions options)
public static Output<GetTaskDefinitionResult> getTaskDefinition(GetTaskDefinitionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:ecs/getTaskDefinition:getTaskDefinition
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

TaskDefinition This property is required. string
Family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, the ARN of the task definition to access to.
TaskDefinition This property is required. string
Family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, the ARN of the task definition to access to.
taskDefinition This property is required. String
Family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, the ARN of the task definition to access to.
taskDefinition This property is required. string
Family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, the ARN of the task definition to access to.
task_definition This property is required. str
Family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, the ARN of the task definition to access to.
taskDefinition This property is required. String
Family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, the ARN of the task definition to access to.

getTaskDefinition Result

The following output properties are available:

Arn string
ARN of the task definition.
ArnWithoutRevision string
ARN of the Task Definition with the trailing revision removed. This may be useful for situations where the latest task definition is always desired. If a revision isn't specified, the latest ACTIVE revision is used. See the AWS documentation for details.
ContainerDefinitions string
A list of valid container definitions 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 section from the official Developer Guide.
Cpu string
Number of cpu units used by the task. If the requires_compatibilities is FARGATE this field is required.
EnableFaultInjection bool
Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is false.
EphemeralStorages List<GetTaskDefinitionEphemeralStorage>
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate. See Ephemeral Storage.
ExecutionRoleArn string
ARN of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
Family string
A unique name for your task definition. The following arguments are optional:
Id string
The provider-assigned unique ID for this managed resource.
InferenceAccelerators List<GetTaskDefinitionInferenceAccelerator>
Configuration block(s) with Inference Accelerators settings. Detailed below.
IpcMode string
IPC resource namespace to be used for the containers in the task The valid values are host, task, and none.
Memory string
Amount (in MiB) of memory used by the task. If the requires_compatibilities is FARGATE this field is required.
NetworkMode string
Docker networking mode to use for the containers in the task. Valid values are none, bridge, awsvpc, and host.
PidMode string
Process namespace to use for the containers in the task. The valid values are host and task.
PlacementConstraints List<GetTaskDefinitionPlacementConstraint>
Configuration block for rules that are taken into consideration during task placement. Maximum number of placement_constraints is 10. Detailed below.
ProxyConfigurations List<GetTaskDefinitionProxyConfiguration>
Configuration block for the App Mesh proxy. Detailed below.
RequiresCompatibilities List<string>
Set of launch types required by the task. The valid values are EC2 and FARGATE.
Revision int
Revision of the task in a particular family.
RuntimePlatforms List<GetTaskDefinitionRuntimePlatform>
Configuration block for runtime_platform that containers in your task may use.
Status string
Status of the task definition.
TaskDefinition string
TaskRoleArn string
ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.
Volumes List<GetTaskDefinitionVolume>
Configuration block for volumes that containers in your task may use. Detailed below.
Arn string
ARN of the task definition.
ArnWithoutRevision string
ARN of the Task Definition with the trailing revision removed. This may be useful for situations where the latest task definition is always desired. If a revision isn't specified, the latest ACTIVE revision is used. See the AWS documentation for details.
ContainerDefinitions string
A list of valid container definitions 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 section from the official Developer Guide.
Cpu string
Number of cpu units used by the task. If the requires_compatibilities is FARGATE this field is required.
EnableFaultInjection bool
Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is false.
EphemeralStorages []GetTaskDefinitionEphemeralStorage
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate. See Ephemeral Storage.
ExecutionRoleArn string
ARN of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
Family string
A unique name for your task definition. The following arguments are optional:
Id string
The provider-assigned unique ID for this managed resource.
InferenceAccelerators []GetTaskDefinitionInferenceAccelerator
Configuration block(s) with Inference Accelerators settings. Detailed below.
IpcMode string
IPC resource namespace to be used for the containers in the task The valid values are host, task, and none.
Memory string
Amount (in MiB) of memory used by the task. If the requires_compatibilities is FARGATE this field is required.
NetworkMode string
Docker networking mode to use for the containers in the task. Valid values are none, bridge, awsvpc, and host.
PidMode string
Process namespace to use for the containers in the task. The valid values are host and task.
PlacementConstraints []GetTaskDefinitionPlacementConstraint
Configuration block for rules that are taken into consideration during task placement. Maximum number of placement_constraints is 10. Detailed below.
ProxyConfigurations []GetTaskDefinitionProxyConfiguration
Configuration block for the App Mesh proxy. Detailed below.
RequiresCompatibilities []string
Set of launch types required by the task. The valid values are EC2 and FARGATE.
Revision int
Revision of the task in a particular family.
RuntimePlatforms []GetTaskDefinitionRuntimePlatform
Configuration block for runtime_platform that containers in your task may use.
Status string
Status of the task definition.
TaskDefinition string
TaskRoleArn string
ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.
Volumes []GetTaskDefinitionVolume
Configuration block for volumes that containers in your task may use. Detailed below.
arn String
ARN of the task definition.
arnWithoutRevision String
ARN of the Task Definition with the trailing revision removed. This may be useful for situations where the latest task definition is always desired. If a revision isn't specified, the latest ACTIVE revision is used. See the AWS documentation for details.
containerDefinitions String
A list of valid container definitions 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 section from the official Developer Guide.
cpu String
Number of cpu units used by the task. If the requires_compatibilities is FARGATE this field is required.
enableFaultInjection Boolean
Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is false.
ephemeralStorages List<GetTaskDefinitionEphemeralStorage>
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate. See Ephemeral Storage.
executionRoleArn String
ARN of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
family String
A unique name for your task definition. The following arguments are optional:
id String
The provider-assigned unique ID for this managed resource.
inferenceAccelerators List<GetTaskDefinitionInferenceAccelerator>
Configuration block(s) with Inference Accelerators settings. Detailed below.
ipcMode String
IPC resource namespace to be used for the containers in the task The valid values are host, task, and none.
memory String
Amount (in MiB) of memory used by the task. If the requires_compatibilities is FARGATE this field is required.
networkMode String
Docker networking mode to use for the containers in the task. Valid values are none, bridge, awsvpc, and host.
pidMode String
Process namespace to use for the containers in the task. The valid values are host and task.
placementConstraints List<GetTaskDefinitionPlacementConstraint>
Configuration block for rules that are taken into consideration during task placement. Maximum number of placement_constraints is 10. Detailed below.
proxyConfigurations List<GetTaskDefinitionProxyConfiguration>
Configuration block for the App Mesh proxy. Detailed below.
requiresCompatibilities List<String>
Set of launch types required by the task. The valid values are EC2 and FARGATE.
revision Integer
Revision of the task in a particular family.
runtimePlatforms List<GetTaskDefinitionRuntimePlatform>
Configuration block for runtime_platform that containers in your task may use.
status String
Status of the task definition.
taskDefinition String
taskRoleArn String
ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.
volumes List<GetTaskDefinitionVolume>
Configuration block for volumes that containers in your task may use. Detailed below.
arn string
ARN of the task definition.
arnWithoutRevision string
ARN of the Task Definition with the trailing revision removed. This may be useful for situations where the latest task definition is always desired. If a revision isn't specified, the latest ACTIVE revision is used. See the AWS documentation for details.
containerDefinitions string
A list of valid container definitions 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 section from the official Developer Guide.
cpu string
Number of cpu units used by the task. If the requires_compatibilities is FARGATE this field is required.
enableFaultInjection boolean
Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is false.
ephemeralStorages GetTaskDefinitionEphemeralStorage[]
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate. See Ephemeral Storage.
executionRoleArn string
ARN of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
family string
A unique name for your task definition. The following arguments are optional:
id string
The provider-assigned unique ID for this managed resource.
inferenceAccelerators GetTaskDefinitionInferenceAccelerator[]
Configuration block(s) with Inference Accelerators settings. Detailed below.
ipcMode string
IPC resource namespace to be used for the containers in the task The valid values are host, task, and none.
memory string
Amount (in MiB) of memory used by the task. If the requires_compatibilities is FARGATE this field is required.
networkMode string
Docker networking mode to use for the containers in the task. Valid values are none, bridge, awsvpc, and host.
pidMode string
Process namespace to use for the containers in the task. The valid values are host and task.
placementConstraints GetTaskDefinitionPlacementConstraint[]
Configuration block for rules that are taken into consideration during task placement. Maximum number of placement_constraints is 10. Detailed below.
proxyConfigurations GetTaskDefinitionProxyConfiguration[]
Configuration block for the App Mesh proxy. Detailed below.
requiresCompatibilities string[]
Set of launch types required by the task. The valid values are EC2 and FARGATE.
revision number
Revision of the task in a particular family.
runtimePlatforms GetTaskDefinitionRuntimePlatform[]
Configuration block for runtime_platform that containers in your task may use.
status string
Status of the task definition.
taskDefinition string
taskRoleArn string
ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.
volumes GetTaskDefinitionVolume[]
Configuration block for volumes that containers in your task may use. Detailed below.
arn str
ARN of the task definition.
arn_without_revision str
ARN of the Task Definition with the trailing revision removed. This may be useful for situations where the latest task definition is always desired. If a revision isn't specified, the latest ACTIVE revision is used. See the AWS documentation for details.
container_definitions str
A list of valid container definitions 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 section from the official Developer Guide.
cpu str
Number of cpu units used by the task. If the requires_compatibilities is FARGATE this field is required.
enable_fault_injection bool
Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is false.
ephemeral_storages Sequence[GetTaskDefinitionEphemeralStorage]
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate. See Ephemeral Storage.
execution_role_arn str
ARN of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
family str
A unique name for your task definition. The following arguments are optional:
id str
The provider-assigned unique ID for this managed resource.
inference_accelerators Sequence[GetTaskDefinitionInferenceAccelerator]
Configuration block(s) with Inference Accelerators settings. Detailed below.
ipc_mode str
IPC resource namespace to be used for the containers in the task The valid values are host, task, and none.
memory str
Amount (in MiB) of memory used by the task. If the requires_compatibilities is FARGATE this field is required.
network_mode str
Docker networking mode to use for the containers in the task. Valid values are none, bridge, awsvpc, and host.
pid_mode str
Process namespace to use for the containers in the task. The valid values are host and task.
placement_constraints Sequence[GetTaskDefinitionPlacementConstraint]
Configuration block for rules that are taken into consideration during task placement. Maximum number of placement_constraints is 10. Detailed below.
proxy_configurations Sequence[GetTaskDefinitionProxyConfiguration]
Configuration block for the App Mesh proxy. Detailed below.
requires_compatibilities Sequence[str]
Set of launch types required by the task. The valid values are EC2 and FARGATE.
revision int
Revision of the task in a particular family.
runtime_platforms Sequence[GetTaskDefinitionRuntimePlatform]
Configuration block for runtime_platform that containers in your task may use.
status str
Status of the task definition.
task_definition str
task_role_arn str
ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.
volumes Sequence[GetTaskDefinitionVolume]
Configuration block for volumes that containers in your task may use. Detailed below.
arn String
ARN of the task definition.
arnWithoutRevision String
ARN of the Task Definition with the trailing revision removed. This may be useful for situations where the latest task definition is always desired. If a revision isn't specified, the latest ACTIVE revision is used. See the AWS documentation for details.
containerDefinitions String
A list of valid container definitions 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 section from the official Developer Guide.
cpu String
Number of cpu units used by the task. If the requires_compatibilities is FARGATE this field is required.
enableFaultInjection Boolean
Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is false.
ephemeralStorages List<Property Map>
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate. See Ephemeral Storage.
executionRoleArn String
ARN of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
family String
A unique name for your task definition. The following arguments are optional:
id String
The provider-assigned unique ID for this managed resource.
inferenceAccelerators List<Property Map>
Configuration block(s) with Inference Accelerators settings. Detailed below.
ipcMode String
IPC resource namespace to be used for the containers in the task The valid values are host, task, and none.
memory String
Amount (in MiB) of memory used by the task. If the requires_compatibilities is FARGATE this field is required.
networkMode String
Docker networking mode to use for the containers in the task. Valid values are none, bridge, awsvpc, and host.
pidMode String
Process namespace to use for the containers in the task. The valid values are host and task.
placementConstraints List<Property Map>
Configuration block for rules that are taken into consideration during task placement. Maximum number of placement_constraints is 10. Detailed below.
proxyConfigurations List<Property Map>
Configuration block for the App Mesh proxy. Detailed below.
requiresCompatibilities List<String>
Set of launch types required by the task. The valid values are EC2 and FARGATE.
revision Number
Revision of the task in a particular family.
runtimePlatforms List<Property Map>
Configuration block for runtime_platform that containers in your task may use.
status String
Status of the task definition.
taskDefinition String
taskRoleArn String
ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.
volumes List<Property Map>
Configuration block for volumes that containers in your task may use. Detailed below.

Supporting Types

GetTaskDefinitionEphemeralStorage

SizeInGib This property is required. int
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.
SizeInGib This property is required. int
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.
sizeInGib This property is required. Integer
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.
sizeInGib This property is required. number
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.
size_in_gib This property is required. int
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.
sizeInGib This property is required. Number
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

GetTaskDefinitionInferenceAccelerator

DeviceName This property is required. string
Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
DeviceType This property is required. string
Elastic Inference accelerator type to use.
DeviceName This property is required. string
Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
DeviceType This property is required. string
Elastic Inference accelerator type to use.
deviceName This property is required. String
Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
deviceType This property is required. String
Elastic Inference accelerator type to use.
deviceName This property is required. string
Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
deviceType This property is required. string
Elastic Inference accelerator type to use.
device_name This property is required. str
Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
device_type This property is required. str
Elastic Inference accelerator type to use.
deviceName This property is required. String
Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
deviceType This property is required. String
Elastic Inference accelerator type to use.

GetTaskDefinitionPlacementConstraint

Expression This property is required. string
Cluster Query Language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.
Type This property is required. string
Proxy type. The default value is APPMESH. The only supported value is APPMESH.
Expression This property is required. string
Cluster Query Language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.
Type This property is required. string
Proxy type. The default value is APPMESH. The only supported value is APPMESH.
expression This property is required. String
Cluster Query Language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.
type This property is required. String
Proxy type. The default value is APPMESH. The only supported value is APPMESH.
expression This property is required. string
Cluster Query Language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.
type This property is required. string
Proxy type. The default value is APPMESH. The only supported value is APPMESH.
expression This property is required. str
Cluster Query Language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.
type This property is required. str
Proxy type. The default value is APPMESH. The only supported value is APPMESH.
expression This property is required. String
Cluster Query Language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.
type This property is required. String
Proxy type. The default value is APPMESH. The only supported value is APPMESH.

GetTaskDefinitionProxyConfiguration

ContainerName This property is required. string
Name of the container that will serve as the App Mesh proxy.
Properties This property is required. Dictionary<string, string>
Set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified a key-value mapping.
Type This property is required. string
Proxy type. The default value is APPMESH. The only supported value is APPMESH.
ContainerName This property is required. string
Name of the container that will serve as the App Mesh proxy.
Properties This property is required. map[string]string
Set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified a key-value mapping.
Type This property is required. string
Proxy type. The default value is APPMESH. The only supported value is APPMESH.
containerName This property is required. String
Name of the container that will serve as the App Mesh proxy.
properties This property is required. Map<String,String>
Set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified a key-value mapping.
type This property is required. String
Proxy type. The default value is APPMESH. The only supported value is APPMESH.
containerName This property is required. string
Name of the container that will serve as the App Mesh proxy.
properties This property is required. {[key: string]: string}
Set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified a key-value mapping.
type This property is required. string
Proxy type. The default value is APPMESH. The only supported value is APPMESH.
container_name This property is required. str
Name of the container that will serve as the App Mesh proxy.
properties This property is required. Mapping[str, str]
Set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified a key-value mapping.
type This property is required. str
Proxy type. The default value is APPMESH. The only supported value is APPMESH.
containerName This property is required. String
Name of the container that will serve as the App Mesh proxy.
properties This property is required. Map<String>
Set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified a key-value mapping.
type This property is required. String
Proxy type. The default value is APPMESH. The only supported value is APPMESH.

GetTaskDefinitionRuntimePlatform

CpuArchitecture This property is required. string
Must be set to either X86_64 or ARM64; see cpu architecture
OperatingSystemFamily This property is required. string
If the requires_compatibilities is FARGATE this field is required; must be set to a valid option from the operating system family in the runtime platform setting
CpuArchitecture This property is required. string
Must be set to either X86_64 or ARM64; see cpu architecture
OperatingSystemFamily This property is required. string
If the requires_compatibilities is FARGATE this field is required; must be set to a valid option from the operating system family in the runtime platform setting
cpuArchitecture This property is required. String
Must be set to either X86_64 or ARM64; see cpu architecture
operatingSystemFamily This property is required. String
If the requires_compatibilities is FARGATE this field is required; must be set to a valid option from the operating system family in the runtime platform setting
cpuArchitecture This property is required. string
Must be set to either X86_64 or ARM64; see cpu architecture
operatingSystemFamily This property is required. string
If the requires_compatibilities is FARGATE this field is required; must be set to a valid option from the operating system family in the runtime platform setting
cpu_architecture This property is required. str
Must be set to either X86_64 or ARM64; see cpu architecture
operating_system_family This property is required. str
If the requires_compatibilities is FARGATE this field is required; must be set to a valid option from the operating system family in the runtime platform setting
cpuArchitecture This property is required. String
Must be set to either X86_64 or ARM64; see cpu architecture
operatingSystemFamily This property is required. String
If the requires_compatibilities is FARGATE this field is required; must be set to a valid option from the operating system family in the runtime platform setting

GetTaskDefinitionVolume

ConfigureAtLaunch This property is required. bool
Whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.
DockerVolumeConfigurations This property is required. List<GetTaskDefinitionVolumeDockerVolumeConfiguration>
Configuration block to configure a docker volume. Detailed below.
EfsVolumeConfigurations This property is required. List<GetTaskDefinitionVolumeEfsVolumeConfiguration>
Configuration block for an EFS volume. Detailed below.
FsxWindowsFileServerVolumeConfigurations This property is required. List<GetTaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration>
Configuration block for an FSX Windows File Server volume. Detailed below.
HostPath This property is required. string
Path on the host container instance that is presented to the container. If not set, ECS will create a nonpersistent data volume that starts empty and is deleted after the task has finished.
Name This property is required. string
Name of the volume. This name is referenced in the sourceVolume parameter of container definition in the mountPoints section.
ConfigureAtLaunch This property is required. bool
Whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.
DockerVolumeConfigurations This property is required. []GetTaskDefinitionVolumeDockerVolumeConfiguration
Configuration block to configure a docker volume. Detailed below.
EfsVolumeConfigurations This property is required. []GetTaskDefinitionVolumeEfsVolumeConfiguration
Configuration block for an EFS volume. Detailed below.
FsxWindowsFileServerVolumeConfigurations This property is required. []GetTaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration
Configuration block for an FSX Windows File Server volume. Detailed below.
HostPath This property is required. string
Path on the host container instance that is presented to the container. If not set, ECS will create a nonpersistent data volume that starts empty and is deleted after the task has finished.
Name This property is required. string
Name of the volume. This name is referenced in the sourceVolume parameter of container definition in the mountPoints section.
configureAtLaunch This property is required. Boolean
Whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.
dockerVolumeConfigurations This property is required. List<GetTaskDefinitionVolumeDockerVolumeConfiguration>
Configuration block to configure a docker volume. Detailed below.
efsVolumeConfigurations This property is required. List<GetTaskDefinitionVolumeEfsVolumeConfiguration>
Configuration block for an EFS volume. Detailed below.
fsxWindowsFileServerVolumeConfigurations This property is required. List<GetTaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration>
Configuration block for an FSX Windows File Server volume. Detailed below.
hostPath This property is required. String
Path on the host container instance that is presented to the container. If not set, ECS will create a nonpersistent data volume that starts empty and is deleted after the task has finished.
name This property is required. String
Name of the volume. This name is referenced in the sourceVolume parameter of container definition in the mountPoints section.
configureAtLaunch This property is required. boolean
Whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.
dockerVolumeConfigurations This property is required. GetTaskDefinitionVolumeDockerVolumeConfiguration[]
Configuration block to configure a docker volume. Detailed below.
efsVolumeConfigurations This property is required. GetTaskDefinitionVolumeEfsVolumeConfiguration[]
Configuration block for an EFS volume. Detailed below.
fsxWindowsFileServerVolumeConfigurations This property is required. GetTaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration[]
Configuration block for an FSX Windows File Server volume. Detailed below.
hostPath This property is required. string
Path on the host container instance that is presented to the container. If not set, ECS will create a nonpersistent data volume that starts empty and is deleted after the task has finished.
name This property is required. string
Name of the volume. This name is referenced in the sourceVolume parameter of container definition in the mountPoints section.
configure_at_launch This property is required. bool
Whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.
docker_volume_configurations This property is required. Sequence[GetTaskDefinitionVolumeDockerVolumeConfiguration]
Configuration block to configure a docker volume. Detailed below.
efs_volume_configurations This property is required. Sequence[GetTaskDefinitionVolumeEfsVolumeConfiguration]
Configuration block for an EFS volume. Detailed below.
fsx_windows_file_server_volume_configurations This property is required. Sequence[GetTaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration]
Configuration block for an FSX Windows File Server volume. Detailed below.
host_path This property is required. str
Path on the host container instance that is presented to the container. If not set, ECS will create a nonpersistent data volume that starts empty and is deleted after the task has finished.
name This property is required. str
Name of the volume. This name is referenced in the sourceVolume parameter of container definition in the mountPoints section.
configureAtLaunch This property is required. Boolean
Whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.
dockerVolumeConfigurations This property is required. List<Property Map>
Configuration block to configure a docker volume. Detailed below.
efsVolumeConfigurations This property is required. List<Property Map>
Configuration block for an EFS volume. Detailed below.
fsxWindowsFileServerVolumeConfigurations This property is required. List<Property Map>
Configuration block for an FSX Windows File Server volume. Detailed below.
hostPath This property is required. String
Path on the host container instance that is presented to the container. If not set, ECS will create a nonpersistent data volume that starts empty and is deleted after the task has finished.
name This property is required. String
Name of the volume. This name is referenced in the sourceVolume parameter of container definition in the mountPoints section.

GetTaskDefinitionVolumeDockerVolumeConfiguration

Autoprovision This property is required. bool
If this value is true, the Docker volume is created if it does not already exist. Note: This field is only used if the scope is shared.
Driver This property is required. string
Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement.
DriverOpts This property is required. Dictionary<string, string>
Map of Docker driver specific options.
Labels This property is required. Dictionary<string, string>
Map of custom metadata to add to your Docker volume.
Scope This property is required. string
Scope for the Docker volume, which determines its lifecycle, either task or shared. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.
Autoprovision This property is required. bool
If this value is true, the Docker volume is created if it does not already exist. Note: This field is only used if the scope is shared.
Driver This property is required. string
Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement.
DriverOpts This property is required. map[string]string
Map of Docker driver specific options.
Labels This property is required. map[string]string
Map of custom metadata to add to your Docker volume.
Scope This property is required. string
Scope for the Docker volume, which determines its lifecycle, either task or shared. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.
autoprovision This property is required. Boolean
If this value is true, the Docker volume is created if it does not already exist. Note: This field is only used if the scope is shared.
driver This property is required. String
Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement.
driverOpts This property is required. Map<String,String>
Map of Docker driver specific options.
labels This property is required. Map<String,String>
Map of custom metadata to add to your Docker volume.
scope This property is required. String
Scope for the Docker volume, which determines its lifecycle, either task or shared. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.
autoprovision This property is required. boolean
If this value is true, the Docker volume is created if it does not already exist. Note: This field is only used if the scope is shared.
driver This property is required. string
Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement.
driverOpts This property is required. {[key: string]: string}
Map of Docker driver specific options.
labels This property is required. {[key: string]: string}
Map of custom metadata to add to your Docker volume.
scope This property is required. string
Scope for the Docker volume, which determines its lifecycle, either task or shared. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.
autoprovision This property is required. bool
If this value is true, the Docker volume is created if it does not already exist. Note: This field is only used if the scope is shared.
driver This property is required. str
Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement.
driver_opts This property is required. Mapping[str, str]
Map of Docker driver specific options.
labels This property is required. Mapping[str, str]
Map of custom metadata to add to your Docker volume.
scope This property is required. str
Scope for the Docker volume, which determines its lifecycle, either task or shared. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.
autoprovision This property is required. Boolean
If this value is true, the Docker volume is created if it does not already exist. Note: This field is only used if the scope is shared.
driver This property is required. String
Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement.
driverOpts This property is required. Map<String>
Map of Docker driver specific options.
labels This property is required. Map<String>
Map of custom metadata to add to your Docker volume.
scope This property is required. String
Scope for the Docker volume, which determines its lifecycle, either task or shared. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

GetTaskDefinitionVolumeEfsVolumeConfiguration

AuthorizationConfigs This property is required. List<GetTaskDefinitionVolumeEfsVolumeConfigurationAuthorizationConfig>
Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
FileSystemId This property is required. string
The Amazon FSx for Windows File Server file system ID to use.
RootDirectory This property is required. string
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
TransitEncryption This property is required. string
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. Valid values: ENABLED, DISABLED. If this parameter is omitted, the default value of DISABLED is used.
TransitEncryptionPort This property is required. int
Port to use for transit encryption. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses.
AuthorizationConfigs This property is required. []GetTaskDefinitionVolumeEfsVolumeConfigurationAuthorizationConfig
Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
FileSystemId This property is required. string
The Amazon FSx for Windows File Server file system ID to use.
RootDirectory This property is required. string
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
TransitEncryption This property is required. string
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. Valid values: ENABLED, DISABLED. If this parameter is omitted, the default value of DISABLED is used.
TransitEncryptionPort This property is required. int
Port to use for transit encryption. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses.
authorizationConfigs This property is required. List<GetTaskDefinitionVolumeEfsVolumeConfigurationAuthorizationConfig>
Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
fileSystemId This property is required. String
The Amazon FSx for Windows File Server file system ID to use.
rootDirectory This property is required. String
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
transitEncryption This property is required. String
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. Valid values: ENABLED, DISABLED. If this parameter is omitted, the default value of DISABLED is used.
transitEncryptionPort This property is required. Integer
Port to use for transit encryption. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses.
authorizationConfigs This property is required. GetTaskDefinitionVolumeEfsVolumeConfigurationAuthorizationConfig[]
Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
fileSystemId This property is required. string
The Amazon FSx for Windows File Server file system ID to use.
rootDirectory This property is required. string
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
transitEncryption This property is required. string
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. Valid values: ENABLED, DISABLED. If this parameter is omitted, the default value of DISABLED is used.
transitEncryptionPort This property is required. number
Port to use for transit encryption. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses.
authorization_configs This property is required. Sequence[GetTaskDefinitionVolumeEfsVolumeConfigurationAuthorizationConfig]
Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
file_system_id This property is required. str
The Amazon FSx for Windows File Server file system ID to use.
root_directory This property is required. str
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
transit_encryption This property is required. str
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. Valid values: ENABLED, DISABLED. If this parameter is omitted, the default value of DISABLED is used.
transit_encryption_port This property is required. int
Port to use for transit encryption. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses.
authorizationConfigs This property is required. List<Property Map>
Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
fileSystemId This property is required. String
The Amazon FSx for Windows File Server file system ID to use.
rootDirectory This property is required. String
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
transitEncryption This property is required. String
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. Valid values: ENABLED, DISABLED. If this parameter is omitted, the default value of DISABLED is used.
transitEncryptionPort This property is required. Number
Port to use for transit encryption. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses.

GetTaskDefinitionVolumeEfsVolumeConfigurationAuthorizationConfig

AccessPointId This property is required. string
Access point ID to use. If an access point is specified, the root directory value will be relative to the directory set for the access point. If specified, transit encryption must be enabled in the EFSVolumeConfiguration.
Iam This property is required. string
Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. Valid values: ENABLED, DISABLED. If this parameter is omitted, the default value of DISABLED is used.
AccessPointId This property is required. string
Access point ID to use. If an access point is specified, the root directory value will be relative to the directory set for the access point. If specified, transit encryption must be enabled in the EFSVolumeConfiguration.
Iam This property is required. string
Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. Valid values: ENABLED, DISABLED. If this parameter is omitted, the default value of DISABLED is used.
accessPointId This property is required. String
Access point ID to use. If an access point is specified, the root directory value will be relative to the directory set for the access point. If specified, transit encryption must be enabled in the EFSVolumeConfiguration.
iam This property is required. String
Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. Valid values: ENABLED, DISABLED. If this parameter is omitted, the default value of DISABLED is used.
accessPointId This property is required. string
Access point ID to use. If an access point is specified, the root directory value will be relative to the directory set for the access point. If specified, transit encryption must be enabled in the EFSVolumeConfiguration.
iam This property is required. string
Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. Valid values: ENABLED, DISABLED. If this parameter is omitted, the default value of DISABLED is used.
access_point_id This property is required. str
Access point ID to use. If an access point is specified, the root directory value will be relative to the directory set for the access point. If specified, transit encryption must be enabled in the EFSVolumeConfiguration.
iam This property is required. str
Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. Valid values: ENABLED, DISABLED. If this parameter is omitted, the default value of DISABLED is used.
accessPointId This property is required. String
Access point ID to use. If an access point is specified, the root directory value will be relative to the directory set for the access point. If specified, transit encryption must be enabled in the EFSVolumeConfiguration.
iam This property is required. String
Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. Valid values: ENABLED, DISABLED. If this parameter is omitted, the default value of DISABLED is used.

GetTaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration

AuthorizationConfigs This property is required. List<GetTaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig>
Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
FileSystemId This property is required. string
The Amazon FSx for Windows File Server file system ID to use.
RootDirectory This property is required. string
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
AuthorizationConfigs This property is required. []GetTaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig
Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
FileSystemId This property is required. string
The Amazon FSx for Windows File Server file system ID to use.
RootDirectory This property is required. string
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
authorizationConfigs This property is required. List<GetTaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig>
Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
fileSystemId This property is required. String
The Amazon FSx for Windows File Server file system ID to use.
rootDirectory This property is required. String
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
authorizationConfigs This property is required. GetTaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig[]
Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
fileSystemId This property is required. string
The Amazon FSx for Windows File Server file system ID to use.
rootDirectory This property is required. string
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
authorization_configs This property is required. Sequence[GetTaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig]
Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
file_system_id This property is required. str
The Amazon FSx for Windows File Server file system ID to use.
root_directory This property is required. str
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
authorizationConfigs This property is required. List<Property Map>
Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
fileSystemId This property is required. String
The Amazon FSx for Windows File Server file system ID to use.
rootDirectory This property is required. String
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.

GetTaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig

CredentialsParameter This property is required. string
The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an AWS Secrets Manager secret or AWS Systems Manager Parameter Store parameter. The ARNs refer to the stored credentials.
Domain This property is required. string
A fully qualified domain name hosted by an AWS Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
CredentialsParameter This property is required. string
The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an AWS Secrets Manager secret or AWS Systems Manager Parameter Store parameter. The ARNs refer to the stored credentials.
Domain This property is required. string
A fully qualified domain name hosted by an AWS Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
credentialsParameter This property is required. String
The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an AWS Secrets Manager secret or AWS Systems Manager Parameter Store parameter. The ARNs refer to the stored credentials.
domain This property is required. String
A fully qualified domain name hosted by an AWS Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
credentialsParameter This property is required. string
The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an AWS Secrets Manager secret or AWS Systems Manager Parameter Store parameter. The ARNs refer to the stored credentials.
domain This property is required. string
A fully qualified domain name hosted by an AWS Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
credentials_parameter This property is required. str
The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an AWS Secrets Manager secret or AWS Systems Manager Parameter Store parameter. The ARNs refer to the stored credentials.
domain This property is required. str
A fully qualified domain name hosted by an AWS Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
credentialsParameter This property is required. String
The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an AWS Secrets Manager secret or AWS Systems Manager Parameter Store parameter. The ARNs refer to the stored credentials.
domain This property is required. String
A fully qualified domain name hosted by an AWS Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi