@Generated(value="software.amazon.awssdk:codegen") public final class RegisterTaskDefinitionRequest extends EcsRequest implements ToCopyableBuilder<RegisterTaskDefinitionRequest.Builder,RegisterTaskDefinitionRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
RegisterTaskDefinitionRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static RegisterTaskDefinitionRequest.Builder |
builder() |
List<ContainerDefinition> |
containerDefinitions()
A list of container definitions in JSON format that describe the different containers that make up your task.
|
boolean |
equals(Object obj) |
String |
family()
You must specify a
family for a task definition, which allows you to track multiple versions of the
same task definition. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
NetworkMode |
networkMode()
The Docker networking mode to use for the containers in the task.
|
String |
networkModeAsString()
The Docker networking mode to use for the containers in the task.
|
List<TaskDefinitionPlacementConstraint> |
placementConstraints()
An array of placement constraint objects to use for the task.
|
static Class<? extends RegisterTaskDefinitionRequest.Builder> |
serializableBuilderClass() |
String |
taskRoleArn()
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
|
RegisterTaskDefinitionRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<Volume> |
volumes()
A list of volume definitions in JSON format that containers in your task may use.
|
overrideConfiguration
copy
public String family()
You must specify a family
for a task definition, which allows you to track multiple versions of the
same task definition. The family
is used as a name for your task definition. Up to 255 letters
(uppercase and lowercase), numbers, hyphens, and underscores are allowed.
family
for a task definition, which allows you to track multiple versions
of the same task definition. The family
is used as a name for your task definition. Up to
255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.public String taskRoleArn()
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon EC2 Container Service Developer Guide.
public NetworkMode networkMode()
The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. The default Docker network mode is
bridge
. If the network mode is set to none
, you cannot specify port mappings in your
container definitions, and the task's containers do not have external connectivity. The host
and
awsvpc
network modes offer the highest networking performance for containers because they use the
EC2 network stack instead of the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to
the corresponding host port (for the host
network mode) or the attached ENI port (for the
awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc
, the task is allocated an Elastic Network Interface, and you must
specify a NetworkConfiguration when you create a service or run a task with the task definition. For more
information, see Task
Networking in the Amazon EC2 Container Service Developer Guide.
If the network mode is host
, you can not 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.
If the service returns an enum value that is not available in the current SDK version, networkMode
will
return NetworkMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
networkModeAsString()
.
none
,
bridge
, awsvpc
, and host
. The default Docker network mode is
bridge
. If the network mode is set to none
, you cannot specify port mappings in
your container definitions, and the task's containers do not have external connectivity. The
host
and awsvpc
network modes offer the highest networking performance for
containers because they use the EC2 network stack instead of the virtualized network stack provided by
the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped
directly to the corresponding host port (for the host
network mode) or the attached ENI port
(for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc
, the task is allocated an Elastic Network Interface, and you
must specify a NetworkConfiguration when you create a service or run a task with the task
definition. For more information, see Task Networking
in the Amazon EC2 Container Service Developer Guide.
If the network mode is host
, you can not 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 networkModeAsString()
The Docker networking mode to use for the containers in the task. The valid values are none
,
bridge
, awsvpc
, and host
. The default Docker network mode is
bridge
. If the network mode is set to none
, you cannot specify port mappings in your
container definitions, and the task's containers do not have external connectivity. The host
and
awsvpc
network modes offer the highest networking performance for containers because they use the
EC2 network stack instead of the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to
the corresponding host port (for the host
network mode) or the attached ENI port (for the
awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc
, the task is allocated an Elastic Network Interface, and you must
specify a NetworkConfiguration when you create a service or run a task with the task definition. For more
information, see Task
Networking in the Amazon EC2 Container Service Developer Guide.
If the network mode is host
, you can not 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.
If the service returns an enum value that is not available in the current SDK version, networkMode
will
return NetworkMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
networkModeAsString()
.
none
,
bridge
, awsvpc
, and host
. The default Docker network mode is
bridge
. If the network mode is set to none
, you cannot specify port mappings in
your container definitions, and the task's containers do not have external connectivity. The
host
and awsvpc
network modes offer the highest networking performance for
containers because they use the EC2 network stack instead of the virtualized network stack provided by
the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped
directly to the corresponding host port (for the host
network mode) or the attached ENI port
(for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc
, the task is allocated an Elastic Network Interface, and you
must specify a NetworkConfiguration when you create a service or run a task with the task
definition. For more information, see Task Networking
in the Amazon EC2 Container Service Developer Guide.
If the network mode is host
, you can not 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> containerDefinitions()
A list of container definitions in JSON format that describe the different containers that make up your task.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<Volume> volumes()
A list of volume definitions in JSON format that containers in your task may use.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<TaskDefinitionPlacementConstraint> placementConstraints()
An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public RegisterTaskDefinitionRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RegisterTaskDefinitionRequest.Builder,RegisterTaskDefinitionRequest>
toBuilder
in class EcsRequest
public static RegisterTaskDefinitionRequest.Builder builder()
public static Class<? extends RegisterTaskDefinitionRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.