public static interface TaskDefinition.Builder extends CopyableBuilder<TaskDefinition.Builder,TaskDefinition>
Modifier and Type | Method and Description |
---|---|
TaskDefinition.Builder |
containerDefinitions(Collection<ContainerDefinition> containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
|
TaskDefinition.Builder |
containerDefinitions(Consumer<ContainerDefinition.Builder>... containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
|
TaskDefinition.Builder |
containerDefinitions(ContainerDefinition... containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task.
|
TaskDefinition.Builder |
family(String family)
The family of your task definition, used as the definition name.
|
TaskDefinition.Builder |
networkMode(NetworkMode networkMode)
The Docker networking mode to use for the containers in the task.
|
TaskDefinition.Builder |
networkMode(String networkMode)
The Docker networking mode to use for the containers in the task.
|
TaskDefinition.Builder |
placementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks.
|
TaskDefinition.Builder |
placementConstraints(Consumer<TaskDefinitionPlacementConstraint.Builder>... placementConstraints)
An array of placement constraint objects to use for tasks.
|
TaskDefinition.Builder |
placementConstraints(TaskDefinitionPlacementConstraint... placementConstraints)
An array of placement constraint objects to use for tasks.
|
TaskDefinition.Builder |
requiresAttributes(Attribute... requiresAttributes)
The container instance attributes required by your task.
|
TaskDefinition.Builder |
requiresAttributes(Collection<Attribute> requiresAttributes)
The container instance attributes required by your task.
|
TaskDefinition.Builder |
requiresAttributes(Consumer<Attribute.Builder>... requiresAttributes)
The container instance attributes required by your task.
|
TaskDefinition.Builder |
revision(Integer revision)
The revision of the task in a particular family.
|
TaskDefinition.Builder |
status(String status)
The status of the task definition.
|
TaskDefinition.Builder |
status(TaskDefinitionStatus status)
The status of the task definition.
|
TaskDefinition.Builder |
taskDefinitionArn(String taskDefinitionArn)
The full Amazon Resource Name (ARN) of the task definition.
|
TaskDefinition.Builder |
taskRoleArn(String taskRoleArn)
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
|
TaskDefinition.Builder |
volumes(Collection<Volume> volumes)
The list of volumes in a task.
|
TaskDefinition.Builder |
volumes(Consumer<Volume.Builder>... volumes)
The list of volumes in a task.
|
TaskDefinition.Builder |
volumes(Volume... volumes)
The list of volumes in a task.
|
copy
applyMutation, build
TaskDefinition.Builder taskDefinitionArn(String taskDefinitionArn)
The full Amazon Resource Name (ARN) of the task definition.
taskDefinitionArn
- The full Amazon Resource Name (ARN) of the task definition.TaskDefinition.Builder containerDefinitions(Collection<ContainerDefinition> containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
containerDefinitions
- A list of container definitions in JSON format that describe the different containers that make up
your task. For more information about container definition parameters and defaults, see Amazon ECS Task
Definitions in the Amazon EC2 Container Service Developer Guide.TaskDefinition.Builder containerDefinitions(ContainerDefinition... containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
containerDefinitions
- A list of container definitions in JSON format that describe the different containers that make up
your task. For more information about container definition parameters and defaults, see Amazon ECS Task
Definitions in the Amazon EC2 Container Service Developer Guide.TaskDefinition.Builder containerDefinitions(Consumer<ContainerDefinition.Builder>... containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
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)
TaskDefinition.Builder family(String family)
The family of your task definition, used as the definition name.
family
- The family of your task definition, used as the definition name.TaskDefinition.Builder taskRoleArn(String taskRoleArn)
The 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.
taskRoleArn
- The 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.TaskDefinition.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
.
If the network mode is none
, the containers do not have external connectivity. The default
Docker network mode is bridge
. If the network mode is awsvpc
, the task is allocated
an Elastic Network Interface. 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.
For more information, see Network settings in the Docker run reference.
networkMode
- The Docker networking mode to use for the containers in the task. The valid values are
none
, bridge
, awsvpc
, and host
.
If the network mode is none
, the containers do not have external connectivity. The
default Docker network mode is bridge
. If the network mode is awsvpc
, the
task is allocated an Elastic Network Interface. 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.
For more information, see Network settings in the Docker run reference.
NetworkMode
,
NetworkMode
TaskDefinition.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
.
If the network mode is none
, the containers do not have external connectivity. The default
Docker network mode is bridge
. If the network mode is awsvpc
, the task is allocated
an Elastic Network Interface. 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.
For more information, see Network settings in the Docker run reference.
networkMode
- The Docker networking mode to use for the containers in the task. The valid values are
none
, bridge
, awsvpc
, and host
.
If the network mode is none
, the containers do not have external connectivity. The
default Docker network mode is bridge
. If the network mode is awsvpc
, the
task is allocated an Elastic Network Interface. 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.
For more information, see Network settings in the Docker run reference.
NetworkMode
,
NetworkMode
TaskDefinition.Builder revision(Integer revision)
The revision of the task in a particular family. The revision is a version number of a task definition in a
family. When you register a task definition for the first time, the revision is 1
; each time you
register a new revision of a task definition in the same family, the revision value always increases by one
(even if you have deregistered previous revisions in this family).
revision
- The revision of the task in a particular family. The revision is a version number of a task definition
in a family. When you register a task definition for the first time, the revision is 1
;
each time you register a new revision of a task definition in the same family, the revision value
always increases by one (even if you have deregistered previous revisions in this family).TaskDefinition.Builder volumes(Collection<Volume> volumes)
The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
volumes
- The list of volumes in a task. For more information about volume definition parameters and defaults,
see Amazon
ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.TaskDefinition.Builder volumes(Volume... volumes)
The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
volumes
- The list of volumes in a task. For more information about volume definition parameters and defaults,
see Amazon
ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.TaskDefinition.Builder volumes(Consumer<Volume.Builder>... volumes)
The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
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)
TaskDefinition.Builder status(String status)
The status of the task definition.
status
- The status of the task definition.TaskDefinitionStatus
,
TaskDefinitionStatus
TaskDefinition.Builder status(TaskDefinitionStatus status)
The status of the task definition.
status
- The status of the task definition.TaskDefinitionStatus
,
TaskDefinitionStatus
TaskDefinition.Builder requiresAttributes(Collection<Attribute> requiresAttributes)
The container instance attributes required by your task.
requiresAttributes
- The container instance attributes required by your task.TaskDefinition.Builder requiresAttributes(Attribute... requiresAttributes)
The container instance attributes required by your task.
requiresAttributes
- The container instance attributes required by your task.TaskDefinition.Builder requiresAttributes(Consumer<Attribute.Builder>... requiresAttributes)
The container instance attributes required by 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 #requiresAttributes(List)
.requiresAttributes
- a consumer that will call methods on List.Builder
#requiresAttributes(List)
TaskDefinition.Builder placementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks.
placementConstraints
- An array of placement constraint objects to use for tasks.TaskDefinition.Builder placementConstraints(TaskDefinitionPlacementConstraint... placementConstraints)
An array of placement constraint objects to use for tasks.
placementConstraints
- An array of placement constraint objects to use for tasks.TaskDefinition.Builder placementConstraints(Consumer<TaskDefinitionPlacementConstraint.Builder>... placementConstraints)
An array of placement constraint objects to use for tasks.
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)
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.