@Generated(value="software.amazon.awssdk:codegen") public final class RegisterTaskDefinitionRequest extends EcsRequest implements ToCopyableBuilder<RegisterTaskDefinitionRequest.Builder,RegisterTaskDefinitionRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
RegisterTaskDefinitionRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static RegisterTaskDefinitionRequest.Builder |
builder() |
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()
You must specify a
family for a task definition, which allows you to track multiple versions of the
same task definition. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
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 of memory (in MiB) 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 the task.
|
List<Compatibility> |
requiresCompatibilities()
The launch type required by the task.
|
List<String> |
requiresCompatibilitiesAsStrings()
The launch type required by the task.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends RegisterTaskDefinitionRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
The metadata that you apply to the task definition to help you categorize and organize them.
|
String |
taskRoleArn()
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
|
RegisterTaskDefinitionRequest.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()
A list of volume definitions in JSON format that containers in your task may use.
|
overrideConfigurationcopypublic String family()
You must specify a family for a task definition, which allows you to track multiple versions of the
same task definition. The family is used as a name for your task definition. Up to 255 letters
(uppercase and lowercase), numbers, hyphens, and underscores are allowed.
family for a task definition, which allows you to track multiple versions
of the same task definition. The family is used as a name for your task definition. Up to
255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.public String taskRoleArn()
The short name or full Amazon Resource Name (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. For more information, see 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.
NetworkModepublic 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.
NetworkModepublic List<ContainerDefinition> containerDefinitions()
A list of container definitions in JSON format that describe the different containers that make up your task.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<Volume> volumes()
A list of volume definitions in JSON format that containers in your task may use.
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 the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<Compatibility> requiresCompatibilities()
The launch type required by the task. If no value is specified, it defaults to EC2.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
EC2.public List<String> requiresCompatibilitiesAsStrings()
The launch type required by the task. If no value is specified, it defaults to EC2.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
EC2.public String cpu()
The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example
1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task
definition. String values are converted to an integer indicating the CPU units when the task definition is
registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU
units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
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 supported 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)
1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in
a task definition. String values are converted to an integer indicating the CPU units when the task
definition is registered. Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you are using the EC2 launch type, this field is optional. Supported values are between
128 CPU units (0.125 vCPUs) and 10240 CPU units (10
vCPUs).
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 supported 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 of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example
1024, or as a string using GB, for example 1GB or 1 GB, in a task
definition. String values are converted to an integer indicating the MiB when the task definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If using the EC2 launch type, this field is optional.
If using the Fargate launch type, this field is required and you must use one of the following values, which
determines your range of supported 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)
1024, or as a string using GB, for example 1GB or 1 GB, in a task
definition. String values are converted to an integer indicating the MiB when the task definition is
registered. Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If using the EC2 launch type, this field is optional.
If using the Fargate launch type, this field is required and you must use one of the following values,
which determines your range of supported 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 List<Tag> tags()
The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
PidModepublic 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.
PidModepublic 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.
IpcModepublic 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.
IpcModepublic RegisterTaskDefinitionRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<RegisterTaskDefinitionRequest.Builder,RegisterTaskDefinitionRequest>toBuilder in class EcsRequestpublic static RegisterTaskDefinitionRequest.Builder builder()
public static Class<? extends RegisterTaskDefinitionRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.