AWS SDK for C++  1.9.3
AWS SDK for C++
Public Member Functions | List of all members
Aws::Batch::Model::RegisterJobDefinitionRequest Class Reference

#include <RegisterJobDefinitionRequest.h>

+ Inheritance diagram for Aws::Batch::Model::RegisterJobDefinitionRequest:

Public Member Functions

 RegisterJobDefinitionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetJobDefinitionName () const
 
bool JobDefinitionNameHasBeenSet () const
 
void SetJobDefinitionName (const Aws::String &value)
 
void SetJobDefinitionName (Aws::String &&value)
 
void SetJobDefinitionName (const char *value)
 
RegisterJobDefinitionRequestWithJobDefinitionName (const Aws::String &value)
 
RegisterJobDefinitionRequestWithJobDefinitionName (Aws::String &&value)
 
RegisterJobDefinitionRequestWithJobDefinitionName (const char *value)
 
const JobDefinitionTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const JobDefinitionType &value)
 
void SetType (JobDefinitionType &&value)
 
RegisterJobDefinitionRequestWithType (const JobDefinitionType &value)
 
RegisterJobDefinitionRequestWithType (JobDefinitionType &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
RegisterJobDefinitionRequestWithParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
RegisterJobDefinitionRequestWithParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
RegisterJobDefinitionRequestAddParameters (const Aws::String &key, const Aws::String &value)
 
RegisterJobDefinitionRequestAddParameters (Aws::String &&key, const Aws::String &value)
 
RegisterJobDefinitionRequestAddParameters (const Aws::String &key, Aws::String &&value)
 
RegisterJobDefinitionRequestAddParameters (Aws::String &&key, Aws::String &&value)
 
RegisterJobDefinitionRequestAddParameters (const char *key, Aws::String &&value)
 
RegisterJobDefinitionRequestAddParameters (Aws::String &&key, const char *value)
 
RegisterJobDefinitionRequestAddParameters (const char *key, const char *value)
 
const ContainerPropertiesGetContainerProperties () const
 
bool ContainerPropertiesHasBeenSet () const
 
void SetContainerProperties (const ContainerProperties &value)
 
void SetContainerProperties (ContainerProperties &&value)
 
RegisterJobDefinitionRequestWithContainerProperties (const ContainerProperties &value)
 
RegisterJobDefinitionRequestWithContainerProperties (ContainerProperties &&value)
 
const NodePropertiesGetNodeProperties () const
 
bool NodePropertiesHasBeenSet () const
 
void SetNodeProperties (const NodeProperties &value)
 
void SetNodeProperties (NodeProperties &&value)
 
RegisterJobDefinitionRequestWithNodeProperties (const NodeProperties &value)
 
RegisterJobDefinitionRequestWithNodeProperties (NodeProperties &&value)
 
const RetryStrategyGetRetryStrategy () const
 
bool RetryStrategyHasBeenSet () const
 
void SetRetryStrategy (const RetryStrategy &value)
 
void SetRetryStrategy (RetryStrategy &&value)
 
RegisterJobDefinitionRequestWithRetryStrategy (const RetryStrategy &value)
 
RegisterJobDefinitionRequestWithRetryStrategy (RetryStrategy &&value)
 
bool GetPropagateTags () const
 
bool PropagateTagsHasBeenSet () const
 
void SetPropagateTags (bool value)
 
RegisterJobDefinitionRequestWithPropagateTags (bool value)
 
const JobTimeoutGetTimeout () const
 
bool TimeoutHasBeenSet () const
 
void SetTimeout (const JobTimeout &value)
 
void SetTimeout (JobTimeout &&value)
 
RegisterJobDefinitionRequestWithTimeout (const JobTimeout &value)
 
RegisterJobDefinitionRequestWithTimeout (JobTimeout &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
RegisterJobDefinitionRequestWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
RegisterJobDefinitionRequestWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
RegisterJobDefinitionRequestAddTags (const Aws::String &key, const Aws::String &value)
 
RegisterJobDefinitionRequestAddTags (Aws::String &&key, const Aws::String &value)
 
RegisterJobDefinitionRequestAddTags (const Aws::String &key, Aws::String &&value)
 
RegisterJobDefinitionRequestAddTags (Aws::String &&key, Aws::String &&value)
 
RegisterJobDefinitionRequestAddTags (const char *key, Aws::String &&value)
 
RegisterJobDefinitionRequestAddTags (Aws::String &&key, const char *value)
 
RegisterJobDefinitionRequestAddTags (const char *key, const char *value)
 
const Aws::Vector< PlatformCapability > & GetPlatformCapabilities () const
 
bool PlatformCapabilitiesHasBeenSet () const
 
void SetPlatformCapabilities (const Aws::Vector< PlatformCapability > &value)
 
void SetPlatformCapabilities (Aws::Vector< PlatformCapability > &&value)
 
RegisterJobDefinitionRequestWithPlatformCapabilities (const Aws::Vector< PlatformCapability > &value)
 
RegisterJobDefinitionRequestWithPlatformCapabilities (Aws::Vector< PlatformCapability > &&value)
 
RegisterJobDefinitionRequestAddPlatformCapabilities (const PlatformCapability &value)
 
RegisterJobDefinitionRequestAddPlatformCapabilities (PlatformCapability &&value)
 
- Public Member Functions inherited from Aws::Batch::BatchRequest
virtual ~BatchRequest ()
 
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::Batch::BatchRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Contains the parameters for RegisterJobDefinition.

See Also:

AWS API Reference

Definition at line 33 of file RegisterJobDefinitionRequest.h.

Constructor & Destructor Documentation

◆ RegisterJobDefinitionRequest()

Aws::Batch::Model::RegisterJobDefinitionRequest::RegisterJobDefinitionRequest ( )

Member Function Documentation

◆ AddParameters() [1/7]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddParameters ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 235 of file RegisterJobDefinitionRequest.h.

◆ AddParameters() [2/7]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddParameters ( Aws::String &&  key,
const Aws::String value 
)
inline

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 219 of file RegisterJobDefinitionRequest.h.

◆ AddParameters() [3/7]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddParameters ( Aws::String &&  key,
const char *  value 
)
inline

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 251 of file RegisterJobDefinitionRequest.h.

◆ AddParameters() [4/7]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddParameters ( const Aws::String key,
Aws::String &&  value 
)
inline

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 227 of file RegisterJobDefinitionRequest.h.

◆ AddParameters() [5/7]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddParameters ( const Aws::String key,
const Aws::String value 
)
inline

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 211 of file RegisterJobDefinitionRequest.h.

◆ AddParameters() [6/7]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddParameters ( const char *  key,
Aws::String &&  value 
)
inline

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 243 of file RegisterJobDefinitionRequest.h.

◆ AddParameters() [7/7]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddParameters ( const char *  key,
const char *  value 
)
inline

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 259 of file RegisterJobDefinitionRequest.h.

◆ AddPlatformCapabilities() [1/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddPlatformCapabilities ( const PlatformCapability value)
inline

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

Definition at line 742 of file RegisterJobDefinitionRequest.h.

◆ AddPlatformCapabilities() [2/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddPlatformCapabilities ( PlatformCapability &&  value)
inline

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

Definition at line 749 of file RegisterJobDefinitionRequest.h.

◆ AddTags() [1/7]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Definition at line 665 of file RegisterJobDefinitionRequest.h.

◆ AddTags() [2/7]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Definition at line 647 of file RegisterJobDefinitionRequest.h.

◆ AddTags() [3/7]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Definition at line 683 of file RegisterJobDefinitionRequest.h.

◆ AddTags() [4/7]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Definition at line 656 of file RegisterJobDefinitionRequest.h.

◆ AddTags() [5/7]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Definition at line 638 of file RegisterJobDefinitionRequest.h.

◆ AddTags() [6/7]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Definition at line 674 of file RegisterJobDefinitionRequest.h.

◆ AddTags() [7/7]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::AddTags ( const char *  key,
const char *  value 
)
inline

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Definition at line 692 of file RegisterJobDefinitionRequest.h.

◆ ContainerPropertiesHasBeenSet()

bool Aws::Batch::Model::RegisterJobDefinitionRequest::ContainerPropertiesHasBeenSet ( ) const
inline

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

Definition at line 282 of file RegisterJobDefinitionRequest.h.

◆ GetContainerProperties()

const ContainerProperties& Aws::Batch::Model::RegisterJobDefinitionRequest::GetContainerProperties ( ) const
inline

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

Definition at line 271 of file RegisterJobDefinitionRequest.h.

◆ GetJobDefinitionName()

const Aws::String& Aws::Batch::Model::RegisterJobDefinitionRequest::GetJobDefinitionName ( ) const
inline

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 51 of file RegisterJobDefinitionRequest.h.

◆ GetNodeProperties()

const NodeProperties& Aws::Batch::Model::RegisterJobDefinitionRequest::GetNodeProperties ( ) const
inline

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

Definition at line 341 of file RegisterJobDefinitionRequest.h.

◆ GetParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::Batch::Model::RegisterJobDefinitionRequest::GetParameters ( ) const
inline

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 163 of file RegisterJobDefinitionRequest.h.

◆ GetPlatformCapabilities()

const Aws::Vector<PlatformCapability>& Aws::Batch::Model::RegisterJobDefinitionRequest::GetPlatformCapabilities ( ) const
inline

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

Definition at line 700 of file RegisterJobDefinitionRequest.h.

◆ GetPropagateTags()

bool Aws::Batch::Model::RegisterJobDefinitionRequest::GetPropagateTags ( ) const
inline

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

Definition at line 471 of file RegisterJobDefinitionRequest.h.

◆ GetRetryStrategy()

const RetryStrategy& Aws::Batch::Model::RegisterJobDefinitionRequest::GetRetryStrategy ( ) const
inline

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

Definition at line 420 of file RegisterJobDefinitionRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Batch::Model::RegisterJobDefinitionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 42 of file RegisterJobDefinitionRequest.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::Batch::Model::RegisterJobDefinitionRequest::GetTags ( ) const
inline

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Definition at line 584 of file RegisterJobDefinitionRequest.h.

◆ GetTimeout()

const JobTimeout& Aws::Batch::Model::RegisterJobDefinitionRequest::GetTimeout ( ) const
inline

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.

Definition at line 514 of file RegisterJobDefinitionRequest.h.

◆ GetType()

const JobDefinitionType& Aws::Batch::Model::RegisterJobDefinitionRequest::GetType ( ) const
inline

The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.

If the job is run on Fargate resources, then multinode isn't supported.

Definition at line 104 of file RegisterJobDefinitionRequest.h.

◆ JobDefinitionNameHasBeenSet()

bool Aws::Batch::Model::RegisterJobDefinitionRequest::JobDefinitionNameHasBeenSet ( ) const
inline

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 57 of file RegisterJobDefinitionRequest.h.

◆ NodePropertiesHasBeenSet()

bool Aws::Batch::Model::RegisterJobDefinitionRequest::NodePropertiesHasBeenSet ( ) const
inline

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

Definition at line 355 of file RegisterJobDefinitionRequest.h.

◆ ParametersHasBeenSet()

bool Aws::Batch::Model::RegisterJobDefinitionRequest::ParametersHasBeenSet ( ) const
inline

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 171 of file RegisterJobDefinitionRequest.h.

◆ PlatformCapabilitiesHasBeenSet()

bool Aws::Batch::Model::RegisterJobDefinitionRequest::PlatformCapabilitiesHasBeenSet ( ) const
inline

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

Definition at line 707 of file RegisterJobDefinitionRequest.h.

◆ PropagateTagsHasBeenSet()

bool Aws::Batch::Model::RegisterJobDefinitionRequest::PropagateTagsHasBeenSet ( ) const
inline

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

Definition at line 481 of file RegisterJobDefinitionRequest.h.

◆ RetryStrategyHasBeenSet()

bool Aws::Batch::Model::RegisterJobDefinitionRequest::RetryStrategyHasBeenSet ( ) const
inline

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

Definition at line 428 of file RegisterJobDefinitionRequest.h.

◆ SerializePayload()

Aws::String Aws::Batch::Model::RegisterJobDefinitionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetContainerProperties() [1/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetContainerProperties ( const ContainerProperties value)
inline

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

Definition at line 293 of file RegisterJobDefinitionRequest.h.

◆ SetContainerProperties() [2/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetContainerProperties ( ContainerProperties &&  value)
inline

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

Definition at line 304 of file RegisterJobDefinitionRequest.h.

◆ SetJobDefinitionName() [1/3]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetJobDefinitionName ( Aws::String &&  value)
inline

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 69 of file RegisterJobDefinitionRequest.h.

◆ SetJobDefinitionName() [2/3]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetJobDefinitionName ( const Aws::String value)
inline

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 63 of file RegisterJobDefinitionRequest.h.

◆ SetJobDefinitionName() [3/3]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetJobDefinitionName ( const char *  value)
inline

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 75 of file RegisterJobDefinitionRequest.h.

◆ SetNodeProperties() [1/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetNodeProperties ( const NodeProperties value)
inline

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

Definition at line 369 of file RegisterJobDefinitionRequest.h.

◆ SetNodeProperties() [2/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetNodeProperties ( NodeProperties &&  value)
inline

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

Definition at line 383 of file RegisterJobDefinitionRequest.h.

◆ SetParameters() [1/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 187 of file RegisterJobDefinitionRequest.h.

◆ SetParameters() [2/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 179 of file RegisterJobDefinitionRequest.h.

◆ SetPlatformCapabilities() [1/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetPlatformCapabilities ( Aws::Vector< PlatformCapability > &&  value)
inline

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

Definition at line 721 of file RegisterJobDefinitionRequest.h.

◆ SetPlatformCapabilities() [2/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetPlatformCapabilities ( const Aws::Vector< PlatformCapability > &  value)
inline

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

Definition at line 714 of file RegisterJobDefinitionRequest.h.

◆ SetPropagateTags()

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetPropagateTags ( bool  value)
inline

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

Definition at line 491 of file RegisterJobDefinitionRequest.h.

◆ SetRetryStrategy() [1/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetRetryStrategy ( const RetryStrategy value)
inline

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

Definition at line 436 of file RegisterJobDefinitionRequest.h.

◆ SetRetryStrategy() [2/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetRetryStrategy ( RetryStrategy &&  value)
inline

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

Definition at line 444 of file RegisterJobDefinitionRequest.h.

◆ SetTags() [1/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Definition at line 611 of file RegisterJobDefinitionRequest.h.

◆ SetTags() [2/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Definition at line 602 of file RegisterJobDefinitionRequest.h.

◆ SetTimeout() [1/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetTimeout ( const JobTimeout value)
inline

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.

Definition at line 538 of file RegisterJobDefinitionRequest.h.

◆ SetTimeout() [2/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetTimeout ( JobTimeout &&  value)
inline

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.

Definition at line 550 of file RegisterJobDefinitionRequest.h.

◆ SetType() [1/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetType ( const JobDefinitionType value)
inline

The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.

If the job is run on Fargate resources, then multinode isn't supported.

Definition at line 124 of file RegisterJobDefinitionRequest.h.

◆ SetType() [2/2]

void Aws::Batch::Model::RegisterJobDefinitionRequest::SetType ( JobDefinitionType &&  value)
inline

The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.

If the job is run on Fargate resources, then multinode isn't supported.

Definition at line 134 of file RegisterJobDefinitionRequest.h.

◆ TagsHasBeenSet()

bool Aws::Batch::Model::RegisterJobDefinitionRequest::TagsHasBeenSet ( ) const
inline

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Definition at line 593 of file RegisterJobDefinitionRequest.h.

◆ TimeoutHasBeenSet()

bool Aws::Batch::Model::RegisterJobDefinitionRequest::TimeoutHasBeenSet ( ) const
inline

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.

Definition at line 526 of file RegisterJobDefinitionRequest.h.

◆ TypeHasBeenSet()

bool Aws::Batch::Model::RegisterJobDefinitionRequest::TypeHasBeenSet ( ) const
inline

The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.

If the job is run on Fargate resources, then multinode isn't supported.

Definition at line 114 of file RegisterJobDefinitionRequest.h.

◆ WithContainerProperties() [1/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithContainerProperties ( const ContainerProperties value)
inline

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

Definition at line 315 of file RegisterJobDefinitionRequest.h.

◆ WithContainerProperties() [2/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithContainerProperties ( ContainerProperties &&  value)
inline

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

Definition at line 326 of file RegisterJobDefinitionRequest.h.

◆ WithJobDefinitionName() [1/3]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithJobDefinitionName ( Aws::String &&  value)
inline

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 87 of file RegisterJobDefinitionRequest.h.

◆ WithJobDefinitionName() [2/3]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithJobDefinitionName ( const Aws::String value)
inline

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 81 of file RegisterJobDefinitionRequest.h.

◆ WithJobDefinitionName() [3/3]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithJobDefinitionName ( const char *  value)
inline

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 93 of file RegisterJobDefinitionRequest.h.

◆ WithNodeProperties() [1/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithNodeProperties ( const NodeProperties value)
inline

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

Definition at line 397 of file RegisterJobDefinitionRequest.h.

◆ WithNodeProperties() [2/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithNodeProperties ( NodeProperties &&  value)
inline

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

Definition at line 411 of file RegisterJobDefinitionRequest.h.

◆ WithParameters() [1/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 203 of file RegisterJobDefinitionRequest.h.

◆ WithParameters() [2/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 195 of file RegisterJobDefinitionRequest.h.

◆ WithPlatformCapabilities() [1/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithPlatformCapabilities ( Aws::Vector< PlatformCapability > &&  value)
inline

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

Definition at line 735 of file RegisterJobDefinitionRequest.h.

◆ WithPlatformCapabilities() [2/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithPlatformCapabilities ( const Aws::Vector< PlatformCapability > &  value)
inline

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

Definition at line 728 of file RegisterJobDefinitionRequest.h.

◆ WithPropagateTags()

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithPropagateTags ( bool  value)
inline

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

Definition at line 501 of file RegisterJobDefinitionRequest.h.

◆ WithRetryStrategy() [1/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithRetryStrategy ( const RetryStrategy value)
inline

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

Definition at line 452 of file RegisterJobDefinitionRequest.h.

◆ WithRetryStrategy() [2/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithRetryStrategy ( RetryStrategy &&  value)
inline

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

Definition at line 460 of file RegisterJobDefinitionRequest.h.

◆ WithTags() [1/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Definition at line 629 of file RegisterJobDefinitionRequest.h.

◆ WithTags() [2/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Definition at line 620 of file RegisterJobDefinitionRequest.h.

◆ WithTimeout() [1/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithTimeout ( const JobTimeout value)
inline

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.

Definition at line 562 of file RegisterJobDefinitionRequest.h.

◆ WithTimeout() [2/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithTimeout ( JobTimeout &&  value)
inline

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.

Definition at line 574 of file RegisterJobDefinitionRequest.h.

◆ WithType() [1/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithType ( const JobDefinitionType value)
inline

The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.

If the job is run on Fargate resources, then multinode isn't supported.

Definition at line 144 of file RegisterJobDefinitionRequest.h.

◆ WithType() [2/2]

RegisterJobDefinitionRequest& Aws::Batch::Model::RegisterJobDefinitionRequest::WithType ( JobDefinitionType &&  value)
inline

The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.

If the job is run on Fargate resources, then multinode isn't supported.

Definition at line 154 of file RegisterJobDefinitionRequest.h.


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