public static interface StartTaskRequest.Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder<StartTaskRequest.Builder,StartTaskRequest>
| Modifier and Type | Method and Description |
|---|---|
StartTaskRequest.Builder |
cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster where to start your task.
|
StartTaskRequest.Builder |
containerInstances(Collection<String> containerInstances)
The container instance IDs or full ARN entries for the container instances where you would like to place your
task.
|
StartTaskRequest.Builder |
containerInstances(String... containerInstances)
The container instance IDs or full ARN entries for the container instances where you would like to place your
task.
|
StartTaskRequest.Builder |
enableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to use Amazon ECS managed tags for the task.
|
StartTaskRequest.Builder |
enableExecuteCommand(Boolean enableExecuteCommand)
Whether or not the execute command functionality is turned on for the task.
|
StartTaskRequest.Builder |
group(String group)
The name of the task group to associate with the task.
|
default StartTaskRequest.Builder |
networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the
awsvpc networking mode. |
StartTaskRequest.Builder |
networkConfiguration(NetworkConfiguration networkConfiguration)
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the
awsvpc networking mode. |
StartTaskRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
StartTaskRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
default StartTaskRequest.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 receives.
|
StartTaskRequest.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 receives.
|
StartTaskRequest.Builder |
propagateTags(PropagateTags propagateTags)
Specifies whether to propagate the tags from the task definition or the service to the task.
|
StartTaskRequest.Builder |
propagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition or the service to the task.
|
StartTaskRequest.Builder |
referenceId(String referenceId)
The reference ID to use for the task.
|
StartTaskRequest.Builder |
startedBy(String startedBy)
An optional tag specified when a task is started.
|
StartTaskRequest.Builder |
tags(Collection<Tag> tags)
The metadata that you apply to the task to help you categorize and organize them.
|
StartTaskRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
The metadata that you apply to the task to help you categorize and organize them.
|
StartTaskRequest.Builder |
tags(Tag... tags)
The metadata that you apply to the task to help you categorize and organize them.
|
StartTaskRequest.Builder |
taskDefinition(String taskDefinition)
The
family and revision (family:revision) or full ARN of the task
definition to start. |
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildStartTaskRequest.Builder cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster where to start 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 where to start your task. If you do
not specify a cluster, the default cluster is assumed.StartTaskRequest.Builder containerInstances(Collection<String> containerInstances)
The container instance IDs or full ARN entries for the container instances where you would like to place your task. You can specify up to 10 container instances.
containerInstances - The container instance IDs or full ARN entries for the container instances where you would like to
place your task. You can specify up to 10 container instances.StartTaskRequest.Builder containerInstances(String... containerInstances)
The container instance IDs or full ARN entries for the container instances where you would like to place your task. You can specify up to 10 container instances.
containerInstances - The container instance IDs or full ARN entries for the container instances where you would like to
place your task. You can specify up to 10 container instances.StartTaskRequest.Builder enableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to use 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 use Amazon ECS managed tags for the task. For more information, see Tagging Your
Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.StartTaskRequest.Builder enableExecuteCommand(Boolean enableExecuteCommand)
Whether or not the execute command functionality is turned on for the task. If true, this
enables execute command functionality on all containers in the task.
enableExecuteCommand - Whether or not the execute command functionality is turned on for the task. If true, this
enables execute command functionality on all containers in the task.StartTaskRequest.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).StartTaskRequest.Builder networkConfiguration(NetworkConfiguration networkConfiguration)
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the awsvpc networking mode.
networkConfiguration - The VPC subnet and security group configuration for tasks that receive their own elastic network
interface by using the awsvpc networking mode.default StartTaskRequest.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the awsvpc networking mode.
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)StartTaskRequest.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 receives. You can override the default command for a container (that's
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 receives. You can override the default command for a container
(that's 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 StartTaskRequest.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 receives. You can override the default command for a container (that's
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)StartTaskRequest.Builder propagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
propagateTags - Specifies whether to propagate the tags from the task definition or the service to the task. If no
value is specified, the tags aren't propagated.PropagateTags,
PropagateTagsStartTaskRequest.Builder propagateTags(PropagateTags propagateTags)
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
propagateTags - Specifies whether to propagate the tags from the task definition or the service to the task. If no
value is specified, the tags aren't propagated.PropagateTags,
PropagateTagsStartTaskRequest.Builder referenceId(String referenceId)
The reference ID to use for the task.
referenceId - The reference ID to use for the task.StartTaskRequest.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, 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, the startedBy parameter contains the
deployment ID of the service that starts it.
StartTaskRequest.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 Amazon Web Services 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 Amazon Web Services 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.
StartTaskRequest.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 Amazon Web Services 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 Amazon Web Services 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.
StartTaskRequest.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 Amazon Web Services 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.
Tag.Builder avoiding the need to create one manually via
Tag.builder().
When the Consumer completes, SdkBuilder.build() is
called immediately and its result is passed to #tags(List.
tags - a consumer that will call methods on Tag.Builder#tags(java.util.Collection) StartTaskRequest.Builder taskDefinition(String taskDefinition)
The family and revision (family:revision) or full ARN of the task
definition to start. If a revision isn't specified, the latest ACTIVE revision is
used.
taskDefinition - The family and revision (family:revision) or full ARN of the
task definition to start. If a revision isn't specified, the latest ACTIVE
revision is used.StartTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderStartTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.