Aws::ECS::Model::StartTaskRequest Class Reference

#include <StartTaskRequest.h>

Inheritance diagram for Aws::ECS::Model::StartTaskRequest:

Public Member Functions
	StartTaskRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetCluster () const
bool	ClusterHasBeenSet () const
void	SetCluster (const Aws::String &value)
void	SetCluster (Aws::String &&value)
void	SetCluster (const char *value)
StartTaskRequest &	WithCluster (const Aws::String &value)
StartTaskRequest &	WithCluster (Aws::String &&value)
StartTaskRequest &	WithCluster (const char *value)
const Aws::Vector< Aws::String > &	GetContainerInstances () const
bool	ContainerInstancesHasBeenSet () const
void	SetContainerInstances (const Aws::Vector< Aws::String > &value)
void	SetContainerInstances (Aws::Vector< Aws::String > &&value)
StartTaskRequest &	WithContainerInstances (const Aws::Vector< Aws::String > &value)
StartTaskRequest &	WithContainerInstances (Aws::Vector< Aws::String > &&value)
StartTaskRequest &	AddContainerInstances (const Aws::String &value)
StartTaskRequest &	AddContainerInstances (Aws::String &&value)
StartTaskRequest &	AddContainerInstances (const char *value)
bool	GetEnableECSManagedTags () const
bool	EnableECSManagedTagsHasBeenSet () const
void	SetEnableECSManagedTags (bool value)
StartTaskRequest &	WithEnableECSManagedTags (bool value)
bool	GetEnableExecuteCommand () const
bool	EnableExecuteCommandHasBeenSet () const
void	SetEnableExecuteCommand (bool value)
StartTaskRequest &	WithEnableExecuteCommand (bool value)
const Aws::String &	GetGroup () const
bool	GroupHasBeenSet () const
void	SetGroup (const Aws::String &value)
void	SetGroup (Aws::String &&value)
void	SetGroup (const char *value)
StartTaskRequest &	WithGroup (const Aws::String &value)
StartTaskRequest &	WithGroup (Aws::String &&value)
StartTaskRequest &	WithGroup (const char *value)
const NetworkConfiguration &	GetNetworkConfiguration () const
bool	NetworkConfigurationHasBeenSet () const
void	SetNetworkConfiguration (const NetworkConfiguration &value)
void	SetNetworkConfiguration (NetworkConfiguration &&value)
StartTaskRequest &	WithNetworkConfiguration (const NetworkConfiguration &value)
StartTaskRequest &	WithNetworkConfiguration (NetworkConfiguration &&value)
const TaskOverride &	GetOverrides () const
bool	OverridesHasBeenSet () const
void	SetOverrides (const TaskOverride &value)
void	SetOverrides (TaskOverride &&value)
StartTaskRequest &	WithOverrides (const TaskOverride &value)
StartTaskRequest &	WithOverrides (TaskOverride &&value)
const PropagateTags &	GetPropagateTags () const
bool	PropagateTagsHasBeenSet () const
void	SetPropagateTags (const PropagateTags &value)
void	SetPropagateTags (PropagateTags &&value)
StartTaskRequest &	WithPropagateTags (const PropagateTags &value)
StartTaskRequest &	WithPropagateTags (PropagateTags &&value)
const Aws::String &	GetReferenceId () const
bool	ReferenceIdHasBeenSet () const
void	SetReferenceId (const Aws::String &value)
void	SetReferenceId (Aws::String &&value)
void	SetReferenceId (const char *value)
StartTaskRequest &	WithReferenceId (const Aws::String &value)
StartTaskRequest &	WithReferenceId (Aws::String &&value)
StartTaskRequest &	WithReferenceId (const char *value)
const Aws::String &	GetStartedBy () const
bool	StartedByHasBeenSet () const
void	SetStartedBy (const Aws::String &value)
void	SetStartedBy (Aws::String &&value)
void	SetStartedBy (const char *value)
StartTaskRequest &	WithStartedBy (const Aws::String &value)
StartTaskRequest &	WithStartedBy (Aws::String &&value)
StartTaskRequest &	WithStartedBy (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)
StartTaskRequest &	WithTags (const Aws::Vector< Tag > &value)
StartTaskRequest &	WithTags (Aws::Vector< Tag > &&value)
StartTaskRequest &	AddTags (const Tag &value)
StartTaskRequest &	AddTags (Tag &&value)
const Aws::String &	GetTaskDefinition () const
bool	TaskDefinitionHasBeenSet () const
void	SetTaskDefinition (const Aws::String &value)
void	SetTaskDefinition (Aws::String &&value)
void	SetTaskDefinition (const char *value)
StartTaskRequest &	WithTaskDefinition (const Aws::String &value)
StartTaskRequest &	WithTaskDefinition (Aws::String &&value)
StartTaskRequest &	WithTaskDefinition (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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 26 of file StartTaskRequest.h.

Constructor & Destructor Documentation

StartTaskRequest()

Aws::ECS::Model::StartTaskRequest::StartTaskRequest

(

)

Member Function Documentation

AddContainerInstances() [1/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::AddContainerInstances ( Aws::String &&  value )

inline

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

Definition at line 153 of file StartTaskRequest.h.

AddContainerInstances() [2/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::AddContainerInstances ( const Aws::String &  value )

inline

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

Definition at line 146 of file StartTaskRequest.h.

AddContainerInstances() [3/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::AddContainerInstances ( const char *  value )

inline

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

Definition at line 160 of file StartTaskRequest.h.

AddTags() [1/2]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::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 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.

Definition at line 721 of file StartTaskRequest.h.

AddTags() [2/2]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::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 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.

Definition at line 741 of file StartTaskRequest.h.

ClusterHasBeenSet()

bool Aws::ECS::Model::StartTaskRequest::ClusterHasBeenSet ( ) const

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.

Definition at line 54 of file StartTaskRequest.h.

ContainerInstancesHasBeenSet()

bool Aws::ECS::Model::StartTaskRequest::ContainerInstancesHasBeenSet ( ) const

inline

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

Definition at line 111 of file StartTaskRequest.h.

EnableECSManagedTagsHasBeenSet()

bool Aws::ECS::Model::StartTaskRequest::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 179 of file StartTaskRequest.h.

EnableExecuteCommandHasBeenSet()

bool Aws::ECS::Model::StartTaskRequest::EnableExecuteCommandHasBeenSet ( ) const

inline

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

Definition at line 212 of file StartTaskRequest.h.

GetCluster()

const Aws::String& Aws::ECS::Model::StartTaskRequest::GetCluster ( ) const

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.

Definition at line 47 of file StartTaskRequest.h.

GetContainerInstances()

const Aws::Vector<Aws::String>& Aws::ECS::Model::StartTaskRequest::GetContainerInstances ( ) const

inline

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

Definition at line 104 of file StartTaskRequest.h.

GetEnableECSManagedTags()

bool Aws::ECS::Model::StartTaskRequest::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 170 of file StartTaskRequest.h.

GetEnableExecuteCommand()

bool Aws::ECS::Model::StartTaskRequest::GetEnableExecuteCommand ( ) const

inline

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

Definition at line 205 of file StartTaskRequest.h.

GetGroup()

const Aws::String& Aws::ECS::Model::StartTaskRequest::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 233 of file StartTaskRequest.h.

GetNetworkConfiguration()

const NetworkConfiguration& Aws::ECS::Model::StartTaskRequest::GetNetworkConfiguration ( ) const

inline

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

Definition at line 283 of file StartTaskRequest.h.

GetOverrides()

const TaskOverride& Aws::ECS::Model::StartTaskRequest::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 332 of file StartTaskRequest.h.

GetPropagateTags()

const PropagateTags& Aws::ECS::Model::StartTaskRequest::GetPropagateTags ( ) const

inline

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

Definition at line 404 of file StartTaskRequest.h.

GetReferenceId()

const Aws::String& Aws::ECS::Model::StartTaskRequest::GetReferenceId ( ) const

inline

The reference ID to use for the task.

Definition at line 440 of file StartTaskRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ECS::Model::StartTaskRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::ECS::ECSRequest.

GetServiceRequestName()

virtual const char* Aws::ECS::Model::StartTaskRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file StartTaskRequest.h.

GetStartedBy()

const Aws::String& Aws::ECS::Model::StartTaskRequest::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 489 of file StartTaskRequest.h.

GetTags()

const Aws::Vector<Tag>& Aws::ECS::Model::StartTaskRequest::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 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.

Definition at line 601 of file StartTaskRequest.h.

GetTaskDefinition()

const Aws::String& Aws::ECS::Model::StartTaskRequest::GetTaskDefinition ( ) const

inline

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

Definition at line 750 of file StartTaskRequest.h.

GroupHasBeenSet()

bool Aws::ECS::Model::StartTaskRequest::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 239 of file StartTaskRequest.h.

NetworkConfigurationHasBeenSet()

bool Aws::ECS::Model::StartTaskRequest::NetworkConfigurationHasBeenSet ( ) const

inline

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

Definition at line 290 of file StartTaskRequest.h.

OverridesHasBeenSet()

bool Aws::ECS::Model::StartTaskRequest::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 345 of file StartTaskRequest.h.

PropagateTagsHasBeenSet()

bool Aws::ECS::Model::StartTaskRequest::PropagateTagsHasBeenSet ( ) const

inline

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

Definition at line 410 of file StartTaskRequest.h.

ReferenceIdHasBeenSet()

bool Aws::ECS::Model::StartTaskRequest::ReferenceIdHasBeenSet ( ) const

inline

The reference ID to use for the task.

Definition at line 445 of file StartTaskRequest.h.

SerializePayload()

Aws::String Aws::ECS::Model::StartTaskRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetCluster() [1/3]

void Aws::ECS::Model::StartTaskRequest::SetCluster ( Aws::String &&  value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.

Definition at line 68 of file StartTaskRequest.h.

SetCluster() [2/3]

void Aws::ECS::Model::StartTaskRequest::SetCluster ( const Aws::String &  value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.

Definition at line 61 of file StartTaskRequest.h.

SetCluster() [3/3]

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

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.

Definition at line 75 of file StartTaskRequest.h.

SetContainerInstances() [1/2]

void Aws::ECS::Model::StartTaskRequest::SetContainerInstances ( Aws::Vector< Aws::String > &&  value )

inline

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

Definition at line 125 of file StartTaskRequest.h.

SetContainerInstances() [2/2]

void Aws::ECS::Model::StartTaskRequest::SetContainerInstances ( const Aws::Vector< Aws::String > &  value )

inline

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

Definition at line 118 of file StartTaskRequest.h.

SetEnableECSManagedTags()

void Aws::ECS::Model::StartTaskRequest::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 188 of file StartTaskRequest.h.

SetEnableExecuteCommand()

void Aws::ECS::Model::StartTaskRequest::SetEnableExecuteCommand ( bool  value )

inline

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

Definition at line 219 of file StartTaskRequest.h.

SetGroup() [1/3]

void Aws::ECS::Model::StartTaskRequest::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 251 of file StartTaskRequest.h.

SetGroup() [2/3]

void Aws::ECS::Model::StartTaskRequest::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 245 of file StartTaskRequest.h.

SetGroup() [3/3]

void Aws::ECS::Model::StartTaskRequest::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 257 of file StartTaskRequest.h.

SetNetworkConfiguration() [1/2]

void Aws::ECS::Model::StartTaskRequest::SetNetworkConfiguration ( const NetworkConfiguration &  value )

inline

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

Definition at line 297 of file StartTaskRequest.h.

SetNetworkConfiguration() [2/2]

void Aws::ECS::Model::StartTaskRequest::SetNetworkConfiguration ( NetworkConfiguration &&  value )

inline

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

Definition at line 304 of file StartTaskRequest.h.

SetOverrides() [1/2]

void Aws::ECS::Model::StartTaskRequest::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 358 of file StartTaskRequest.h.

SetOverrides() [2/2]

void Aws::ECS::Model::StartTaskRequest::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 371 of file StartTaskRequest.h.

SetPropagateTags() [1/2]

void Aws::ECS::Model::StartTaskRequest::SetPropagateTags ( const PropagateTags &  value )

inline

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

Definition at line 416 of file StartTaskRequest.h.

SetPropagateTags() [2/2]

void Aws::ECS::Model::StartTaskRequest::SetPropagateTags ( PropagateTags &&  value )

inline

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

Definition at line 422 of file StartTaskRequest.h.

SetReferenceId() [1/3]

void Aws::ECS::Model::StartTaskRequest::SetReferenceId ( Aws::String &&  value )

inline

The reference ID to use for the task.

Definition at line 455 of file StartTaskRequest.h.

SetReferenceId() [2/3]

void Aws::ECS::Model::StartTaskRequest::SetReferenceId ( const Aws::String &  value )

inline

The reference ID to use for the task.

Definition at line 450 of file StartTaskRequest.h.

SetReferenceId() [3/3]

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

inline

The reference ID to use for the task.

Definition at line 460 of file StartTaskRequest.h.

SetStartedBy() [1/3]

void Aws::ECS::Model::StartTaskRequest::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 528 of file StartTaskRequest.h.

SetStartedBy() [2/3]

void Aws::ECS::Model::StartTaskRequest::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 515 of file StartTaskRequest.h.

SetStartedBy() [3/3]

void Aws::ECS::Model::StartTaskRequest::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 541 of file StartTaskRequest.h.

SetTags() [1/2]

void Aws::ECS::Model::StartTaskRequest::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 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.

Definition at line 661 of file StartTaskRequest.h.

SetTags() [2/2]

void Aws::ECS::Model::StartTaskRequest::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 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.

Definition at line 641 of file StartTaskRequest.h.

SetTaskDefinition() [1/3]

void Aws::ECS::Model::StartTaskRequest::SetTaskDefinition ( Aws::String &&  value )

inline

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

Definition at line 774 of file StartTaskRequest.h.

SetTaskDefinition() [2/3]

void Aws::ECS::Model::StartTaskRequest::SetTaskDefinition ( const Aws::String &  value )

inline

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

Definition at line 766 of file StartTaskRequest.h.

SetTaskDefinition() [3/3]

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

inline

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

Definition at line 782 of file StartTaskRequest.h.

StartedByHasBeenSet()

bool Aws::ECS::Model::StartTaskRequest::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 502 of file StartTaskRequest.h.

TagsHasBeenSet()

bool Aws::ECS::Model::StartTaskRequest::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 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.

Definition at line 621 of file StartTaskRequest.h.

TaskDefinitionHasBeenSet()

bool Aws::ECS::Model::StartTaskRequest::TaskDefinitionHasBeenSet ( ) const

inline

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

Definition at line 758 of file StartTaskRequest.h.

WithCluster() [1/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::WithCluster ( Aws::String &&  value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.

Definition at line 89 of file StartTaskRequest.h.

WithCluster() [2/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::WithCluster ( const Aws::String &  value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.

Definition at line 82 of file StartTaskRequest.h.

WithCluster() [3/3]

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

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.

Definition at line 96 of file StartTaskRequest.h.

WithContainerInstances() [1/2]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::WithContainerInstances ( Aws::Vector< Aws::String > &&  value )

inline

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

Definition at line 139 of file StartTaskRequest.h.

WithContainerInstances() [2/2]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::WithContainerInstances ( const Aws::Vector< Aws::String > &  value )

inline

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

Definition at line 132 of file StartTaskRequest.h.

WithEnableECSManagedTags()

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::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 197 of file StartTaskRequest.h.

WithEnableExecuteCommand()

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::WithEnableExecuteCommand ( bool  value )

inline

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

Definition at line 226 of file StartTaskRequest.h.

WithGroup() [1/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::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 269 of file StartTaskRequest.h.

WithGroup() [2/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::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 263 of file StartTaskRequest.h.

WithGroup() [3/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::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 275 of file StartTaskRequest.h.

WithNetworkConfiguration() [1/2]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::WithNetworkConfiguration ( const NetworkConfiguration &  value )

inline

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

Definition at line 311 of file StartTaskRequest.h.

WithNetworkConfiguration() [2/2]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::WithNetworkConfiguration ( NetworkConfiguration &&  value )

inline

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

Definition at line 318 of file StartTaskRequest.h.

WithOverrides() [1/2]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::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 384 of file StartTaskRequest.h.

WithOverrides() [2/2]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::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 397 of file StartTaskRequest.h.

WithPropagateTags() [1/2]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::WithPropagateTags ( const PropagateTags &  value )

inline

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

Definition at line 428 of file StartTaskRequest.h.

WithPropagateTags() [2/2]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::WithPropagateTags ( PropagateTags &&  value )

inline

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

Definition at line 434 of file StartTaskRequest.h.

WithReferenceId() [1/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::WithReferenceId ( Aws::String &&  value )

inline

The reference ID to use for the task.

Definition at line 470 of file StartTaskRequest.h.

WithReferenceId() [2/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::WithReferenceId ( const Aws::String &  value )

inline

The reference ID to use for the task.

Definition at line 465 of file StartTaskRequest.h.

WithReferenceId() [3/3]

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

inline

The reference ID to use for the task.

Definition at line 475 of file StartTaskRequest.h.

WithStartedBy() [1/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::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 567 of file StartTaskRequest.h.

WithStartedBy() [2/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::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 554 of file StartTaskRequest.h.

WithStartedBy() [3/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::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 580 of file StartTaskRequest.h.

WithTags() [1/2]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::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 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.

Definition at line 701 of file StartTaskRequest.h.

WithTags() [2/2]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::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 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.

Definition at line 681 of file StartTaskRequest.h.

WithTaskDefinition() [1/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::WithTaskDefinition ( Aws::String &&  value )

inline

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

Definition at line 798 of file StartTaskRequest.h.

WithTaskDefinition() [2/3]

StartTaskRequest& Aws::ECS::Model::StartTaskRequest::WithTaskDefinition ( const Aws::String &  value )

inline

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

Definition at line 790 of file StartTaskRequest.h.

WithTaskDefinition() [3/3]

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

inline

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

Definition at line 806 of file StartTaskRequest.h.

---

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

• aws-cpp-sdk-ecs/include/aws/ecs/model/StartTaskRequest.h