@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class TaskDefinition extends Object implements Serializable, Cloneable, StructuredPojo
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.
| Constructor and Description |
|---|
TaskDefinition() |
| Modifier and Type | Method and Description |
|---|---|
TaskDefinition |
clone() |
boolean |
equals(Object obj) |
List<String> |
getCompatibilities()
The task launch types the task definition validated against during task definition registration.
|
List<ContainerDefinition> |
getContainerDefinitions()
A list of container definitions in JSON format that describe the different containers that make up your task.
|
String |
getCpu()
The number of
cpu units used by the task. |
Date |
getDeregisteredAt()
The Unix timestamp for the time when the task definition was deregistered.
|
EphemeralStorage |
getEphemeralStorage()
The ephemeral storage settings to use for tasks run with the task definition.
|
String |
getExecutionRoleArn()
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 |
getFamily()
The name of a family that this task definition is registered to.
|
List<InferenceAccelerator> |
getInferenceAccelerators()
The Elastic Inference accelerator that's associated with the task.
|
String |
getIpcMode()
The IPC resource namespace to use for the containers in the task.
|
String |
getMemory()
The amount (in MiB) of memory used by the task.
|
String |
getNetworkMode()
The Docker networking mode to use for the containers in the task.
|
String |
getPidMode()
The process namespace to use for the containers in the task.
|
List<TaskDefinitionPlacementConstraint> |
getPlacementConstraints()
An array of placement constraint objects to use for tasks.
|
ProxyConfiguration |
getProxyConfiguration()
The configuration details for the App Mesh proxy.
|
Date |
getRegisteredAt()
The Unix timestamp for the time when the task definition was registered.
|
String |
getRegisteredBy()
The principal that registered the task definition.
|
List<Attribute> |
getRequiresAttributes()
The container instance attributes required by your task.
|
List<String> |
getRequiresCompatibilities()
The task launch types the task definition was validated against.
|
Integer |
getRevision()
The revision of the task in a particular family.
|
RuntimePlatform |
getRuntimePlatform()
The operating system that your task definitions are running on.
|
String |
getStatus()
The status of the task definition.
|
String |
getTaskDefinitionArn()
The full Amazon Resource Name (ARN) of the task definition.
|
String |
getTaskRoleArn()
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.
|
List<Volume> |
getVolumes()
The list of data volume definitions for the task.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller. |
void |
setCompatibilities(Collection<String> compatibilities)
The task launch types the task definition validated against during task definition registration.
|
void |
setContainerDefinitions(Collection<ContainerDefinition> containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
|
void |
setCpu(String cpu)
The number of
cpu units used by the task. |
void |
setDeregisteredAt(Date deregisteredAt)
The Unix timestamp for the time when the task definition was deregistered.
|
void |
setEphemeralStorage(EphemeralStorage ephemeralStorage)
The ephemeral storage settings to use for tasks run with the task definition.
|
void |
setExecutionRoleArn(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.
|
void |
setFamily(String family)
The name of a family that this task definition is registered to.
|
void |
setInferenceAccelerators(Collection<InferenceAccelerator> inferenceAccelerators)
The Elastic Inference accelerator that's associated with the task.
|
void |
setIpcMode(IpcMode ipcMode)
The IPC resource namespace to use for the containers in the task.
|
void |
setIpcMode(String ipcMode)
The IPC resource namespace to use for the containers in the task.
|
void |
setMemory(String memory)
The amount (in MiB) of memory used by the task.
|
void |
setNetworkMode(NetworkMode networkMode)
The Docker networking mode to use for the containers in the task.
|
void |
setNetworkMode(String networkMode)
The Docker networking mode to use for the containers in the task.
|
void |
setPidMode(PidMode pidMode)
The process namespace to use for the containers in the task.
|
void |
setPidMode(String pidMode)
The process namespace to use for the containers in the task.
|
void |
setPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks.
|
void |
setProxyConfiguration(ProxyConfiguration proxyConfiguration)
The configuration details for the App Mesh proxy.
|
void |
setRegisteredAt(Date registeredAt)
The Unix timestamp for the time when the task definition was registered.
|
void |
setRegisteredBy(String registeredBy)
The principal that registered the task definition.
|
void |
setRequiresAttributes(Collection<Attribute> requiresAttributes)
The container instance attributes required by your task.
|
void |
setRequiresCompatibilities(Collection<String> requiresCompatibilities)
The task launch types the task definition was validated against.
|
void |
setRevision(Integer revision)
The revision of the task in a particular family.
|
void |
setRuntimePlatform(RuntimePlatform runtimePlatform)
The operating system that your task definitions are running on.
|
void |
setStatus(String status)
The status of the task definition.
|
void |
setStatus(TaskDefinitionStatus status)
The status of the task definition.
|
void |
setTaskDefinitionArn(String taskDefinitionArn)
The full Amazon Resource Name (ARN) of the task definition.
|
void |
setTaskRoleArn(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.
|
void |
setVolumes(Collection<Volume> volumes)
The list of data volume definitions for the task.
|
String |
toString()
Returns a string representation of this object.
|
TaskDefinition |
withCompatibilities(Collection<String> compatibilities)
The task launch types the task definition validated against during task definition registration.
|
TaskDefinition |
withCompatibilities(Compatibility... compatibilities)
The task launch types the task definition validated against during task definition registration.
|
TaskDefinition |
withCompatibilities(String... compatibilities)
The task launch types the task definition validated against during task definition registration.
|
TaskDefinition |
withContainerDefinitions(Collection<ContainerDefinition> containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
|
TaskDefinition |
withContainerDefinitions(ContainerDefinition... containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
|
TaskDefinition |
withCpu(String cpu)
The number of
cpu units used by the task. |
TaskDefinition |
withDeregisteredAt(Date deregisteredAt)
The Unix timestamp for the time when the task definition was deregistered.
|
TaskDefinition |
withEphemeralStorage(EphemeralStorage ephemeralStorage)
The ephemeral storage settings to use for tasks run with the task definition.
|
TaskDefinition |
withExecutionRoleArn(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.
|
TaskDefinition |
withFamily(String family)
The name of a family that this task definition is registered to.
|
TaskDefinition |
withInferenceAccelerators(Collection<InferenceAccelerator> inferenceAccelerators)
The Elastic Inference accelerator that's associated with the task.
|
TaskDefinition |
withInferenceAccelerators(InferenceAccelerator... inferenceAccelerators)
The Elastic Inference accelerator that's associated with the task.
|
TaskDefinition |
withIpcMode(IpcMode ipcMode)
The IPC resource namespace to use for the containers in the task.
|
TaskDefinition |
withIpcMode(String ipcMode)
The IPC resource namespace to use for the containers in the task.
|
TaskDefinition |
withMemory(String memory)
The amount (in MiB) of memory used by the task.
|
TaskDefinition |
withNetworkMode(NetworkMode networkMode)
The Docker networking mode to use for the containers in the task.
|
TaskDefinition |
withNetworkMode(String networkMode)
The Docker networking mode to use for the containers in the task.
|
TaskDefinition |
withPidMode(PidMode pidMode)
The process namespace to use for the containers in the task.
|
TaskDefinition |
withPidMode(String pidMode)
The process namespace to use for the containers in the task.
|
TaskDefinition |
withPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks.
|
TaskDefinition |
withPlacementConstraints(TaskDefinitionPlacementConstraint... placementConstraints)
An array of placement constraint objects to use for tasks.
|
TaskDefinition |
withProxyConfiguration(ProxyConfiguration proxyConfiguration)
The configuration details for the App Mesh proxy.
|
TaskDefinition |
withRegisteredAt(Date registeredAt)
The Unix timestamp for the time when the task definition was registered.
|
TaskDefinition |
withRegisteredBy(String registeredBy)
The principal that registered the task definition.
|
TaskDefinition |
withRequiresAttributes(Attribute... requiresAttributes)
The container instance attributes required by your task.
|
TaskDefinition |
withRequiresAttributes(Collection<Attribute> requiresAttributes)
The container instance attributes required by your task.
|
TaskDefinition |
withRequiresCompatibilities(Collection<String> requiresCompatibilities)
The task launch types the task definition was validated against.
|
TaskDefinition |
withRequiresCompatibilities(Compatibility... requiresCompatibilities)
The task launch types the task definition was validated against.
|
TaskDefinition |
withRequiresCompatibilities(String... requiresCompatibilities)
The task launch types the task definition was validated against.
|
TaskDefinition |
withRevision(Integer revision)
The revision of the task in a particular family.
|
TaskDefinition |
withRuntimePlatform(RuntimePlatform runtimePlatform)
The operating system that your task definitions are running on.
|
TaskDefinition |
withStatus(String status)
The status of the task definition.
|
TaskDefinition |
withStatus(TaskDefinitionStatus status)
The status of the task definition.
|
TaskDefinition |
withTaskDefinitionArn(String taskDefinitionArn)
The full Amazon Resource Name (ARN) of the task definition.
|
TaskDefinition |
withTaskRoleArn(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 |
withVolumes(Collection<Volume> volumes)
The list of data volume definitions for the task.
|
TaskDefinition |
withVolumes(Volume... volumes)
The list of data volume definitions for the task.
|
public void setTaskDefinitionArn(String taskDefinitionArn)
The full Amazon Resource Name (ARN) of the task definition.
taskDefinitionArn - The full Amazon Resource Name (ARN) of the task definition.public String getTaskDefinitionArn()
The full Amazon Resource Name (ARN) of the task definition.
public TaskDefinition withTaskDefinitionArn(String taskDefinitionArn)
The full Amazon Resource Name (ARN) of the task definition.
taskDefinitionArn - The full Amazon Resource Name (ARN) of the task definition.public List<ContainerDefinition> getContainerDefinitions()
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.
public void setContainerDefinitions(Collection<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.
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.public TaskDefinition withContainerDefinitions(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.
NOTE: This method appends the values to the existing list (if any). Use
setContainerDefinitions(java.util.Collection) or withContainerDefinitions(java.util.Collection)
if you want to override the existing values.
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.public TaskDefinition withContainerDefinitions(Collection<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.
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.public void setFamily(String family)
The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), 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.
family - The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters
(both uppercase and lowercase letters), 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.
public String getFamily()
The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), 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.
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.
public TaskDefinition withFamily(String family)
The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), 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.
family - The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters
(both uppercase and lowercase letters), 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.
public void setTaskRoleArn(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 to use the feature. For
more information, see Windows IAM roles
for tasks in the Amazon Elastic Container Service Developer Guide.
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 to use
the feature. For more information, see Windows IAM
roles for tasks in the Amazon Elastic Container Service Developer Guide.
public String getTaskRoleArn()
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 to use the feature. For
more information, see Windows IAM roles
for tasks 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 to use
the feature. For more information, see Windows
IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.
public TaskDefinition withTaskRoleArn(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 to use the feature. For
more information, see Windows IAM roles
for tasks in the Amazon Elastic Container Service Developer Guide.
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 to use
the feature. For more information, see Windows IAM
roles for tasks in the Amazon Elastic Container Service Developer Guide.
public void setExecutionRoleArn(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.
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.public String getExecutionRoleArn()
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.
public TaskDefinition withExecutionRoleArn(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.
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.public void setNetworkMode(String 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.
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.
NetworkModepublic String getNetworkMode()
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.
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.
NetworkModepublic TaskDefinition withNetworkMode(String 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.
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.
NetworkModepublic void setNetworkMode(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.
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.
NetworkModepublic TaskDefinition withNetworkMode(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.
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.
NetworkModepublic void setRevision(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.
This is even if you deregistered previous revisions in this family.
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. This is even if you deregistered previous revisions in this family.public Integer getRevision()
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.
This is even if you deregistered previous revisions in this family.
1. Each
time that you register a new revision of a task definition in the same family, the revision value always
increases by one. This is even if you deregistered previous revisions in this family.public TaskDefinition withRevision(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.
This is even if you deregistered previous revisions in this family.
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. This is even if you deregistered previous revisions in this family.public List<Volume> getVolumes()
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 aren't supported for tasks run on Fargate.
The host and sourcePath parameters aren't supported for tasks run on Fargate.
public void setVolumes(Collection<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 aren't supported for tasks run on Fargate.
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 aren't supported for tasks run on Fargate.
public TaskDefinition withVolumes(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 aren't supported for tasks run on Fargate.
NOTE: This method appends the values to the existing list (if any). Use
setVolumes(java.util.Collection) or withVolumes(java.util.Collection) if you want to override
the existing values.
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 aren't supported for tasks run on Fargate.
public TaskDefinition withVolumes(Collection<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 aren't supported for tasks run on Fargate.
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 aren't supported for tasks run on Fargate.
public void setStatus(String status)
The status of the task definition.
status - The status of the task definition.TaskDefinitionStatuspublic String getStatus()
The status of the task definition.
TaskDefinitionStatuspublic TaskDefinition withStatus(String status)
The status of the task definition.
status - The status of the task definition.TaskDefinitionStatuspublic void setStatus(TaskDefinitionStatus status)
The status of the task definition.
status - The status of the task definition.TaskDefinitionStatuspublic TaskDefinition withStatus(TaskDefinitionStatus status)
The status of the task definition.
status - The status of the task definition.TaskDefinitionStatuspublic List<Attribute> getRequiresAttributes()
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. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
This parameter isn't supported for tasks run on Fargate.
This parameter isn't supported for tasks run on Fargate.
public void setRequiresAttributes(Collection<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. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
This parameter isn't supported for tasks run on Fargate.
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. These are specified as key-value pairs using the Amazon ECS console or the
PutAttributes API. These attributes are used when determining task placement for tasks hosted on
Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide. This parameter isn't supported for tasks run on Fargate.
public TaskDefinition withRequiresAttributes(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. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
This parameter isn't supported for tasks run on Fargate.
NOTE: This method appends the values to the existing list (if any). Use
setRequiresAttributes(java.util.Collection) or withRequiresAttributes(java.util.Collection) if
you want to override the existing values.
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. These are specified as key-value pairs using the Amazon ECS console or the
PutAttributes API. These attributes are used when determining task placement for tasks hosted on
Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide. This parameter isn't supported for tasks run on Fargate.
public TaskDefinition withRequiresAttributes(Collection<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. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
This parameter isn't supported for tasks run on Fargate.
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. These are specified as key-value pairs using the Amazon ECS console or the
PutAttributes API. These attributes are used when determining task placement for tasks hosted on
Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide. This parameter isn't supported for tasks run on Fargate.
public List<TaskDefinitionPlacementConstraint> getPlacementConstraints()
An array of placement constraint objects to use for tasks.
This parameter isn't supported for tasks run on Fargate.
This parameter isn't supported for tasks run on Fargate.
public void setPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks.
This parameter isn't supported for tasks run on Fargate.
placementConstraints - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on Fargate.
public TaskDefinition withPlacementConstraints(TaskDefinitionPlacementConstraint... placementConstraints)
An array of placement constraint objects to use for tasks.
This parameter isn't supported for tasks run on Fargate.
NOTE: This method appends the values to the existing list (if any). Use
setPlacementConstraints(java.util.Collection) or withPlacementConstraints(java.util.Collection)
if you want to override the existing values.
placementConstraints - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on Fargate.
public TaskDefinition withPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks.
This parameter isn't supported for tasks run on Fargate.
placementConstraints - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on Fargate.
public List<String> getCompatibilities()
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.
Compatibilitypublic void setCompatibilities(Collection<String> 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.
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.Compatibilitypublic TaskDefinition withCompatibilities(String... 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.
NOTE: This method appends the values to the existing list (if any). Use
setCompatibilities(java.util.Collection) or withCompatibilities(java.util.Collection) if you
want to override the existing values.
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.Compatibilitypublic TaskDefinition withCompatibilities(Collection<String> 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.
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.Compatibilitypublic TaskDefinition withCompatibilities(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.
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.Compatibilitypublic void setRuntimePlatform(RuntimePlatform runtimePlatform)
The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.
When you specify a task in a service, this value must match the runtimePlatform value of the
service.
runtimePlatform - The operating system that your task definitions are running on. A platform family is specified only for
tasks using the Fargate launch type.
When you specify a task in a service, this value must match the runtimePlatform value of the
service.
public RuntimePlatform getRuntimePlatform()
The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.
When you specify a task in a service, this value must match the runtimePlatform value of the
service.
When you specify a task in a service, this value must match the runtimePlatform value of the
service.
public TaskDefinition withRuntimePlatform(RuntimePlatform runtimePlatform)
The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.
When you specify a task in a service, this value must match the runtimePlatform value of the
service.
runtimePlatform - The operating system that your task definitions are running on. A platform family is specified only for
tasks using the Fargate launch type.
When you specify a task in a service, this value must match the runtimePlatform value of the
service.
public List<String> getRequiresCompatibilities()
The task launch types the task definition was validated against. The valid values are EC2,
FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types
in the Amazon Elastic Container Service Developer Guide.
EC2,
FARGATE, and EXTERNAL. For more information, see Amazon ECS launch
types in the Amazon Elastic Container Service Developer Guide.Compatibilitypublic void setRequiresCompatibilities(Collection<String> requiresCompatibilities)
The task launch types the task definition was validated against. The valid values are EC2,
FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types
in the Amazon Elastic Container Service Developer Guide.
requiresCompatibilities - The task launch types the task definition was validated against. The valid values are EC2,
FARGATE, and EXTERNAL. For more information, see Amazon ECS launch
types in the Amazon Elastic Container Service Developer Guide.Compatibilitypublic TaskDefinition withRequiresCompatibilities(String... requiresCompatibilities)
The task launch types the task definition was validated against. The valid values are EC2,
FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types
in the Amazon Elastic Container Service Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setRequiresCompatibilities(java.util.Collection) or
withRequiresCompatibilities(java.util.Collection) if you want to override the existing values.
requiresCompatibilities - The task launch types the task definition was validated against. The valid values are EC2,
FARGATE, and EXTERNAL. For more information, see Amazon ECS launch
types in the Amazon Elastic Container Service Developer Guide.Compatibilitypublic TaskDefinition withRequiresCompatibilities(Collection<String> requiresCompatibilities)
The task launch types the task definition was validated against. The valid values are EC2,
FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types
in the Amazon Elastic Container Service Developer Guide.
requiresCompatibilities - The task launch types the task definition was validated against. The valid values are EC2,
FARGATE, and EXTERNAL. For more information, see Amazon ECS launch
types in the Amazon Elastic Container Service Developer Guide.Compatibilitypublic TaskDefinition withRequiresCompatibilities(Compatibility... requiresCompatibilities)
The task launch types the task definition was validated against. The valid values are EC2,
FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types
in the Amazon Elastic Container Service Developer Guide.
requiresCompatibilities - The task launch types the task definition was validated against. The valid values are EC2,
FARGATE, and EXTERNAL. For more information, see Amazon ECS launch
types in the Amazon Elastic Container Service Developer Guide.Compatibilitypublic void setCpu(String cpu)
The number of cpu units used by the task. If you use the EC2 launch type, this field is optional.
Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the
following values. The value that you choose determines your range of valid values for the memory
parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
cpu - The number of cpu units used by the task. If you use the EC2 launch type, this field is
optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use
one of the following values. The value that you choose determines your range of valid values for the
memory parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024
(1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024
(1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
public String getCpu()
The number of cpu units used by the task. If you use the EC2 launch type, this field is optional.
Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the
following values. The value that you choose determines your range of valid values for the memory
parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
cpu units used by the task. If you use the EC2 launch type, this field is
optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use
one of the following values. The value that you choose determines your range of valid values for the
memory parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024
(1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024
(1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
public TaskDefinition withCpu(String cpu)
The number of cpu units used by the task. If you use the EC2 launch type, this field is optional.
Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the
following values. The value that you choose determines your range of valid values for the memory
parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
cpu - The number of cpu units used by the task. If you use the EC2 launch type, this field is
optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use
one of the following values. The value that you choose determines your range of valid values for the
memory parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024
(1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024
(1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
public void setMemory(String memory)
The amount (in MiB) of memory used by the task.
If your tasks runs 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, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you
choose 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)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or later.
memory - The amount (in MiB) of memory used by the task.
If your tasks runs 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, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks runs on Fargate, this field is required. You must use one of the following values. The value
you choose 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)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or later.
public String getMemory()
The amount (in MiB) of memory used by the task.
If your tasks runs 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, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you
choose 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)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or later.
If your tasks runs 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, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks runs on Fargate, this field is required. You must use one of the following values. The
value you choose 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)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or later.
public TaskDefinition withMemory(String memory)
The amount (in MiB) of memory used by the task.
If your tasks runs 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, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you
choose 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)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or later.
memory - The amount (in MiB) of memory used by the task.
If your tasks runs 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, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks runs on Fargate, this field is required. You must use one of the following values. The value
you choose 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)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or later.
public List<InferenceAccelerator> getInferenceAccelerators()
The Elastic Inference accelerator that's associated with the task.
public void setInferenceAccelerators(Collection<InferenceAccelerator> inferenceAccelerators)
The Elastic Inference accelerator that's associated with the task.
inferenceAccelerators - The Elastic Inference accelerator that's associated with the task.public TaskDefinition withInferenceAccelerators(InferenceAccelerator... inferenceAccelerators)
The Elastic Inference accelerator that's associated with the task.
NOTE: This method appends the values to the existing list (if any). Use
setInferenceAccelerators(java.util.Collection) or
withInferenceAccelerators(java.util.Collection) if you want to override the existing values.
inferenceAccelerators - The Elastic Inference accelerator that's associated with the task.public TaskDefinition withInferenceAccelerators(Collection<InferenceAccelerator> inferenceAccelerators)
The Elastic Inference accelerator that's associated with the task.
inferenceAccelerators - The Elastic Inference accelerator that's associated with the task.public void setPidMode(String pidMode)
The process namespace to use for the containers in the task. The valid values are host or
task. On Fargate for Linux containers, the only valid value is task. For example,
monitoring sidecars might need pidMode to access information about other containers running in the
same task.
If host is specified, 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 each container. For more information, see PID settings in the Docker run reference.
If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For
more information, see Docker security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version
1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
pidMode - The process namespace to use for the containers in the task. The valid values are host or
task. On Fargate for Linux containers, the only valid value is task. For
example, monitoring sidecars might need pidMode to access information about other containers
running in the same task.
If host is specified, 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 each container. For more information, see PID settings in the Docker run reference.
If the host PID mode is used, there's a heightened risk of undesired process namespace
exposure. For more information, see Docker
security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform
version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
PidModepublic String getPidMode()
The process namespace to use for the containers in the task. The valid values are host or
task. On Fargate for Linux containers, the only valid value is task. For example,
monitoring sidecars might need pidMode to access information about other containers running in the
same task.
If host is specified, 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 each container. For more information, see PID settings in the Docker run reference.
If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For
more information, see Docker security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version
1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
host or
task. On Fargate for Linux containers, the only valid value is task. For
example, monitoring sidecars might need pidMode to access information about other containers
running in the same task.
If host is specified, 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 each container. For more information, see PID settings in the Docker run reference.
If the host PID mode is used, there's a heightened risk of undesired process namespace
exposure. For more information, see Docker
security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform
version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
PidModepublic TaskDefinition withPidMode(String pidMode)
The process namespace to use for the containers in the task. The valid values are host or
task. On Fargate for Linux containers, the only valid value is task. For example,
monitoring sidecars might need pidMode to access information about other containers running in the
same task.
If host is specified, 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 each container. For more information, see PID settings in the Docker run reference.
If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For
more information, see Docker security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version
1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
pidMode - The process namespace to use for the containers in the task. The valid values are host or
task. On Fargate for Linux containers, the only valid value is task. For
example, monitoring sidecars might need pidMode to access information about other containers
running in the same task.
If host is specified, 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 each container. For more information, see PID settings in the Docker run reference.
If the host PID mode is used, there's a heightened risk of undesired process namespace
exposure. For more information, see Docker
security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform
version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
PidModepublic void setPidMode(PidMode pidMode)
The process namespace to use for the containers in the task. The valid values are host or
task. On Fargate for Linux containers, the only valid value is task. For example,
monitoring sidecars might need pidMode to access information about other containers running in the
same task.
If host is specified, 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 each container. For more information, see PID settings in the Docker run reference.
If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For
more information, see Docker security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version
1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
pidMode - The process namespace to use for the containers in the task. The valid values are host or
task. On Fargate for Linux containers, the only valid value is task. For
example, monitoring sidecars might need pidMode to access information about other containers
running in the same task.
If host is specified, 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 each container. For more information, see PID settings in the Docker run reference.
If the host PID mode is used, there's a heightened risk of undesired process namespace
exposure. For more information, see Docker
security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform
version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
PidModepublic TaskDefinition withPidMode(PidMode pidMode)
The process namespace to use for the containers in the task. The valid values are host or
task. On Fargate for Linux containers, the only valid value is task. For example,
monitoring sidecars might need pidMode to access information about other containers running in the
same task.
If host is specified, 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 each container. For more information, see PID settings in the Docker run reference.
If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For
more information, see Docker security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version
1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
pidMode - The process namespace to use for the containers in the task. The valid values are host or
task. On Fargate for Linux containers, the only valid value is task. For
example, monitoring sidecars might need pidMode to access information about other containers
running in the same task.
If host is specified, 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 each container. For more information, see PID settings in the Docker run reference.
If the host PID mode is used, there's a heightened risk of undesired process namespace
exposure. For more information, see Docker
security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform
version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
PidModepublic void setIpcMode(String 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.
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.
IpcModepublic String getIpcMode()
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.
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.
IpcModepublic TaskDefinition withIpcMode(String 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.
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.
IpcModepublic void setIpcMode(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.
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.
IpcModepublic TaskDefinition withIpcMode(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.
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.
IpcModepublic void setProxyConfiguration(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 use a proxy configuration. If your container instances are
launched from the Amazon ECS optimized AMI version 20190301 or later, 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.
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 use a proxy configuration. If your container
instances are launched from the Amazon ECS optimized AMI version 20190301 or later, 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.
public ProxyConfiguration getProxyConfiguration()
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 use a proxy configuration. If your container instances are
launched from the Amazon ECS optimized AMI version 20190301 or later, 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.
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 use a proxy configuration. If your container
instances are launched from the Amazon ECS optimized AMI version 20190301 or later, 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.
public TaskDefinition withProxyConfiguration(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 use a proxy configuration. If your container instances are
launched from the Amazon ECS optimized AMI version 20190301 or later, 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.
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 use a proxy configuration. If your container
instances are launched from the Amazon ECS optimized AMI version 20190301 or later, 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.
public void setRegisteredAt(Date registeredAt)
The Unix timestamp for the time when the task definition was registered.
registeredAt - The Unix timestamp for the time when the task definition was registered.public Date getRegisteredAt()
The Unix timestamp for the time when the task definition was registered.
public TaskDefinition withRegisteredAt(Date registeredAt)
The Unix timestamp for the time when the task definition was registered.
registeredAt - The Unix timestamp for the time when the task definition was registered.public void setDeregisteredAt(Date deregisteredAt)
The Unix timestamp for the time when the task definition was deregistered.
deregisteredAt - The Unix timestamp for the time when the task definition was deregistered.public Date getDeregisteredAt()
The Unix timestamp for the time when the task definition was deregistered.
public TaskDefinition withDeregisteredAt(Date deregisteredAt)
The Unix timestamp for the time when the task definition was deregistered.
deregisteredAt - The Unix timestamp for the time when the task definition was deregistered.public void setRegisteredBy(String registeredBy)
The principal that registered the task definition.
registeredBy - The principal that registered the task definition.public String getRegisteredBy()
The principal that registered the task definition.
public TaskDefinition withRegisteredBy(String registeredBy)
The principal that registered the task definition.
registeredBy - The principal that registered the task definition.public void setEphemeralStorage(EphemeralStorage ephemeralStorage)
The ephemeral storage settings to use for tasks run with the task definition.
ephemeralStorage - The ephemeral storage settings to use for tasks run with the task definition.public EphemeralStorage getEphemeralStorage()
The ephemeral storage settings to use for tasks run with the task definition.
public TaskDefinition withEphemeralStorage(EphemeralStorage ephemeralStorage)
The ephemeral storage settings to use for tasks run with the task definition.
ephemeralStorage - The ephemeral storage settings to use for tasks run with the task definition.public String toString()
toString in class ObjectObject.toString()public TaskDefinition clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.