AwsEcsTaskDefinitionDetails
Details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.
Contents
- ContainerDefinitions
-
The container definitions that describe the containers that make up the task.
Type: Array of AwsEcsTaskDefinitionContainerDefinitionsDetails objects
Required: No
- Cpu
-
The number of CPU units used by the task.Valid values are as follows:
-
256 (.25 vCPU)
-
512 (.5 vCPU)
-
1024 (1 vCPU)
-
2048 (2 vCPU)
-
4096 (4 vCPU)
Type: String
Pattern:
.*\S.*
Required: No
-
- ExecutionRoleArn
-
The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.
Type: String
Pattern:
.*\S.*
Required: No
- Family
-
The name of a family that this task definition is registered to.
Type: String
Pattern:
.*\S.*
Required: No
- InferenceAccelerators
-
The Elastic Inference accelerators to use for the containers in the task.
Type: Array of AwsEcsTaskDefinitionInferenceAcceleratorsDetails objects
Required: No
- IpcMode
-
The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:
-
host
-
none
-
task
Type: String
Pattern:
.*\S.*
Required: No
-
- Memory
-
The amount (in MiB) of memory used by the task.
For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level memory value. For tasks that are hosted on AWS Fargate, you must use one of the specified values in the Amazon Elastic Container Service Developer Guide , which determines your range of supported values for the
Cpu
andMemory
parameters.Type: String
Pattern:
.*\S.*
Required: No
- NetworkMode
-
The Docker networking mode to use for the containers in the task. Valid values are as follows:
-
awsvpc
-
bridge
-
host
-
none
Type: String
Pattern:
.*\S.*
Required: No
-
- PidMode
-
The process namespace to use for the containers in the task. Valid values are
host
ortask
.Type: String
Pattern:
.*\S.*
Required: No
- PlacementConstraints
-
The placement constraint objects to use for tasks.
Type: Array of AwsEcsTaskDefinitionPlacementConstraintsDetails objects
Required: No
- ProxyConfiguration
-
The configuration details for the App Mesh proxy.
Type: AwsEcsTaskDefinitionProxyConfigurationDetails object
Required: No
- RequiresCompatibilities
-
The task launch types that the task definition was validated against.
Type: Array of strings
Pattern:
.*\S.*
Required: No
- Status
-
The status of the task definition.
Type: String
Pattern:
.*\S.*
Required: No
- TaskRoleArn
-
The short name or ARN of the IAM role that grants containers in the task permission to call AWS API operations on your behalf.
Type: String
Pattern:
.*\S.*
Required: No
- Volumes
-
The data volume definitions for the task.
Type: Array of AwsEcsTaskDefinitionVolumesDetails objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: