public static interface RunTaskRequest.Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder<RunTaskRequest.Builder,RunTaskRequest>
| Modifier and Type | Method and Description |
|---|---|
RunTaskRequest.Builder |
capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy to use for the task.
|
RunTaskRequest.Builder |
capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy to use for the task.
|
RunTaskRequest.Builder |
capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy)
The capacity provider strategy to use for the task.
|
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 |
enableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to enable Amazon ECS managed tags for the task.
|
RunTaskRequest.Builder |
enableExecuteCommand(Boolean enableExecuteCommand)
Whether or not to enable the execute command functionality for the containers in this task.
|
RunTaskRequest.Builder |
group(String group)
The name of the task group to associate with the task.
|
RunTaskRequest.Builder |
launchType(LaunchType launchType)
The launch type on which to run your task.
|
RunTaskRequest.Builder |
launchType(String launchType)
The launch type on which to run your 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.
|
RunTaskRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
RunTaskRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
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(Consumer<PlacementConstraint.Builder>... 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(Consumer<PlacementStrategy.Builder>... 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 |
platformVersion(String platformVersion)
The platform version the task should run.
|
RunTaskRequest.Builder |
propagateTags(PropagateTags propagateTags)
Specifies whether to propagate the tags from the task definition to the task.
|
RunTaskRequest.Builder |
propagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition to the task.
|
RunTaskRequest.Builder |
referenceId(String referenceId)
The reference ID to use for the task.
|
RunTaskRequest.Builder |
startedBy(String startedBy)
An optional tag specified when a task is started.
|
RunTaskRequest.Builder |
tags(Collection<Tag> tags)
The metadata that you apply to the task to help you categorize and organize them.
|
RunTaskRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
The metadata that you apply to the task to help you categorize and organize them.
|
RunTaskRequest.Builder |
tags(Tag... tags)
The metadata that you apply to the task to help you categorize and organize them.
|
RunTaskRequest.Builder |
taskDefinition(String taskDefinition)
The
family and revision (family:revision) or full ARN of the task
definition to run. |
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildRunTaskRequest.Builder capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be
omitted. If no capacityProviderStrategy or launchType is specified, the
defaultCapacityProviderStrategy for the cluster is used.
capacityProviderStrategy - The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be
omitted. If no capacityProviderStrategy or launchType is specified, the
defaultCapacityProviderStrategy for the cluster is used.
RunTaskRequest.Builder capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be
omitted. If no capacityProviderStrategy or launchType is specified, the
defaultCapacityProviderStrategy for the cluster is used.
capacityProviderStrategy - The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be
omitted. If no capacityProviderStrategy or launchType is specified, the
defaultCapacityProviderStrategy for the cluster is used.
RunTaskRequest.Builder capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy)
The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be
omitted. If no capacityProviderStrategy or launchType is specified, the
defaultCapacityProviderStrategy for the cluster is used.
List.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 #capacityProviderStrategy(List)
.capacityProviderStrategy - a consumer that will call methods on List.Builder #capacityProviderStrategy(List) 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 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 enableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
enableECSManagedTags - Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your
Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.RunTaskRequest.Builder enableExecuteCommand(Boolean enableExecuteCommand)
Whether or not to enable the execute command functionality for the containers in this task. If
true, this enables execute command functionality on all containers in the task.
enableExecuteCommand - Whether or not to enable the execute command functionality for the containers in this task. If
true, this enables execute command functionality on all containers in the task.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 launchType(String launchType)
The launch type on which to run your task. The accepted values are FARGATE and EC2.
For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.
When a value of FARGATE is specified, your tasks are launched on AWS Fargate On-Demand
infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the
FARGATE_SPOT capacity provider.
When a value of EC2 is specified, your tasks are launched on Amazon EC2 instances registered to
your cluster.
If a launchType is specified, the capacityProviderStrategy parameter must be
omitted.
launchType - The launch type on which to run your task. The accepted values are FARGATE and
EC2. For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.
When a value of FARGATE is specified, your tasks are launched on AWS Fargate On-Demand
infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the
FARGATE_SPOT capacity provider.
When a value of EC2 is specified, your tasks are launched on Amazon EC2 instances
registered to your cluster.
If a launchType is specified, the capacityProviderStrategy parameter must be
omitted.
LaunchType,
LaunchTypeRunTaskRequest.Builder launchType(LaunchType launchType)
The launch type on which to run your task. The accepted values are FARGATE and EC2.
For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.
When a value of FARGATE is specified, your tasks are launched on AWS Fargate On-Demand
infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the
FARGATE_SPOT capacity provider.
When a value of EC2 is specified, your tasks are launched on Amazon EC2 instances registered to
your cluster.
If a launchType is specified, the capacityProviderStrategy parameter must be
omitted.
launchType - The launch type on which to run your task. The accepted values are FARGATE and
EC2. For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.
When a value of FARGATE is specified, your tasks are launched on AWS Fargate On-Demand
infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the
FARGATE_SPOT capacity provider.
When a value of EC2 is specified, your tasks are launched on Amazon EC2 instances
registered to your cluster.
If a launchType is specified, the capacityProviderStrategy parameter must be
omitted.
LaunchType,
LaunchTypeRunTaskRequest.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 Elastic 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 Elastic 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 Elastic 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.BuildernetworkConfiguration(NetworkConfiguration)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.Builderoverrides(TaskOverride)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 runtime).
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 runtime).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 runtime).
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 runtime).RunTaskRequest.Builder placementConstraints(Consumer<PlacementConstraint.Builder>... 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 runtime).
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) RunTaskRequest.Builder placementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
placementStrategy - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules
per task.RunTaskRequest.Builder placementStrategy(PlacementStrategy... placementStrategy)
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
placementStrategy - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules
per task.RunTaskRequest.Builder placementStrategy(Consumer<PlacementStrategy.Builder>... placementStrategy)
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per 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 #placementStrategy(List) .placementStrategy - a consumer that will call methods on List.Builder #placementStrategy(List) RunTaskRequest.Builder platformVersion(String platformVersion)
The platform version the task should run. A platform version is only specified for tasks using the Fargate
launch type. If one is not specified, the LATEST platform version is used by default. For more
information, see AWS Fargate
Platform Versions in the Amazon Elastic Container Service Developer Guide.
platformVersion - The platform version the task should run. A platform version is only specified for tasks using the
Fargate launch type. If one is not specified, the LATEST platform version is used by
default. For more information, see AWS Fargate
Platform Versions in the Amazon Elastic Container Service Developer Guide.RunTaskRequest.Builder propagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
An error will be received if you specify the SERVICE option when running a task.
propagateTags - Specifies whether to propagate the tags from the task definition to the task. If no value is
specified, the tags are not propagated. Tags can only be propagated to the task during task creation.
To add tags to a task after task creation, use the TagResource API action.
An error will be received if you specify the SERVICE option when running a task.
PropagateTags,
PropagateTagsRunTaskRequest.Builder propagateTags(PropagateTags propagateTags)
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
An error will be received if you specify the SERVICE option when running a task.
propagateTags - Specifies whether to propagate the tags from the task definition to the task. If no value is
specified, the tags are not propagated. Tags can only be propagated to the task during task creation.
To add tags to a task after task creation, use the TagResource API action.
An error will be received if you specify the SERVICE option when running a task.
PropagateTags,
PropagateTagsRunTaskRequest.Builder referenceId(String referenceId)
The reference ID to use for the task.
referenceId - The reference ID to use for the task.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 tags(Collection<Tag> tags)
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix
for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with
this prefix. Tags with this prefix do not count against your tags per resource limit.
tags - The metadata that you apply to the task to help you categorize and organize them. Each tag consists of
a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a
prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or
values with this prefix. Tags with this prefix do not count against your tags per resource limit.
RunTaskRequest.Builder tags(Tag... tags)
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix
for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with
this prefix. Tags with this prefix do not count against your tags per resource limit.
tags - The metadata that you apply to the task to help you categorize and organize them. Each tag consists of
a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a
prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or
values with this prefix. Tags with this prefix do not count against your tags per resource limit.
RunTaskRequest.Builder tags(Consumer<Tag.Builder>... tags)
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix
for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with
this prefix. Tags with this prefix do not count against your tags per resource limit.
List.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 #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) RunTaskRequest.Builder taskDefinition(String taskDefinition)
The family and revision (family:revision) or full 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 ARN of the
task definition to run. If a revision is not specified, the latest ACTIVE
revision is used.RunTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderRunTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.