/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace Batch { namespace Model { /** *

Contains the parameters for RegisterJobDefinition.

See * Also:

AWS * API Reference

*/ class RegisterJobDefinitionRequest : public BatchRequest { public: AWS_BATCH_API RegisterJobDefinitionRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "RegisterJobDefinition"; } AWS_BATCH_API Aws::String SerializePayload() const override; /** *

The name of the job definition to register. It can be up to 128 letters long. * It can contain uppercase and lowercase letters, numbers, hyphens (-), and * underscores (_).

*/ inline const Aws::String& GetJobDefinitionName() const{ return m_jobDefinitionName; } /** *

The name of the job definition to register. It can be up to 128 letters long. * It can contain uppercase and lowercase letters, numbers, hyphens (-), and * underscores (_).

*/ inline bool JobDefinitionNameHasBeenSet() const { return m_jobDefinitionNameHasBeenSet; } /** *

The name of the job definition to register. It can be up to 128 letters long. * It can contain uppercase and lowercase letters, numbers, hyphens (-), and * underscores (_).

*/ inline void SetJobDefinitionName(const Aws::String& value) { m_jobDefinitionNameHasBeenSet = true; m_jobDefinitionName = value; } /** *

The name of the job definition to register. It can be up to 128 letters long. * It can contain uppercase and lowercase letters, numbers, hyphens (-), and * underscores (_).

*/ inline void SetJobDefinitionName(Aws::String&& value) { m_jobDefinitionNameHasBeenSet = true; m_jobDefinitionName = std::move(value); } /** *

The name of the job definition to register. It can be up to 128 letters long. * It can contain uppercase and lowercase letters, numbers, hyphens (-), and * underscores (_).

*/ inline void SetJobDefinitionName(const char* value) { m_jobDefinitionNameHasBeenSet = true; m_jobDefinitionName.assign(value); } /** *

The name of the job definition to register. It can be up to 128 letters long. * It can contain uppercase and lowercase letters, numbers, hyphens (-), and * underscores (_).

*/ inline RegisterJobDefinitionRequest& WithJobDefinitionName(const Aws::String& value) { SetJobDefinitionName(value); return *this;} /** *

The name of the job definition to register. It can be up to 128 letters long. * It can contain uppercase and lowercase letters, numbers, hyphens (-), and * underscores (_).

*/ inline RegisterJobDefinitionRequest& WithJobDefinitionName(Aws::String&& value) { SetJobDefinitionName(std::move(value)); return *this;} /** *

The name of the job definition to register. It can be up to 128 letters long. * It can contain uppercase and lowercase letters, numbers, hyphens (-), and * underscores (_).

*/ inline RegisterJobDefinitionRequest& WithJobDefinitionName(const char* value) { SetJobDefinitionName(value); return *this;} /** *

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

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

*/ inline const JobDefinitionType& GetType() const{ return m_type; } /** *

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

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

*/ inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; } /** *

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

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

*/ inline void SetType(const JobDefinitionType& value) { m_typeHasBeenSet = true; m_type = value; } /** *

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

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

*/ inline void SetType(JobDefinitionType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); } /** *

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

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

*/ inline RegisterJobDefinitionRequest& WithType(const JobDefinitionType& value) { SetType(value); return *this;} /** *

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

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

*/ inline RegisterJobDefinitionRequest& WithType(JobDefinitionType&& value) { SetType(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Map& GetParameters() const{ return m_parameters; } /** *

*/ inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; } /** *

*/ inline void SetParameters(const Aws::Map& value) { m_parametersHasBeenSet = true; m_parameters = value; } /** *

*/ inline void SetParameters(Aws::Map&& value) { m_parametersHasBeenSet = true; m_parameters = std::move(value); } /** *

*/ inline RegisterJobDefinitionRequest& WithParameters(const Aws::Map& value) { SetParameters(value); return *this;} /** *

*/ inline RegisterJobDefinitionRequest& WithParameters(Aws::Map&& value) { SetParameters(std::move(value)); return *this;} /** *

*/ inline RegisterJobDefinitionRequest& AddParameters(const Aws::String& key, const Aws::String& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; } /** *

*/ inline RegisterJobDefinitionRequest& AddParameters(Aws::String&& key, const Aws::String& value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), value); return *this; } /** *

*/ inline RegisterJobDefinitionRequest& AddParameters(const Aws::String& key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, std::move(value)); return *this; } /** *

*/ inline RegisterJobDefinitionRequest& AddParameters(Aws::String&& key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), std::move(value)); return *this; } /** *

*/ inline RegisterJobDefinitionRequest& AddParameters(const char* key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, std::move(value)); return *this; } /** *

*/ inline RegisterJobDefinitionRequest& AddParameters(Aws::String&& key, const char* value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), value); return *this; } /** *

*/ inline RegisterJobDefinitionRequest& AddParameters(const char* key, const char* value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; } /** *

The scheduling priority for jobs that are submitted with this job definition. * This only affects jobs in job queues with a fair share policy. Jobs with a * higher scheduling priority are scheduled before jobs with a lower scheduling * priority.

The minimum supported value is 0 and the maximum supported * value is 9999.

*/ inline int GetSchedulingPriority() const{ return m_schedulingPriority; } /** *

The minimum supported value is 0 and the maximum supported * value is 9999.

*/ inline bool SchedulingPriorityHasBeenSet() const { return m_schedulingPriorityHasBeenSet; } /** *

The minimum supported value is 0 and the maximum supported * value is 9999.

*/ inline void SetSchedulingPriority(int value) { m_schedulingPriorityHasBeenSet = true; m_schedulingPriority = value; } /** *

The minimum supported value is 0 and the maximum supported * value is 9999.

*/ inline RegisterJobDefinitionRequest& WithSchedulingPriority(int value) { SetSchedulingPriority(value); return *this;} /** *

An object with various properties specific to Amazon ECS based single-node * container-based jobs. If the job definition's type parameter is * container, then you must specify either * containerProperties or nodeProperties. This must not * be specified for Amazon EKS based job definitions.

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

*/ inline const ContainerProperties& GetContainerProperties() const{ return m_containerProperties; } /** *

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

*/ inline bool ContainerPropertiesHasBeenSet() const { return m_containerPropertiesHasBeenSet; } /** *

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

*/ inline void SetContainerProperties(const ContainerProperties& value) { m_containerPropertiesHasBeenSet = true; m_containerProperties = value; } /** *

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

*/ inline void SetContainerProperties(ContainerProperties&& value) { m_containerPropertiesHasBeenSet = true; m_containerProperties = std::move(value); } /** *

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

*/ inline RegisterJobDefinitionRequest& WithContainerProperties(const ContainerProperties& value) { SetContainerProperties(value); return *this;} /** *

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

*/ inline RegisterJobDefinitionRequest& WithContainerProperties(ContainerProperties&& value) { SetContainerProperties(std::move(value)); return *this;} /** *

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

If the job runs on Amazon EKS resources, then you must not * specify nodeProperties.

*/ inline const NodeProperties& GetNodeProperties() const{ return m_nodeProperties; } /** *

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

If the job runs on Amazon EKS resources, then you must not * specify nodeProperties.

*/ inline bool NodePropertiesHasBeenSet() const { return m_nodePropertiesHasBeenSet; } /** *

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

If the job runs on Amazon EKS resources, then you must not * specify nodeProperties.

*/ inline void SetNodeProperties(const NodeProperties& value) { m_nodePropertiesHasBeenSet = true; m_nodeProperties = value; } /** *

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

If the job runs on Amazon EKS resources, then you must not * specify nodeProperties.

*/ inline void SetNodeProperties(NodeProperties&& value) { m_nodePropertiesHasBeenSet = true; m_nodeProperties = std::move(value); } /** *

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

If the job runs on Amazon EKS resources, then you must not * specify nodeProperties.

*/ inline RegisterJobDefinitionRequest& WithNodeProperties(const NodeProperties& value) { SetNodeProperties(value); return *this;} /** *

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

If the job runs on Amazon EKS resources, then you must not * specify nodeProperties.

*/ inline RegisterJobDefinitionRequest& WithNodeProperties(NodeProperties&& value) { SetNodeProperties(std::move(value)); return *this;} /** *

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.

*/ inline const RetryStrategy& GetRetryStrategy() const{ return m_retryStrategy; } /** *

*/ inline bool RetryStrategyHasBeenSet() const { return m_retryStrategyHasBeenSet; } /** *

*/ inline void SetRetryStrategy(const RetryStrategy& value) { m_retryStrategyHasBeenSet = true; m_retryStrategy = value; } /** *

*/ inline void SetRetryStrategy(RetryStrategy&& value) { m_retryStrategyHasBeenSet = true; m_retryStrategy = std::move(value); } /** *

*/ inline RegisterJobDefinitionRequest& WithRetryStrategy(const RetryStrategy& value) { SetRetryStrategy(value); return *this;} /** *

*/ inline RegisterJobDefinitionRequest& WithRetryStrategy(RetryStrategy&& value) { SetRetryStrategy(std::move(value)); return *this;} /** *

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.

If the job runs * on Amazon EKS resources, then you must not specify * propagateTags.

*/ inline bool GetPropagateTags() const{ return m_propagateTags; } /** *

If the job runs * on Amazon EKS resources, then you must not specify * propagateTags.

*/ inline bool PropagateTagsHasBeenSet() const { return m_propagateTagsHasBeenSet; } /** *

If the job runs * on Amazon EKS resources, then you must not specify * propagateTags.

*/ inline void SetPropagateTags(bool value) { m_propagateTagsHasBeenSet = true; m_propagateTags = value; } /** *

If the job runs * on Amazon EKS resources, then you must not specify * propagateTags.

*/ inline RegisterJobDefinitionRequest& WithPropagateTags(bool value) { SetPropagateTags(value); return *this;} /** *

The timeout configuration for jobs that are submitted with this job * definition, after which 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 Batch User Guide.

*/ inline const JobTimeout& GetTimeout() const{ return m_timeout; } /** *

*/ inline bool TimeoutHasBeenSet() const { return m_timeoutHasBeenSet; } /** *

*/ inline void SetTimeout(const JobTimeout& value) { m_timeoutHasBeenSet = true; m_timeout = value; } /** *

*/ inline void SetTimeout(JobTimeout&& value) { m_timeoutHasBeenSet = true; m_timeout = std::move(value); } /** *

*/ inline RegisterJobDefinitionRequest& WithTimeout(const JobTimeout& value) { SetTimeout(value); return *this;} /** *

*/ inline RegisterJobDefinitionRequest& WithTimeout(JobTimeout&& value) { SetTimeout(std::move(value)); return *this;} /** *

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 * Amazon Web Services Resources in Batch User Guide.

*/ inline const Aws::Map& GetTags() const{ return m_tags; } /** *

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

*/ inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

*/ inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

*/ inline RegisterJobDefinitionRequest& WithTags(const Aws::Map& value) { SetTags(value); return *this;} /** *

*/ inline RegisterJobDefinitionRequest& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} /** *

*/ inline RegisterJobDefinitionRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

*/ inline RegisterJobDefinitionRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

*/ inline RegisterJobDefinitionRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

*/ inline RegisterJobDefinitionRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } /** *

*/ inline RegisterJobDefinitionRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

*/ inline RegisterJobDefinitionRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

*/ inline RegisterJobDefinitionRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

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.