com.amazonaws.services.ecs.model

Class StartTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.StartTaskRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartTaskRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartTaskRequest()

Method Summary

Modifier and Type	Method and Description
StartTaskRequest	clone()
boolean	equals(Object obj)
String	getCluster() The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task.
List<String>	getContainerInstances() The container instance IDs or full ARN entries for the container instances on which you would like to place your task.
Boolean	getEnableECSManagedTags() Specifies whether to enable Amazon ECS managed tags for the task.
String	getGroup() The name of the task group to associate with the task.
NetworkConfiguration	getNetworkConfiguration() The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
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	getPropagateTags() Specifies whether to propagate the tags from the task definition or the service to the task.
String	getStartedBy() An optional tag specified when a task is started.
List<Tag>	getTags() The metadata that you apply to the task to help you categorize and organize them.
String	getTaskDefinition() The family and revision (family:revision) or full ARN of the task definition to start.
int	hashCode()
Boolean	isEnableECSManagedTags() Specifies whether to enable Amazon ECS managed tags for the task.
void	setCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task.
void	setContainerInstances(Collection<String> containerInstances) The container instance IDs or full ARN entries for the container instances on which you would like to place your task.
void	setEnableECSManagedTags(Boolean enableECSManagedTags) Specifies whether to enable Amazon ECS managed tags for the task.
void	setGroup(String group) The name of the task group to associate with the task.
void	setNetworkConfiguration(NetworkConfiguration networkConfiguration) The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
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	setPropagateTags(String propagateTags) Specifies whether to propagate the tags from the task definition or the service to the task.
void	setStartedBy(String startedBy) An optional tag specified when a task is started.
void	setTags(Collection<Tag> tags) The metadata that you apply to the task to help you categorize and organize them.
void	setTaskDefinition(String taskDefinition) The family and revision (family:revision) or full ARN of the task definition to start.
String	toString() Returns a string representation of this object.
StartTaskRequest	withCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task.
StartTaskRequest	withContainerInstances(Collection<String> containerInstances) The container instance IDs or full ARN entries for the container instances on which you would like to place your task.
StartTaskRequest	withContainerInstances(String... containerInstances) The container instance IDs or full ARN entries for the container instances on which you would like to place your task.
StartTaskRequest	withEnableECSManagedTags(Boolean enableECSManagedTags) Specifies whether to enable Amazon ECS managed tags for the task.
StartTaskRequest	withGroup(String group) The name of the task group to associate with the task.
StartTaskRequest	withNetworkConfiguration(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	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	withPropagateTags(PropagateTags propagateTags) Specifies whether to propagate the tags from the task definition or the service to the task.
StartTaskRequest	withPropagateTags(String propagateTags) Specifies whether to propagate the tags from the task definition or the service to the task.
StartTaskRequest	withStartedBy(String startedBy) An optional tag specified when a task is started.
StartTaskRequest	withTags(Collection<Tag> tags) The metadata that you apply to the task to help you categorize and organize them.
StartTaskRequest	withTags(Tag... tags) The metadata that you apply to the task to help you categorize and organize them.
StartTaskRequest	withTaskDefinition(String taskDefinition) The family and revision (family:revision) or full ARN of the task definition to start.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

StartTaskRequest

public StartTaskRequest()

Method Detail

setCluster

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

Parameters:

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.

getCluster

public String getCluster()

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.

withCluster

public StartTaskRequest withCluster(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.

Parameters:

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:

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

setTaskDefinition

public void setTaskDefinition(String taskDefinition)

The family and revision (family:revision) or full ARN of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

Parameters:

taskDefinition - The family and revision (family:revision) or full ARN of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

getTaskDefinition

public String getTaskDefinition()

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

Parameters:

taskDefinition - The family and revision (family:revision) or full ARN of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

Returns:

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

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.

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.

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.

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:

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

getContainerInstances

public List<String> getContainerInstances()

The container instance IDs or full 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 ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

setContainerInstances

public void setContainerInstances(Collection<String> containerInstances)

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

Parameters:

containerInstances - The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

withContainerInstances

public StartTaskRequest withContainerInstances(String... containerInstances)

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

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.

Parameters:

containerInstances - The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

Returns:

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

withContainerInstances

public StartTaskRequest withContainerInstances(Collection<String> containerInstances)

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

Parameters:

containerInstances - The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

Returns:

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

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

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

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

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

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

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

setGroup

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

Parameters:

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

getGroup

public String getGroup()

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

withGroup

public StartTaskRequest withGroup(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).

Parameters:

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:

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

setNetworkConfiguration

public void setNetworkConfiguration(NetworkConfiguration networkConfiguration)

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

Parameters:

networkConfiguration - The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

getNetworkConfiguration

public NetworkConfiguration getNetworkConfiguration()

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

Returns:

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

withNetworkConfiguration

public StartTaskRequest withNetworkConfiguration(NetworkConfiguration networkConfiguration)

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

Parameters:

networkConfiguration - The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

Returns:

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

getTags

public List<Tag> getTags()

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. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Returns:

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. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

setTags

public void setTags(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. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Parameters:

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. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

withTags

public StartTaskRequest withTags(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. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

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

Parameters:

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. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Returns:

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

withTags

public StartTaskRequest withTags(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. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Parameters:

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. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Returns:

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

setEnableECSManagedTags

public void setEnableECSManagedTags(Boolean enableECSManagedTags)

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Parameters:

enableECSManagedTags - Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

getEnableECSManagedTags

public Boolean getEnableECSManagedTags()

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Returns:

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

withEnableECSManagedTags

public StartTaskRequest withEnableECSManagedTags(Boolean enableECSManagedTags)

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Parameters:

enableECSManagedTags - Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Returns:

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

isEnableECSManagedTags

public Boolean isEnableECSManagedTags()

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Returns:

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

setPropagateTags

public void setPropagateTags(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 are not propagated.

Parameters:

propagateTags - Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

See Also:

PropagateTags

getPropagateTags

public String getPropagateTags()

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

Returns:

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

See Also:

PropagateTags

withPropagateTags

public StartTaskRequest withPropagateTags(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 are not propagated.

Parameters:

propagateTags - Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

Returns:

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

See Also:

PropagateTags

withPropagateTags

public StartTaskRequest withPropagateTags(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 are not propagated.

Parameters:

propagateTags - Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

Returns:

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

See Also:

PropagateTags

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartTaskRequest clone()

Overrides:

clone in class AmazonWebServiceRequest