@Generated(value="software.amazon.awssdk:codegen") public final class TaskDefinition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TaskDefinition.Builder,TaskDefinition>
Details of a task definition.
Modifier and Type | Class and Description |
---|---|
static interface |
TaskDefinition.Builder |
Modifier and Type | Method and Description |
---|---|
static TaskDefinition.Builder |
builder() |
List<Compatibility> |
compatibilities()
The launch type to use with your task.
|
List<String> |
compatibilitiesAsStrings()
The launch type to use with your task.
|
List<ContainerDefinition> |
containerDefinitions()
A list of container definitions in JSON format that describe the different containers that make up your task.
|
String |
cpu()
The number of
cpu units used by the task. |
boolean |
equals(Object obj) |
String |
executionRoleArn()
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker
daemon can assume.
|
String |
family()
The family of your task definition, used as the definition name.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
IpcMode |
ipcMode()
The IPC resource namespace to use for the containers in the task.
|
String |
ipcModeAsString()
The IPC resource namespace to use for the containers in the task.
|
String |
memory()
The amount (in MiB) of memory used by the task.
|
NetworkMode |
networkMode()
The Docker networking mode to use for the containers in the task.
|
String |
networkModeAsString()
The Docker networking mode to use for the containers in the task.
|
PidMode |
pidMode()
The process namespace to use for the containers in the task.
|
String |
pidModeAsString()
The process namespace to use for the containers in the task.
|
List<TaskDefinitionPlacementConstraint> |
placementConstraints()
An array of placement constraint objects to use for tasks.
|
List<Attribute> |
requiresAttributes()
The container instance attributes required by your task.
|
List<Compatibility> |
requiresCompatibilities()
The launch type that the task is using.
|
List<String> |
requiresCompatibilitiesAsStrings()
The launch type that the task is using.
|
Integer |
revision()
The revision of the task in a particular family.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends TaskDefinition.Builder> |
serializableBuilderClass() |
TaskDefinitionStatus |
status()
The status of the task definition.
|
String |
statusAsString()
The status of the task definition.
|
String |
taskDefinitionArn()
The full Amazon Resource Name (ARN) of the task definition.
|
String |
taskRoleArn()
The ARN of the IAM role that containers in this task can assume.
|
TaskDefinition.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<Volume> |
volumes()
The list of volumes in a task.
|
copy
public String taskDefinitionArn()
The full Amazon Resource Name (ARN) of the task definition.
public List<ContainerDefinition> containerDefinitions()
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String family()
The family of your task definition, used as the definition name.
public 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.
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 executionRoleArn()
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
public 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 you are using the Fargate launch type, the awsvpc
network mode is required.
If you are using the EC2 launch type, any network mode 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.
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.
Currently, only Amazon ECS-optimized AMIs, 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 cannot 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.
If the service returns an enum value that is not available in the current SDK version, networkMode
will
return NetworkMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
networkModeAsString()
.
none
,
bridge
, awsvpc
, and host
. The default Docker network mode is
bridge
. If you are using the Fargate launch type, the awsvpc
network mode is
required. If you are using the EC2 launch type, any network mode 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.
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.
Currently, only Amazon ECS-optimized AMIs, 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 cannot 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
public String networkModeAsString()
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 you are using the Fargate launch type, the awsvpc
network mode is required.
If you are using the EC2 launch type, any network mode 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.
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.
Currently, only Amazon ECS-optimized AMIs, 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 cannot 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.
If the service returns an enum value that is not available in the current SDK version, networkMode
will
return NetworkMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
networkModeAsString()
.
none
,
bridge
, awsvpc
, and host
. The default Docker network mode is
bridge
. If you are using the Fargate launch type, the awsvpc
network mode is
required. If you are using the EC2 launch type, any network mode 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.
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.
Currently, only Amazon ECS-optimized AMIs, 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 cannot 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
public Integer revision()
The revision of the task in a particular family. The revision is a version number of a task definition in a
family. When you register a task definition for the first time, the revision is 1
. Each time that
you register a new revision of a task definition in the same family, the revision value always increases by one,
even if you have deregistered previous revisions in this family.
1
. Each
time that you register a new revision of a task definition in the same family, the revision value always
increases by one, even if you have deregistered previous revisions in this family.public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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 TaskDefinitionStatus status()
The status of the task definition.
If the service returns an enum value that is not available in the current SDK version, status
will
return TaskDefinitionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from statusAsString()
.
TaskDefinitionStatus
public String statusAsString()
The status of the task definition.
If the service returns an enum value that is not available in the current SDK version, status
will
return TaskDefinitionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from statusAsString()
.
TaskDefinitionStatus
public List<Attribute> requiresAttributes()
The container instance attributes required by your task. This field is not valid if you are using the Fargate launch type for your task.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<TaskDefinitionPlacementConstraint> placementConstraints()
An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> compatibilitiesAsStrings()
The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<Compatibility> requiresCompatibilities()
The launch type that the task is using.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> requiresCompatibilitiesAsStrings()
The launch type that the task is using.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String cpu()
The number of cpu
units used by the task. If you are using the EC2 launch type, this field is
optional and any value can be used. If you are using the Fargate launch type, this field is required and you must
use one of the following values, which determines your range of valid values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6
GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024
(1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024
(1 GB)
cpu
units used by the task. If you are using the EC2 launch type, this field
is optional and any value can be used. If you are using the Fargate launch type, this field is required
and you must use one of the following values, which determines your range of valid values for the
memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB),
6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments
of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments
of 1024 (1 GB)
public 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)
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 PidMode pidMode()
The process namespace to use for the containers in the task. The valid values are host
or
task
. If host
is specified, then all containers within the tasks that specified the
host
PID mode on the same container instance share the same IPC resources with the host Amazon EC2
instance. If task
is specified, all containers within the specified task share the same process
namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run
reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process
namespace expose. For more information, see Docker
security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
If the service returns an enum value that is not available in the current SDK version, pidMode
will
return PidMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
pidModeAsString()
.
host
or
task
. If host
is specified, then all containers within the tasks that specified
the host
PID mode on the same container instance share the same IPC resources with the host
Amazon EC2 instance. If task
is specified, all containers within the specified task share
the same process namespace. If no value is specified, the default is a private namespace. For more
information, see PID
settings in the Docker run reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process
namespace expose. For more information, see Docker security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
PidMode
public String pidModeAsString()
The process namespace to use for the containers in the task. The valid values are host
or
task
. If host
is specified, then all containers within the tasks that specified the
host
PID mode on the same container instance share the same IPC resources with the host Amazon EC2
instance. If task
is specified, all containers within the specified task share the same process
namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run
reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process
namespace expose. For more information, see Docker
security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
If the service returns an enum value that is not available in the current SDK version, pidMode
will
return PidMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
pidModeAsString()
.
host
or
task
. If host
is specified, then all containers within the tasks that specified
the host
PID mode on the same container instance share the same IPC resources with the host
Amazon EC2 instance. If task
is specified, all containers within the specified task share
the same process namespace. If no value is specified, the default is a private namespace. For more
information, see PID
settings in the Docker run reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process
namespace expose. For more information, see Docker security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
PidMode
public 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 using the Fargate launch type.
If the service returns an enum value that is not available in the current SDK version, ipcMode
will
return IpcMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
ipcModeAsString()
.
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 using the Fargate launch type.
IpcMode
public String ipcModeAsString()
The IPC resource namespace to use for the containers in the task. The valid values are host
,
task
, or none
. If host
is specified, then all containers within the tasks
that specified the host
IPC mode on the same container instance share the same IPC resources with
the host Amazon EC2 instance. If task
is specified, all containers within the specified task share
the same IPC resources. If none
is specified, then IPC resources within the containers of a task are
private and not shared with other containers in a task or on the container instance. If no value is specified,
then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more
information, see IPC settings in
the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace
expose. For more information, see Docker
security.
If you are setting namespaced kernel parameters using systemControls
for the containers in the task,
the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are not
supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will apply
to all containers within a task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
If the service returns an enum value that is not available in the current SDK version, ipcMode
will
return IpcMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
ipcModeAsString()
.
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 using the Fargate launch type.
IpcMode
public TaskDefinition.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<TaskDefinition.Builder,TaskDefinition>
public static TaskDefinition.Builder builder()
public static Class<? extends TaskDefinition.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.