AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
aws.ecs.getTaskDefinition
Explore with Pulumi AI
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),
});
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)
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
	})
}
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),
    });
});
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());
    }
}
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}
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>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]func LookupTaskDefinition(ctx *Context, args *LookupTaskDefinitionArgs, opts ...InvokeOption) (*LookupTaskDefinitionResult, error)
func LookupTaskDefinitionOutput(ctx *Context, args *LookupTaskDefinitionOutputArgs, opts ...InvokeOption) LookupTaskDefinitionResultOutput> 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)
}public static CompletableFuture<GetTaskDefinitionResult> getTaskDefinition(GetTaskDefinitionArgs args, InvokeOptions options)
public static Output<GetTaskDefinitionResult> getTaskDefinition(GetTaskDefinitionArgs args, InvokeOptions options)
fn::invoke:
  function: aws:ecs/getTaskDefinition:getTaskDefinition
  arguments:
    # arguments dictionaryThe following arguments are supported:
- TaskDefinition 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 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 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 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 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 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.
- ArnWithout stringRevision 
- ARN of the Task Definition with the trailing revisionremoved. 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_compatibilitiesisFARGATEthis field is required.
- EnableFault boolInjection 
- Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is false.
- EphemeralStorages List<GetTask Definition Ephemeral Storage> 
- 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.
- ExecutionRole stringArn 
- 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<GetTask Definition Inference Accelerator> 
- 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, andnone.
- Memory string
- Amount (in MiB) of memory used by the task. If the requires_compatibilitiesisFARGATEthis field is required.
- NetworkMode string
- Docker networking mode to use for the containers in the task. Valid values are none,bridge,awsvpc, andhost.
- PidMode string
- Process namespace to use for the containers in the task. The valid values are hostandtask.
- PlacementConstraints List<GetTask Definition Placement Constraint> 
- Configuration block for rules that are taken into consideration during task placement. Maximum number of placement_constraintsis10. Detailed below.
- ProxyConfigurations List<GetTask Definition Proxy Configuration> 
- Configuration block for the App Mesh proxy. Detailed below.
- RequiresCompatibilities List<string>
- Set of launch types required by the task. The valid values are EC2andFARGATE.
- Revision int
- Revision of the task in a particular family.
- RuntimePlatforms List<GetTask Definition Runtime Platform> 
- Configuration block for runtime_platform that containers in your task may use.
- Status string
- Status of the task definition.
- TaskDefinition string
- TaskRole stringArn 
- ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.
- Volumes
List<GetTask Definition Volume> 
- Configuration block for volumes that containers in your task may use. Detailed below.
- Arn string
- ARN of the task definition.
- ArnWithout stringRevision 
- ARN of the Task Definition with the trailing revisionremoved. 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_compatibilitiesisFARGATEthis field is required.
- EnableFault boolInjection 
- Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is false.
- EphemeralStorages []GetTask Definition Ephemeral Storage 
- 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.
- ExecutionRole stringArn 
- 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 []GetTask Definition Inference Accelerator 
- 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, andnone.
- Memory string
- Amount (in MiB) of memory used by the task. If the requires_compatibilitiesisFARGATEthis field is required.
- NetworkMode string
- Docker networking mode to use for the containers in the task. Valid values are none,bridge,awsvpc, andhost.
- PidMode string
- Process namespace to use for the containers in the task. The valid values are hostandtask.
- PlacementConstraints []GetTask Definition Placement Constraint 
- Configuration block for rules that are taken into consideration during task placement. Maximum number of placement_constraintsis10. Detailed below.
- ProxyConfigurations []GetTask Definition Proxy Configuration 
- Configuration block for the App Mesh proxy. Detailed below.
- RequiresCompatibilities []string
- Set of launch types required by the task. The valid values are EC2andFARGATE.
- Revision int
- Revision of the task in a particular family.
- RuntimePlatforms []GetTask Definition Runtime Platform 
- Configuration block for runtime_platform that containers in your task may use.
- Status string
- Status of the task definition.
- TaskDefinition string
- TaskRole stringArn 
- ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.
- Volumes
[]GetTask Definition Volume 
- Configuration block for volumes that containers in your task may use. Detailed below.
- arn String
- ARN of the task definition.
- arnWithout StringRevision 
- ARN of the Task Definition with the trailing revisionremoved. 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_compatibilitiesisFARGATEthis field is required.
- enableFault BooleanInjection 
- Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is false.
- ephemeralStorages List<GetTask Definition Ephemeral Storage> 
- 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.
- executionRole StringArn 
- 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<GetTask Definition Inference Accelerator> 
- 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, andnone.
- memory String
- Amount (in MiB) of memory used by the task. If the requires_compatibilitiesisFARGATEthis field is required.
- networkMode String
- Docker networking mode to use for the containers in the task. Valid values are none,bridge,awsvpc, andhost.
- pidMode String
- Process namespace to use for the containers in the task. The valid values are hostandtask.
- placementConstraints List<GetTask Definition Placement Constraint> 
- Configuration block for rules that are taken into consideration during task placement. Maximum number of placement_constraintsis10. Detailed below.
- proxyConfigurations List<GetTask Definition Proxy Configuration> 
- Configuration block for the App Mesh proxy. Detailed below.
- requiresCompatibilities List<String>
- Set of launch types required by the task. The valid values are EC2andFARGATE.
- revision Integer
- Revision of the task in a particular family.
- runtimePlatforms List<GetTask Definition Runtime Platform> 
- Configuration block for runtime_platform that containers in your task may use.
- status String
- Status of the task definition.
- taskDefinition String
- taskRole StringArn 
- ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.
- volumes
List<GetTask Definition Volume> 
- Configuration block for volumes that containers in your task may use. Detailed below.
- arn string
- ARN of the task definition.
- arnWithout stringRevision 
- ARN of the Task Definition with the trailing revisionremoved. 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_compatibilitiesisFARGATEthis field is required.
- enableFault booleanInjection 
- Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is false.
- ephemeralStorages GetTask Definition Ephemeral Storage[] 
- 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.
- executionRole stringArn 
- 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 GetTask Definition Inference Accelerator[] 
- 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, andnone.
- memory string
- Amount (in MiB) of memory used by the task. If the requires_compatibilitiesisFARGATEthis field is required.
- networkMode string
- Docker networking mode to use for the containers in the task. Valid values are none,bridge,awsvpc, andhost.
- pidMode string
- Process namespace to use for the containers in the task. The valid values are hostandtask.
- placementConstraints GetTask Definition Placement Constraint[] 
- Configuration block for rules that are taken into consideration during task placement. Maximum number of placement_constraintsis10. Detailed below.
- proxyConfigurations GetTask Definition Proxy Configuration[] 
- Configuration block for the App Mesh proxy. Detailed below.
- requiresCompatibilities string[]
- Set of launch types required by the task. The valid values are EC2andFARGATE.
- revision number
- Revision of the task in a particular family.
- runtimePlatforms GetTask Definition Runtime Platform[] 
- Configuration block for runtime_platform that containers in your task may use.
- status string
- Status of the task definition.
- taskDefinition string
- taskRole stringArn 
- ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.
- volumes
GetTask Definition Volume[] 
- Configuration block for volumes that containers in your task may use. Detailed below.
- arn str
- ARN of the task definition.
- arn_without_ strrevision 
- ARN of the Task Definition with the trailing revisionremoved. 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_compatibilitiesisFARGATEthis field is required.
- enable_fault_ boolinjection 
- Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is false.
- ephemeral_storages Sequence[GetTask Definition Ephemeral Storage] 
- 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_ strarn 
- 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[GetTask Definition Inference Accelerator] 
- 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, andnone.
- memory str
- Amount (in MiB) of memory used by the task. If the requires_compatibilitiesisFARGATEthis field is required.
- network_mode str
- Docker networking mode to use for the containers in the task. Valid values are none,bridge,awsvpc, andhost.
- pid_mode str
- Process namespace to use for the containers in the task. The valid values are hostandtask.
- placement_constraints Sequence[GetTask Definition Placement Constraint] 
- Configuration block for rules that are taken into consideration during task placement. Maximum number of placement_constraintsis10. Detailed below.
- proxy_configurations Sequence[GetTask Definition Proxy Configuration] 
- 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 EC2andFARGATE.
- revision int
- Revision of the task in a particular family.
- runtime_platforms Sequence[GetTask Definition Runtime Platform] 
- Configuration block for runtime_platform that containers in your task may use.
- status str
- Status of the task definition.
- task_definition str
- task_role_ strarn 
- ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.
- volumes
Sequence[GetTask Definition Volume] 
- Configuration block for volumes that containers in your task may use. Detailed below.
- arn String
- ARN of the task definition.
- arnWithout StringRevision 
- ARN of the Task Definition with the trailing revisionremoved. 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_compatibilitiesisFARGATEthis field is required.
- enableFault BooleanInjection 
- 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.
- executionRole StringArn 
- 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, andnone.
- memory String
- Amount (in MiB) of memory used by the task. If the requires_compatibilitiesisFARGATEthis field is required.
- networkMode String
- Docker networking mode to use for the containers in the task. Valid values are none,bridge,awsvpc, andhost.
- pidMode String
- Process namespace to use for the containers in the task. The valid values are hostandtask.
- placementConstraints List<Property Map>
- Configuration block for rules that are taken into consideration during task placement. Maximum number of placement_constraintsis10. 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 EC2andFARGATE.
- 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
- taskRole StringArn 
- 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    
- SizeIn intGib 
- The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21GiB and the maximum supported value is200GiB.
- SizeIn intGib 
- The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21GiB and the maximum supported value is200GiB.
- sizeIn IntegerGib 
- The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21GiB and the maximum supported value is200GiB.
- sizeIn numberGib 
- The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21GiB and the maximum supported value is200GiB.
- size_in_ intgib 
- The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21GiB and the maximum supported value is200GiB.
- sizeIn NumberGib 
- The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21GiB and the maximum supported value is200GiB.
GetTaskDefinitionInferenceAccelerator    
- DeviceName string
- Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
- DeviceType string
- Elastic Inference accelerator type to use.
- DeviceName string
- Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
- DeviceType string
- Elastic Inference accelerator type to use.
- deviceName String
- Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
- deviceType String
- Elastic Inference accelerator type to use.
- deviceName string
- Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
- deviceType string
- Elastic Inference accelerator type to use.
- device_name str
- Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
- device_type str
- Elastic Inference accelerator type to use.
- deviceName String
- Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
- deviceType String
- Elastic Inference accelerator type to use.
GetTaskDefinitionPlacementConstraint    
- Expression 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 string
- Proxy type. The default value is APPMESH. The only supported value isAPPMESH.
- Expression 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 string
- Proxy type. The default value is APPMESH. The only supported value isAPPMESH.
- expression 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 String
- Proxy type. The default value is APPMESH. The only supported value isAPPMESH.
- expression 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 string
- Proxy type. The default value is APPMESH. The only supported value isAPPMESH.
- expression 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 str
- Proxy type. The default value is APPMESH. The only supported value isAPPMESH.
- expression 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 String
- Proxy type. The default value is APPMESH. The only supported value isAPPMESH.
GetTaskDefinitionProxyConfiguration    
- ContainerName string
- Name of the container that will serve as the App Mesh proxy.
- Properties Dictionary<string, string>
- Set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified a key-value mapping.
- Type string
- Proxy type. The default value is APPMESH. The only supported value isAPPMESH.
- ContainerName string
- Name of the container that will serve as the App Mesh proxy.
- Properties map[string]string
- Set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified a key-value mapping.
- Type string
- Proxy type. The default value is APPMESH. The only supported value isAPPMESH.
- containerName String
- Name of the container that will serve as the App Mesh proxy.
- properties Map<String,String>
- Set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified a key-value mapping.
- type String
- Proxy type. The default value is APPMESH. The only supported value isAPPMESH.
- containerName string
- Name of the container that will serve as the App Mesh proxy.
- properties {[key: string]: string}
- Set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified a key-value mapping.
- type string
- Proxy type. The default value is APPMESH. The only supported value isAPPMESH.
- container_name str
- Name of the container that will serve as the App Mesh proxy.
- properties Mapping[str, str]
- Set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified a key-value mapping.
- type str
- Proxy type. The default value is APPMESH. The only supported value isAPPMESH.
- containerName String
- Name of the container that will serve as the App Mesh proxy.
- properties Map<String>
- Set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified a key-value mapping.
- type String
- Proxy type. The default value is APPMESH. The only supported value isAPPMESH.
GetTaskDefinitionRuntimePlatform    
- CpuArchitecture string
- Must be set to either X86_64orARM64; see cpu architecture
- OperatingSystem stringFamily 
- If the requires_compatibilitiesisFARGATEthis field is required; must be set to a valid option from the operating system family in the runtime platform setting
- CpuArchitecture string
- Must be set to either X86_64orARM64; see cpu architecture
- OperatingSystem stringFamily 
- If the requires_compatibilitiesisFARGATEthis field is required; must be set to a valid option from the operating system family in the runtime platform setting
- cpuArchitecture String
- Must be set to either X86_64orARM64; see cpu architecture
- operatingSystem StringFamily 
- If the requires_compatibilitiesisFARGATEthis field is required; must be set to a valid option from the operating system family in the runtime platform setting
- cpuArchitecture string
- Must be set to either X86_64orARM64; see cpu architecture
- operatingSystem stringFamily 
- If the requires_compatibilitiesisFARGATEthis field is required; must be set to a valid option from the operating system family in the runtime platform setting
- cpu_architecture str
- Must be set to either X86_64orARM64; see cpu architecture
- operating_system_ strfamily 
- If the requires_compatibilitiesisFARGATEthis field is required; must be set to a valid option from the operating system family in the runtime platform setting
- cpuArchitecture String
- Must be set to either X86_64orARM64; see cpu architecture
- operatingSystem StringFamily 
- If the requires_compatibilitiesisFARGATEthis field is required; must be set to a valid option from the operating system family in the runtime platform setting
GetTaskDefinitionVolume   
- ConfigureAt boolLaunch 
- 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.
- DockerVolume List<GetConfigurations Task Definition Volume Docker Volume Configuration> 
- Configuration block to configure a docker volume. Detailed below.
- EfsVolume List<GetConfigurations Task Definition Volume Efs Volume Configuration> 
- Configuration block for an EFS volume. Detailed below.
- FsxWindows List<GetFile Server Volume Configurations Task Definition Volume Fsx Windows File Server Volume Configuration> 
- Configuration block for an FSX Windows File Server volume. Detailed below.
- HostPath 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 string
- Name of the volume. This name is referenced in the sourceVolumeparameter of container definition in themountPointssection.
- ConfigureAt boolLaunch 
- 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.
- DockerVolume []GetConfigurations Task Definition Volume Docker Volume Configuration 
- Configuration block to configure a docker volume. Detailed below.
- EfsVolume []GetConfigurations Task Definition Volume Efs Volume Configuration 
- Configuration block for an EFS volume. Detailed below.
- FsxWindows []GetFile Server Volume Configurations Task Definition Volume Fsx Windows File Server Volume Configuration 
- Configuration block for an FSX Windows File Server volume. Detailed below.
- HostPath 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 string
- Name of the volume. This name is referenced in the sourceVolumeparameter of container definition in themountPointssection.
- configureAt BooleanLaunch 
- 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.
- dockerVolume List<GetConfigurations Task Definition Volume Docker Volume Configuration> 
- Configuration block to configure a docker volume. Detailed below.
- efsVolume List<GetConfigurations Task Definition Volume Efs Volume Configuration> 
- Configuration block for an EFS volume. Detailed below.
- fsxWindows List<GetFile Server Volume Configurations Task Definition Volume Fsx Windows File Server Volume Configuration> 
- Configuration block for an FSX Windows File Server volume. Detailed below.
- hostPath 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 String
- Name of the volume. This name is referenced in the sourceVolumeparameter of container definition in themountPointssection.
- configureAt booleanLaunch 
- 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.
- dockerVolume GetConfigurations Task Definition Volume Docker Volume Configuration[] 
- Configuration block to configure a docker volume. Detailed below.
- efsVolume GetConfigurations Task Definition Volume Efs Volume Configuration[] 
- Configuration block for an EFS volume. Detailed below.
- fsxWindows GetFile Server Volume Configurations Task Definition Volume Fsx Windows File Server Volume Configuration[] 
- Configuration block for an FSX Windows File Server volume. Detailed below.
- hostPath 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 string
- Name of the volume. This name is referenced in the sourceVolumeparameter of container definition in themountPointssection.
- configure_at_ boollaunch 
- 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_ Sequence[Getconfigurations Task Definition Volume Docker Volume Configuration] 
- Configuration block to configure a docker volume. Detailed below.
- efs_volume_ Sequence[Getconfigurations Task Definition Volume Efs Volume Configuration] 
- Configuration block for an EFS volume. Detailed below.
- fsx_windows_ Sequence[Getfile_ server_ volume_ configurations Task Definition Volume Fsx Windows File Server Volume Configuration] 
- Configuration block for an FSX Windows File Server volume. Detailed below.
- host_path 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 str
- Name of the volume. This name is referenced in the sourceVolumeparameter of container definition in themountPointssection.
- configureAt BooleanLaunch 
- 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.
- dockerVolume List<Property Map>Configurations 
- Configuration block to configure a docker volume. Detailed below.
- efsVolume List<Property Map>Configurations 
- Configuration block for an EFS volume. Detailed below.
- fsxWindows List<Property Map>File Server Volume Configurations 
- Configuration block for an FSX Windows File Server volume. Detailed below.
- hostPath 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 String
- Name of the volume. This name is referenced in the sourceVolumeparameter of container definition in themountPointssection.
GetTaskDefinitionVolumeDockerVolumeConfiguration      
- Autoprovision 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 isshared.
- Driver 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 Dictionary<string, string>
- Map of Docker driver specific options.
- Labels Dictionary<string, string>
- Map of custom metadata to add to your Docker volume.
- Scope string
- Scope for the Docker volume, which determines its lifecycle, either taskorshared. Docker volumes that are scoped to ataskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- Autoprovision 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 isshared.
- Driver 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 map[string]string
- Map of Docker driver specific options.
- Labels map[string]string
- Map of custom metadata to add to your Docker volume.
- Scope string
- Scope for the Docker volume, which determines its lifecycle, either taskorshared. Docker volumes that are scoped to ataskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- autoprovision 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 isshared.
- driver 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 Map<String,String>
- Map of Docker driver specific options.
- labels Map<String,String>
- Map of custom metadata to add to your Docker volume.
- scope String
- Scope for the Docker volume, which determines its lifecycle, either taskorshared. Docker volumes that are scoped to ataskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- autoprovision 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 isshared.
- driver 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 {[key: string]: string}
- Map of Docker driver specific options.
- labels {[key: string]: string}
- Map of custom metadata to add to your Docker volume.
- scope string
- Scope for the Docker volume, which determines its lifecycle, either taskorshared. Docker volumes that are scoped to ataskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- autoprovision 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 isshared.
- driver 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 Mapping[str, str]
- Map of Docker driver specific options.
- labels Mapping[str, str]
- Map of custom metadata to add to your Docker volume.
- scope str
- Scope for the Docker volume, which determines its lifecycle, either taskorshared. Docker volumes that are scoped to ataskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- autoprovision 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 isshared.
- driver 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 Map<String>
- Map of Docker driver specific options.
- labels Map<String>
- Map of custom metadata to add to your Docker volume.
- scope String
- Scope for the Docker volume, which determines its lifecycle, either taskorshared. Docker volumes that are scoped to ataskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
GetTaskDefinitionVolumeEfsVolumeConfiguration      
- 
List<GetTask Definition Volume Efs Volume Configuration Authorization Config> 
- Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
- FileSystem stringId 
- The Amazon FSx for Windows File Server file system ID to use.
- RootDirectory string
- The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
- TransitEncryption 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 ofDISABLEDis used.
- TransitEncryption intPort 
- 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.
- 
[]GetTask Definition Volume Efs Volume Configuration Authorization Config 
- Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
- FileSystem stringId 
- The Amazon FSx for Windows File Server file system ID to use.
- RootDirectory string
- The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
- TransitEncryption 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 ofDISABLEDis used.
- TransitEncryption intPort 
- 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.
- 
List<GetTask Definition Volume Efs Volume Configuration Authorization Config> 
- Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
- fileSystem StringId 
- The Amazon FSx for Windows File Server file system ID to use.
- rootDirectory String
- The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
- transitEncryption 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 ofDISABLEDis used.
- transitEncryption IntegerPort 
- 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.
- 
GetTask Definition Volume Efs Volume Configuration Authorization Config[] 
- Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
- fileSystem stringId 
- The Amazon FSx for Windows File Server file system ID to use.
- rootDirectory string
- The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
- transitEncryption 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 ofDISABLEDis used.
- transitEncryption numberPort 
- 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.
- 
Sequence[GetTask Definition Volume Efs Volume Configuration Authorization Config] 
- Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
- file_system_ strid 
- The Amazon FSx for Windows File Server file system ID to use.
- root_directory str
- The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
- transit_encryption 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 ofDISABLEDis used.
- transit_encryption_ intport 
- 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.
- List<Property Map>
- Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
- fileSystem StringId 
- The Amazon FSx for Windows File Server file system ID to use.
- rootDirectory String
- The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
- transitEncryption 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 ofDISABLEDis used.
- transitEncryption NumberPort 
- 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        
- AccessPoint stringId 
- 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 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 ofDISABLEDis used.
- AccessPoint stringId 
- 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 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 ofDISABLEDis used.
- accessPoint StringId 
- 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 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 ofDISABLEDis used.
- accessPoint stringId 
- 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 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 ofDISABLEDis used.
- access_point_ strid 
- 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 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 ofDISABLEDis used.
- accessPoint StringId 
- 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 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 ofDISABLEDis used.
GetTaskDefinitionVolumeFsxWindowsFileServerVolumeConfiguration         
- 
List<GetTask Definition Volume Fsx Windows File Server Volume Configuration Authorization Config> 
- Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
- FileSystem stringId 
- The Amazon FSx for Windows File Server file system ID to use.
- RootDirectory string
- The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
- 
[]GetTask Definition Volume Fsx Windows File Server Volume Configuration Authorization Config 
- Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
- FileSystem stringId 
- The Amazon FSx for Windows File Server file system ID to use.
- RootDirectory string
- The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
- 
List<GetTask Definition Volume Fsx Windows File Server Volume Configuration Authorization Config> 
- Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
- fileSystem StringId 
- The Amazon FSx for Windows File Server file system ID to use.
- rootDirectory String
- The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
- 
GetTask Definition Volume Fsx Windows File Server Volume Configuration Authorization Config[] 
- Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
- fileSystem stringId 
- The Amazon FSx for Windows File Server file system ID to use.
- rootDirectory string
- The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
- 
Sequence[GetTask Definition Volume Fsx Windows File Server Volume Configuration Authorization Config] 
- Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
- file_system_ strid 
- The Amazon FSx for Windows File Server file system ID to use.
- root_directory str
- The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
- List<Property Map>
- Configuration block for authorization for the Amazon FSx for Windows File Server file system detailed below.
- fileSystem StringId 
- The Amazon FSx for Windows File Server file system ID to use.
- rootDirectory String
- The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
GetTaskDefinitionVolumeFsxWindowsFileServerVolumeConfigurationAuthorizationConfig           
- CredentialsParameter 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 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 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 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 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 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 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 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 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 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 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 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 awsTerraform Provider.