@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RegisterTaskDefinitionRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
RegisterTaskDefinitionRequest() |
Modifier and Type | Method and Description |
---|---|
RegisterTaskDefinitionRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
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.
|
EphemeralStorage |
getEphemeralStorage()
The amount of ephemeral storage to allocate for the task.
|
String |
getExecutionRoleArn()
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission
to make Amazon Web Services API calls on your behalf.
|
String |
getFamily()
You must specify a
family for a task definition. |
List<InferenceAccelerator> |
getInferenceAccelerators()
The Elastic Inference accelerators to use for the containers in the task.
|
String |
getIpcMode()
The IPC resource namespace to use for the containers in the task.
|
String |
getMemory()
The amount of memory (in MiB) used by the task.
|
String |
getNetworkMode()
The Docker networking mode to use for the containers in the task.
|
String |
getPidMode()
The process namespace to use for the containers in the task.
|
List<TaskDefinitionPlacementConstraint> |
getPlacementConstraints()
An array of placement constraint objects to use for the task.
|
ProxyConfiguration |
getProxyConfiguration()
The configuration details for the App Mesh proxy.
|
List<String> |
getRequiresCompatibilities()
The task launch type that Amazon ECS validates the task definition against.
|
RuntimePlatform |
getRuntimePlatform()
The operating system that your tasks definitions run on.
|
List<Tag> |
getTags()
The metadata that you apply to the task definition to help you categorize and organize them.
|
String |
getTaskRoleArn()
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
|
List<Volume> |
getVolumes()
A list of volume definitions in JSON format that containers in your task might use.
|
int |
hashCode() |
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 |
setEphemeralStorage(EphemeralStorage ephemeralStorage)
The amount of ephemeral storage to allocate for the task.
|
void |
setExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission
to make Amazon Web Services API calls on your behalf.
|
void |
setFamily(String family)
You must specify a
family for a task definition. |
void |
setInferenceAccelerators(Collection<InferenceAccelerator> inferenceAccelerators)
The Elastic Inference accelerators to use for the containers in the task.
|
void |
setIpcMode(IpcMode ipcMode)
The IPC resource namespace to use for the containers in the task.
|
void |
setIpcMode(String ipcMode)
The IPC resource namespace to use for the containers in the task.
|
void |
setMemory(String memory)
The amount of memory (in MiB) used by the task.
|
void |
setNetworkMode(NetworkMode networkMode)
The Docker networking mode to use for the containers in the task.
|
void |
setNetworkMode(String networkMode)
The Docker networking mode to use for the containers in the task.
|
void |
setPidMode(PidMode pidMode)
The process namespace to use for the containers in the task.
|
void |
setPidMode(String pidMode)
The process namespace to use for the containers in the task.
|
void |
setPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)
An array of placement constraint objects to use for the task.
|
void |
setProxyConfiguration(ProxyConfiguration proxyConfiguration)
The configuration details for the App Mesh proxy.
|
void |
setRequiresCompatibilities(Collection<String> requiresCompatibilities)
The task launch type that Amazon ECS validates the task definition against.
|
void |
setRuntimePlatform(RuntimePlatform runtimePlatform)
The operating system that your tasks definitions run on.
|
void |
setTags(Collection<Tag> tags)
The metadata that you apply to the task definition to help you categorize and organize them.
|
void |
setTaskRoleArn(String taskRoleArn)
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
|
void |
setVolumes(Collection<Volume> volumes)
A list of volume definitions in JSON format that containers in your task might use.
|
String |
toString()
Returns a string representation of this object.
|
RegisterTaskDefinitionRequest |
withContainerDefinitions(Collection<ContainerDefinition> containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
|
RegisterTaskDefinitionRequest |
withContainerDefinitions(ContainerDefinition... containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
|
RegisterTaskDefinitionRequest |
withCpu(String cpu)
The number of CPU units used by the task.
|
RegisterTaskDefinitionRequest |
withEphemeralStorage(EphemeralStorage ephemeralStorage)
The amount of ephemeral storage to allocate for the task.
|
RegisterTaskDefinitionRequest |
withExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission
to make Amazon Web Services API calls on your behalf.
|
RegisterTaskDefinitionRequest |
withFamily(String family)
You must specify a
family for a task definition. |
RegisterTaskDefinitionRequest |
withInferenceAccelerators(Collection<InferenceAccelerator> inferenceAccelerators)
The Elastic Inference accelerators to use for the containers in the task.
|
RegisterTaskDefinitionRequest |
withInferenceAccelerators(InferenceAccelerator... inferenceAccelerators)
The Elastic Inference accelerators to use for the containers in the task.
|
RegisterTaskDefinitionRequest |
withIpcMode(IpcMode ipcMode)
The IPC resource namespace to use for the containers in the task.
|
RegisterTaskDefinitionRequest |
withIpcMode(String ipcMode)
The IPC resource namespace to use for the containers in the task.
|
RegisterTaskDefinitionRequest |
withMemory(String memory)
The amount of memory (in MiB) used by the task.
|
RegisterTaskDefinitionRequest |
withNetworkMode(NetworkMode networkMode)
The Docker networking mode to use for the containers in the task.
|
RegisterTaskDefinitionRequest |
withNetworkMode(String networkMode)
The Docker networking mode to use for the containers in the task.
|
RegisterTaskDefinitionRequest |
withPidMode(PidMode pidMode)
The process namespace to use for the containers in the task.
|
RegisterTaskDefinitionRequest |
withPidMode(String pidMode)
The process namespace to use for the containers in the task.
|
RegisterTaskDefinitionRequest |
withPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)
An array of placement constraint objects to use for the task.
|
RegisterTaskDefinitionRequest |
withPlacementConstraints(TaskDefinitionPlacementConstraint... placementConstraints)
An array of placement constraint objects to use for the task.
|
RegisterTaskDefinitionRequest |
withProxyConfiguration(ProxyConfiguration proxyConfiguration)
The configuration details for the App Mesh proxy.
|
RegisterTaskDefinitionRequest |
withRequiresCompatibilities(Collection<String> requiresCompatibilities)
The task launch type that Amazon ECS validates the task definition against.
|
RegisterTaskDefinitionRequest |
withRequiresCompatibilities(Compatibility... requiresCompatibilities)
The task launch type that Amazon ECS validates the task definition against.
|
RegisterTaskDefinitionRequest |
withRequiresCompatibilities(String... requiresCompatibilities)
The task launch type that Amazon ECS validates the task definition against.
|
RegisterTaskDefinitionRequest |
withRuntimePlatform(RuntimePlatform runtimePlatform)
The operating system that your tasks definitions run on.
|
RegisterTaskDefinitionRequest |
withTags(Collection<Tag> tags)
The metadata that you apply to the task definition to help you categorize and organize them.
|
RegisterTaskDefinitionRequest |
withTags(Tag... tags)
The metadata that you apply to the task definition to help you categorize and organize them.
|
RegisterTaskDefinitionRequest |
withTaskRoleArn(String taskRoleArn)
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
|
RegisterTaskDefinitionRequest |
withVolumes(Collection<Volume> volumes)
A list of volume definitions in JSON format that containers in your task might use.
|
RegisterTaskDefinitionRequest |
withVolumes(Volume... volumes)
A list of volume definitions in JSON format that containers in your task might use.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setFamily(String family)
You must specify a family
for a task definition. You can use it 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, underscores, and hyphens are allowed.
family
- You must specify a family
for a task definition. You can use it 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, underscores, and hyphens are allowed.public String getFamily()
You must specify a family
for a task definition. You can use it 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, underscores, and hyphens are allowed.
family
for a task definition. You can use it 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, underscores, and hyphens are allowed.public RegisterTaskDefinitionRequest withFamily(String family)
You must specify a family
for a task definition. You can use it 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, underscores, and hyphens are allowed.
family
- You must specify a family
for a task definition. You can use it 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, underscores, and hyphens are allowed.public void setTaskRoleArn(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.
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 getTaskRoleArn()
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 RegisterTaskDefinitionRequest withTaskRoleArn(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.
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 void setExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
executionRoleArn
- The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent
permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required
depending on the requirements of your task. For more information, see Amazon ECS
task execution IAM role in the Amazon Elastic Container Service Developer Guide.public String getExecutionRoleArn()
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
public RegisterTaskDefinitionRequest withExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
executionRoleArn
- The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent
permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required
depending on the requirements of your task. For more information, see Amazon ECS
task execution IAM role in the Amazon Elastic Container Service Developer Guide.public void setNetworkMode(String networkMode)
The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. If no network mode is specified, the default is
bridge
.
For Amazon ECS tasks on Fargate, the awsvpc
network mode is required. For Amazon ECS tasks on Amazon
EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances,
<default>
or awsvpc
can be used. If the network mode is set to none
,
you cannot specify port mappings in your container definitions, and the tasks containers do not have external
connectivity. The host
and awsvpc
network modes offer the highest networking
performance for containers because they use the EC2 network stack instead of the virtualized network stack
provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to
the corresponding host port (for the host
network mode) or the attached elastic network interface
port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
When using the host
network mode, you should not run containers using the root user (UID 0). It is
considered best practice to use a non-root user.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you must
specify a NetworkConfiguration value when you create a service or run a task with the task definition. For
more information, see Task Networking in
the Amazon Elastic Container Service Developer Guide.
If the network mode is host
, you cannot run multiple instantiations of the same task on a single
container instance when port mappings are used.
For more information, see Network settings in the Docker run reference.
networkMode
- The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. If no network mode is specified, the
default is bridge
.
For Amazon ECS tasks on Fargate, the awsvpc
network mode is required. For Amazon ECS tasks on
Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows
instances, <default>
or awsvpc
can be used. If the network mode is set to
none
, you cannot specify port mappings in your container definitions, and the tasks
containers do not have external connectivity. The host
and awsvpc
network modes
offer the highest networking performance for containers because they use the EC2 network stack instead of
the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped
directly to the corresponding host port (for the host
network mode) or the attached elastic
network interface port (for the awsvpc
network mode), so you cannot take advantage of dynamic
host port mappings.
When using the host
network mode, you should not run containers using the root user (UID 0).
It is considered best practice to use a non-root user.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you
must specify a NetworkConfiguration value when you create a service or run a task with the task
definition. For more information, see Task
Networking in the Amazon Elastic Container Service Developer Guide.
If the network mode is host
, you cannot run multiple instantiations of the same task on a
single container instance when port mappings are used.
For more information, see Network settings in the Docker run reference.
NetworkMode
public String getNetworkMode()
The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. If no network mode is specified, the default is
bridge
.
For Amazon ECS tasks on Fargate, the awsvpc
network mode is required. For Amazon ECS tasks on Amazon
EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances,
<default>
or awsvpc
can be used. If the network mode is set to none
,
you cannot specify port mappings in your container definitions, and the tasks containers do not have external
connectivity. The host
and awsvpc
network modes offer the highest networking
performance for containers because they use the EC2 network stack instead of the virtualized network stack
provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to
the corresponding host port (for the host
network mode) or the attached elastic network interface
port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
When using the host
network mode, you should not run containers using the root user (UID 0). It is
considered best practice to use a non-root user.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you must
specify a NetworkConfiguration value when you create a service or run a task with the task definition. For
more information, see Task Networking in
the Amazon Elastic Container Service Developer Guide.
If the network mode is host
, you cannot run multiple instantiations of the same task on a single
container instance when port mappings are used.
For more information, see Network settings in the Docker run reference.
none
,
bridge
, awsvpc
, and host
. If no network mode is specified, the
default is bridge
.
For Amazon ECS tasks on Fargate, the awsvpc
network mode is required. For Amazon ECS tasks
on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows
instances, <default>
or awsvpc
can be used. If the network mode is set to
none
, you cannot specify port mappings in your container definitions, and the tasks
containers do not have external connectivity. The host
and awsvpc
network modes
offer the highest networking performance for containers because they use the EC2 network stack instead of
the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped
directly to the corresponding host port (for the host
network mode) or the attached elastic
network interface port (for the awsvpc
network mode), so you cannot take advantage of
dynamic host port mappings.
When using the host
network mode, you should not run containers using the root user (UID 0).
It is considered best practice to use a non-root user.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you
must specify a NetworkConfiguration value when you create a service or run a task with the task
definition. For more information, see Task
Networking in the Amazon Elastic Container Service Developer Guide.
If the network mode is host
, you cannot run multiple instantiations of the same task on a
single container instance when port mappings are used.
For more information, see Network settings in the Docker run reference.
NetworkMode
public RegisterTaskDefinitionRequest withNetworkMode(String networkMode)
The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. If no network mode is specified, the default is
bridge
.
For Amazon ECS tasks on Fargate, the awsvpc
network mode is required. For Amazon ECS tasks on Amazon
EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances,
<default>
or awsvpc
can be used. If the network mode is set to none
,
you cannot specify port mappings in your container definitions, and the tasks containers do not have external
connectivity. The host
and awsvpc
network modes offer the highest networking
performance for containers because they use the EC2 network stack instead of the virtualized network stack
provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to
the corresponding host port (for the host
network mode) or the attached elastic network interface
port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
When using the host
network mode, you should not run containers using the root user (UID 0). It is
considered best practice to use a non-root user.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you must
specify a NetworkConfiguration value when you create a service or run a task with the task definition. For
more information, see Task Networking in
the Amazon Elastic Container Service Developer Guide.
If the network mode is host
, you cannot run multiple instantiations of the same task on a single
container instance when port mappings are used.
For more information, see Network settings in the Docker run reference.
networkMode
- The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. If no network mode is specified, the
default is bridge
.
For Amazon ECS tasks on Fargate, the awsvpc
network mode is required. For Amazon ECS tasks on
Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows
instances, <default>
or awsvpc
can be used. If the network mode is set to
none
, you cannot specify port mappings in your container definitions, and the tasks
containers do not have external connectivity. The host
and awsvpc
network modes
offer the highest networking performance for containers because they use the EC2 network stack instead of
the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped
directly to the corresponding host port (for the host
network mode) or the attached elastic
network interface port (for the awsvpc
network mode), so you cannot take advantage of dynamic
host port mappings.
When using the host
network mode, you should not run containers using the root user (UID 0).
It is considered best practice to use a non-root user.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you
must specify a NetworkConfiguration value when you create a service or run a task with the task
definition. For more information, see Task
Networking in the Amazon Elastic Container Service Developer Guide.
If the network mode is host
, you cannot run multiple instantiations of the same task on a
single container instance when port mappings are used.
For more information, see Network settings in the Docker run reference.
NetworkMode
public void setNetworkMode(NetworkMode networkMode)
The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. If no network mode is specified, the default is
bridge
.
For Amazon ECS tasks on Fargate, the awsvpc
network mode is required. For Amazon ECS tasks on Amazon
EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances,
<default>
or awsvpc
can be used. If the network mode is set to none
,
you cannot specify port mappings in your container definitions, and the tasks containers do not have external
connectivity. The host
and awsvpc
network modes offer the highest networking
performance for containers because they use the EC2 network stack instead of the virtualized network stack
provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to
the corresponding host port (for the host
network mode) or the attached elastic network interface
port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
When using the host
network mode, you should not run containers using the root user (UID 0). It is
considered best practice to use a non-root user.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you must
specify a NetworkConfiguration value when you create a service or run a task with the task definition. For
more information, see Task Networking in
the Amazon Elastic Container Service Developer Guide.
If the network mode is host
, you cannot run multiple instantiations of the same task on a single
container instance when port mappings are used.
For more information, see Network settings in the Docker run reference.
networkMode
- The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. If no network mode is specified, the
default is bridge
.
For Amazon ECS tasks on Fargate, the awsvpc
network mode is required. For Amazon ECS tasks on
Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows
instances, <default>
or awsvpc
can be used. If the network mode is set to
none
, you cannot specify port mappings in your container definitions, and the tasks
containers do not have external connectivity. The host
and awsvpc
network modes
offer the highest networking performance for containers because they use the EC2 network stack instead of
the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped
directly to the corresponding host port (for the host
network mode) or the attached elastic
network interface port (for the awsvpc
network mode), so you cannot take advantage of dynamic
host port mappings.
When using the host
network mode, you should not run containers using the root user (UID 0).
It is considered best practice to use a non-root user.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you
must specify a NetworkConfiguration value when you create a service or run a task with the task
definition. For more information, see Task
Networking in the Amazon Elastic Container Service Developer Guide.
If the network mode is host
, you cannot run multiple instantiations of the same task on a
single container instance when port mappings are used.
For more information, see Network settings in the Docker run reference.
NetworkMode
public RegisterTaskDefinitionRequest withNetworkMode(NetworkMode networkMode)
The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. If no network mode is specified, the default is
bridge
.
For Amazon ECS tasks on Fargate, the awsvpc
network mode is required. For Amazon ECS tasks on Amazon
EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances,
<default>
or awsvpc
can be used. If the network mode is set to none
,
you cannot specify port mappings in your container definitions, and the tasks containers do not have external
connectivity. The host
and awsvpc
network modes offer the highest networking
performance for containers because they use the EC2 network stack instead of the virtualized network stack
provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to
the corresponding host port (for the host
network mode) or the attached elastic network interface
port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
When using the host
network mode, you should not run containers using the root user (UID 0). It is
considered best practice to use a non-root user.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you must
specify a NetworkConfiguration value when you create a service or run a task with the task definition. For
more information, see Task Networking in
the Amazon Elastic Container Service Developer Guide.
If the network mode is host
, you cannot run multiple instantiations of the same task on a single
container instance when port mappings are used.
For more information, see Network settings in the Docker run reference.
networkMode
- The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. If no network mode is specified, the
default is bridge
.
For Amazon ECS tasks on Fargate, the awsvpc
network mode is required. For Amazon ECS tasks on
Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows
instances, <default>
or awsvpc
can be used. If the network mode is set to
none
, you cannot specify port mappings in your container definitions, and the tasks
containers do not have external connectivity. The host
and awsvpc
network modes
offer the highest networking performance for containers because they use the EC2 network stack instead of
the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped
directly to the corresponding host port (for the host
network mode) or the attached elastic
network interface port (for the awsvpc
network mode), so you cannot take advantage of dynamic
host port mappings.
When using the host
network mode, you should not run containers using the root user (UID 0).
It is considered best practice to use a non-root user.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you
must specify a NetworkConfiguration value when you create a service or run a task with the task
definition. For more information, see Task
Networking in the Amazon Elastic Container Service Developer Guide.
If the network mode is host
, you cannot run multiple instantiations of the same task on a
single container instance when port mappings are used.
For more information, see Network settings in the Docker run reference.
NetworkMode
public List<ContainerDefinition> getContainerDefinitions()
A list of container definitions in JSON format that describe the different containers that make up your task.
public void setContainerDefinitions(Collection<ContainerDefinition> containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
containerDefinitions
- A list of container definitions in JSON format that describe the different containers that make up your
task.public RegisterTaskDefinitionRequest withContainerDefinitions(ContainerDefinition... containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
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.public RegisterTaskDefinitionRequest withContainerDefinitions(Collection<ContainerDefinition> containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
containerDefinitions
- A list of container definitions in JSON format that describe the different containers that make up your
task.public List<Volume> getVolumes()
A list of volume definitions in JSON format that containers in your task might use.
public void setVolumes(Collection<Volume> volumes)
A list of volume definitions in JSON format that containers in your task might use.
volumes
- A list of volume definitions in JSON format that containers in your task might use.public RegisterTaskDefinitionRequest withVolumes(Volume... volumes)
A list of volume definitions in JSON format that containers in your task might use.
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
- A list of volume definitions in JSON format that containers in your task might use.public RegisterTaskDefinitionRequest withVolumes(Collection<Volume> volumes)
A list of volume definitions in JSON format that containers in your task might use.
volumes
- A list of volume definitions in JSON format that containers in your task might use.public List<TaskDefinitionPlacementConstraint> getPlacementConstraints()
An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
public void setPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)
An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
placementConstraints
- An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints
for each task. This limit includes constraints in the task definition and those specified at runtime.public RegisterTaskDefinitionRequest withPlacementConstraints(TaskDefinitionPlacementConstraint... placementConstraints)
An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
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 the task. You can specify a maximum of 10 constraints
for each task. This limit includes constraints in the task definition and those specified at runtime.public RegisterTaskDefinitionRequest withPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)
An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
placementConstraints
- An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints
for each task. This limit includes constraints in the task definition and those specified at runtime.public List<String> getRequiresCompatibilities()
The task launch type that Amazon ECS validates the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.
Compatibility
public void setRequiresCompatibilities(Collection<String> requiresCompatibilities)
The task launch type that Amazon ECS validates the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.
requiresCompatibilities
- The task launch type that Amazon ECS validates the task definition against. A client exception is returned
if the task definition doesn't validate against the compatibilities specified. If no value is specified,
the parameter is omitted from the response.Compatibility
public RegisterTaskDefinitionRequest withRequiresCompatibilities(String... requiresCompatibilities)
The task launch type that Amazon ECS validates the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.
NOTE: This method appends the values to the existing list (if any). Use
setRequiresCompatibilities(java.util.Collection)
or
withRequiresCompatibilities(java.util.Collection)
if you want to override the existing values.
requiresCompatibilities
- The task launch type that Amazon ECS validates the task definition against. A client exception is returned
if the task definition doesn't validate against the compatibilities specified. If no value is specified,
the parameter is omitted from the response.Compatibility
public RegisterTaskDefinitionRequest withRequiresCompatibilities(Collection<String> requiresCompatibilities)
The task launch type that Amazon ECS validates the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.
requiresCompatibilities
- The task launch type that Amazon ECS validates the task definition against. A client exception is returned
if the task definition doesn't validate against the compatibilities specified. If no value is specified,
the parameter is omitted from the response.Compatibility
public RegisterTaskDefinitionRequest withRequiresCompatibilities(Compatibility... requiresCompatibilities)
The task launch type that Amazon ECS validates the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.
requiresCompatibilities
- The task launch type that Amazon ECS validates the task definition against. A client exception is returned
if the task definition doesn't validate against the compatibilities specified. If no value is specified,
the parameter is omitted from the response.Compatibility
public void setCpu(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're 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 do not specify
a value, the parameter is ignored.
If you're 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:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6
GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory
values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0
or later.
16384 (16vCPU) - Available memory
values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0
or later.
cpu
- The number of CPU units used by the task. 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're 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 do
not specify a value, the parameter is ignored.
If you're 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:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB),
6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024
(1 GB)
4096 (4 vCPU) - Available memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024
(1 GB)
8192 (8 vCPU) - Available memory
values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0
or later.
16384 (16vCPU) - Available memory
values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0
or later.
public String getCpu()
The number of CPU units used by the task. 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're 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 do not specify
a value, the parameter is ignored.
If you're 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:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6
GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory
values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0
or later.
16384 (16vCPU) - Available memory
values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0
or later.
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're 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 do not specify a value, the parameter is ignored.
If you're 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:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB),
6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024
(1 GB)
4096 (4 vCPU) - Available memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024
(1 GB)
8192 (8 vCPU) - Available memory
values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0
or later.
16384 (16vCPU) - Available memory
values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0
or later.
public RegisterTaskDefinitionRequest withCpu(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're 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 do not specify
a value, the parameter is ignored.
If you're 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:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6
GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory
values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0
or later.
16384 (16vCPU) - Available memory
values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0
or later.
cpu
- The number of CPU units used by the task. 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're 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 do
not specify a value, the parameter is ignored.
If you're 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:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB),
6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024
(1 GB)
4096 (4 vCPU) - Available memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024
(1 GB)
8192 (8 vCPU) - Available memory
values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0
or later.
16384 (16vCPU) - Available memory
values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0
or later.
public void setMemory(String memory)
The amount 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. This
determines your range of supported values for the cpu
parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2
vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4
vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu
values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0
or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu
values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0
or later.
memory
- The amount 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.
This determines your range of supported values for the cpu
parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values:
2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values:
4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu
values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0
or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu
values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0
or later.
public String getMemory()
The amount 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. This
determines your range of supported values for the cpu
parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2
vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4
vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu
values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0
or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu
values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0
or later.
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.
This determines your range of supported values for the cpu
parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values:
2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values:
4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu
values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0
or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu
values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0
or later.
public RegisterTaskDefinitionRequest withMemory(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. This
determines your range of supported values for the cpu
parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2
vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4
vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu
values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0
or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu
values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0
or later.
memory
- The amount 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.
This determines your range of supported values for the cpu
parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values:
2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values:
4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu
values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0
or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu
values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0
or later.
public List<Tag> getTags()
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. You define both of them.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for
either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values
with this prefix. Tags with this prefix do not count against your tags per resource limit.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a
prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete
tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource
limit.
public void setTags(Collection<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. You define both of them.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for
either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values
with this prefix. Tags with this prefix do not count against your tags per resource limit.
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. You define both of them.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix
for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag
keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
public RegisterTaskDefinitionRequest withTags(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. You define both of them.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for
either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values
with this prefix. Tags with this prefix do not count against your tags per resource limit.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
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. You define both of them.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix
for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag
keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
public RegisterTaskDefinitionRequest withTags(Collection<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. You define both of them.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for
either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values
with this prefix. Tags with this prefix do not count against your tags per resource limit.
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. You define both of them.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix
for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag
keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
public void setPidMode(String pidMode)
The process namespace to use for the containers in the task. The valid values are host
or
task
. On Fargate for Linux containers, the only valid value is task
. For example,
monitoring sidecars might need pidMode
to access information about other containers running in the
same task.
If host
is specified, all containers within the tasks that specified the host
PID mode
on the same container instance share the same process namespace with the host Amazon EC2 instance.
If task
is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
If the host
PID mode is used, there's a heightened risk of undesired process namespace exposure. For
more information, see Docker security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version
1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate.
pidMode
- The process namespace to use for the containers in the task. The valid values are host
or
task
. On Fargate for Linux containers, the only valid value is task
. For
example, monitoring sidecars might need pidMode
to access information about other containers
running in the same task.
If host
is specified, all containers within the tasks that specified the host
PID mode on the same container instance share the same process namespace with the host Amazon EC2
instance.
If task
is specified, all containers within the specified task share the same process
namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
If the host
PID mode is used, there's a heightened risk of undesired process namespace
exposure. For more information, see Docker
security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform
version 1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate.
PidMode
public String getPidMode()
The process namespace to use for the containers in the task. The valid values are host
or
task
. On Fargate for Linux containers, the only valid value is task
. For example,
monitoring sidecars might need pidMode
to access information about other containers running in the
same task.
If host
is specified, all containers within the tasks that specified the host
PID mode
on the same container instance share the same process namespace with the host Amazon EC2 instance.
If task
is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
If the host
PID mode is used, there's a heightened risk of undesired process namespace exposure. For
more information, see Docker security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version
1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate.
host
or
task
. On Fargate for Linux containers, the only valid value is task
. For
example, monitoring sidecars might need pidMode
to access information about other containers
running in the same task.
If host
is specified, all containers within the tasks that specified the host
PID mode on the same container instance share the same process namespace with the host Amazon EC2
instance.
If task
is specified, all containers within the specified task share the same process
namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
If the host
PID mode is used, there's a heightened risk of undesired process namespace
exposure. For more information, see Docker
security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform
version 1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate.
PidMode
public RegisterTaskDefinitionRequest withPidMode(String pidMode)
The process namespace to use for the containers in the task. The valid values are host
or
task
. On Fargate for Linux containers, the only valid value is task
. For example,
monitoring sidecars might need pidMode
to access information about other containers running in the
same task.
If host
is specified, all containers within the tasks that specified the host
PID mode
on the same container instance share the same process namespace with the host Amazon EC2 instance.
If task
is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
If the host
PID mode is used, there's a heightened risk of undesired process namespace exposure. For
more information, see Docker security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version
1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate.
pidMode
- The process namespace to use for the containers in the task. The valid values are host
or
task
. On Fargate for Linux containers, the only valid value is task
. For
example, monitoring sidecars might need pidMode
to access information about other containers
running in the same task.
If host
is specified, all containers within the tasks that specified the host
PID mode on the same container instance share the same process namespace with the host Amazon EC2
instance.
If task
is specified, all containers within the specified task share the same process
namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
If the host
PID mode is used, there's a heightened risk of undesired process namespace
exposure. For more information, see Docker
security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform
version 1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate.
PidMode
public void setPidMode(PidMode pidMode)
The process namespace to use for the containers in the task. The valid values are host
or
task
. On Fargate for Linux containers, the only valid value is task
. For example,
monitoring sidecars might need pidMode
to access information about other containers running in the
same task.
If host
is specified, all containers within the tasks that specified the host
PID mode
on the same container instance share the same process namespace with the host Amazon EC2 instance.
If task
is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
If the host
PID mode is used, there's a heightened risk of undesired process namespace exposure. For
more information, see Docker security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version
1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate.
pidMode
- The process namespace to use for the containers in the task. The valid values are host
or
task
. On Fargate for Linux containers, the only valid value is task
. For
example, monitoring sidecars might need pidMode
to access information about other containers
running in the same task.
If host
is specified, all containers within the tasks that specified the host
PID mode on the same container instance share the same process namespace with the host Amazon EC2
instance.
If task
is specified, all containers within the specified task share the same process
namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
If the host
PID mode is used, there's a heightened risk of undesired process namespace
exposure. For more information, see Docker
security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform
version 1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate.
PidMode
public RegisterTaskDefinitionRequest withPidMode(PidMode pidMode)
The process namespace to use for the containers in the task. The valid values are host
or
task
. On Fargate for Linux containers, the only valid value is task
. For example,
monitoring sidecars might need pidMode
to access information about other containers running in the
same task.
If host
is specified, all containers within the tasks that specified the host
PID mode
on the same container instance share the same process namespace with the host Amazon EC2 instance.
If task
is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
If the host
PID mode is used, there's a heightened risk of undesired process namespace exposure. For
more information, see Docker security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version
1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate.
pidMode
- The process namespace to use for the containers in the task. The valid values are host
or
task
. On Fargate for Linux containers, the only valid value is task
. For
example, monitoring sidecars might need pidMode
to access information about other containers
running in the same task.
If host
is specified, all containers within the tasks that specified the host
PID mode on the same container instance share the same process namespace with the host Amazon EC2
instance.
If task
is specified, all containers within the specified task share the same process
namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
If the host
PID mode is used, there's a heightened risk of undesired process namespace
exposure. For more information, see Docker
security.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform
version 1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate.
PidMode
public void setIpcMode(String ipcMode)
The IPC resource namespace to use for the containers in the task. The valid values are host
,
task
, or none
. If host
is specified, then all containers within the tasks
that specified the host
IPC mode on the same container instance share the same IPC resources with
the host Amazon EC2 instance. If task
is specified, all containers within the specified task share
the same IPC resources. If none
is specified, then IPC resources within the containers of a task are
private and not shared with other containers in a task or on the container instance. If no value is specified,
then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more
information, see IPC settings in
the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace
expose. For more information, see Docker
security.
If you are setting namespaced kernel parameters using systemControls
for the containers in the task,
the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are not
supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will apply
to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
ipcMode
- The IPC resource namespace to use for the containers in the task. The valid values are host
,
task
, or none
. If host
is specified, then all containers within the
tasks that specified the host
IPC mode on the same container instance share the same IPC
resources with the host Amazon EC2 instance. If task
is specified, all containers within the
specified task share the same IPC resources. If none
is specified, then IPC resources within
the containers of a task are private and not shared with other containers in a task or on the container
instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon
setting on the container instance. For more information, see IPC settings in the Docker
run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC
namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in
the task, the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are
not supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will
apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
IpcMode
public String getIpcMode()
The IPC resource namespace to use for the containers in the task. The valid values are host
,
task
, or none
. If host
is specified, then all containers within the tasks
that specified the host
IPC mode on the same container instance share the same IPC resources with
the host Amazon EC2 instance. If task
is specified, all containers within the specified task share
the same IPC resources. If none
is specified, then IPC resources within the containers of a task are
private and not shared with other containers in a task or on the container instance. If no value is specified,
then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more
information, see IPC settings in
the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace
expose. For more information, see Docker
security.
If you are setting namespaced kernel parameters using systemControls
for the containers in the task,
the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are not
supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will apply
to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
host
,
task
, or none
. If host
is specified, then all containers within
the tasks that specified the host
IPC mode on the same container instance share the same IPC
resources with the host Amazon EC2 instance. If task
is specified, all containers within the
specified task share the same IPC resources. If none
is specified, then IPC resources within
the containers of a task are private and not shared with other containers in a task or on the container
instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon
setting on the container instance. For more information, see IPC settings in the Docker
run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC
namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in
the task, the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are
not supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will
apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
IpcMode
public RegisterTaskDefinitionRequest withIpcMode(String ipcMode)
The IPC resource namespace to use for the containers in the task. The valid values are host
,
task
, or none
. If host
is specified, then all containers within the tasks
that specified the host
IPC mode on the same container instance share the same IPC resources with
the host Amazon EC2 instance. If task
is specified, all containers within the specified task share
the same IPC resources. If none
is specified, then IPC resources within the containers of a task are
private and not shared with other containers in a task or on the container instance. If no value is specified,
then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more
information, see IPC settings in
the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace
expose. For more information, see Docker
security.
If you are setting namespaced kernel parameters using systemControls
for the containers in the task,
the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are not
supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will apply
to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
ipcMode
- The IPC resource namespace to use for the containers in the task. The valid values are host
,
task
, or none
. If host
is specified, then all containers within the
tasks that specified the host
IPC mode on the same container instance share the same IPC
resources with the host Amazon EC2 instance. If task
is specified, all containers within the
specified task share the same IPC resources. If none
is specified, then IPC resources within
the containers of a task are private and not shared with other containers in a task or on the container
instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon
setting on the container instance. For more information, see IPC settings in the Docker
run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC
namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in
the task, the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are
not supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will
apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
IpcMode
public void setIpcMode(IpcMode ipcMode)
The IPC resource namespace to use for the containers in the task. The valid values are host
,
task
, or none
. If host
is specified, then all containers within the tasks
that specified the host
IPC mode on the same container instance share the same IPC resources with
the host Amazon EC2 instance. If task
is specified, all containers within the specified task share
the same IPC resources. If none
is specified, then IPC resources within the containers of a task are
private and not shared with other containers in a task or on the container instance. If no value is specified,
then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more
information, see IPC settings in
the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace
expose. For more information, see Docker
security.
If you are setting namespaced kernel parameters using systemControls
for the containers in the task,
the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are not
supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will apply
to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
ipcMode
- The IPC resource namespace to use for the containers in the task. The valid values are host
,
task
, or none
. If host
is specified, then all containers within the
tasks that specified the host
IPC mode on the same container instance share the same IPC
resources with the host Amazon EC2 instance. If task
is specified, all containers within the
specified task share the same IPC resources. If none
is specified, then IPC resources within
the containers of a task are private and not shared with other containers in a task or on the container
instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon
setting on the container instance. For more information, see IPC settings in the Docker
run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC
namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in
the task, the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are
not supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will
apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
IpcMode
public RegisterTaskDefinitionRequest withIpcMode(IpcMode ipcMode)
The IPC resource namespace to use for the containers in the task. The valid values are host
,
task
, or none
. If host
is specified, then all containers within the tasks
that specified the host
IPC mode on the same container instance share the same IPC resources with
the host Amazon EC2 instance. If task
is specified, all containers within the specified task share
the same IPC resources. If none
is specified, then IPC resources within the containers of a task are
private and not shared with other containers in a task or on the container instance. If no value is specified,
then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more
information, see IPC settings in
the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace
expose. For more information, see Docker
security.
If you are setting namespaced kernel parameters using systemControls
for the containers in the task,
the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are not
supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will apply
to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
ipcMode
- The IPC resource namespace to use for the containers in the task. The valid values are host
,
task
, or none
. If host
is specified, then all containers within the
tasks that specified the host
IPC mode on the same container instance share the same IPC
resources with the host Amazon EC2 instance. If task
is specified, all containers within the
specified task share the same IPC resources. If none
is specified, then IPC resources within
the containers of a task are private and not shared with other containers in a task or on the container
instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon
setting on the container instance. For more information, see IPC settings in the Docker
run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC
namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in
the task, the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are
not supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will
apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
IpcMode
public void setProxyConfiguration(ProxyConfiguration proxyConfiguration)
The configuration details for the App Mesh proxy.
For tasks hosted on Amazon EC2 instances, the container instances require at least version 1.26.0
of
the container agent and at least version 1.26.0-1
of the ecs-init
package to use a
proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version
20190301
or later, then they contain the required versions of the container agent and
ecs-init
. For more information, see Amazon ECS-optimized AMI
versions in the Amazon Elastic Container Service Developer Guide.
proxyConfiguration
- The configuration details for the App Mesh proxy.
For tasks hosted on Amazon EC2 instances, the container instances require at least version
1.26.0
of the container agent and at least version 1.26.0-1
of the
ecs-init
package to use a proxy configuration. If your container instances are launched from
the Amazon ECS-optimized AMI version 20190301
or later, then they contain the required
versions of the container agent and ecs-init
. For more information, see Amazon
ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.
public ProxyConfiguration getProxyConfiguration()
The configuration details for the App Mesh proxy.
For tasks hosted on Amazon EC2 instances, the container instances require at least version 1.26.0
of
the container agent and at least version 1.26.0-1
of the ecs-init
package to use a
proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version
20190301
or later, then they contain the required versions of the container agent and
ecs-init
. For more information, see Amazon ECS-optimized AMI
versions in the Amazon Elastic Container Service Developer Guide.
For tasks hosted on Amazon EC2 instances, the container instances require at least version
1.26.0
of the container agent and at least version 1.26.0-1
of the
ecs-init
package to use a proxy configuration. If your container instances are launched from
the Amazon ECS-optimized AMI version 20190301
or later, then they contain the required
versions of the container agent and ecs-init
. For more information, see Amazon
ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.
public RegisterTaskDefinitionRequest withProxyConfiguration(ProxyConfiguration proxyConfiguration)
The configuration details for the App Mesh proxy.
For tasks hosted on Amazon EC2 instances, the container instances require at least version 1.26.0
of
the container agent and at least version 1.26.0-1
of the ecs-init
package to use a
proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version
20190301
or later, then they contain the required versions of the container agent and
ecs-init
. For more information, see Amazon ECS-optimized AMI
versions in the Amazon Elastic Container Service Developer Guide.
proxyConfiguration
- The configuration details for the App Mesh proxy.
For tasks hosted on Amazon EC2 instances, the container instances require at least version
1.26.0
of the container agent and at least version 1.26.0-1
of the
ecs-init
package to use a proxy configuration. If your container instances are launched from
the Amazon ECS-optimized AMI version 20190301
or later, then they contain the required
versions of the container agent and ecs-init
. For more information, see Amazon
ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.
public List<InferenceAccelerator> getInferenceAccelerators()
The Elastic Inference accelerators to use for the containers in the task.
public void setInferenceAccelerators(Collection<InferenceAccelerator> inferenceAccelerators)
The Elastic Inference accelerators to use for the containers in the task.
inferenceAccelerators
- The Elastic Inference accelerators to use for the containers in the task.public RegisterTaskDefinitionRequest withInferenceAccelerators(InferenceAccelerator... inferenceAccelerators)
The Elastic Inference accelerators to use for the containers in the task.
NOTE: This method appends the values to the existing list (if any). Use
setInferenceAccelerators(java.util.Collection)
or
withInferenceAccelerators(java.util.Collection)
if you want to override the existing values.
inferenceAccelerators
- The Elastic Inference accelerators to use for the containers in the task.public RegisterTaskDefinitionRequest withInferenceAccelerators(Collection<InferenceAccelerator> inferenceAccelerators)
The Elastic Inference accelerators to use for the containers in the task.
inferenceAccelerators
- The Elastic Inference accelerators to use for the containers in the task.public void setEphemeralStorage(EphemeralStorage ephemeralStorage)
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide.
For tasks using the Fargate launch type, the task requires the following platforms:
Linux platform version 1.4.0
or later.
Windows platform version 1.0.0
or later.
ephemeralStorage
- The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total
amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more
information, see Using data
volumes in tasks in the Amazon ECS Developer Guide. For tasks using the Fargate launch type, the task requires the following platforms:
Linux platform version 1.4.0
or later.
Windows platform version 1.0.0
or later.
public EphemeralStorage getEphemeralStorage()
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide.
For tasks using the Fargate launch type, the task requires the following platforms:
Linux platform version 1.4.0
or later.
Windows platform version 1.0.0
or later.
For tasks using the Fargate launch type, the task requires the following platforms:
Linux platform version 1.4.0
or later.
Windows platform version 1.0.0
or later.
public RegisterTaskDefinitionRequest withEphemeralStorage(EphemeralStorage ephemeralStorage)
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide.
For tasks using the Fargate launch type, the task requires the following platforms:
Linux platform version 1.4.0
or later.
Windows platform version 1.0.0
or later.
ephemeralStorage
- The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total
amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more
information, see Using data
volumes in tasks in the Amazon ECS Developer Guide. For tasks using the Fargate launch type, the task requires the following platforms:
Linux platform version 1.4.0
or later.
Windows platform version 1.0.0
or later.
public void setRuntimePlatform(RuntimePlatform runtimePlatform)
The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.
runtimePlatform
- The operating system that your tasks definitions run on. A platform family is specified only for tasks
using the Fargate launch type.public RuntimePlatform getRuntimePlatform()
The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.
public RegisterTaskDefinitionRequest withRuntimePlatform(RuntimePlatform runtimePlatform)
The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.
runtimePlatform
- The operating system that your tasks definitions run on. A platform family is specified only for tasks
using the Fargate launch type.public String toString()
toString
in class Object
Object.toString()
public RegisterTaskDefinitionRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()