aws.batch.JobQueue
Provides a Batch Job Queue resource.
Example Usage
Basic Job Queue
using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var testQueue = new Aws.Batch.JobQueue("testQueue", new()
{
State = "ENABLED",
Priority = 1,
ComputeEnvironments = new[]
{
aws_batch_compute_environment.Test_environment_1.Arn,
aws_batch_compute_environment.Test_environment_2.Arn,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/batch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := batch.NewJobQueue(ctx, "testQueue", &batch.JobQueueArgs{
State: pulumi.String("ENABLED"),
Priority: pulumi.Int(1),
ComputeEnvironments: pulumi.StringArray{
aws_batch_compute_environment.Test_environment_1.Arn,
aws_batch_compute_environment.Test_environment_2.Arn,
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.batch.JobQueue;
import com.pulumi.aws.batch.JobQueueArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testQueue = new JobQueue("testQueue", JobQueueArgs.builder()
.state("ENABLED")
.priority(1)
.computeEnvironments(
aws_batch_compute_environment.test_environment_1().arn(),
aws_batch_compute_environment.test_environment_2().arn())
.build());
}
}
import pulumi
import pulumi_aws as aws
test_queue = aws.batch.JobQueue("testQueue",
state="ENABLED",
priority=1,
compute_environments=[
aws_batch_compute_environment["test_environment_1"]["arn"],
aws_batch_compute_environment["test_environment_2"]["arn"],
])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const testQueue = new aws.batch.JobQueue("testQueue", {
state: "ENABLED",
priority: 1,
computeEnvironments: [
aws_batch_compute_environment.test_environment_1.arn,
aws_batch_compute_environment.test_environment_2.arn,
],
});
resources:
testQueue:
type: aws:batch:JobQueue
properties:
state: ENABLED
priority: 1
computeEnvironments:
- ${aws_batch_compute_environment.test_environment_1.arn}
- ${aws_batch_compute_environment.test_environment_2.arn}
Job Queue with a fair share scheduling policy
using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleSchedulingPolicy = new Aws.Batch.SchedulingPolicy("exampleSchedulingPolicy", new()
{
FairSharePolicy = new Aws.Batch.Inputs.SchedulingPolicyFairSharePolicyArgs
{
ComputeReservation = 1,
ShareDecaySeconds = 3600,
ShareDistributions = new[]
{
new Aws.Batch.Inputs.SchedulingPolicyFairSharePolicyShareDistributionArgs
{
ShareIdentifier = "A1*",
WeightFactor = 0.1,
},
},
},
});
var exampleJobQueue = new Aws.Batch.JobQueue("exampleJobQueue", new()
{
SchedulingPolicyArn = exampleSchedulingPolicy.Arn,
State = "ENABLED",
Priority = 1,
ComputeEnvironments = new[]
{
aws_batch_compute_environment.Test_environment_1.Arn,
aws_batch_compute_environment.Test_environment_2.Arn,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/batch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleSchedulingPolicy, err := batch.NewSchedulingPolicy(ctx, "exampleSchedulingPolicy", &batch.SchedulingPolicyArgs{
FairSharePolicy: &batch.SchedulingPolicyFairSharePolicyArgs{
ComputeReservation: pulumi.Int(1),
ShareDecaySeconds: pulumi.Int(3600),
ShareDistributions: batch.SchedulingPolicyFairSharePolicyShareDistributionArray{
&batch.SchedulingPolicyFairSharePolicyShareDistributionArgs{
ShareIdentifier: pulumi.String("A1*"),
WeightFactor: pulumi.Float64(0.1),
},
},
},
})
if err != nil {
return err
}
_, err = batch.NewJobQueue(ctx, "exampleJobQueue", &batch.JobQueueArgs{
SchedulingPolicyArn: exampleSchedulingPolicy.Arn,
State: pulumi.String("ENABLED"),
Priority: pulumi.Int(1),
ComputeEnvironments: pulumi.StringArray{
aws_batch_compute_environment.Test_environment_1.Arn,
aws_batch_compute_environment.Test_environment_2.Arn,
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.batch.SchedulingPolicy;
import com.pulumi.aws.batch.SchedulingPolicyArgs;
import com.pulumi.aws.batch.inputs.SchedulingPolicyFairSharePolicyArgs;
import com.pulumi.aws.batch.JobQueue;
import com.pulumi.aws.batch.JobQueueArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleSchedulingPolicy = new SchedulingPolicy("exampleSchedulingPolicy", SchedulingPolicyArgs.builder()
.fairSharePolicy(SchedulingPolicyFairSharePolicyArgs.builder()
.computeReservation(1)
.shareDecaySeconds(3600)
.shareDistributions(SchedulingPolicyFairSharePolicyShareDistributionArgs.builder()
.shareIdentifier("A1*")
.weightFactor(0.1)
.build())
.build())
.build());
var exampleJobQueue = new JobQueue("exampleJobQueue", JobQueueArgs.builder()
.schedulingPolicyArn(exampleSchedulingPolicy.arn())
.state("ENABLED")
.priority(1)
.computeEnvironments(
aws_batch_compute_environment.test_environment_1().arn(),
aws_batch_compute_environment.test_environment_2().arn())
.build());
}
}
import pulumi
import pulumi_aws as aws
example_scheduling_policy = aws.batch.SchedulingPolicy("exampleSchedulingPolicy", fair_share_policy=aws.batch.SchedulingPolicyFairSharePolicyArgs(
compute_reservation=1,
share_decay_seconds=3600,
share_distributions=[aws.batch.SchedulingPolicyFairSharePolicyShareDistributionArgs(
share_identifier="A1*",
weight_factor=0.1,
)],
))
example_job_queue = aws.batch.JobQueue("exampleJobQueue",
scheduling_policy_arn=example_scheduling_policy.arn,
state="ENABLED",
priority=1,
compute_environments=[
aws_batch_compute_environment["test_environment_1"]["arn"],
aws_batch_compute_environment["test_environment_2"]["arn"],
])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleSchedulingPolicy = new aws.batch.SchedulingPolicy("exampleSchedulingPolicy", {fairSharePolicy: {
computeReservation: 1,
shareDecaySeconds: 3600,
shareDistributions: [{
shareIdentifier: "A1*",
weightFactor: 0.1,
}],
}});
const exampleJobQueue = new aws.batch.JobQueue("exampleJobQueue", {
schedulingPolicyArn: exampleSchedulingPolicy.arn,
state: "ENABLED",
priority: 1,
computeEnvironments: [
aws_batch_compute_environment.test_environment_1.arn,
aws_batch_compute_environment.test_environment_2.arn,
],
});
resources:
exampleSchedulingPolicy:
type: aws:batch:SchedulingPolicy
properties:
fairSharePolicy:
computeReservation: 1
shareDecaySeconds: 3600
shareDistributions:
- shareIdentifier: A1*
weightFactor: 0.1
exampleJobQueue:
type: aws:batch:JobQueue
properties:
schedulingPolicyArn: ${exampleSchedulingPolicy.arn}
state: ENABLED
priority: 1
computeEnvironments:
- ${aws_batch_compute_environment.test_environment_1.arn}
- ${aws_batch_compute_environment.test_environment_2.arn}
Create JobQueue Resource
new JobQueue(name: string, args: JobQueueArgs, opts?: CustomResourceOptions);
@overload
def JobQueue(resource_name: str,
opts: Optional[ResourceOptions] = None,
compute_environments: Optional[Sequence[str]] = None,
name: Optional[str] = None,
priority: Optional[int] = None,
scheduling_policy_arn: Optional[str] = None,
state: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
@overload
def JobQueue(resource_name: str,
args: JobQueueArgs,
opts: Optional[ResourceOptions] = 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:batch:JobQueue
properties: # The arguments to resource properties.
options: # 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.
- 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:
- Compute
Environments List<string> Specifies the set of compute environments mapped to a job queue and their order. The position of the compute environments in the list will dictate the order.
- Priority int
The priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.
- State string
The state of the job queue. Must be one of:
ENABLED
orDISABLED
- Name string
Specifies the name of the job queue.
- Scheduling
Policy stringArn The 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.
- Dictionary<string, string>
Key-value map of resource tags. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- Compute
Environments []string Specifies the set of compute environments mapped to a job queue and their order. The position of the compute environments in the list will dictate the order.
- Priority int
The priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.
- State string
The state of the job queue. Must be one of:
ENABLED
orDISABLED
- Name string
Specifies the name of the job queue.
- Scheduling
Policy stringArn The 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.
- map[string]string
Key-value map of resource tags. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- compute
Environments List<String> Specifies the set of compute environments mapped to a job queue and their order. The position of the compute environments in the list will dictate the order.
- priority Integer
The priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.
- state String
The state of the job queue. Must be one of:
ENABLED
orDISABLED
- name String
Specifies the name of the job queue.
- scheduling
Policy StringArn The 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.
- Map<String,String>
Key-value map of resource tags. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- compute
Environments string[] Specifies the set of compute environments mapped to a job queue and their order. The position of the compute environments in the list will dictate the order.
- priority number
The priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.
- state string
The state of the job queue. Must be one of:
ENABLED
orDISABLED
- name string
Specifies the name of the job queue.
- scheduling
Policy stringArn The 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.
- {[key: string]: string}
Key-value map of resource tags. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- compute_
environments Sequence[str] Specifies the set of compute environments mapped to a job queue and their order. The position of the compute environments in the list will dictate the order.
- priority int
The priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.
- state str
The state of the job queue. Must be one of:
ENABLED
orDISABLED
- name str
Specifies the name of the job queue.
- scheduling_
policy_ strarn The 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.
- Mapping[str, str]
Key-value map of resource tags. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- compute
Environments List<String> Specifies the set of compute environments mapped to a job queue and their order. The position of the compute environments in the list will dictate the order.
- priority Number
The priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.
- state String
The state of the job queue. Must be one of:
ENABLED
orDISABLED
- name String
Specifies the name of the job queue.
- scheduling
Policy StringArn The 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.
- Map<String>
Key-value map of resource tags. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the JobQueue resource produces the following output properties:
Look up Existing JobQueue Resource
Get an existing JobQueue resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: JobQueueState, opts?: CustomResourceOptions): JobQueue
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
compute_environments: Optional[Sequence[str]] = None,
name: Optional[str] = None,
priority: Optional[int] = None,
scheduling_policy_arn: Optional[str] = None,
state: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> JobQueue
func GetJobQueue(ctx *Context, name string, id IDInput, state *JobQueueState, opts ...ResourceOption) (*JobQueue, error)
public static JobQueue Get(string name, Input<string> id, JobQueueState? state, CustomResourceOptions? opts = null)
public static JobQueue get(String name, Output<String> id, JobQueueState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
The Amazon Resource Name of the job queue.
- Compute
Environments List<string> Specifies the set of compute environments mapped to a job queue and their order. The position of the compute environments in the list will dictate the order.
- Name string
Specifies the name of the job queue.
- Priority int
The priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.
- Scheduling
Policy stringArn The 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.
- State string
The state of the job queue. Must be one of:
ENABLED
orDISABLED
- Dictionary<string, string>
Key-value map of resource tags. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
The Amazon Resource Name of the job queue.
- Compute
Environments []string Specifies the set of compute environments mapped to a job queue and their order. The position of the compute environments in the list will dictate the order.
- Name string
Specifies the name of the job queue.
- Priority int
The priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.
- Scheduling
Policy stringArn The 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.
- State string
The state of the job queue. Must be one of:
ENABLED
orDISABLED
- map[string]string
Key-value map of resource tags. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
The Amazon Resource Name of the job queue.
- compute
Environments List<String> Specifies the set of compute environments mapped to a job queue and their order. The position of the compute environments in the list will dictate the order.
- name String
Specifies the name of the job queue.
- priority Integer
The priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.
- scheduling
Policy StringArn The 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.
- state String
The state of the job queue. Must be one of:
ENABLED
orDISABLED
- Map<String,String>
Key-value map of resource tags. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
The Amazon Resource Name of the job queue.
- compute
Environments string[] Specifies the set of compute environments mapped to a job queue and their order. The position of the compute environments in the list will dictate the order.
- name string
Specifies the name of the job queue.
- priority number
The priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.
- scheduling
Policy stringArn The 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.
- state string
The state of the job queue. Must be one of:
ENABLED
orDISABLED
- {[key: string]: string}
Key-value map of resource tags. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
The Amazon Resource Name of the job queue.
- compute_
environments Sequence[str] Specifies the set of compute environments mapped to a job queue and their order. The position of the compute environments in the list will dictate the order.
- name str
Specifies the name of the job queue.
- priority int
The priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.
- scheduling_
policy_ strarn The 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.
- state str
The state of the job queue. Must be one of:
ENABLED
orDISABLED
- Mapping[str, str]
Key-value map of resource tags. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
The Amazon Resource Name of the job queue.
- compute
Environments List<String> Specifies the set of compute environments mapped to a job queue and their order. The position of the compute environments in the list will dictate the order.
- name String
Specifies the name of the job queue.
- priority Number
The priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.
- scheduling
Policy StringArn The 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.
- state String
The state of the job queue. Must be one of:
ENABLED
orDISABLED
- Map<String>
Key-value map of resource tags. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Import
Batch Job Queue can be imported using the arn
, e.g.,
$ pulumi import aws:batch/jobQueue:JobQueue test_queue arn:aws:batch:us-east-1:123456789012:job-queue/sample
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.