@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RunTaskRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
RunTaskRequest() |
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 infrastructure on which to run your standalone 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 use.
|
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 infrastructure on which to run your standalone 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 use.
|
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 infrastructure on which to run your standalone task.
|
RunTaskRequest |
withLaunchType(String launchType)
The infrastructure on which to run your standalone 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 use.
|
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. |
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
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.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
A capacity provider strategy may contain a maximum of 6 capacity providers.
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.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
A capacity provider strategy may contain a maximum of 6 capacity providers.
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.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
A capacity provider strategy may contain a maximum of 6 capacity providers.
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.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
A capacity provider strategy may contain a maximum of 6 capacity providers.
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.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
A capacity provider strategy may contain a maximum of 6 capacity providers.
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.
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.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
A capacity provider strategy may contain a maximum of 6 capacity providers.
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.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
A capacity provider strategy may contain a maximum of 6 capacity providers.
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.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
A capacity provider strategy may contain a maximum of 6 capacity providers.
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.
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.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.
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.
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.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.
count
- The number of instantiations of the specified task to place on your cluster. You can specify up to 10
tasks per call.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.
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.
count
- The number of instantiations of the specified task to place on your cluster. You can specify up to 10
tasks per call.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.
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.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.
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.
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.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.
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.
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.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.
true
, this enables execute command functionality on all containers in the task.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.
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.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.
true
, this enables execute command functionality on all containers in the task.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
).
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
).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
).
family:my-family-name
).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
).
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
).public void setLaunchType(String launchType)
The infrastructure on which to run your standalone task. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premise server or virtual machine (VM) capacity
registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a launchType
is specified,
the capacityProviderStrategy
parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
launchType
- The infrastructure on which to run your standalone task. For more information, see Amazon ECS launch
types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premise server or virtual machine (VM)
capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a launchType
is
specified, the capacityProviderStrategy
parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
LaunchType
public String getLaunchType()
The infrastructure on which to run your standalone task. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premise server or virtual machine (VM) capacity
registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a launchType
is specified,
the capacityProviderStrategy
parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premise server or virtual machine (VM)
capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a launchType
is
specified, the capacityProviderStrategy
parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
LaunchType
public RunTaskRequest withLaunchType(String launchType)
The infrastructure on which to run your standalone task. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premise server or virtual machine (VM) capacity
registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a launchType
is specified,
the capacityProviderStrategy
parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
launchType
- The infrastructure on which to run your standalone task. For more information, see Amazon ECS launch
types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premise server or virtual machine (VM)
capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a launchType
is
specified, the capacityProviderStrategy
parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
LaunchType
public RunTaskRequest withLaunchType(LaunchType launchType)
The infrastructure on which to run your standalone task. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premise server or virtual machine (VM) capacity
registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a launchType
is specified,
the capacityProviderStrategy
parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
launchType
- The infrastructure on which to run your standalone task. For more information, see Amazon ECS launch
types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premise server or virtual machine (VM)
capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a launchType
is
specified, the capacityProviderStrategy
parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not
launchType
.
LaunchType
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.
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.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.
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.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.
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.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.
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.
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.
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.
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.
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.
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).
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).
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).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.
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).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).
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).public List<PlacementStrategy> getPlacementStrategy()
The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.
public void setPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.
placementStrategy
- The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per
task.public RunTaskRequest withPlacementStrategy(PlacementStrategy... placementStrategy)
The placement strategy objects to use for the task. You can specify a maximum of 5 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.
placementStrategy
- The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per
task.public RunTaskRequest withPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.
placementStrategy
- The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per
task.public void setPlatformVersion(String platformVersion)
The platform version the task should use. A platform version is only specified for tasks hosted on Fargate. If
one is not specified, the LATEST
platform version is used by default. For more information, see Fargate platform
versions in the Amazon Elastic Container Service Developer Guide.
platformVersion
- The platform version the task should use. A platform version is only specified for tasks hosted on
Fargate. If one is not specified, the LATEST
platform version is used by default. For more
information, see Fargate platform
versions in the Amazon Elastic Container Service Developer Guide.public String getPlatformVersion()
The platform version the task should use. A platform version is only specified for tasks hosted on Fargate. If
one is not specified, the LATEST
platform version is used by default. For more information, see Fargate platform
versions in the Amazon Elastic Container Service Developer Guide.
LATEST
platform version is used by default. For more
information, see Fargate
platform versions in the Amazon Elastic Container Service Developer Guide.public RunTaskRequest withPlatformVersion(String platformVersion)
The platform version the task should use. A platform version is only specified for tasks hosted on Fargate. If
one is not specified, the LATEST
platform version is used by default. For more information, see Fargate platform
versions in the Amazon Elastic Container Service Developer Guide.
platformVersion
- The platform version the task should use. A platform version is only specified for tasks hosted on
Fargate. If one is not specified, the LATEST
platform version is used by default. For more
information, see Fargate platform
versions in the Amazon Elastic Container Service Developer Guide.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.
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.
PropagateTags
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.
An error will be received if you specify the SERVICE
option when running a task.
PropagateTags
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.
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.
PropagateTags
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.
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.
PropagateTags
public void setReferenceId(String referenceId)
The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.
referenceId
- The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.public String getReferenceId()
The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.
public RunTaskRequest withReferenceId(String referenceId)
The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.
referenceId
- The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.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.
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.
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.
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.
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.
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.
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 Amazon Web Services 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.
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 Amazon Web Services 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.
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 Amazon Web Services 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.
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 Amazon Web Services 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.
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 Amazon Web Services 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.
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 Amazon Web Services 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.
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 Amazon Web Services 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.
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 Amazon Web Services 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.
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.
The full ARN value must match the value that you specified ias the Resource
of the IAM principal's
permissions policy. For example, if the Resource
is
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the taskDefinition
ARN value
must be arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName
.
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.
The full ARN value must match the value that you specified ias the Resource
of the IAM
principal's permissions policy. For example, if the Resource
is
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the taskDefinition
ARN
value must be arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName
.
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.
The full ARN value must match the value that you specified ias the Resource
of the IAM principal's
permissions policy. For example, if the Resource
is
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the taskDefinition
ARN value
must be arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName
.
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.
The full ARN value must match the value that you specified ias the Resource
of the IAM
principal's permissions policy. For example, if the Resource
is
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the taskDefinition
ARN
value must be arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName
.
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.
The full ARN value must match the value that you specified ias the Resource
of the IAM principal's
permissions policy. For example, if the Resource
is
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the taskDefinition
ARN value
must be arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName
.
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.
The full ARN value must match the value that you specified ias the Resource
of the IAM
principal's permissions policy. For example, if the Resource
is
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the taskDefinition
ARN
value must be arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName
.
public String toString()
toString
in class Object
Object.toString()
public RunTaskRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()