com.amazonaws.services.ecs.model

Class RunTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.RunTaskRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RunTaskRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the RunTask operation.

Start a task using random placement and the default Amazon ECS scheduler. If you want to use your own scheduler or place a task on a specific container instance, use StartTask instead.

IMPORTANT: The count parameter is limited to 10 tasks per call.

See Also:

AmazonECS.runTask(RunTaskRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RunTaskRequest()

Method Summary

Methods

Modifier and Type	Method and Description
RunTaskRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getCluster() The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your task on.
Integer	getCount() The number of instantiations of the specified task that you would like to place on your cluster.
TaskOverride	getOverrides() 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.
String	getStartedBy() An optional tag specified when a task is started.
String	getTaskDefinition() The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run.
int	hashCode()
void	setCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your task on.
void	setCount(Integer count) The number of instantiations of the specified task that you would like to place on your cluster.
void	setOverrides(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.
void	setStartedBy(String startedBy) An optional tag specified when a task is started.
void	setTaskDefinition(String taskDefinition) The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RunTaskRequest	withCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your task on.
RunTaskRequest	withCount(Integer count) The number of instantiations of the specified task that you would like to place on your cluster.
RunTaskRequest	withOverrides(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	withStartedBy(String startedBy) An optional tag specified when a task is started.
RunTaskRequest	withTaskDefinition(String taskDefinition) The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RunTaskRequest

public RunTaskRequest()

Method Detail

getCluster

public String getCluster()

The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your task on. If you do not specify a cluster, the default cluster is assumed..

Returns:

The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your task on. If you do not specify a cluster, the default cluster is assumed..

setCluster

public void setCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your task on. If you do not specify a cluster, the default cluster is assumed..

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your task on. If you do not specify a cluster, the default cluster is assumed..

withCluster

public RunTaskRequest withCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your task on. If you do not specify a cluster, the default cluster is assumed..

Returns a reference to this object so that method calls can be chained together.

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your task on. If you do not specify a cluster, the default cluster is assumed..

Returns:

A reference to this updated object so that method calls can be chained together.

getTaskDefinition

public String getTaskDefinition()

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run. If a revision is not specified, the latest ACTIVE revision is used.

Returns:

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run. If a revision is not specified, the latest ACTIVE revision is used.

setTaskDefinition

public void setTaskDefinition(String taskDefinition)

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run. If a revision is not specified, the latest ACTIVE revision is used.

Parameters:

taskDefinition - The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run. If a revision is not specified, the latest ACTIVE revision is used.

withTaskDefinition

public RunTaskRequest withTaskDefinition(String taskDefinition)

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run. If a revision is not specified, the latest ACTIVE revision is used.

Returns a reference to this object so that method calls can be chained together.

Parameters:

taskDefinition - The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run. If a revision is not specified, the latest ACTIVE revision is used.

Returns:

A reference to this updated object so that method calls can be chained together.

getOverrides

public TaskOverride getOverrides()

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.

Returns:

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.

setOverrides

public void setOverrides(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.

Parameters:

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.

withOverrides

public RunTaskRequest withOverrides(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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getCount

public Integer getCount()

The number of instantiations of the specified task that you would like to place on your cluster.

The count parameter is limited to 10 tasks per call.

Returns:

The number of instantiations of the specified task that you would like to place on your cluster.

The count parameter is limited to 10 tasks per call.

setCount

public void setCount(Integer count)

The number of instantiations of the specified task that you would like to place on your cluster.

The count parameter is limited to 10 tasks per call.

Parameters:

count - The number of instantiations of the specified task that you would like to place on your cluster.

The count parameter is limited to 10 tasks per call.

withCount

public RunTaskRequest withCount(Integer count)

The number of instantiations of the specified task that you would like to place on your cluster.

The count parameter is limited to 10 tasks per call.

Returns a reference to this object so that method calls can be chained together.

Parameters:

count - The number of instantiations of the specified task that you would like to place on your cluster.

The count parameter is limited to 10 tasks per call.

Returns:

A reference to this updated object so that method calls can be chained together.

getStartedBy

public String getStartedBy()

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.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Returns:

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.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

setStartedBy

public void setStartedBy(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.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Parameters:

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.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

withStartedBy

public RunTaskRequest withStartedBy(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.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public RunTaskRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()