TaskDefinition (AWS Java SDK :: Services :: Amazon EC2 Container Service 2.17.33 API)

java.lang.Object
- software.amazon.awssdk.services.ecs.model.TaskDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TaskDefinition.Builder,TaskDefinition>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class TaskDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TaskDefinition.Builder,TaskDefinition>
```
The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TaskDefinition.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TaskDefinition.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TaskDefinition.Builder`	`builder()`
`List<Compatibility>`	`compatibilities()` The task launch types the task definition validated against during task definition registration.
`List<String>`	`compatibilitiesAsStrings()` The task launch types the task definition validated against during task definition registration.
`List<ContainerDefinition>`	`containerDefinitions()` A list of container definitions in JSON format that describe the different containers that make up your task.
`String`	`cpu()` The number of `cpu` units used by the task.
`Instant`	`deregisteredAt()` The Unix timestamp for when the task definition was deregistered.
`EphemeralStorage`	`ephemeralStorage()` The ephemeral storage settings to use for tasks run with the task definition.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executionRoleArn()` The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf.
`String`	`family()` The name of a family that this task definition is registered to.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCompatibilities()` For responses, this returns true if the service returned a value for the Compatibilities property.
`boolean`	`hasContainerDefinitions()` For responses, this returns true if the service returned a value for the ContainerDefinitions property.
`int`	`hashCode()`
`boolean`	`hasInferenceAccelerators()` For responses, this returns true if the service returned a value for the InferenceAccelerators property.
`boolean`	`hasPlacementConstraints()` For responses, this returns true if the service returned a value for the PlacementConstraints property.
`boolean`	`hasRequiresAttributes()` For responses, this returns true if the service returned a value for the RequiresAttributes property.
`boolean`	`hasRequiresCompatibilities()` For responses, this returns true if the service returned a value for the RequiresCompatibilities property.
`boolean`	`hasVolumes()` For responses, this returns true if the service returned a value for the Volumes property.
`List<InferenceAccelerator>`	`inferenceAccelerators()` The Elastic Inference accelerator associated with the task.
`IpcMode`	`ipcMode()` The IPC resource namespace to use for the containers in the task.
`String`	`ipcModeAsString()` The IPC resource namespace to use for the containers in the task.
`String`	`memory()` The amount (in MiB) of memory used by the task.
`NetworkMode`	`networkMode()` The Docker networking mode to use for the containers in the task.
`String`	`networkModeAsString()` The Docker networking mode to use for the containers in the task.
`PidMode`	`pidMode()` The process namespace to use for the containers in the task.
`String`	`pidModeAsString()` The process namespace to use for the containers in the task.
`List<TaskDefinitionPlacementConstraint>`	`placementConstraints()` An array of placement constraint objects to use for tasks.
`ProxyConfiguration`	`proxyConfiguration()` The configuration details for the App Mesh proxy.
`Instant`	`registeredAt()` The Unix timestamp for when the task definition was registered.
`String`	`registeredBy()` The principal that registered the task definition.
`List<Attribute>`	`requiresAttributes()` The container instance attributes required by your task.
`List<Compatibility>`	`requiresCompatibilities()` The task launch types the task definition was validated against.
`List<String>`	`requiresCompatibilitiesAsStrings()` The task launch types the task definition was validated against.
`Integer`	`revision()` The revision of the task in a particular family.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TaskDefinition.Builder>`	`serializableBuilderClass()`
`TaskDefinitionStatus`	`status()` The status of the task definition.
`String`	`statusAsString()` The status of the task definition.
`String`	`taskDefinitionArn()` The full Amazon Resource Name (ARN) of the task definition.
`String`	`taskRoleArn()` The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf.
`TaskDefinition.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<Volume>`	`volumes()` The list of data volume definitions for the task.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - taskDefinitionArn
```
public final String taskDefinitionArn()
```
    The full Amazon Resource Name (ARN) of the task definition.
    
    Returns:
    
    The full Amazon Resource Name (ARN) of the task definition.
  - hasContainerDefinitions
```
public final boolean hasContainerDefinitions()
```
    For responses, this returns true if the service returned a value for the ContainerDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - containerDefinitions
```
public final List<ContainerDefinition> containerDefinitions()
```
    A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContainerDefinitions() method.
    
    Returns:
    
    A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
  - family
```
public final String family()
```
    The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
    
    A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
    
    Returns:
    
    The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
    
    A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
  - taskRoleArn
```
public final String taskRoleArn()
```
    The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.
    
    IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.
    
    IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.
  - executionRoleArn
```
public final String executionRoleArn()
```
    The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
  - networkMode
```
public final NetworkMode networkMode()
```
    The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
    
    For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
    
    With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
    
    When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
    
    If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
    
    If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
    
    For more information, see Network settings in the Docker run reference.
    
    If the service returns an enum value that is not available in the current SDK version, networkMode will return NetworkMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkModeAsString().
    
    Returns:
    
    The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
    
    For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
    
    With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
    
    When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
    
    If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
    
    If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
    
    For more information, see Network settings in the Docker run reference.
    
    See Also:
    
    NetworkMode
  - networkModeAsString
```
public final String networkModeAsString()
```
    The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
    
    For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
    
    With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
    
    When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
    
    If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
    
    If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
    
    For more information, see Network settings in the Docker run reference.
    
    If the service returns an enum value that is not available in the current SDK version, networkMode will return NetworkMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkModeAsString().
    
    Returns:
    
    The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
    
    For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
    
    With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
    
    When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
    
    If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
    
    If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
    
    For more information, see Network settings in the Docker run reference.
    
    See Also:
    
    NetworkMode
  - revision
```
public final Integer revision()
```
    The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one, even if you have deregistered previous revisions in this family.
    
    Returns:
    
    The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one, even if you have deregistered previous revisions in this family.
  - hasVolumes
```
public final boolean hasVolumes()
```
    For responses, this returns true if the service returned a value for the Volumes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - volumes
```
public final List<Volume> volumes()
```
    The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
    
    The host and sourcePath parameters are not supported for tasks run on Fargate.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVolumes() method.
    
    Returns:
    
    The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
    
    The host and sourcePath parameters are not supported for tasks run on Fargate.
  - status
```
public final TaskDefinitionStatus status()
```
    The status of the task definition.
    
    If the service returns an enum value that is not available in the current SDK version, status will return TaskDefinitionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the task definition.
    
    See Also:
    
    TaskDefinitionStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the task definition.
    
    If the service returns an enum value that is not available in the current SDK version, status will return TaskDefinitionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the task definition.
    
    See Also:
    
    TaskDefinitionStatus
  - hasRequiresAttributes
```
public final boolean hasRequiresAttributes()
```
    For responses, this returns true if the service returned a value for the RequiresAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - requiresAttributes
```
public final List<Attribute> requiresAttributes()
```
    The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes, specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when considering task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
    
    This parameter is not supported for tasks run on Fargate.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequiresAttributes() method.
    
    Returns:
    
    The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes, specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when considering task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
    
    This parameter is not supported for tasks run on Fargate.
  - hasPlacementConstraints
```
public final boolean hasPlacementConstraints()
```
    For responses, this returns true if the service returned a value for the PlacementConstraints property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - placementConstraints
```
public final List<TaskDefinitionPlacementConstraint> placementConstraints()
```
    An array of placement constraint objects to use for tasks.
    
    This parameter is not supported for tasks run on Fargate.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPlacementConstraints() method.
    
    Returns:
    
    An array of placement constraint objects to use for tasks.
    
    This parameter is not supported for tasks run on Fargate.
  - compatibilities
```
public final List<Compatibility> compatibilities()
```
    The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCompatibilities() method.
    
    Returns:
    
    The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
  - hasCompatibilities
```
public final boolean hasCompatibilities()
```
    For responses, this returns true if the service returned a value for the Compatibilities property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - compatibilitiesAsStrings
```
public final List<String> compatibilitiesAsStrings()
```
    The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCompatibilities() method.
    
    Returns:
    
    The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
  - requiresCompatibilities
```
public final List<Compatibility> requiresCompatibilities()
```
    The task launch types the task definition was validated against. To determine which task launch types the task definition is validated for, see the TaskDefinition$compatibilities parameter.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequiresCompatibilities() method.
    
    Returns:
    
    The task launch types the task definition was validated against. To determine which task launch types the task definition is validated for, see the TaskDefinition$compatibilities parameter.
  - hasRequiresCompatibilities
```
public final boolean hasRequiresCompatibilities()
```
    For responses, this returns true if the service returned a value for the RequiresCompatibilities property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - requiresCompatibilitiesAsStrings
```
public final List<String> requiresCompatibilitiesAsStrings()
```
    The task launch types the task definition was validated against. To determine which task launch types the task definition is validated for, see the TaskDefinition$compatibilities parameter.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequiresCompatibilities() method.
    
    Returns:
    
    The task launch types the task definition was validated against. To determine which task launch types the task definition is validated for, see the TaskDefinition$compatibilities parameter.
  - cpu
```
public final String cpu()
```
    The number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:
    - 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
    - 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
    - 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
    - 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
    - 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
    Returns:
    The number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:
    
    256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
    
    512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
    
    1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
    
    2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
    
    4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
  - memory
```
public final String memory()
```
    The amount (in MiB) of memory used by the task.
    
    If your tasks will be run on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified then the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
    
    If your tasks will be run on Fargate, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
    - 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
    - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
    - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
    - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
    - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
    Returns:
    The amount (in MiB) of memory used by the task.
    
    If your tasks will be run on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified then the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
    
    If your tasks will be run on Fargate, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
    
    512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
    
    1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
    
    2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
    
    Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
    
    Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
  - hasInferenceAccelerators
```
public final boolean hasInferenceAccelerators()
```
    For responses, this returns true if the service returned a value for the InferenceAccelerators property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - inferenceAccelerators
```
public final List<InferenceAccelerator> inferenceAccelerators()
```
    The Elastic Inference accelerator associated with the task.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInferenceAccelerators() method.
    
    Returns:
    
    The Elastic Inference accelerator associated with the task.
  - pidMode
```
public final PidMode pidMode()
```
    The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.
    
    If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.
    
    This parameter is not supported for Windows containers or tasks run on Fargate.
    
    If the service returns an enum value that is not available in the current SDK version, pidMode will return PidMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pidModeAsString().
    
    Returns:
    
    The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.
    
    If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.
    
    This parameter is not supported for Windows containers or tasks run on Fargate.
    
    See Also:
    
    PidMode
  - pidModeAsString
```
public final String pidModeAsString()
```
    The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.
    
    If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.
    
    This parameter is not supported for Windows containers or tasks run on Fargate.
    
    If the service returns an enum value that is not available in the current SDK version, pidMode will return PidMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pidModeAsString().
    
    Returns:
    
    The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.
    
    If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.
    
    This parameter is not supported for Windows containers or tasks run on Fargate.
    
    See Also:
    
    PidMode
  - ipcMode
```
public final IpcMode ipcMode()
```
    The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
    
    If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
    
    If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
    - For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
    - For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.
    This parameter is not supported for Windows containers or tasks run on Fargate.
    
    If the service returns an enum value that is not available in the current SDK version, ipcMode will return IpcMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipcModeAsString().
    Returns:
    The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
    
    If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
    
    If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
    
    For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
    
    For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.
    
    This parameter is not supported for Windows containers or tasks run on Fargate.
    See Also:
    
    IpcMode
  - ipcModeAsString
```
public final String ipcModeAsString()
```
    The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
    
    If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
    
    If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
    - For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
    - For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.
    This parameter is not supported for Windows containers or tasks run on Fargate.
    
    If the service returns an enum value that is not available in the current SDK version, ipcMode will return IpcMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipcModeAsString().
    Returns:
    The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
    
    If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
    
    If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
    
    For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
    
    For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.
    
    This parameter is not supported for Windows containers or tasks run on Fargate.
    See Also:
    
    IpcMode
  - proxyConfiguration
```
public final ProxyConfiguration proxyConfiguration()
```
    The configuration details for the App Mesh proxy.
    
    Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    The configuration details for the App Mesh proxy.
    
    Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
  - registeredAt
```
public final Instant registeredAt()
```
    The Unix timestamp for when the task definition was registered.
    
    Returns:
    
    The Unix timestamp for when the task definition was registered.
  - deregisteredAt
```
public final Instant deregisteredAt()
```
    The Unix timestamp for when the task definition was deregistered.
    
    Returns:
    
    The Unix timestamp for when the task definition was deregistered.
  - registeredBy
```
public final String registeredBy()
```
    The principal that registered the task definition.
    
    Returns:
    
    The principal that registered the task definition.
  - ephemeralStorage
```
public final EphemeralStorage ephemeralStorage()
```
    The ephemeral storage settings to use for tasks run with the task definition.
    
    Returns:
    
    The ephemeral storage settings to use for tasks run with the task definition.
  - toBuilder
```
public TaskDefinition.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TaskDefinition.Builder,TaskDefinition>
  - builder
```
public static TaskDefinition.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TaskDefinition.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class TaskDefinition

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

taskDefinitionArn

hasContainerDefinitions

containerDefinitions

family

taskRoleArn

executionRoleArn

networkMode

networkModeAsString

revision

hasVolumes

volumes

status

statusAsString

hasRequiresAttributes

requiresAttributes

hasPlacementConstraints

placementConstraints

compatibilities

hasCompatibilities

compatibilitiesAsStrings

requiresCompatibilities

hasRequiresCompatibilities

requiresCompatibilitiesAsStrings

cpu

memory

hasInferenceAccelerators

inferenceAccelerators

pidMode

pidModeAsString

ipcMode

ipcModeAsString

proxyConfiguration

registeredAt

deregisteredAt

registeredBy

ephemeralStorage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields