Class RunTaskRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<RunTaskRequest.Builder,
RunTaskRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic RunTaskRequest.Builder
builder()
final List
<CapacityProviderStrategyItem> The capacity provider strategy to use for the task.final String
An identifier that you provide to ensure the idempotency of the request.final String
cluster()
The short name or full Amazon Resource Name (ARN) of the cluster to run your task on.final Integer
count()
The number of instantiations of the specified task to place on your cluster.final Boolean
Specifies whether to use Amazon ECS managed tags for the task.final Boolean
Determines whether to use the execute command functionality for the containers in this task.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final String
group()
The name of the task group to associate with the task.final boolean
For responses, this returns true if the service returned a value for the CapacityProviderStrategy property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PlacementConstraints property.final boolean
For responses, this returns true if the service returned a value for the PlacementStrategy property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the VolumeConfigurations property.final LaunchType
The infrastructure to run your standalone task on.final String
The infrastructure to run your standalone task on.final NetworkConfiguration
The network configuration for the task.final TaskOverride
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.final List
<PlacementConstraint> An array of placement constraint objects to use for the task.final List
<PlacementStrategy> The placement strategy objects to use for the task.final String
The platform version the task uses.final PropagateTags
Specifies whether to propagate the tags from the task definition to the task.final String
Specifies whether to propagate the tags from the task definition to the task.final String
The reference ID to use for the task.static Class
<? extends RunTaskRequest.Builder> final String
An optional tag specified when a task is started.tags()
The metadata that you apply to the task to help you categorize and organize them.final String
Thefamily
andrevision
(family:revision
) or full ARN of the task definition to run.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final List
<TaskVolumeConfiguration> The details of the volume that wasconfiguredAtLaunch
.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasCapacityProviderStrategy
public final boolean hasCapacityProviderStrategy()For responses, this returns true if the service returned a value for the CapacityProviderStrategy property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
capacityProviderStrategy
The capacity provider strategy to use for the task.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
for the cluster is used.When you use cluster auto scaling, you must specify
capacityProviderStrategy
and notlaunchType
.A capacity provider strategy may contain a maximum of 6 capacity providers.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCapacityProviderStrategy()
method.- Returns:
- The capacity provider strategy to use for the task.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
for the cluster is used.When you use cluster auto scaling, you must specify
capacityProviderStrategy
and notlaunchType
.A capacity provider strategy may contain a maximum of 6 capacity providers.
-
cluster
The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. If you do not specify a cluster, the default cluster is assumed.
- Returns:
- The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. If you do not specify a cluster, the default cluster is assumed.
-
count
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.
- Returns:
- The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.
-
enableECSManagedTags
Specifies whether to use 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 use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
-
enableExecuteCommand
Determines whether to use the execute command functionality for the containers in this task. If
true
, this enables execute command functionality on all containers in the task.If
true
, then the task definition must have a task role, or you must provide one as an override.- Returns:
- Determines whether to use the execute command functionality for the containers in this task. If
true
, this enables execute command functionality on all containers in the task.If
true
, then the task definition must have a task role, or you must provide one as an override.
-
group
The name of the task group to associate with the task. The default value is the family name of the task definition (for example,
family:my-family-name
).- Returns:
- The name of the task group to associate with the task. The default value is the family name of the task
definition (for example,
family:my-family-name
).
-
launchType
The infrastructure to run your standalone task on. 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 Developer Guide.
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-premises 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, thecapacityProviderStrategy
parameter must be omitted.When you use cluster auto scaling, you must specify
capacityProviderStrategy
and notlaunchType
.If the service returns an enum value that is not available in the current SDK version,
launchType
will returnLaunchType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlaunchTypeAsString()
.- Returns:
- The infrastructure to run your standalone task on. 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 Developer Guide.
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-premises 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, thecapacityProviderStrategy
parameter must be omitted.When you use cluster auto scaling, you must specify
capacityProviderStrategy
and notlaunchType
. - See Also:
-
launchTypeAsString
The infrastructure to run your standalone task on. 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 Developer Guide.
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-premises 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, thecapacityProviderStrategy
parameter must be omitted.When you use cluster auto scaling, you must specify
capacityProviderStrategy
and notlaunchType
.If the service returns an enum value that is not available in the current SDK version,
launchType
will returnLaunchType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlaunchTypeAsString()
.- Returns:
- The infrastructure to run your standalone task on. 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 Developer Guide.
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-premises 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, thecapacityProviderStrategy
parameter must be omitted.When you use cluster auto scaling, you must specify
capacityProviderStrategy
and notlaunchType
. - See Also:
-
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 isn't 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 isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.
-
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's 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 anenvironment
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's 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 anenvironment
override.A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
-
hasPlacementConstraints
public final boolean hasPlacementConstraints()For responses, this returns true if the service returned a value for the PlacementConstraints property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
placementConstraints
An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPlacementConstraints()
method.- Returns:
- An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime).
-
hasPlacementStrategy
public final boolean hasPlacementStrategy()For responses, this returns true if the service returned a value for the PlacementStrategy property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
placementStrategy
The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPlacementStrategy()
method.- Returns:
- The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.
-
platformVersion
The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If one isn't specified, the
LATEST
platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.- Returns:
- The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If
one isn't specified, the
LATEST
platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
-
propagateTags
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't 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.If the service returns an enum value that is not available in the current SDK version,
propagateTags
will returnPropagateTags.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompropagateTagsAsString()
.- Returns:
- Specifies whether to propagate the tags from the task definition to the task. If no value is specified,
the tags aren't 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:
-
propagateTagsAsString
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't 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.If the service returns an enum value that is not available in the current SDK version,
propagateTags
will returnPropagateTags.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompropagateTagsAsString()
.- Returns:
- Specifies whether to propagate the tags from the task definition to the task. If no value is specified,
the tags aren't 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:
-
referenceId
The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.
- Returns:
- The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.
-
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 thestartedBy
value. Up to 128 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 thestartedBy
value. Up to 128 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.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- 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 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.
-
-
-
taskDefinition
The
family
andrevision
(family:revision
) or full ARN of the task definition to run. If arevision
isn't specified, the latestACTIVE
revision is used.When you create a policy for run-task, you can set the resource to be the latest task definition revision, or a specific revision.
The full ARN value must match the value that you specified as the
Resource
of the principal's permissions policy.When you specify the policy resource as the latest task definition version (by setting the
Resource
in the policy toarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName
), then set this value toarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName
.When you specify the policy resource as a specific task definition version (by setting the
Resource
in the policy toarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1
orarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*
), then set this value toarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1
.For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service developer Guide.
- Returns:
- The
family
andrevision
(family:revision
) or full ARN of the task definition to run. If arevision
isn't specified, the latestACTIVE
revision is used.When you create a policy for run-task, you can set the resource to be the latest task definition revision, or a specific revision.
The full ARN value must match the value that you specified as the
Resource
of the principal's permissions policy.When you specify the policy resource as the latest task definition version (by setting the
Resource
in the policy toarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName
), then set this value toarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName
.When you specify the policy resource as a specific task definition version (by setting the
Resource
in the policy toarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1
orarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*
), then set this value toarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1
.For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service developer Guide.
-
clientToken
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.
- Returns:
- An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.
-
hasVolumeConfigurations
public final boolean hasVolumeConfigurations()For responses, this returns true if the service returned a value for the VolumeConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
volumeConfigurations
The details of the volume that was
configuredAtLaunch
. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. Thename
of the volume must match thename
from the task definition.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasVolumeConfigurations()
method.- Returns:
- The details of the volume that was
configuredAtLaunch
. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. Thename
of the volume must match thename
from the task definition.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<RunTaskRequest.Builder,
RunTaskRequest> - Specified by:
toBuilder
in classEcsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-