/** * 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 namespace Aws { namespace Batch { namespace Model { /** *

Contains the parameters for CreateJobQueue.

See * Also:

AWS * API Reference

*/ class CreateJobQueueRequest : public BatchRequest { public: AWS_BATCH_API CreateJobQueueRequest(); // 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 "CreateJobQueue"; } AWS_BATCH_API Aws::String SerializePayload() const override; /** *

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

*/ inline const Aws::String& GetJobQueueName() const{ return m_jobQueueName; } /** *

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

*/ inline bool JobQueueNameHasBeenSet() const { return m_jobQueueNameHasBeenSet; } /** *

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

*/ inline void SetJobQueueName(const Aws::String& value) { m_jobQueueNameHasBeenSet = true; m_jobQueueName = value; } /** *

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

*/ inline void SetJobQueueName(Aws::String&& value) { m_jobQueueNameHasBeenSet = true; m_jobQueueName = std::move(value); } /** *

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

*/ inline void SetJobQueueName(const char* value) { m_jobQueueNameHasBeenSet = true; m_jobQueueName.assign(value); } /** *

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

*/ inline CreateJobQueueRequest& WithJobQueueName(const Aws::String& value) { SetJobQueueName(value); return *this;} /** *

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

*/ inline CreateJobQueueRequest& WithJobQueueName(Aws::String&& value) { SetJobQueueName(std::move(value)); return *this;} /** *

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

*/ inline CreateJobQueueRequest& WithJobQueueName(const char* value) { SetJobQueueName(value); return *this;} /** *

The state of the job queue. If the job queue state is ENABLED, * it is able to accept jobs. If the job queue state is DISABLED, new * jobs can't be added to the queue, but jobs already in the queue can finish.

*/ inline const JQState& GetState() const{ return m_state; } /** *

*/ inline bool StateHasBeenSet() const { return m_stateHasBeenSet; } /** *

*/ inline void SetState(const JQState& value) { m_stateHasBeenSet = true; m_state = value; } /** *

*/ inline void SetState(JQState&& value) { m_stateHasBeenSet = true; m_state = std::move(value); } /** *

*/ inline CreateJobQueueRequest& WithState(const JQState& value) { SetState(value); return *this;} /** *

*/ inline CreateJobQueueRequest& WithState(JQState&& value) { SetState(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the fair share scheduling policy. If this * parameter is specified, the job queue uses a fair share scheduling policy. If * this parameter isn't specified, the job queue uses a first in, first out (FIFO) * scheduling policy. After a job queue is created, you can replace but can't * remove the fair share scheduling policy. The format is * aws:Partition:batch:Region:Account:scheduling-policy/Name *. An example is * aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

*/ inline const Aws::String& GetSchedulingPolicyArn() const{ return m_schedulingPolicyArn; } /** *

*/ inline bool SchedulingPolicyArnHasBeenSet() const { return m_schedulingPolicyArnHasBeenSet; } /** *

*/ inline void SetSchedulingPolicyArn(const Aws::String& value) { m_schedulingPolicyArnHasBeenSet = true; m_schedulingPolicyArn = value; } /** *

*/ inline void SetSchedulingPolicyArn(Aws::String&& value) { m_schedulingPolicyArnHasBeenSet = true; m_schedulingPolicyArn = std::move(value); } /** *

*/ inline void SetSchedulingPolicyArn(const char* value) { m_schedulingPolicyArnHasBeenSet = true; m_schedulingPolicyArn.assign(value); } /** *

*/ inline CreateJobQueueRequest& WithSchedulingPolicyArn(const Aws::String& value) { SetSchedulingPolicyArn(value); return *this;} /** *

*/ inline CreateJobQueueRequest& WithSchedulingPolicyArn(Aws::String&& value) { SetSchedulingPolicyArn(std::move(value)); return *this;} /** *

*/ inline CreateJobQueueRequest& WithSchedulingPolicyArn(const char* value) { SetSchedulingPolicyArn(value); return *this;} /** *

The priority of the job queue. Job queues with a higher priority (or a higher * integer value for the priority parameter) are evaluated first when * associated with the same compute environment. Priority is determined in * descending order. For example, a job queue with a priority value of * 10 is given scheduling preference over a job queue with a priority * value of 1. All of the compute environments must be either EC2 * (EC2 or SPOT) or Fargate (FARGATE or * FARGATE_SPOT); EC2 and Fargate compute environments can't be * mixed.

*/ inline int GetPriority() const{ return m_priority; } /** *

*/ inline bool PriorityHasBeenSet() const { return m_priorityHasBeenSet; } /** *

*/ inline void SetPriority(int value) { m_priorityHasBeenSet = true; m_priority = value; } /** *

*/ inline CreateJobQueueRequest& WithPriority(int value) { SetPriority(value); return *this;} /** *

The set of compute environments mapped to a job queue and their order * relative to each other. The job scheduler uses this parameter to determine which * compute environment runs a specific job. Compute environments must be in the * VALID state before you can associate them with a job queue. You can * associate up to three compute environments with a job queue. All of the compute * environments must be either EC2 (EC2 or SPOT) or * Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate * compute environments can't be mixed.