com.amazonaws.services.ecs.model

Class RunTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.RunTaskRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RunTaskRequest
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
RunTaskRequest()

Method Summary

Modifier and Type	Method and Description
RunTaskRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<CapacityProviderStrategyItem>	getCapacityProviderStrategy() The capacity provider strategy to use for the task.
String	getCluster() The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.
Integer	getCount() The number of instantiations of the specified task to place on your cluster.
Boolean	getEnableECSManagedTags() Specifies whether to enable Amazon ECS managed tags for the task.
Boolean	getEnableExecuteCommand() Whether or not to enable the execute command functionality for the containers in this task.
String	getGroup() The name of the task group to associate with the task.
String	getLaunchType() The launch type on which to run your task.
NetworkConfiguration	getNetworkConfiguration() The network configuration for the 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.
List<PlacementConstraint>	getPlacementConstraints() An array of placement constraint objects to use for the task.
List<PlacementStrategy>	getPlacementStrategy() The placement strategy objects to use for the task.
String	getPlatformVersion() The platform version the task should run.
String	getPropagateTags() Specifies whether to propagate the tags from the task definition to the task.
String	getReferenceId() The reference ID to use for 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 run.
int	hashCode()
Boolean	isEnableECSManagedTags() Specifies whether to enable Amazon ECS managed tags for the task.
Boolean	isEnableExecuteCommand() Whether or not to enable the execute command functionality for the containers in this task.
void	setCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy) The capacity provider strategy to use for the task.
void	setCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.
void	setCount(Integer count) The number of instantiations of the specified task to place on your cluster.
void	setEnableECSManagedTags(Boolean enableECSManagedTags) Specifies whether to enable Amazon ECS managed tags for the task.
void	setEnableExecuteCommand(Boolean enableExecuteCommand) Whether or not to enable the execute command functionality for the containers in this task.
void	setGroup(String group) The name of the task group to associate with the task.
void	setLaunchType(String launchType) The launch type on which to run your task.
void	setNetworkConfiguration(NetworkConfiguration networkConfiguration) The network configuration for the 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	setPlacementConstraints(Collection<PlacementConstraint> placementConstraints) An array of placement constraint objects to use for the task.
void	setPlacementStrategy(Collection<PlacementStrategy> placementStrategy) The placement strategy objects to use for the task.
void	setPlatformVersion(String platformVersion) The platform version the task should run.
void	setPropagateTags(String propagateTags) Specifies whether to propagate the tags from the task definition to the task.
void	setReferenceId(String referenceId) The reference ID to use for 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 run.
String	toString() Returns a string representation of this object.
RunTaskRequest	withCapacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy) The capacity provider strategy to use for the task.
RunTaskRequest	withCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy) The capacity provider strategy to use for the task.
RunTaskRequest	withCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.
RunTaskRequest	withCount(Integer count) The number of instantiations of the specified task to place on your cluster.
RunTaskRequest	withEnableECSManagedTags(Boolean enableECSManagedTags) Specifies whether to enable Amazon ECS managed tags for the task.
RunTaskRequest	withEnableExecuteCommand(Boolean enableExecuteCommand) Whether or not to enable the execute command functionality for the containers in this task.
RunTaskRequest	withGroup(String group) The name of the task group to associate with the task.
RunTaskRequest	withLaunchType(LaunchType launchType) The launch type on which to run your task.
RunTaskRequest	withLaunchType(String launchType) The launch type on which to run your task.
RunTaskRequest	withNetworkConfiguration(NetworkConfiguration networkConfiguration) The network configuration for the task.
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	withPlacementConstraints(Collection<PlacementConstraint> placementConstraints) An array of placement constraint objects to use for the task.
RunTaskRequest	withPlacementConstraints(PlacementConstraint... placementConstraints) An array of placement constraint objects to use for the task.
RunTaskRequest	withPlacementStrategy(Collection<PlacementStrategy> placementStrategy) The placement strategy objects to use for the task.
RunTaskRequest	withPlacementStrategy(PlacementStrategy... placementStrategy) The placement strategy objects to use for the task.
RunTaskRequest	withPlatformVersion(String platformVersion) The platform version the task should run.
RunTaskRequest	withPropagateTags(PropagateTags propagateTags) Specifies whether to propagate the tags from the task definition to the task.
RunTaskRequest	withPropagateTags(String propagateTags) Specifies whether to propagate the tags from the task definition to the task.
RunTaskRequest	withReferenceId(String referenceId) The reference ID to use for the task.
RunTaskRequest	withStartedBy(String startedBy) An optional tag specified when a task is started.
RunTaskRequest	withTags(Collection<Tag> tags) The metadata that you apply to the task to help you categorize and organize them.
RunTaskRequest	withTags(Tag... tags) The metadata that you apply to the task to help you categorize and organize them.
RunTaskRequest	withTaskDefinition(String taskDefinition) The family and revision (family:revision) or full ARN of the task definition to run.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, 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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RunTaskRequest

public RunTaskRequest()

Method Detail

getCapacityProviderStrategy

public List<CapacityProviderStrategyItem> getCapacityProviderStrategy()

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

Returns:

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

setCapacityProviderStrategy

public void setCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

Parameters:

capacityProviderStrategy - The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

withCapacityProviderStrategy

public RunTaskRequest withCapacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

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

Parameters:

capacityProviderStrategy - The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

Returns:

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

withCapacityProviderStrategy

public RunTaskRequest withCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

Parameters:

capacityProviderStrategy - The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

Returns:

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

setCluster

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

Parameters:

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.

getCluster

public String getCluster()

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.

Returns:

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.

withCluster

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

Parameters:

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.

Returns:

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

setCount

public void setCount(Integer count)

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

Parameters:

count - The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

getCount

public Integer getCount()

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

Returns:

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

withCount

public RunTaskRequest withCount(Integer count)

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

Parameters:

count - The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

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

setEnableExecuteCommand

public void setEnableExecuteCommand(Boolean enableExecuteCommand)

Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

Parameters:

enableExecuteCommand - Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

getEnableExecuteCommand

public Boolean getEnableExecuteCommand()

Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

Returns:

Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

withEnableExecuteCommand

public RunTaskRequest withEnableExecuteCommand(Boolean enableExecuteCommand)

Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

Parameters:

enableExecuteCommand - Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

Returns:

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

isEnableExecuteCommand

public Boolean isEnableExecuteCommand()

Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

Returns:

Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

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

setLaunchType

public void setLaunchType(String launchType)

The launch type on which to run your task. The accepted values are FARGATE and EC2. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

When a value of FARGATE is specified, your tasks are launched on AWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the FARGATE_SPOT capacity provider.

When a value of EC2 is specified, your tasks are launched on Amazon EC2 instances registered to your cluster.

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Parameters:

launchType - The launch type on which to run your task. The accepted values are FARGATE and EC2. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

When a value of FARGATE is specified, your tasks are launched on AWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the FARGATE_SPOT capacity provider.

When a value of EC2 is specified, your tasks are launched on Amazon EC2 instances registered to your cluster.

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

See Also:

LaunchType

getLaunchType

public String getLaunchType()

The launch type on which to run your task. The accepted values are FARGATE and EC2. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

When a value of FARGATE is specified, your tasks are launched on AWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the FARGATE_SPOT capacity provider.

When a value of EC2 is specified, your tasks are launched on Amazon EC2 instances registered to your cluster.

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Returns:

The launch type on which to run your task. The accepted values are FARGATE and EC2. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

When a value of FARGATE is specified, your tasks are launched on AWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the FARGATE_SPOT capacity provider.

When a value of EC2 is specified, your tasks are launched on Amazon EC2 instances registered to your cluster.

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

See Also:

LaunchType

withLaunchType

public RunTaskRequest withLaunchType(String launchType)

The launch type on which to run your task. The accepted values are FARGATE and EC2. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

When a value of FARGATE is specified, your tasks are launched on AWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the FARGATE_SPOT capacity provider.

When a value of EC2 is specified, your tasks are launched on Amazon EC2 instances registered to your cluster.

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Parameters:

launchType - The launch type on which to run your task. The accepted values are FARGATE and EC2. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

When a value of FARGATE is specified, your tasks are launched on AWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the FARGATE_SPOT capacity provider.

When a value of EC2 is specified, your tasks are launched on Amazon EC2 instances registered to your cluster.

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Returns:

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

See Also:

LaunchType

withLaunchType

public RunTaskRequest withLaunchType(LaunchType launchType)

The launch type on which to run your task. The accepted values are FARGATE and EC2. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

When a value of FARGATE is specified, your tasks are launched on AWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the FARGATE_SPOT capacity provider.

When a value of EC2 is specified, your tasks are launched on Amazon EC2 instances registered to your cluster.

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Parameters:

launchType - The launch type on which to run your task. The accepted values are FARGATE and EC2. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

When a value of FARGATE is specified, your tasks are launched on AWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the FARGATE_SPOT capacity provider.

When a value of EC2 is specified, your tasks are launched on Amazon EC2 instances registered to your cluster.

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Returns:

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

See Also:

LaunchType

setNetworkConfiguration

public void setNetworkConfiguration(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 Elastic Container Service Developer Guide.

Parameters:

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 Elastic Container Service Developer Guide.

getNetworkConfiguration

public NetworkConfiguration getNetworkConfiguration()

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 Elastic Container Service Developer Guide.

Returns:

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 Elastic Container Service Developer Guide.

withNetworkConfiguration

public RunTaskRequest withNetworkConfiguration(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 Elastic Container Service Developer Guide.

Parameters:

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 Elastic Container Service Developer Guide.

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

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.

getPlacementConstraints

public List<PlacementConstraint> getPlacementConstraints()

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

Returns:

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

setPlacementConstraints

public void setPlacementConstraints(Collection<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 runtime).

Parameters:

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

withPlacementConstraints

public RunTaskRequest withPlacementConstraints(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 runtime).

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

Parameters:

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

Returns:

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

withPlacementConstraints

public RunTaskRequest withPlacementConstraints(Collection<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 runtime).

Parameters:

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

Returns:

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

getPlacementStrategy

public List<PlacementStrategy> getPlacementStrategy()

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Returns:

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

setPlacementStrategy

public void setPlacementStrategy(Collection<PlacementStrategy> placementStrategy)

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Parameters:

placementStrategy - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

withPlacementStrategy

public RunTaskRequest withPlacementStrategy(PlacementStrategy... placementStrategy)

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

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

Parameters:

placementStrategy - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Returns:

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

withPlacementStrategy

public RunTaskRequest withPlacementStrategy(Collection<PlacementStrategy> placementStrategy)

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Parameters:

placementStrategy - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Returns:

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

setPlatformVersion

public void setPlatformVersion(String platformVersion)

The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Parameters:

platformVersion - The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

getPlatformVersion

public String getPlatformVersion()

The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Returns:

The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

withPlatformVersion

public RunTaskRequest withPlatformVersion(String platformVersion)

The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Parameters:

platformVersion - The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Returns:

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

setPropagateTags

public void setPropagateTags(String propagateTags)

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the SERVICE option when running a task.

Parameters:

propagateTags - Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the SERVICE option when running a task.

See Also:

PropagateTags

getPropagateTags

public String getPropagateTags()

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the SERVICE option when running a task.

Returns:

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the SERVICE option when running a task.

See Also:

PropagateTags

withPropagateTags

public RunTaskRequest withPropagateTags(String propagateTags)

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the SERVICE option when running a task.

Parameters:

propagateTags - Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the SERVICE option when running a task.

Returns:

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

See Also:

PropagateTags

withPropagateTags

public RunTaskRequest withPropagateTags(PropagateTags propagateTags)

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the SERVICE option when running a task.

Parameters:

propagateTags - Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the SERVICE option when running a task.

Returns:

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

See Also:

PropagateTags

setReferenceId

public void setReferenceId(String referenceId)

The reference ID to use for the task.

Parameters:

referenceId - The reference ID to use for the task.

getReferenceId

public String getReferenceId()

The reference ID to use for the task.

Returns:

The reference ID to use for the task.

withReferenceId

public RunTaskRequest withReferenceId(String referenceId)

The reference ID to use for the task.

Parameters:

referenceId - The reference ID to use for the task.

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

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.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

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.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

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.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

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.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

withTags

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

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

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.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Returns:

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

withTags

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

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

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.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

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 run. 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 run. 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 run. 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 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 ARN of the task definition to run. 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 run. 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.

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 RunTaskRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()