@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class TaskDefinition extends Object implements Serializable, Cloneable, StructuredPojo
Details of a task definition.
| Constructor and Description |
|---|
TaskDefinition() |
| Modifier and Type | Method and Description |
|---|---|
TaskDefinition |
clone() |
boolean |
equals(Object obj) |
List<String> |
getCompatibilities()
The launch type to use with your task.
|
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. |
String |
getExecutionRoleArn()
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker
daemon can assume.
|
String |
getFamily()
The family of your task definition, used as the definition name.
|
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.
|
List<TaskDefinitionPlacementConstraint> |
getPlacementConstraints()
An array of placement constraint objects to use for tasks.
|
List<Attribute> |
getRequiresAttributes()
The container instance attributes required by your task.
|
List<String> |
getRequiresCompatibilities()
The launch type the task is using.
|
Integer |
getRevision()
The revision of the task in a particular family.
|
String |
getStatus()
The status of the task definition.
|
String |
getTaskDefinitionArn()
The full Amazon Resource Name (ARN) of the task definition.
|
String |
getTaskRoleArn()
The ARN of the IAM role that containers in this task can assume.
|
List<Volume> |
getVolumes()
The list of volumes in a task.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller. |
void |
setCompatibilities(Collection<String> compatibilities)
The launch type to use with your task.
|
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 |
setExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker
daemon can assume.
|
void |
setFamily(String family)
The family of your task definition, used as the definition name.
|
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 |
setPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks.
|
void |
setRequiresAttributes(Collection<Attribute> requiresAttributes)
The container instance attributes required by your task.
|
void |
setRequiresCompatibilities(Collection<String> requiresCompatibilities)
The launch type the task is using.
|
void |
setRevision(Integer revision)
The revision of the task in a particular family.
|
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 ARN of the IAM role that containers in this task can assume.
|
void |
setVolumes(Collection<Volume> volumes)
The list of volumes in a task.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
TaskDefinition |
withCompatibilities(Collection<String> compatibilities)
The launch type to use with your task.
|
TaskDefinition |
withCompatibilities(Compatibility... compatibilities)
The launch type to use with your task.
|
TaskDefinition |
withCompatibilities(String... compatibilities)
The launch type to use with your task.
|
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 |
withExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker
daemon can assume.
|
TaskDefinition |
withFamily(String family)
The family of your task definition, used as the definition name.
|
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 |
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 |
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 launch type the task is using.
|
TaskDefinition |
withRequiresCompatibilities(Compatibility... requiresCompatibilities)
The launch type the task is using.
|
TaskDefinition |
withRequiresCompatibilities(String... requiresCompatibilities)
The launch type the task is using.
|
TaskDefinition |
withRevision(Integer revision)
The revision of the task in a particular family.
|
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 ARN of the IAM role that containers in this task can assume.
|
TaskDefinition |
withVolumes(Collection<Volume> volumes)
The list of volumes in a task.
|
TaskDefinition |
withVolumes(Volume... volumes)
The list of volumes in a 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 family of your task definition, used as the definition name.
family - The family of your task definition, used as the definition name.public String getFamily()
The family of your task definition, used as the definition name.
public TaskDefinition withFamily(String family)
The family of your task definition, used as the definition name.
family - The family of your task definition, used as the definition name.public void setTaskRoleArn(String taskRoleArn)
The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the
Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take
advantage of the feature. For more information, see Windows IAM Roles
for Tasks in the Amazon Elastic Container Service Developer Guide.
taskRoleArn - The ARN of the IAM role that containers in this task can assume. All containers in this task are granted
the permissions that are specified in this role.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you
launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in
order to take advantage of the feature. For more information, see Windows IAM
Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
public String getTaskRoleArn()
The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the
Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take
advantage of the feature. For more information, see Windows IAM Roles
for Tasks in the Amazon Elastic Container Service Developer Guide.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you
launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in
order to take advantage of the feature. For more information, see Windows IAM
Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
public TaskDefinition withTaskRoleArn(String taskRoleArn)
The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the
Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take
advantage of the feature. For more information, see Windows IAM Roles
for Tasks in the Amazon Elastic Container Service Developer Guide.
taskRoleArn - The ARN of the IAM role that containers in this task can assume. All containers in this task are granted
the permissions that are specified in this role.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you
launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in
order to take advantage of the feature. For more information, see Windows IAM
Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
public void setExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
executionRoleArn - The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the
Docker daemon can assume.public String getExecutionRoleArn()
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
public TaskDefinition withExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
executionRoleArn - The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the
Docker daemon can assume.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. The default Docker network mode is
bridge. If using the Fargate launch type, the awsvpc network mode is required. If using
the EC2 launch type, any network mode can be used. If the network mode is set to none, you can't
specify port mappings in your container definitions, and the task's 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.
If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must
specify a NetworkConfiguration 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.
Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants with the ecs-init package,
or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host, you can't run multiple instantiations of the same task on a single
container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with
Windows containers, you must not specify a network mode. If you use the console to register a task definition
with Windows containers, you must choose the <default> network mode object.
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. The default Docker network mode is
bridge. If using the Fargate launch type, the awsvpc network mode is required.
If using the EC2 launch type, any network mode can be used. If the network mode is set to
none, you can't specify port mappings in your container definitions, and the task's
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.
If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you
must specify a NetworkConfiguration 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.
Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants with the ecs-init
package, or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host, you can't run multiple instantiations of the same task on a
single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition
with Windows containers, you must not specify a network mode. If you use the console to register a task
definition with Windows containers, you must choose the <default> network mode object.
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. The default Docker network mode is
bridge. If using the Fargate launch type, the awsvpc network mode is required. If using
the EC2 launch type, any network mode can be used. If the network mode is set to none, you can't
specify port mappings in your container definitions, and the task's 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.
If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must
specify a NetworkConfiguration 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.
Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants with the ecs-init package,
or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host, you can't run multiple instantiations of the same task on a single
container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with
Windows containers, you must not specify a network mode. If you use the console to register a task definition
with Windows containers, you must choose the <default> network mode object.
For more information, see Network settings in the Docker run reference.
none,
bridge, awsvpc, and host. The default Docker network mode is
bridge. If using the Fargate launch type, the awsvpc network mode is required.
If using the EC2 launch type, any network mode can be used. If the network mode is set to
none, you can't specify port mappings in your container definitions, and the task's
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.
If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you
must specify a NetworkConfiguration 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.
Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants with the ecs-init
package, or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host, you can't run multiple instantiations of the same task on a
single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task
definition with Windows containers, you must not specify a network mode. If you use the console to
register a task definition with Windows containers, you must choose the <default>
network mode object.
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. The default Docker network mode is
bridge. If using the Fargate launch type, the awsvpc network mode is required. If using
the EC2 launch type, any network mode can be used. If the network mode is set to none, you can't
specify port mappings in your container definitions, and the task's 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.
If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must
specify a NetworkConfiguration 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.
Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants with the ecs-init package,
or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host, you can't run multiple instantiations of the same task on a single
container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with
Windows containers, you must not specify a network mode. If you use the console to register a task definition
with Windows containers, you must choose the <default> network mode object.
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. The default Docker network mode is
bridge. If using the Fargate launch type, the awsvpc network mode is required.
If using the EC2 launch type, any network mode can be used. If the network mode is set to
none, you can't specify port mappings in your container definitions, and the task's
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.
If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you
must specify a NetworkConfiguration 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.
Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants with the ecs-init
package, or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host, you can't run multiple instantiations of the same task on a
single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition
with Windows containers, you must not specify a network mode. If you use the console to register a task
definition with Windows containers, you must choose the <default> network mode object.
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. The default Docker network mode is
bridge. If using the Fargate launch type, the awsvpc network mode is required. If using
the EC2 launch type, any network mode can be used. If the network mode is set to none, you can't
specify port mappings in your container definitions, and the task's 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.
If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must
specify a NetworkConfiguration 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.
Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants with the ecs-init package,
or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host, you can't run multiple instantiations of the same task on a single
container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with
Windows containers, you must not specify a network mode. If you use the console to register a task definition
with Windows containers, you must choose the <default> network mode object.
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. The default Docker network mode is
bridge. If using the Fargate launch type, the awsvpc network mode is required.
If using the EC2 launch type, any network mode can be used. If the network mode is set to
none, you can't specify port mappings in your container definitions, and the task's
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.
If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you
must specify a NetworkConfiguration 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.
Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants with the ecs-init
package, or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host, you can't run multiple instantiations of the same task on a
single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition
with Windows containers, you must not specify a network mode. If you use the console to register a task
definition with Windows containers, you must choose the <default> network mode object.
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. The default Docker network mode is
bridge. If using the Fargate launch type, the awsvpc network mode is required. If using
the EC2 launch type, any network mode can be used. If the network mode is set to none, you can't
specify port mappings in your container definitions, and the task's 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.
If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must
specify a NetworkConfiguration 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.
Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants with the ecs-init package,
or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host, you can't run multiple instantiations of the same task on a single
container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with
Windows containers, you must not specify a network mode. If you use the console to register a task definition
with Windows containers, you must choose the <default> network mode object.
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. The default Docker network mode is
bridge. If using the Fargate launch type, the awsvpc network mode is required.
If using the EC2 launch type, any network mode can be used. If the network mode is set to
none, you can't specify port mappings in your container definitions, and the task's
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.
If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you
must specify a NetworkConfiguration 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.
Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants with the ecs-init
package, or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host, you can't run multiple instantiations of the same task on a
single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition
with Windows containers, you must not specify a network mode. If you use the console to register a task
definition with Windows containers, you must choose the <default> network mode object.
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 you
register a new revision of a task definition in the same family, the revision value always increases by one (even
if you have deregistered previous revisions in this family).
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 you register a new revision of a task definition in the same family, the revision value always
increases by one (even if you have deregistered previous revisions in this family).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 you
register a new revision of a task definition in the same family, the revision value always increases by one (even
if you have deregistered previous revisions in this family).
1; each
time you register a new revision of a task definition in the same family, the revision value always
increases by one (even if you have deregistered previous revisions in this family).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 you
register a new revision of a task definition in the same family, the revision value always increases by one (even
if you have deregistered previous revisions in this family).
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 you register a new revision of a task definition in the same family, the revision value always
increases by one (even if you have deregistered previous revisions in this family).public List<Volume> getVolumes()
The list of volumes in a task.
If you are using the Fargate launch type, the host and sourcePath parameters are not
supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
If you are using the Fargate launch type, the host and sourcePath parameters
are not supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
public void setVolumes(Collection<Volume> volumes)
The list of volumes in a task.
If you are using the Fargate launch type, the host and sourcePath parameters are not
supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
volumes - The list of volumes in a task.
If you are using the Fargate launch type, the host and sourcePath parameters are
not supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
public TaskDefinition withVolumes(Volume... volumes)
The list of volumes in a task.
If you are using the Fargate launch type, the host and sourcePath parameters are not
supported.
For more information about volume 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
setVolumes(java.util.Collection) or withVolumes(java.util.Collection) if you want to override
the existing values.
volumes - The list of volumes in a task.
If you are using the Fargate launch type, the host and sourcePath parameters are
not supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
public TaskDefinition withVolumes(Collection<Volume> volumes)
The list of volumes in a task.
If you are using the Fargate launch type, the host and sourcePath parameters are not
supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
volumes - The list of volumes in a task.
If you are using the Fargate launch type, the host and sourcePath parameters are
not supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
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. This field is not valid if using the Fargate launch type for your task.
public void setRequiresAttributes(Collection<Attribute> requiresAttributes)
The container instance attributes required by your task. This field is not valid if using the Fargate launch type for your task.
requiresAttributes - The container instance attributes required by your task. This field is not valid if using the Fargate
launch type for your task.public TaskDefinition withRequiresAttributes(Attribute... requiresAttributes)
The container instance attributes required by your task. This field is not valid if using the Fargate launch type for your task.
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. This field is not valid if using the Fargate
launch type for your task.public TaskDefinition withRequiresAttributes(Collection<Attribute> requiresAttributes)
The container instance attributes required by your task. This field is not valid if using the Fargate launch type for your task.
requiresAttributes - The container instance attributes required by your task. This field is not valid if using the Fargate
launch type for your task.public List<TaskDefinitionPlacementConstraint> getPlacementConstraints()
An array of placement constraint objects to use for tasks. This field is not valid if using the Fargate launch type for your task.
public void setPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks. This field is not valid if using the Fargate launch type for your task.
placementConstraints - An array of placement constraint objects to use for tasks. This field is not valid if using the Fargate
launch type for your task.public TaskDefinition withPlacementConstraints(TaskDefinitionPlacementConstraint... placementConstraints)
An array of placement constraint objects to use for tasks. This field is not valid if using the Fargate launch type for your task.
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 field is not valid if using the Fargate
launch type for your task.public TaskDefinition withPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks. This field is not valid if using the Fargate launch type for your task.
placementConstraints - An array of placement constraint objects to use for tasks. This field is not valid if using the Fargate
launch type for your task.public List<String> getCompatibilities()
The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
Compatibilitypublic void setCompatibilities(Collection<String> compatibilities)
The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
compatibilities - The launch type to use with your task. For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.Compatibilitypublic TaskDefinition withCompatibilities(String... compatibilities)
The launch type to use with your task. 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 launch type to use with your task. For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.Compatibilitypublic TaskDefinition withCompatibilities(Collection<String> compatibilities)
The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
compatibilities - The launch type to use with your task. For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.Compatibilitypublic TaskDefinition withCompatibilities(Compatibility... compatibilities)
The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
compatibilities - The launch type to use with your task. For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.Compatibilitypublic List<String> getRequiresCompatibilities()
The launch type the task is using.
Compatibilitypublic void setRequiresCompatibilities(Collection<String> requiresCompatibilities)
The launch type the task is using.
requiresCompatibilities - The launch type the task is using.Compatibilitypublic TaskDefinition withRequiresCompatibilities(String... requiresCompatibilities)
The launch type the task is using.
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 launch type the task is using.Compatibilitypublic TaskDefinition withRequiresCompatibilities(Collection<String> requiresCompatibilities)
The launch type the task is using.
requiresCompatibilities - The launch type the task is using.Compatibilitypublic TaskDefinition withRequiresCompatibilities(Compatibility... requiresCompatibilities)
The launch type the task is using.
requiresCompatibilities - The launch type the task is using.Compatibilitypublic void setCpu(String cpu)
The number of cpu units used by the task. If using the EC2 launch type, this field is optional and
any value can be used. If using the Fargate launch type, this field is required and you must use one of the
following values, which determines your range of valid values for the memory parameter:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6
GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024
(1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024
(1 GB)
cpu - The number of cpu units used by the task. If using the EC2 launch type, this field is
optional and any value can be used. If using the Fargate launch type, this field is required and you must
use one of the following values, which determines your range of valid values for the memory
parameter:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB),
6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments
of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments
of 1024 (1 GB)
public String getCpu()
The number of cpu units used by the task. If using the EC2 launch type, this field is optional and
any value can be used. If using the Fargate launch type, this field is required and you must use one of the
following values, which determines your range of valid values for the memory parameter:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6
GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024
(1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024
(1 GB)
cpu units used by the task. If using the EC2 launch type, this field is
optional and any value can be used. If using the Fargate launch type, this field is required and you must
use one of the following values, which determines your range of valid values for the memory
parameter:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB),
6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments
of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments
of 1024 (1 GB)
public TaskDefinition withCpu(String cpu)
The number of cpu units used by the task. If using the EC2 launch type, this field is optional and
any value can be used. If using the Fargate launch type, this field is required and you must use one of the
following values, which determines your range of valid values for the memory parameter:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6
GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024
(1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024
(1 GB)
cpu - The number of cpu units used by the task. If using the EC2 launch type, this field is
optional and any value can be used. If using the Fargate launch type, this field is required and you must
use one of the following values, which determines your range of valid values for the memory
parameter:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB),
6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments
of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments
of 1024 (1 GB)
public void setMemory(String memory)
The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any
value can be used. If using the Fargate launch type, this field is required and you must use one of the following
values, which determines your range of valid values for the 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)
memory - The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and
any value can be used. If using the Fargate launch type, this field is required and you must use one of
the following values, which determines your range of valid values for the 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)
public String getMemory()
The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any
value can be used. If using the Fargate launch type, this field is required and you must use one of the following
values, which determines your range of valid values for the 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)
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)
public TaskDefinition withMemory(String memory)
The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any
value can be used. If using the Fargate launch type, this field is required and you must use one of the following
values, which determines your range of valid values for the 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)
memory - The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and
any value can be used. If using the Fargate launch type, this field is required and you must use one of
the following values, which determines your range of valid values for the 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)
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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.