@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() |
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.
|
String |
getExecutionRoleArn()
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker
daemon can assume.
|
String |
getFamily()
You must specify a
family for a task definition, which allows you to track multiple versions of the
same task definition. |
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() |
List<String> |
getRequiresCompatibilities()
The launch type required by the task.
|
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 may 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 |
setExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker
daemon can assume.
|
void |
setFamily(String family)
You must specify a
family for a task definition, which allows you to track multiple versions of the
same task definition. |
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) |
void |
setRequiresCompatibilities(Collection<String> requiresCompatibilities)
The launch type required by the task.
|
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 may 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 |
withExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker
daemon can assume.
|
RegisterTaskDefinitionRequest |
withFamily(String family)
You must specify a
family for a task definition, which allows you to track multiple versions of the
same task definition. |
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) |
RegisterTaskDefinitionRequest |
withRequiresCompatibilities(Collection<String> requiresCompatibilities)
The launch type required by the task.
|
RegisterTaskDefinitionRequest |
withRequiresCompatibilities(Compatibility... requiresCompatibilities)
The launch type required by the task.
|
RegisterTaskDefinitionRequest |
withRequiresCompatibilities(String... requiresCompatibilities)
The launch type required by the task.
|
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 may use.
|
RegisterTaskDefinitionRequest |
withVolumes(Volume... volumes)
A list of volume definitions in JSON format that containers in your task may use.
|
addHandlerContext, copyBaseTo, 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, which allows you to track multiple versions of the
same task definition. The family
is used as a name for your task definition. Up to 255 letters
(uppercase and lowercase), numbers, hyphens, and underscores are allowed.
family
- You must specify a family
for a task definition, which allows you to track multiple versions
of the same task definition. The family
is used as a name for your task definition. Up to 255
letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.public String getFamily()
You must specify a family
for a task definition, which allows you to track multiple versions of the
same task definition. The family
is used as a name for your task definition. Up to 255 letters
(uppercase and lowercase), numbers, hyphens, and underscores are allowed.
family
for a task definition, which allows you to track multiple versions
of the same task definition. The family
is used as a name for your task definition. Up to
255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.public RegisterTaskDefinitionRequest withFamily(String family)
You must specify a family
for a task definition, which allows you to track multiple versions of the
same task definition. The family
is used as a name for your task definition. Up to 255 letters
(uppercase and lowercase), numbers, hyphens, and underscores are allowed.
family
- You must specify a family
for a task definition, which allows you to track multiple versions
of the same task definition. The family
is used as a name for your task definition. Up to 255
letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.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 the Amazon ECS container agent and the Docker daemon can assume.
executionRoleArn
- The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the
Docker daemon can assume.public String getExecutionRoleArn()
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
public RegisterTaskDefinitionRequest withExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
executionRoleArn
- The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the
Docker daemon can assume.public void setNetworkMode(String networkMode)
The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. The default Docker network mode is
bridge
. If you are using the Fargate launch type, the awsvpc
network mode is required.
If you are using the EC2 launch type, any network mode can be used. If the network mode is set to
none
, you cannot specify port mappings in your container definitions, and the tasks containers do
not have external connectivity. The host
and awsvpc
network modes offer the highest
networking performance for containers because they use the EC2 network stack instead of the virtualized network
stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to
the corresponding host port (for the host
network mode) or the attached elastic network interface
port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you must
specify a NetworkConfiguration value when you create a service or run a task with the task definition. For
more information, see Task Networking in the
Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init
package, or
AWS Fargate infrastructure support the awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the same task on a single
container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with
Windows containers, you must not specify a network mode. If you use the console to register a task definition
with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference.
networkMode
- The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. The default Docker network mode is
bridge
. If you are using the Fargate launch type, the awsvpc
network mode is
required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set
to none
, you cannot specify port mappings in your container definitions, and the tasks
containers do not have external connectivity. The host
and awsvpc
network modes
offer the highest networking performance for containers because they use the EC2 network stack instead of
the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped
directly to the corresponding host port (for the host
network mode) or the attached elastic
network interface port (for the awsvpc
network mode), so you cannot take advantage of dynamic
host port mappings.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you
must specify a NetworkConfiguration value when you create a service or run a task with the task
definition. For more information, see Task Networking
in the Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init
package, or AWS Fargate infrastructure support the awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the same task on a
single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition
with Windows containers, you must not specify a network mode. If you use the console to register a task
definition with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference.
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
. The default Docker network mode is
bridge
. If you are using the Fargate launch type, the awsvpc
network mode is required.
If you are using the EC2 launch type, any network mode can be used. If the network mode is set to
none
, you cannot specify port mappings in your container definitions, and the tasks containers do
not have external connectivity. The host
and awsvpc
network modes offer the highest
networking performance for containers because they use the EC2 network stack instead of the virtualized network
stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to
the corresponding host port (for the host
network mode) or the attached elastic network interface
port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you must
specify a NetworkConfiguration value when you create a service or run a task with the task definition. For
more information, see Task Networking in the
Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init
package, or
AWS Fargate infrastructure support the awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the same task on a single
container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with
Windows containers, you must not specify a network mode. If you use the console to register a task definition
with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference.
none
,
bridge
, awsvpc
, and host
. The default Docker network mode is
bridge
. If you are using the Fargate launch type, the awsvpc
network mode is
required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set
to none
, you cannot specify port mappings in your container definitions, and the tasks
containers do not have external connectivity. The host
and awsvpc
network modes
offer the highest networking performance for containers because they use the EC2 network stack instead of
the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped
directly to the corresponding host port (for the host
network mode) or the attached elastic
network interface port (for the awsvpc
network mode), so you cannot take advantage of
dynamic host port mappings.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you
must specify a NetworkConfiguration value when you create a service or run a task with the task
definition. For more information, see Task
Networking in the Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init
package, or AWS Fargate infrastructure support the awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the same task on a
single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task
definition with Windows containers, you must not specify a network mode. If you use the console to
register a task definition with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference.
NetworkMode
public 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
. The default Docker network mode is
bridge
. If you are using the Fargate launch type, the awsvpc
network mode is required.
If you are using the EC2 launch type, any network mode can be used. If the network mode is set to
none
, you cannot specify port mappings in your container definitions, and the tasks containers do
not have external connectivity. The host
and awsvpc
network modes offer the highest
networking performance for containers because they use the EC2 network stack instead of the virtualized network
stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to
the corresponding host port (for the host
network mode) or the attached elastic network interface
port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you must
specify a NetworkConfiguration value when you create a service or run a task with the task definition. For
more information, see Task Networking in the
Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init
package, or
AWS Fargate infrastructure support the awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the same task on a single
container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with
Windows containers, you must not specify a network mode. If you use the console to register a task definition
with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference.
networkMode
- The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. The default Docker network mode is
bridge
. If you are using the Fargate launch type, the awsvpc
network mode is
required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set
to none
, you cannot specify port mappings in your container definitions, and the tasks
containers do not have external connectivity. The host
and awsvpc
network modes
offer the highest networking performance for containers because they use the EC2 network stack instead of
the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped
directly to the corresponding host port (for the host
network mode) or the attached elastic
network interface port (for the awsvpc
network mode), so you cannot take advantage of dynamic
host port mappings.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you
must specify a NetworkConfiguration value when you create a service or run a task with the task
definition. For more information, see Task Networking
in the Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init
package, or AWS Fargate infrastructure support the awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the same task on a
single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition
with Windows containers, you must not specify a network mode. If you use the console to register a task
definition with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference.
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
. The default Docker network mode is
bridge
. If you are using the Fargate launch type, the awsvpc
network mode is required.
If you are using the EC2 launch type, any network mode can be used. If the network mode is set to
none
, you cannot specify port mappings in your container definitions, and the tasks containers do
not have external connectivity. The host
and awsvpc
network modes offer the highest
networking performance for containers because they use the EC2 network stack instead of the virtualized network
stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to
the corresponding host port (for the host
network mode) or the attached elastic network interface
port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you must
specify a NetworkConfiguration value when you create a service or run a task with the task definition. For
more information, see Task Networking in the
Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init
package, or
AWS Fargate infrastructure support the awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the same task on a single
container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with
Windows containers, you must not specify a network mode. If you use the console to register a task definition
with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference.
networkMode
- The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. The default Docker network mode is
bridge
. If you are using the Fargate launch type, the awsvpc
network mode is
required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set
to none
, you cannot specify port mappings in your container definitions, and the tasks
containers do not have external connectivity. The host
and awsvpc
network modes
offer the highest networking performance for containers because they use the EC2 network stack instead of
the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped
directly to the corresponding host port (for the host
network mode) or the attached elastic
network interface port (for the awsvpc
network mode), so you cannot take advantage of dynamic
host port mappings.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you
must specify a NetworkConfiguration value when you create a service or run a task with the task
definition. For more information, see Task Networking
in the Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init
package, or AWS Fargate infrastructure support the awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the same task on a
single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition
with Windows containers, you must not specify a network mode. If you use the console to register a task
definition with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference.
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
. The default Docker network mode is
bridge
. If you are using the Fargate launch type, the awsvpc
network mode is required.
If you are using the EC2 launch type, any network mode can be used. If the network mode is set to
none
, you cannot specify port mappings in your container definitions, and the tasks containers do
not have external connectivity. The host
and awsvpc
network modes offer the highest
networking performance for containers because they use the EC2 network stack instead of the virtualized network
stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to
the corresponding host port (for the host
network mode) or the attached elastic network interface
port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you must
specify a NetworkConfiguration value when you create a service or run a task with the task definition. For
more information, see Task Networking in the
Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init
package, or
AWS Fargate infrastructure support the awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the same task on a single
container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with
Windows containers, you must not specify a network mode. If you use the console to register a task definition
with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference.
networkMode
- The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. The default Docker network mode is
bridge
. If you are using the Fargate launch type, the awsvpc
network mode is
required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set
to none
, you cannot specify port mappings in your container definitions, and the tasks
containers do not have external connectivity. The host
and awsvpc
network modes
offer the highest networking performance for containers because they use the EC2 network stack instead of
the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped
directly to the corresponding host port (for the host
network mode) or the attached elastic
network interface port (for the awsvpc
network mode), so you cannot take advantage of dynamic
host port mappings.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you
must specify a NetworkConfiguration value when you create a service or run a task with the task
definition. For more information, see Task Networking
in the Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init
package, or AWS Fargate infrastructure support the awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the same task on a
single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition
with Windows containers, you must not specify a network mode. If you use the console to register a task
definition with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference.
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 may use.
public void setVolumes(Collection<Volume> volumes)
A list of volume definitions in JSON format that containers in your task may use.
volumes
- A list of volume definitions in JSON format that containers in your task may use.public RegisterTaskDefinitionRequest withVolumes(Volume... volumes)
A list of volume definitions in JSON format that containers in your task may 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 may use.public RegisterTaskDefinitionRequest withVolumes(Collection<Volume> volumes)
A list of volume definitions in JSON format that containers in your task may use.
volumes
- A list of volume definitions in JSON format that containers in your task may use.public List<TaskDefinitionPlacementConstraint> getPlacementConstraints()
An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
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 per 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
per 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 per 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
per 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 per 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
per task (this limit includes constraints in the task definition and those specified at runtime).public List<String> getRequiresCompatibilities()
The launch type required by the task. If no value is specified, it defaults to EC2
.
EC2
.Compatibility
public void setRequiresCompatibilities(Collection<String> requiresCompatibilities)
The launch type required by the task. If no value is specified, it defaults to EC2
.
requiresCompatibilities
- The launch type required by the task. If no value is specified, it defaults to EC2
.Compatibility
public RegisterTaskDefinitionRequest withRequiresCompatibilities(String... requiresCompatibilities)
The launch type required by the task. If no value is specified, it defaults to EC2
.
NOTE: This method appends the values to the existing list (if any). Use
setRequiresCompatibilities(java.util.Collection)
or
withRequiresCompatibilities(java.util.Collection)
if you want to override the existing values.
requiresCompatibilities
- The launch type required by the task. If no value is specified, it defaults to EC2
.Compatibility
public RegisterTaskDefinitionRequest withRequiresCompatibilities(Collection<String> requiresCompatibilities)
The launch type required by the task. If no value is specified, it defaults to EC2
.
requiresCompatibilities
- The launch type required by the task. If no value is specified, it defaults to EC2
.Compatibility
public RegisterTaskDefinitionRequest withRequiresCompatibilities(Compatibility... requiresCompatibilities)
The launch type required by the task. If no value is specified, it defaults to EC2
.
requiresCompatibilities
- The launch type required by the task. If no value is specified, it defaults to EC2
.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 are using the EC2 launch type, this field is optional. Supported values are between 128
CPU
units (0.125
vCPUs) and 10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values,
which determines your range of supported values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6
GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024
(1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024
(1 GB)
cpu
- The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example
1024
, or as a string using vCPUs, for example 1 vCPU
or 1 vcpu
, in
a task definition. String values are converted to an integer indicating the CPU units when the task
definition is registered. Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you are using the EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and 10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following
values, which determines your range of supported values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB),
6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments
of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments
of 1024 (1 GB)
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 are using the EC2 launch type, this field is optional. Supported values are between 128
CPU
units (0.125
vCPUs) and 10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values,
which determines your range of supported values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6
GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024
(1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024
(1 GB)
1024
, or as a string using vCPUs, for example 1 vCPU
or 1 vcpu
, in
a task definition. String values are converted to an integer indicating the CPU units when the task
definition is registered. Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you are using the EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and 10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following
values, which determines your range of supported values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB),
6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments
of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments
of 1024 (1 GB)
public 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 are using the EC2 launch type, this field is optional. Supported values are between 128
CPU
units (0.125
vCPUs) and 10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values,
which determines your range of supported values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6
GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024
(1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024
(1 GB)
cpu
- The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example
1024
, or as a string using vCPUs, for example 1 vCPU
or 1 vcpu
, in
a task definition. String values are converted to an integer indicating the CPU units when the task
definition is registered. Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you are using the EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and 10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following
values, which determines your range of supported values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB),
6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments
of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments
of 1024 (1 GB)
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, which
determines your range of supported values for the cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2
vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4
vCPU)
memory
- The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example
1024
, or as a string using GB, for example 1GB
or 1 GB
, in a task
definition. String values are converted to an integer indicating the MiB when the task definition is
registered. Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If using the EC2 launch type, this field is optional.
If using the Fargate launch type, this field is required and you must use one of the following values,
which determines your range of supported values for the cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values:
2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values:
4096 (4 vCPU)
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, which
determines your range of supported values for the cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2
vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4
vCPU)
1024
, or as a string using GB, for example 1GB
or 1 GB
, in a task
definition. String values are converted to an integer indicating the MiB when the task definition is
registered. Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If using the EC2 launch type, this field is optional.
If using the Fargate launch type, this field is required and you must use one of the following values,
which determines your range of supported values for the cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values:
2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values:
4096 (4 vCPU)
public 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, which
determines your range of supported values for the cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2
vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4
vCPU)
memory
- The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example
1024
, or as a string using GB, for example 1GB
or 1 GB
, in a task
definition. String values are converted to an integer indicating the MiB when the task definition is
registered. Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If using the EC2 launch type, this field is optional.
If using the Fargate launch type, this field is required and you must use one of the following values,
which determines your range of supported values for the cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values:
2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values:
4096 (4 vCPU)
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, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
tags
- The metadata that you apply to the task definition to help you categorize and organize them. Each tag
consists of a key and an optional value, both of which you define. Tag keys can have a maximum character
length of 128 characters, and tag values can have a maximum length of 256 characters.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, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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, both of which you define. Tag keys can have a maximum character
length of 128 characters, and tag values can have a maximum length of 256 characters.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, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
tags
- The metadata that you apply to the task definition to help you categorize and organize them. Each tag
consists of a key and an optional value, both of which you define. Tag keys can have a maximum character
length of 128 characters, and tag values can have a maximum length of 256 characters.public void setPidMode(String pidMode)
The process namespace to use for the containers in the task. The valid values are host
or
task
. If host
is specified, then all containers within the tasks that specified the
host
PID mode on the same container instance share the same IPC resources with the host Amazon EC2
instance. If task
is specified, all containers within the specified task share the same process
namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run
reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process
namespace expose. For more information, see Docker
security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
pidMode
- The process namespace to use for the containers in the task. The valid values are host
or
task
. If host
is specified, then all containers within the tasks that specified
the host
PID mode on the same container instance share the same IPC resources with the host
Amazon EC2 instance. If task
is specified, all containers within the specified task share the
same process namespace. If no value is specified, the default is a private namespace. For more
information, see PID
settings in the Docker run reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process
namespace expose. For more information, see Docker security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
PidMode
public String getPidMode()
The process namespace to use for the containers in the task. The valid values are host
or
task
. If host
is specified, then all containers within the tasks that specified the
host
PID mode on the same container instance share the same IPC resources with the host Amazon EC2
instance. If task
is specified, all containers within the specified task share the same process
namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run
reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process
namespace expose. For more information, see Docker
security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
host
or
task
. If host
is specified, then all containers within the tasks that specified
the host
PID mode on the same container instance share the same IPC resources with the host
Amazon EC2 instance. If task
is specified, all containers within the specified task share
the same process namespace. If no value is specified, the default is a private namespace. For more
information, see PID
settings in the Docker run reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process
namespace expose. For more information, see Docker security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
PidMode
public RegisterTaskDefinitionRequest withPidMode(String pidMode)
The process namespace to use for the containers in the task. The valid values are host
or
task
. If host
is specified, then all containers within the tasks that specified the
host
PID mode on the same container instance share the same IPC resources with the host Amazon EC2
instance. If task
is specified, all containers within the specified task share the same process
namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run
reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process
namespace expose. For more information, see Docker
security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
pidMode
- The process namespace to use for the containers in the task. The valid values are host
or
task
. If host
is specified, then all containers within the tasks that specified
the host
PID mode on the same container instance share the same IPC resources with the host
Amazon EC2 instance. If task
is specified, all containers within the specified task share the
same process namespace. If no value is specified, the default is a private namespace. For more
information, see PID
settings in the Docker run reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process
namespace expose. For more information, see Docker security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
PidMode
public void setPidMode(PidMode pidMode)
The process namespace to use for the containers in the task. The valid values are host
or
task
. If host
is specified, then all containers within the tasks that specified the
host
PID mode on the same container instance share the same IPC resources with the host Amazon EC2
instance. If task
is specified, all containers within the specified task share the same process
namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run
reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process
namespace expose. For more information, see Docker
security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
pidMode
- The process namespace to use for the containers in the task. The valid values are host
or
task
. If host
is specified, then all containers within the tasks that specified
the host
PID mode on the same container instance share the same IPC resources with the host
Amazon EC2 instance. If task
is specified, all containers within the specified task share the
same process namespace. If no value is specified, the default is a private namespace. For more
information, see PID
settings in the Docker run reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process
namespace expose. For more information, see Docker security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
PidMode
public RegisterTaskDefinitionRequest withPidMode(PidMode pidMode)
The process namespace to use for the containers in the task. The valid values are host
or
task
. If host
is specified, then all containers within the tasks that specified the
host
PID mode on the same container instance share the same IPC resources with the host Amazon EC2
instance. If task
is specified, all containers within the specified task share the same process
namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run
reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process
namespace expose. For more information, see Docker
security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
pidMode
- The process namespace to use for the containers in the task. The valid values are host
or
task
. If host
is specified, then all containers within the tasks that specified
the host
PID mode on the same container instance share the same IPC resources with the host
Amazon EC2 instance. If task
is specified, all containers within the specified task share the
same process namespace. If no value is specified, the default is a private namespace. For more
information, see PID
settings in the Docker run reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process
namespace expose. For more information, see Docker security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
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 using the Fargate launch type.
ipcMode
- The IPC resource namespace to use for the containers in the task. The valid values are host
,
task
, or none
. If host
is specified, then all containers within the
tasks that specified the host
IPC mode on the same container instance share the same IPC
resources with the host Amazon EC2 instance. If task
is specified, all containers within the
specified task share the same IPC resources. If none
is specified, then IPC resources within
the containers of a task are private and not shared with other containers in a task or on the container
instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon
setting on the container instance. For more information, see IPC settings in the Docker
run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC
namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in
the task, the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are
not supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will
apply to all containers within a task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
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 using the Fargate launch type.
host
,
task
, or none
. If host
is specified, then all containers within
the tasks that specified the host
IPC mode on the same container instance share the same IPC
resources with the host Amazon EC2 instance. If task
is specified, all containers within the
specified task share the same IPC resources. If none
is specified, then IPC resources within
the containers of a task are private and not shared with other containers in a task or on the container
instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon
setting on the container instance. For more information, see IPC settings in the Docker
run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC
namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in
the task, the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are
not supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will
apply to all containers within a task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
IpcMode
public 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 using the Fargate launch type.
ipcMode
- The IPC resource namespace to use for the containers in the task. The valid values are host
,
task
, or none
. If host
is specified, then all containers within the
tasks that specified the host
IPC mode on the same container instance share the same IPC
resources with the host Amazon EC2 instance. If task
is specified, all containers within the
specified task share the same IPC resources. If none
is specified, then IPC resources within
the containers of a task are private and not shared with other containers in a task or on the container
instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon
setting on the container instance. For more information, see IPC settings in the Docker
run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC
namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in
the task, the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are
not supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will
apply to all containers within a task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
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 using the Fargate launch type.
ipcMode
- The IPC resource namespace to use for the containers in the task. The valid values are host
,
task
, or none
. If host
is specified, then all containers within the
tasks that specified the host
IPC mode on the same container instance share the same IPC
resources with the host Amazon EC2 instance. If task
is specified, all containers within the
specified task share the same IPC resources. If none
is specified, then IPC resources within
the containers of a task are private and not shared with other containers in a task or on the container
instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon
setting on the container instance. For more information, see IPC settings in the Docker
run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC
namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in
the task, the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are
not supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will
apply to all containers within a task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
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 using the Fargate launch type.
ipcMode
- The IPC resource namespace to use for the containers in the task. The valid values are host
,
task
, or none
. If host
is specified, then all containers within the
tasks that specified the host
IPC mode on the same container instance share the same IPC
resources with the host Amazon EC2 instance. If task
is specified, all containers within the
specified task share the same IPC resources. If none
is specified, then IPC resources within
the containers of a task are private and not shared with other containers in a task or on the container
instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon
setting on the container instance. For more information, see IPC settings in the Docker
run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC
namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in
the task, the following will apply to your IPC resource namespace. For more information, see System
Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are
not supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will
apply to all containers within a task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
IpcMode
public void setProxyConfiguration(ProxyConfiguration proxyConfiguration)
proxyConfiguration
- public ProxyConfiguration getProxyConfiguration()
public RegisterTaskDefinitionRequest withProxyConfiguration(ProxyConfiguration proxyConfiguration)
proxyConfiguration
- public String toString()
toString
in class Object
Object.toString()
public RegisterTaskDefinitionRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2019. All rights reserved.