com.amazonaws.services.ecs.model

Class StartTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.StartTaskRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class StartTaskRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the StartTask operation.

Starts a new task from the specified task definition on the specified container instance or instances. If you want to use the default Amazon ECS scheduler to place your task, use RunTask instead.

IMPORTANT: The list of container instances to start tasks on is limited to 10.

See Also:

AmazonECS.startTask(StartTaskRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartTaskRequest()

Method Summary

Methods

Modifier and Type	Method and Description
StartTaskRequest	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 start your task on.
List<String>	getContainerInstances() The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
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 start.
int	hashCode()
void	setCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that you want to start your task on.
void	setContainerInstances(Collection<String> containerInstances) The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
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 start.
String	toString() Returns a string representation of this object; useful for testing and debugging.
StartTaskRequest	withCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that you want to start your task on.
StartTaskRequest	withContainerInstances(Collection<String> containerInstances) The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
StartTaskRequest	withContainerInstances(String... containerInstances) The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
StartTaskRequest	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.
StartTaskRequest	withStartedBy(String startedBy) An optional tag specified when a task is started.
StartTaskRequest	withTaskDefinition(String taskDefinition) The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to start.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

StartTaskRequest

public StartTaskRequest()

Method Detail

getCluster

public String getCluster()

The short name or full Amazon Resource Name (ARN) of the cluster that you want to start 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 start 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 start 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 start your task on. If you do not specify a cluster, the default cluster is assumed..

withCluster

public StartTaskRequest withCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that you want to start 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 start 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 start. 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 start. 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 start. 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 start. If a revision is not specified, the latest ACTIVE revision is used.

withTaskDefinition

public StartTaskRequest withTaskDefinition(String taskDefinition)

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to start. 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 start. 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 StartTaskRequest 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.

getContainerInstances

public List<String> getContainerInstances()

The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

The list of container instances to start tasks on is limited to 10.

Returns:

The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

The list of container instances to start tasks on is limited to 10.

setContainerInstances

public void setContainerInstances(Collection<String> containerInstances)

The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

The list of container instances to start tasks on is limited to 10.

Parameters:

containerInstances - The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

The list of container instances to start tasks on is limited to 10.

withContainerInstances

public StartTaskRequest withContainerInstances(String... containerInstances)

The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

The list of container instances to start tasks on is limited to 10.

NOTE: This method appends the values to the existing list (if any). Use setContainerInstances(java.util.Collection) or withContainerInstances(java.util.Collection) if you want to override the existing values.

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

Parameters:

containerInstances - The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

The list of container instances to start tasks on is limited to 10.

Returns:

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

withContainerInstances

public StartTaskRequest withContainerInstances(Collection<String> containerInstances)

The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

The list of container instances to start tasks on is limited to 10.

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

Parameters:

containerInstances - The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

The list of container instances to start tasks on is limited to 10.

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 StartTaskRequest 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 StartTaskRequest 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()