AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::RunTaskRequest Class Reference

#include <RunTaskRequest.h>

+ Inheritance diagram for Aws::ECS::Model::RunTaskRequest:

Public Member Functions

 RunTaskRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< CapacityProviderStrategyItem > & GetCapacityProviderStrategy () const
 
bool CapacityProviderStrategyHasBeenSet () const
 
void SetCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)
 
void SetCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)
 
RunTaskRequestWithCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)
 
RunTaskRequestWithCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)
 
RunTaskRequestAddCapacityProviderStrategy (const CapacityProviderStrategyItem &value)
 
RunTaskRequestAddCapacityProviderStrategy (CapacityProviderStrategyItem &&value)
 
const Aws::StringGetCluster () const
 
bool ClusterHasBeenSet () const
 
void SetCluster (const Aws::String &value)
 
void SetCluster (Aws::String &&value)
 
void SetCluster (const char *value)
 
RunTaskRequestWithCluster (const Aws::String &value)
 
RunTaskRequestWithCluster (Aws::String &&value)
 
RunTaskRequestWithCluster (const char *value)
 
int GetCount () const
 
bool CountHasBeenSet () const
 
void SetCount (int value)
 
RunTaskRequestWithCount (int value)
 
bool GetEnableECSManagedTags () const
 
bool EnableECSManagedTagsHasBeenSet () const
 
void SetEnableECSManagedTags (bool value)
 
RunTaskRequestWithEnableECSManagedTags (bool value)
 
const Aws::StringGetGroup () const
 
bool GroupHasBeenSet () const
 
void SetGroup (const Aws::String &value)
 
void SetGroup (Aws::String &&value)
 
void SetGroup (const char *value)
 
RunTaskRequestWithGroup (const Aws::String &value)
 
RunTaskRequestWithGroup (Aws::String &&value)
 
RunTaskRequestWithGroup (const char *value)
 
const LaunchTypeGetLaunchType () const
 
bool LaunchTypeHasBeenSet () const
 
void SetLaunchType (const LaunchType &value)
 
void SetLaunchType (LaunchType &&value)
 
RunTaskRequestWithLaunchType (const LaunchType &value)
 
RunTaskRequestWithLaunchType (LaunchType &&value)
 
const NetworkConfigurationGetNetworkConfiguration () const
 
bool NetworkConfigurationHasBeenSet () const
 
void SetNetworkConfiguration (const NetworkConfiguration &value)
 
void SetNetworkConfiguration (NetworkConfiguration &&value)
 
RunTaskRequestWithNetworkConfiguration (const NetworkConfiguration &value)
 
RunTaskRequestWithNetworkConfiguration (NetworkConfiguration &&value)
 
const TaskOverrideGetOverrides () const
 
bool OverridesHasBeenSet () const
 
void SetOverrides (const TaskOverride &value)
 
void SetOverrides (TaskOverride &&value)
 
RunTaskRequestWithOverrides (const TaskOverride &value)
 
RunTaskRequestWithOverrides (TaskOverride &&value)
 
const Aws::Vector< PlacementConstraint > & GetPlacementConstraints () const
 
bool PlacementConstraintsHasBeenSet () const
 
void SetPlacementConstraints (const Aws::Vector< PlacementConstraint > &value)
 
void SetPlacementConstraints (Aws::Vector< PlacementConstraint > &&value)
 
RunTaskRequestWithPlacementConstraints (const Aws::Vector< PlacementConstraint > &value)
 
RunTaskRequestWithPlacementConstraints (Aws::Vector< PlacementConstraint > &&value)
 
RunTaskRequestAddPlacementConstraints (const PlacementConstraint &value)
 
RunTaskRequestAddPlacementConstraints (PlacementConstraint &&value)
 
const Aws::Vector< PlacementStrategy > & GetPlacementStrategy () const
 
bool PlacementStrategyHasBeenSet () const
 
void SetPlacementStrategy (const Aws::Vector< PlacementStrategy > &value)
 
void SetPlacementStrategy (Aws::Vector< PlacementStrategy > &&value)
 
RunTaskRequestWithPlacementStrategy (const Aws::Vector< PlacementStrategy > &value)
 
RunTaskRequestWithPlacementStrategy (Aws::Vector< PlacementStrategy > &&value)
 
RunTaskRequestAddPlacementStrategy (const PlacementStrategy &value)
 
RunTaskRequestAddPlacementStrategy (PlacementStrategy &&value)
 
const Aws::StringGetPlatformVersion () const
 
bool PlatformVersionHasBeenSet () const
 
void SetPlatformVersion (const Aws::String &value)
 
void SetPlatformVersion (Aws::String &&value)
 
void SetPlatformVersion (const char *value)
 
RunTaskRequestWithPlatformVersion (const Aws::String &value)
 
RunTaskRequestWithPlatformVersion (Aws::String &&value)
 
RunTaskRequestWithPlatformVersion (const char *value)
 
const PropagateTagsGetPropagateTags () const
 
bool PropagateTagsHasBeenSet () const
 
void SetPropagateTags (const PropagateTags &value)
 
void SetPropagateTags (PropagateTags &&value)
 
RunTaskRequestWithPropagateTags (const PropagateTags &value)
 
RunTaskRequestWithPropagateTags (PropagateTags &&value)
 
const Aws::StringGetReferenceId () const
 
bool ReferenceIdHasBeenSet () const
 
void SetReferenceId (const Aws::String &value)
 
void SetReferenceId (Aws::String &&value)
 
void SetReferenceId (const char *value)
 
RunTaskRequestWithReferenceId (const Aws::String &value)
 
RunTaskRequestWithReferenceId (Aws::String &&value)
 
RunTaskRequestWithReferenceId (const char *value)
 
const Aws::StringGetStartedBy () const
 
bool StartedByHasBeenSet () const
 
void SetStartedBy (const Aws::String &value)
 
void SetStartedBy (Aws::String &&value)
 
void SetStartedBy (const char *value)
 
RunTaskRequestWithStartedBy (const Aws::String &value)
 
RunTaskRequestWithStartedBy (Aws::String &&value)
 
RunTaskRequestWithStartedBy (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
RunTaskRequestWithTags (const Aws::Vector< Tag > &value)
 
RunTaskRequestWithTags (Aws::Vector< Tag > &&value)
 
RunTaskRequestAddTags (const Tag &value)
 
RunTaskRequestAddTags (Tag &&value)
 
const Aws::StringGetTaskDefinition () const
 
bool TaskDefinitionHasBeenSet () const
 
void SetTaskDefinition (const Aws::String &value)
 
void SetTaskDefinition (Aws::String &&value)
 
void SetTaskDefinition (const char *value)
 
RunTaskRequestWithTaskDefinition (const Aws::String &value)
 
RunTaskRequestWithTaskDefinition (Aws::String &&value)
 
RunTaskRequestWithTaskDefinition (const char *value)
 
- Public Member Functions inherited from Aws::ECS::ECSRequest
virtual ~ECSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 30 of file RunTaskRequest.h.

Constructor & Destructor Documentation

◆ RunTaskRequest()

Aws::ECS::Model::RunTaskRequest::RunTaskRequest ( )

Member Function Documentation

◆ AddCapacityProviderStrategy() [1/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::AddCapacityProviderStrategy ( const CapacityProviderStrategyItem value)
inline

The capacity provider strategy to use for the task.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 212 of file RunTaskRequest.h.

◆ AddCapacityProviderStrategy() [2/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::AddCapacityProviderStrategy ( CapacityProviderStrategyItem &&  value)
inline

The capacity provider strategy to use for the task.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 236 of file RunTaskRequest.h.

◆ AddPlacementConstraints() [1/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::AddPlacementConstraints ( const PlacementConstraint value)
inline

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

Definition at line 655 of file RunTaskRequest.h.

◆ AddPlacementConstraints() [2/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::AddPlacementConstraints ( PlacementConstraint &&  value)
inline

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

Definition at line 662 of file RunTaskRequest.h.

◆ AddPlacementStrategy() [1/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::AddPlacementStrategy ( const PlacementStrategy value)
inline

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

Definition at line 705 of file RunTaskRequest.h.

◆ AddPlacementStrategy() [2/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::AddPlacementStrategy ( PlacementStrategy &&  value)
inline

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

Definition at line 711 of file RunTaskRequest.h.

◆ AddTags() [1/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::AddTags ( const Tag value)
inline

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.

Definition at line 1148 of file RunTaskRequest.h.

◆ AddTags() [2/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::AddTags ( Tag &&  value)
inline

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.

Definition at line 1168 of file RunTaskRequest.h.

◆ CapacityProviderStrategyHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::CapacityProviderStrategyHasBeenSet ( ) const
inline

The capacity provider strategy to use for the task.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 92 of file RunTaskRequest.h.

◆ ClusterHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::ClusterHasBeenSet ( ) const
inline

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.

Definition at line 251 of file RunTaskRequest.h.

◆ CountHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::CountHasBeenSet ( ) const
inline

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

Definition at line 306 of file RunTaskRequest.h.

◆ EnableECSManagedTagsHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::EnableECSManagedTagsHasBeenSet ( ) const
inline

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.

Definition at line 337 of file RunTaskRequest.h.

◆ GetCapacityProviderStrategy()

const Aws::Vector<CapacityProviderStrategyItem>& Aws::ECS::Model::RunTaskRequest::GetCapacityProviderStrategy ( ) const
inline

The capacity provider strategy to use for the task.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 68 of file RunTaskRequest.h.

◆ GetCluster()

const Aws::String& Aws::ECS::Model::RunTaskRequest::GetCluster ( ) const
inline

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.

Definition at line 244 of file RunTaskRequest.h.

◆ GetCount()

int Aws::ECS::Model::RunTaskRequest::GetCount ( ) const
inline

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

Definition at line 300 of file RunTaskRequest.h.

◆ GetEnableECSManagedTags()

bool Aws::ECS::Model::RunTaskRequest::GetEnableECSManagedTags ( ) const
inline

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.

Definition at line 328 of file RunTaskRequest.h.

◆ GetGroup()

const Aws::String& Aws::ECS::Model::RunTaskRequest::GetGroup ( ) const
inline

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

Definition at line 362 of file RunTaskRequest.h.

◆ GetLaunchType()

const LaunchType& Aws::ECS::Model::RunTaskRequest::GetLaunchType ( ) const
inline

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

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

Definition at line 414 of file RunTaskRequest.h.

◆ GetNetworkConfiguration()

const NetworkConfiguration& Aws::ECS::Model::RunTaskRequest::GetNetworkConfiguration ( ) const
inline

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.

Definition at line 471 of file RunTaskRequest.h.

◆ GetOverrides()

const TaskOverride& Aws::ECS::Model::RunTaskRequest::GetOverrides ( ) const
inline

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.

Definition at line 540 of file RunTaskRequest.h.

◆ GetPlacementConstraints()

const Aws::Vector<PlacementConstraint>& Aws::ECS::Model::RunTaskRequest::GetPlacementConstraints ( ) const
inline

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

Definition at line 613 of file RunTaskRequest.h.

◆ GetPlacementStrategy()

const Aws::Vector<PlacementStrategy>& Aws::ECS::Model::RunTaskRequest::GetPlacementStrategy ( ) const
inline

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

Definition at line 669 of file RunTaskRequest.h.

◆ GetPlatformVersion()

const Aws::String& Aws::ECS::Model::RunTaskRequest::GetPlatformVersion ( ) const
inline

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.

Definition at line 723 of file RunTaskRequest.h.

◆ GetPropagateTags()

const PropagateTags& Aws::ECS::Model::RunTaskRequest::GetPropagateTags ( ) const
inline

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.

Definition at line 811 of file RunTaskRequest.h.

◆ GetReferenceId()

const Aws::String& Aws::ECS::Model::RunTaskRequest::GetReferenceId ( ) const
inline

The reference ID to use for the task.

Definition at line 867 of file RunTaskRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ECS::Model::RunTaskRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::ECS::ECSRequest.

◆ GetServiceRequestName()

virtual const char* Aws::ECS::Model::RunTaskRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 39 of file RunTaskRequest.h.

◆ GetStartedBy()

const Aws::String& Aws::ECS::Model::RunTaskRequest::GetStartedBy ( ) const
inline

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.

Definition at line 916 of file RunTaskRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::ECS::Model::RunTaskRequest::GetTags ( ) const
inline

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.

Definition at line 1028 of file RunTaskRequest.h.

◆ GetTaskDefinition()

const Aws::String& Aws::ECS::Model::RunTaskRequest::GetTaskDefinition ( ) const
inline

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.

Definition at line 1177 of file RunTaskRequest.h.

◆ GroupHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::GroupHasBeenSet ( ) const
inline

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

Definition at line 368 of file RunTaskRequest.h.

◆ LaunchTypeHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::LaunchTypeHasBeenSet ( ) const
inline

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

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

Definition at line 423 of file RunTaskRequest.h.

◆ NetworkConfigurationHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::NetworkConfigurationHasBeenSet ( ) const
inline

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.

Definition at line 482 of file RunTaskRequest.h.

◆ OverridesHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::OverridesHasBeenSet ( ) const
inline

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.

Definition at line 553 of file RunTaskRequest.h.

◆ PlacementConstraintsHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::PlacementConstraintsHasBeenSet ( ) const
inline

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

Definition at line 620 of file RunTaskRequest.h.

◆ PlacementStrategyHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::PlacementStrategyHasBeenSet ( ) const
inline

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

Definition at line 675 of file RunTaskRequest.h.

◆ PlatformVersionHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::PlatformVersionHasBeenSet ( ) const
inline

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.

Definition at line 734 of file RunTaskRequest.h.

◆ PropagateTagsHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::PropagateTagsHasBeenSet ( ) const
inline

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.

Definition at line 821 of file RunTaskRequest.h.

◆ ReferenceIdHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::ReferenceIdHasBeenSet ( ) const
inline

The reference ID to use for the task.

Definition at line 872 of file RunTaskRequest.h.

◆ SerializePayload()

Aws::String Aws::ECS::Model::RunTaskRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCapacityProviderStrategy() [1/2]

void Aws::ECS::Model::RunTaskRequest::SetCapacityProviderStrategy ( const Aws::Vector< CapacityProviderStrategyItem > &  value)
inline

The capacity provider strategy to use for the task.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 116 of file RunTaskRequest.h.

◆ SetCapacityProviderStrategy() [2/2]

void Aws::ECS::Model::RunTaskRequest::SetCapacityProviderStrategy ( Aws::Vector< CapacityProviderStrategyItem > &&  value)
inline

The capacity provider strategy to use for the task.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 140 of file RunTaskRequest.h.

◆ SetCluster() [1/3]

void Aws::ECS::Model::RunTaskRequest::SetCluster ( const Aws::String value)
inline

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.

Definition at line 258 of file RunTaskRequest.h.

◆ SetCluster() [2/3]

void Aws::ECS::Model::RunTaskRequest::SetCluster ( Aws::String &&  value)
inline

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.

Definition at line 265 of file RunTaskRequest.h.

◆ SetCluster() [3/3]

void Aws::ECS::Model::RunTaskRequest::SetCluster ( const char *  value)
inline

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.

Definition at line 272 of file RunTaskRequest.h.

◆ SetCount()

void Aws::ECS::Model::RunTaskRequest::SetCount ( int  value)
inline

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

Definition at line 312 of file RunTaskRequest.h.

◆ SetEnableECSManagedTags()

void Aws::ECS::Model::RunTaskRequest::SetEnableECSManagedTags ( bool  value)
inline

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.

Definition at line 346 of file RunTaskRequest.h.

◆ SetGroup() [1/3]

void Aws::ECS::Model::RunTaskRequest::SetGroup ( const Aws::String value)
inline

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

Definition at line 374 of file RunTaskRequest.h.

◆ SetGroup() [2/3]

void Aws::ECS::Model::RunTaskRequest::SetGroup ( Aws::String &&  value)
inline

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

Definition at line 380 of file RunTaskRequest.h.

◆ SetGroup() [3/3]

void Aws::ECS::Model::RunTaskRequest::SetGroup ( const char *  value)
inline

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

Definition at line 386 of file RunTaskRequest.h.

◆ SetLaunchType() [1/2]

void Aws::ECS::Model::RunTaskRequest::SetLaunchType ( const LaunchType value)
inline

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

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

Definition at line 432 of file RunTaskRequest.h.

◆ SetLaunchType() [2/2]

void Aws::ECS::Model::RunTaskRequest::SetLaunchType ( LaunchType &&  value)
inline

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

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

Definition at line 441 of file RunTaskRequest.h.

◆ SetNetworkConfiguration() [1/2]

void Aws::ECS::Model::RunTaskRequest::SetNetworkConfiguration ( const NetworkConfiguration value)
inline

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.

Definition at line 493 of file RunTaskRequest.h.

◆ SetNetworkConfiguration() [2/2]

void Aws::ECS::Model::RunTaskRequest::SetNetworkConfiguration ( NetworkConfiguration &&  value)
inline

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.

Definition at line 504 of file RunTaskRequest.h.

◆ SetOverrides() [1/2]

void Aws::ECS::Model::RunTaskRequest::SetOverrides ( const TaskOverride value)
inline

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.

Definition at line 566 of file RunTaskRequest.h.

◆ SetOverrides() [2/2]

void Aws::ECS::Model::RunTaskRequest::SetOverrides ( TaskOverride &&  value)
inline

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.

Definition at line 579 of file RunTaskRequest.h.

◆ SetPlacementConstraints() [1/2]

void Aws::ECS::Model::RunTaskRequest::SetPlacementConstraints ( const Aws::Vector< PlacementConstraint > &  value)
inline

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

Definition at line 627 of file RunTaskRequest.h.

◆ SetPlacementConstraints() [2/2]

void Aws::ECS::Model::RunTaskRequest::SetPlacementConstraints ( Aws::Vector< PlacementConstraint > &&  value)
inline

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

Definition at line 634 of file RunTaskRequest.h.

◆ SetPlacementStrategy() [1/2]

void Aws::ECS::Model::RunTaskRequest::SetPlacementStrategy ( const Aws::Vector< PlacementStrategy > &  value)
inline

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

Definition at line 681 of file RunTaskRequest.h.

◆ SetPlacementStrategy() [2/2]

void Aws::ECS::Model::RunTaskRequest::SetPlacementStrategy ( Aws::Vector< PlacementStrategy > &&  value)
inline

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

Definition at line 687 of file RunTaskRequest.h.

◆ SetPlatformVersion() [1/3]

void Aws::ECS::Model::RunTaskRequest::SetPlatformVersion ( const Aws::String value)
inline

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.

Definition at line 745 of file RunTaskRequest.h.

◆ SetPlatformVersion() [2/3]

void Aws::ECS::Model::RunTaskRequest::SetPlatformVersion ( Aws::String &&  value)
inline

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.

Definition at line 756 of file RunTaskRequest.h.

◆ SetPlatformVersion() [3/3]

void Aws::ECS::Model::RunTaskRequest::SetPlatformVersion ( const char *  value)
inline

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.

Definition at line 767 of file RunTaskRequest.h.

◆ SetPropagateTags() [1/2]

void Aws::ECS::Model::RunTaskRequest::SetPropagateTags ( const PropagateTags value)
inline

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.

Definition at line 831 of file RunTaskRequest.h.

◆ SetPropagateTags() [2/2]

void Aws::ECS::Model::RunTaskRequest::SetPropagateTags ( PropagateTags &&  value)
inline

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.

Definition at line 841 of file RunTaskRequest.h.

◆ SetReferenceId() [1/3]

void Aws::ECS::Model::RunTaskRequest::SetReferenceId ( const Aws::String value)
inline

The reference ID to use for the task.

Definition at line 877 of file RunTaskRequest.h.

◆ SetReferenceId() [2/3]

void Aws::ECS::Model::RunTaskRequest::SetReferenceId ( Aws::String &&  value)
inline

The reference ID to use for the task.

Definition at line 882 of file RunTaskRequest.h.

◆ SetReferenceId() [3/3]

void Aws::ECS::Model::RunTaskRequest::SetReferenceId ( const char *  value)
inline

The reference ID to use for the task.

Definition at line 887 of file RunTaskRequest.h.

◆ SetStartedBy() [1/3]

void Aws::ECS::Model::RunTaskRequest::SetStartedBy ( const Aws::String value)
inline

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.

Definition at line 942 of file RunTaskRequest.h.

◆ SetStartedBy() [2/3]

void Aws::ECS::Model::RunTaskRequest::SetStartedBy ( Aws::String &&  value)
inline

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.

Definition at line 955 of file RunTaskRequest.h.

◆ SetStartedBy() [3/3]

void Aws::ECS::Model::RunTaskRequest::SetStartedBy ( const char *  value)
inline

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.

Definition at line 968 of file RunTaskRequest.h.

◆ SetTags() [1/2]

void Aws::ECS::Model::RunTaskRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

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.

Definition at line 1068 of file RunTaskRequest.h.

◆ SetTags() [2/2]

void Aws::ECS::Model::RunTaskRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

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.

Definition at line 1088 of file RunTaskRequest.h.

◆ SetTaskDefinition() [1/3]

void Aws::ECS::Model::RunTaskRequest::SetTaskDefinition ( const Aws::String value)
inline

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.

Definition at line 1193 of file RunTaskRequest.h.

◆ SetTaskDefinition() [2/3]

void Aws::ECS::Model::RunTaskRequest::SetTaskDefinition ( Aws::String &&  value)
inline

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.

Definition at line 1201 of file RunTaskRequest.h.

◆ SetTaskDefinition() [3/3]

void Aws::ECS::Model::RunTaskRequest::SetTaskDefinition ( const char *  value)
inline

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.

Definition at line 1209 of file RunTaskRequest.h.

◆ StartedByHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::StartedByHasBeenSet ( ) const
inline

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.

Definition at line 929 of file RunTaskRequest.h.

◆ TagsHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::TagsHasBeenSet ( ) const
inline

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.

Definition at line 1048 of file RunTaskRequest.h.

◆ TaskDefinitionHasBeenSet()

bool Aws::ECS::Model::RunTaskRequest::TaskDefinitionHasBeenSet ( ) const
inline

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.

Definition at line 1185 of file RunTaskRequest.h.

◆ WithCapacityProviderStrategy() [1/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithCapacityProviderStrategy ( const Aws::Vector< CapacityProviderStrategyItem > &  value)
inline

The capacity provider strategy to use for the task.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 164 of file RunTaskRequest.h.

◆ WithCapacityProviderStrategy() [2/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithCapacityProviderStrategy ( Aws::Vector< CapacityProviderStrategyItem > &&  value)
inline

The capacity provider strategy to use for the task.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 188 of file RunTaskRequest.h.

◆ WithCluster() [1/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithCluster ( const Aws::String value)
inline

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.

Definition at line 279 of file RunTaskRequest.h.

◆ WithCluster() [2/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithCluster ( Aws::String &&  value)
inline

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.

Definition at line 286 of file RunTaskRequest.h.

◆ WithCluster() [3/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithCluster ( const char *  value)
inline

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.

Definition at line 293 of file RunTaskRequest.h.

◆ WithCount()

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithCount ( int  value)
inline

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

Definition at line 318 of file RunTaskRequest.h.

◆ WithEnableECSManagedTags()

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithEnableECSManagedTags ( bool  value)
inline

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.

Definition at line 355 of file RunTaskRequest.h.

◆ WithGroup() [1/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithGroup ( const Aws::String value)
inline

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

Definition at line 392 of file RunTaskRequest.h.

◆ WithGroup() [2/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithGroup ( Aws::String &&  value)
inline

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

Definition at line 398 of file RunTaskRequest.h.

◆ WithGroup() [3/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithGroup ( const char *  value)
inline

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

Definition at line 404 of file RunTaskRequest.h.

◆ WithLaunchType() [1/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithLaunchType ( const LaunchType value)
inline

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

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

Definition at line 450 of file RunTaskRequest.h.

◆ WithLaunchType() [2/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithLaunchType ( LaunchType &&  value)
inline

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

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

Definition at line 459 of file RunTaskRequest.h.

◆ WithNetworkConfiguration() [1/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithNetworkConfiguration ( const NetworkConfiguration value)
inline

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.

Definition at line 515 of file RunTaskRequest.h.

◆ WithNetworkConfiguration() [2/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithNetworkConfiguration ( NetworkConfiguration &&  value)
inline

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.

Definition at line 526 of file RunTaskRequest.h.

◆ WithOverrides() [1/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithOverrides ( const TaskOverride value)
inline

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.

Definition at line 592 of file RunTaskRequest.h.

◆ WithOverrides() [2/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithOverrides ( TaskOverride &&  value)
inline

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.

Definition at line 605 of file RunTaskRequest.h.

◆ WithPlacementConstraints() [1/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithPlacementConstraints ( const Aws::Vector< PlacementConstraint > &  value)
inline

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

Definition at line 641 of file RunTaskRequest.h.

◆ WithPlacementConstraints() [2/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithPlacementConstraints ( Aws::Vector< PlacementConstraint > &&  value)
inline

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

Definition at line 648 of file RunTaskRequest.h.

◆ WithPlacementStrategy() [1/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithPlacementStrategy ( const Aws::Vector< PlacementStrategy > &  value)
inline

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

Definition at line 693 of file RunTaskRequest.h.

◆ WithPlacementStrategy() [2/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithPlacementStrategy ( Aws::Vector< PlacementStrategy > &&  value)
inline

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

Definition at line 699 of file RunTaskRequest.h.

◆ WithPlatformVersion() [1/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithPlatformVersion ( const Aws::String value)
inline

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.

Definition at line 778 of file RunTaskRequest.h.

◆ WithPlatformVersion() [2/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithPlatformVersion ( Aws::String &&  value)
inline

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.

Definition at line 789 of file RunTaskRequest.h.

◆ WithPlatformVersion() [3/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithPlatformVersion ( const char *  value)
inline

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.

Definition at line 800 of file RunTaskRequest.h.

◆ WithPropagateTags() [1/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithPropagateTags ( const PropagateTags value)
inline

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.

Definition at line 851 of file RunTaskRequest.h.

◆ WithPropagateTags() [2/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithPropagateTags ( PropagateTags &&  value)
inline

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.

Definition at line 861 of file RunTaskRequest.h.

◆ WithReferenceId() [1/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithReferenceId ( const Aws::String value)
inline

The reference ID to use for the task.

Definition at line 892 of file RunTaskRequest.h.

◆ WithReferenceId() [2/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithReferenceId ( Aws::String &&  value)
inline

The reference ID to use for the task.

Definition at line 897 of file RunTaskRequest.h.

◆ WithReferenceId() [3/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithReferenceId ( const char *  value)
inline

The reference ID to use for the task.

Definition at line 902 of file RunTaskRequest.h.

◆ WithStartedBy() [1/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithStartedBy ( const Aws::String value)
inline

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.

Definition at line 981 of file RunTaskRequest.h.

◆ WithStartedBy() [2/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithStartedBy ( Aws::String &&  value)
inline

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.

Definition at line 994 of file RunTaskRequest.h.

◆ WithStartedBy() [3/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithStartedBy ( const char *  value)
inline

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.

Definition at line 1007 of file RunTaskRequest.h.

◆ WithTags() [1/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

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.

Definition at line 1108 of file RunTaskRequest.h.

◆ WithTags() [2/2]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

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.

Definition at line 1128 of file RunTaskRequest.h.

◆ WithTaskDefinition() [1/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithTaskDefinition ( const Aws::String value)
inline

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.

Definition at line 1217 of file RunTaskRequest.h.

◆ WithTaskDefinition() [2/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithTaskDefinition ( Aws::String &&  value)
inline

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.

Definition at line 1225 of file RunTaskRequest.h.

◆ WithTaskDefinition() [3/3]

RunTaskRequest& Aws::ECS::Model::RunTaskRequest::WithTaskDefinition ( const char *  value)
inline

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.

Definition at line 1233 of file RunTaskRequest.h.


The documentation for this class was generated from the following file: