public static interface RegisterTaskDefinitionRequest.Builder extends EcsRequest.Builder, CopyableBuilder<RegisterTaskDefinitionRequest.Builder,RegisterTaskDefinitionRequest>
Modifier and Type | Method and Description |
---|---|
RegisterTaskDefinitionRequest.Builder |
containerDefinitions(Collection<ContainerDefinition> containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
|
RegisterTaskDefinitionRequest.Builder |
containerDefinitions(Consumer<ContainerDefinition.Builder>... containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
|
RegisterTaskDefinitionRequest.Builder |
containerDefinitions(ContainerDefinition... containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
|
RegisterTaskDefinitionRequest.Builder |
family(String family)
You must specify a
family for a task definition, which allows you to track multiple versions of
the same task definition. |
RegisterTaskDefinitionRequest.Builder |
networkMode(NetworkMode networkMode)
The Docker networking mode to use for the containers in the task.
|
RegisterTaskDefinitionRequest.Builder |
networkMode(String networkMode)
The Docker networking mode to use for the containers in the task.
|
RegisterTaskDefinitionRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
RegisterTaskDefinitionRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
RegisterTaskDefinitionRequest.Builder |
placementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)
An array of placement constraint objects to use for the task.
|
RegisterTaskDefinitionRequest.Builder |
placementConstraints(Consumer<TaskDefinitionPlacementConstraint.Builder>... placementConstraints)
An array of placement constraint objects to use for the task.
|
RegisterTaskDefinitionRequest.Builder |
placementConstraints(TaskDefinitionPlacementConstraint... placementConstraints)
An array of placement constraint objects to use for the task.
|
RegisterTaskDefinitionRequest.Builder |
taskRoleArn(String taskRoleArn)
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
|
RegisterTaskDefinitionRequest.Builder |
volumes(Collection<Volume> volumes)
A list of volume definitions in JSON format that containers in your task may use.
|
RegisterTaskDefinitionRequest.Builder |
volumes(Consumer<Volume.Builder>... volumes)
A list of volume definitions in JSON format that containers in your task may use.
|
RegisterTaskDefinitionRequest.Builder |
volumes(Volume... volumes)
A list of volume definitions in JSON format that containers in your task may use.
|
build
overrideConfiguration
copy
applyMutation, build
RegisterTaskDefinitionRequest.Builder family(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.RegisterTaskDefinitionRequest.Builder taskRoleArn(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.
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.RegisterTaskDefinitionRequest.Builder networkMode(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 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
- 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.
NetworkMode
,
NetworkMode
RegisterTaskDefinitionRequest.Builder networkMode(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.
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.
NetworkMode
,
NetworkMode
RegisterTaskDefinitionRequest.Builder containerDefinitions(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.RegisterTaskDefinitionRequest.Builder containerDefinitions(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.RegisterTaskDefinitionRequest.Builder containerDefinitions(Consumer<ContainerDefinition.Builder>... containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
This is a convenience that creates an instance of theList.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately
and its result is passed to #containerDefinitions(List)
.containerDefinitions
- a consumer that will call methods on List.Builder
#containerDefinitions(List)
RegisterTaskDefinitionRequest.Builder volumes(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.RegisterTaskDefinitionRequest.Builder volumes(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.RegisterTaskDefinitionRequest.Builder volumes(Consumer<Volume.Builder>... volumes)
A list of volume definitions in JSON format that containers in your task may use.
This is a convenience that creates an instance of theList.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #volumes(List)
.volumes
- a consumer that will call methods on List.Builder
#volumes(List)
RegisterTaskDefinitionRequest.Builder placementConstraints(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 run time).
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).RegisterTaskDefinitionRequest.Builder placementConstraints(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).
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).RegisterTaskDefinitionRequest.Builder placementConstraints(Consumer<TaskDefinitionPlacementConstraint.Builder>... 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).
This is a convenience that creates an instance of theList.Builder
avoiding the need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is
called immediately and its result is passed to #placementConstraints(List)
.placementConstraints
- a consumer that will call methods on List.Builder
#placementConstraints(List)
RegisterTaskDefinitionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.RegisterTaskDefinitionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.