public static interface RunTaskRequest.Builder extends ECSRequest.Builder, CopyableBuilder<RunTaskRequest.Builder,RunTaskRequest>
Modifier and Type | Method and Description |
---|---|
RunTaskRequest.Builder |
cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.
|
RunTaskRequest.Builder |
count(Integer count)
The number of instantiations of the specified task to place on your cluster.
|
RunTaskRequest.Builder |
group(String group)
The name of the task group to associate with the task.
|
default RunTaskRequest.Builder |
networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)
The network configuration for the task.
|
RunTaskRequest.Builder |
networkConfiguration(NetworkConfiguration networkConfiguration)
The network configuration for the task.
|
default RunTaskRequest.Builder |
overrides(Consumer<TaskOverride.Builder> overrides)
A list of container overrides in JSON format that specify the name of a container in the specified task
definition and the overrides it should receive.
|
RunTaskRequest.Builder |
overrides(TaskOverride overrides)
A list of container overrides in JSON format that specify the name of a container in the specified task
definition and the overrides it should receive.
|
RunTaskRequest.Builder |
placementConstraints(Collection<PlacementConstraint> placementConstraints)
An array of placement constraint objects to use for the task.
|
RunTaskRequest.Builder |
placementConstraints(PlacementConstraint... placementConstraints)
An array of placement constraint objects to use for the task.
|
RunTaskRequest.Builder |
placementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for the task.
|
RunTaskRequest.Builder |
placementStrategy(PlacementStrategy... placementStrategy)
The placement strategy objects to use for the task.
|
RunTaskRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
RunTaskRequest.Builder |
startedBy(String startedBy)
An optional tag specified when a task is started.
|
RunTaskRequest.Builder |
taskDefinition(String taskDefinition)
The
family and revision (family:revision ) or full Amazon Resource Name
(ARN) of the task definition to run. |
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
RunTaskRequest.Builder cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.
cluster
- The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do
not specify a cluster, the default cluster is assumed.RunTaskRequest.Builder taskDefinition(String taskDefinition)
The family
and revision
(family:revision
) or full Amazon Resource Name
(ARN) of the task definition to run. If a revision
is not specified, the latest
ACTIVE
revision is used.
taskDefinition
- The family
and revision
(family:revision
) or full Amazon
Resource Name (ARN) of the task definition to run. If a revision
is not specified, the
latest ACTIVE
revision is used.RunTaskRequest.Builder overrides(TaskOverride overrides)
A list of container overrides in JSON format that specify the name of a container in the specified task
definition and the overrides it should receive. You can override the default command for a container (that is
specified in the task definition or Docker image) with a command
override. You can also override
existing environment variables (that are specified in the task definition or Docker image) on a container or
add new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
overrides
- A list of container overrides in JSON format that specify the name of a container in the specified
task definition and the overrides it should receive. You can override the default command for a
container (that is specified in the task definition or Docker image) with a command
override. You can also override existing environment variables (that are specified in the task
definition or Docker image) on a container or add new environment variables to it with an
environment
override. A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
default RunTaskRequest.Builder overrides(Consumer<TaskOverride.Builder> overrides)
A list of container overrides in JSON format that specify the name of a container in the specified task
definition and the overrides it should receive. You can override the default command for a container (that is
specified in the task definition or Docker image) with a command
override. You can also override
existing environment variables (that are specified in the task definition or Docker image) on a container or
add new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
TaskOverride.Builder
avoiding the need
to create one manually via TaskOverride.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to overrides(TaskOverride)
.overrides
- a consumer that will call methods on TaskOverride.Builder
overrides(TaskOverride)
RunTaskRequest.Builder count(Integer count)
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.
count
- The number of instantiations of the specified task to place on your cluster. You can specify up to 10
tasks per call.RunTaskRequest.Builder startedBy(String startedBy)
An optional tag specified when a task is started. For example if you automatically trigger a task to run a
batch process job, you could apply a unique identifier for that job to your task with the
startedBy
parameter. You can then identify which tasks belong to that job by filtering the
results of a ListTasks call with the startedBy
value. Up to 36 letters (uppercase and
lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter contains the
deployment ID of the service that starts it.
startedBy
- An optional tag specified when a task is started. For example if you automatically trigger a task to
run a batch process job, you could apply a unique identifier for that job to your task with the
startedBy
parameter. You can then identify which tasks belong to that job by filtering
the results of a ListTasks call with the startedBy
value. Up to 36 letters
(uppercase and lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter contains the
deployment ID of the service that starts it.
RunTaskRequest.Builder group(String group)
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
group
- The name of the task group to associate with the task. The default value is the family name of the
task definition (for example, family:my-family-name).RunTaskRequest.Builder placementConstraints(Collection<PlacementConstraint> placementConstraints)
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including 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 up to 10 constraints per
task (including constraints in the task definition and those specified at run time).RunTaskRequest.Builder placementConstraints(PlacementConstraint... placementConstraints)
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including 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 up to 10 constraints per
task (including constraints in the task definition and those specified at run time).RunTaskRequest.Builder placementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.
placementStrategy
- The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per
task.RunTaskRequest.Builder placementStrategy(PlacementStrategy... placementStrategy)
The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.
placementStrategy
- The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per
task.RunTaskRequest.Builder networkConfiguration(NetworkConfiguration networkConfiguration)
The network configuration for the task. This parameter is required for task definitions that use the
awsvpc
network mode to receive their own Elastic Network Interface, and it is not supported for
other network modes. For more information, see Task Networking in
the Amazon EC2 Container Service Developer Guide.
networkConfiguration
- The network configuration for the task. This parameter is required for task definitions that use the
awsvpc
network mode to receive their own Elastic Network Interface, and it is not
supported for other network modes. For more information, see Task
Networking in the Amazon EC2 Container Service Developer Guide.default RunTaskRequest.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)
The network configuration for the task. This parameter is required for task definitions that use the
awsvpc
network mode to receive their own Elastic Network Interface, and it is not supported for
other network modes. For more information, see Task Networking in
the Amazon EC2 Container Service Developer Guide.
NetworkConfiguration.Builder
avoiding the need
to create one manually via NetworkConfiguration.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to networkConfiguration(NetworkConfiguration)
.networkConfiguration
- a consumer that will call methods on NetworkConfiguration.Builder
networkConfiguration(NetworkConfiguration)
RunTaskRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.