Package software.amazon.awssdk.services.ecs.model

Class StartTaskRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.ecs.model.StartTaskRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<StartTaskRequest.Builder,StartTaskRequest>

@Generated("software.amazon.awssdk:codegen")
public class StartTaskRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<StartTaskRequest.Builder,StartTaskRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartTaskRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static StartTaskRequest.Builder	builder()
String	cluster()	The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task.
List<String>	containerInstances()	The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
boolean	equals(Object obj)
String	group()	The name of the task group to associate with the task.
int	hashCode()
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.
static Class<? extends StartTaskRequest.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 start.
StartTaskRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

cluster

public String cluster()

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

taskDefinition

public String taskDefinition()

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition 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 to start. If a revision is not specified, the latest ACTIVE revision is used.

overrides

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.

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.

containerInstances

public List<String> containerInstances()

The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

Returns:

The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

startedBy

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.

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. 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.

group

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).

Returns:

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).

toBuilder

public StartTaskRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<StartTaskRequest.Builder,StartTaskRequest>

Returns:

a builder for type T

builder

public static StartTaskRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartTaskRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object