AWS Native v0.126.0, Sep 30 24

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.batch.JobQueue

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

Create JobQueue Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new JobQueue(name: string, args: JobQueueArgs, opts?: CustomResourceOptions);

@overload
def JobQueue(resource_name: str,
             args: JobQueueArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def JobQueue(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             compute_environment_order: Optional[Sequence[JobQueueComputeEnvironmentOrderArgs]] = None,
             priority: Optional[int] = None,
             job_queue_name: Optional[str] = None,
             job_state_time_limit_actions: Optional[Sequence[JobQueueJobStateTimeLimitActionArgs]] = None,
             scheduling_policy_arn: Optional[str] = None,
             state: Optional[JobQueueState] = None,
             tags: Optional[Mapping[str, str]] = None)

func NewJobQueue(ctx *Context, name string, args JobQueueArgs, opts ...ResourceOption) (*JobQueue, error)

public JobQueue(string name, JobQueueArgs args, CustomResourceOptions? opts = null)

public JobQueue(String name, JobQueueArgs args)
public JobQueue(String name, JobQueueArgs args, CustomResourceOptions options)

type: aws-native:batch:JobQueue
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args JobQueueArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args JobQueueArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args JobQueueArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args JobQueueArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args JobQueueArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

JobQueue Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The JobQueue resource accepts the following input properties:

ComputeEnvironmentOrder List<Pulumi.AwsNative.Batch.Inputs.JobQueueComputeEnvironmentOrder>: 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.
All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
Priority int: 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.
JobQueueName string: 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 (_).
JobStateTimeLimitActions List<Pulumi.AwsNative.Batch.Inputs.JobQueueJobStateTimeLimitAction>: The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after maxTimeSeconds has passed.
SchedulingPolicyArn string: The Amazon Resource Name (ARN) of the scheduling policy. The format is aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name* . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy .
State Pulumi.AwsNative.Batch.JobQueueState: 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.
Tags Dictionary<string, string>: A key-value pair to associate with a resource.

ComputeEnvironmentOrder []JobQueueComputeEnvironmentOrderArgs: 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.
All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
Priority int: 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.
JobQueueName string: 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 (_).
JobStateTimeLimitActions []JobQueueJobStateTimeLimitActionArgs: The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after maxTimeSeconds has passed.
SchedulingPolicyArn string: The Amazon Resource Name (ARN) of the scheduling policy. The format is aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name* . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy .
State JobQueueStateEnum: 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.
Tags map[string]string: A key-value pair to associate with a resource.

computeEnvironmentOrder List<JobQueueComputeEnvironmentOrder>: 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.
All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
priority Integer: 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.
jobQueueName String: 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 (_).
jobStateTimeLimitActions List<JobQueueJobStateTimeLimitAction>: The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after maxTimeSeconds has passed.
schedulingPolicyArn String: The Amazon Resource Name (ARN) of the scheduling policy. The format is aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name* . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy .
state JobQueueState: 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.
tags Map<String,String>: A key-value pair to associate with a resource.

computeEnvironmentOrder JobQueueComputeEnvironmentOrder[]: 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.
All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
priority number: 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.
jobQueueName string: 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 (_).
jobStateTimeLimitActions JobQueueJobStateTimeLimitAction[]: The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after maxTimeSeconds has passed.
schedulingPolicyArn string: The Amazon Resource Name (ARN) of the scheduling policy. The format is aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name* . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy .
state JobQueueState: 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.
tags {[key: string]: string}: A key-value pair to associate with a resource.

compute_environment_order Sequence[JobQueueComputeEnvironmentOrderArgs]: 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.
All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
priority int: 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.
job_queue_name str: 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 (_).
job_state_time_limit_actions Sequence[JobQueueJobStateTimeLimitActionArgs]: The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after maxTimeSeconds has passed.
scheduling_policy_arn str: The Amazon Resource Name (ARN) of the scheduling policy. The format is aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name* . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy .
state JobQueueState: 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.
tags Mapping[str, str]: A key-value pair to associate with a resource.

computeEnvironmentOrder List<Property Map>: 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.
All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
priority Number: 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.
jobQueueName String: 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 (_).
jobStateTimeLimitActions List<Property Map>: The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after maxTimeSeconds has passed.
schedulingPolicyArn String: The Amazon Resource Name (ARN) of the scheduling policy. The format is aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name* . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy .
state "DISABLED" | "ENABLED": 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.
tags Map<String>: A key-value pair to associate with a resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the JobQueue resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
JobQueueArn string: Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .

Id string: The provider-assigned unique ID for this managed resource.
JobQueueArn string: Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .

id String: The provider-assigned unique ID for this managed resource.
jobQueueArn String: Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .

id string: The provider-assigned unique ID for this managed resource.
jobQueueArn string: Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .

id str: The provider-assigned unique ID for this managed resource.
job_queue_arn str: Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .

id String: The provider-assigned unique ID for this managed resource.
jobQueueArn String: Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .

Supporting Types

JobQueueComputeEnvironmentOrder, JobQueueComputeEnvironmentOrderArgs

ComputeEnvironment string: The Amazon Resource Name (ARN) of the compute environment.
Order int: The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

ComputeEnvironment string: The Amazon Resource Name (ARN) of the compute environment.
Order int: The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

computeEnvironment String: The Amazon Resource Name (ARN) of the compute environment.
order Integer: The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

computeEnvironment string: The Amazon Resource Name (ARN) of the compute environment.
order number: The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

compute_environment str: The Amazon Resource Name (ARN) of the compute environment.
order int: The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

computeEnvironment String: The Amazon Resource Name (ARN) of the compute environment.
order Number: The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

JobQueueJobStateTimeLimitAction, JobQueueJobStateTimeLimitActionArgs

Action Pulumi.AwsNative.Batch.JobQueueJobStateTimeLimitActionAction: The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL , which will cancel the job.
MaxTimeSeconds int: The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
Reason string: The reason to log for the action being taken.
State Pulumi.AwsNative.Batch.JobQueueJobStateTimeLimitActionState: The state of the job needed to trigger the action. The only supported value is RUNNABLE .

Action JobQueueJobStateTimeLimitActionAction: The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL , which will cancel the job.
MaxTimeSeconds int: The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
Reason string: The reason to log for the action being taken.
State JobQueueJobStateTimeLimitActionState: The state of the job needed to trigger the action. The only supported value is RUNNABLE .

action JobQueueJobStateTimeLimitActionAction: The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL , which will cancel the job.
maxTimeSeconds Integer: The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
reason String: The reason to log for the action being taken.
state JobQueueJobStateTimeLimitActionState: The state of the job needed to trigger the action. The only supported value is RUNNABLE .

action JobQueueJobStateTimeLimitActionAction: The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL , which will cancel the job.
maxTimeSeconds number: The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
reason string: The reason to log for the action being taken.
state JobQueueJobStateTimeLimitActionState: The state of the job needed to trigger the action. The only supported value is RUNNABLE .

action JobQueueJobStateTimeLimitActionAction: The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL , which will cancel the job.
max_time_seconds int: The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
reason str: The reason to log for the action being taken.
state JobQueueJobStateTimeLimitActionState: The state of the job needed to trigger the action. The only supported value is RUNNABLE .

action "CANCEL": The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL , which will cancel the job.
maxTimeSeconds Number: The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
reason String: The reason to log for the action being taken.
state "RUNNABLE": The state of the job needed to trigger the action. The only supported value is RUNNABLE .

JobQueueJobStateTimeLimitActionAction, JobQueueJobStateTimeLimitActionActionArgs

Cancel: CANCEL

JobQueueJobStateTimeLimitActionActionCancel: CANCEL

Cancel: CANCEL

Cancel: CANCEL

CANCEL: CANCEL

"CANCEL": CANCEL

JobQueueJobStateTimeLimitActionState, JobQueueJobStateTimeLimitActionStateArgs

Runnable: RUNNABLE

JobQueueJobStateTimeLimitActionStateRunnable: RUNNABLE

Runnable: RUNNABLE

Runnable: RUNNABLE

RUNNABLE: RUNNABLE

"RUNNABLE": RUNNABLE

JobQueueState, JobQueueStateArgs

Disabled: DISABLED
Enabled: ENABLED

JobQueueStateDisabled: DISABLED
JobQueueStateEnabled: ENABLED

Disabled: DISABLED
Enabled: ENABLED

Disabled: DISABLED
Enabled: ENABLED

DISABLED: DISABLED
ENABLED: ENABLED

"DISABLED": DISABLED
"ENABLED": ENABLED

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.batch.JobQueue

On this page

On this page

Create JobQueue Resource

Constructor syntax

Parameters

JobQueue Resource Properties

Inputs

Outputs

Supporting Types

JobQueueComputeEnvironmentOrder, JobQueueComputeEnvironmentOrderArgs

JobQueueJobStateTimeLimitAction, JobQueueJobStateTimeLimitActionArgs

JobQueueJobStateTimeLimitActionAction, JobQueueJobStateTimeLimitActionActionArgs

JobQueueJobStateTimeLimitActionState, JobQueueJobStateTimeLimitActionStateArgs

JobQueueState, JobQueueStateArgs

Package Details

On this page

On this page