@Generated(value="software.amazon.awssdk:codegen") public class RunTaskRequest extends ECSRequest implements ToCopyableBuilder<RunTaskRequest.Builder,RunTaskRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
RunTaskRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static RunTaskRequest.Builder |
builder() |
String |
cluster()
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.
|
Integer |
count()
The number of instantiations of the specified task to place on your cluster.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
String |
group()
The name of the task group to associate with the task.
|
int |
hashCode() |
NetworkConfiguration |
networkConfiguration()
The network configuration for the task.
|
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.
|
List<PlacementConstraint> |
placementConstraints()
An array of placement constraint objects to use for the task.
|
List<PlacementStrategy> |
placementStrategy()
The placement strategy objects to use for the task.
|
static Class<? extends RunTaskRequest.Builder> |
serializableBuilderClass() |
String |
startedBy()
An optional tag specified when a task is started.
|
String |
taskDefinition()
The
family and revision (family:revision ) or full Amazon Resource Name
(ARN) of the task definition to run. |
RunTaskRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public 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.
public 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.
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.public 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.
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.
public Integer count()
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.
public 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
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.
public 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).
public List<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).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<PlacementStrategy> placementStrategy()
The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
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.public RunTaskRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RunTaskRequest.Builder,RunTaskRequest>
toBuilder
in class ECSRequest
public static RunTaskRequest.Builder builder()
public static Class<? extends RunTaskRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.