Package software.amazon.awscdk.services.batch

Class CfnJobQueue

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.batch.CfnJobQueue
All Implemented Interfaces:
IInspectable, IJobQueueRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:09:59.604Z") @Stability(Stable) public class CfnJobQueue extends CfnResource implements IInspectable, IJobQueueRef, ITaggable
The AWS::Batch::JobQueue resource specifies the parameters for an AWS Batch job queue definition.

For more information, see Job Queues in the ** .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.batch.*;
 CfnJobQueue cfnJobQueue = CfnJobQueue.Builder.create(this, "MyCfnJobQueue")
         .priority(123)
         // the properties below are optional
         .computeEnvironmentOrder(List.of(ComputeEnvironmentOrderProperty.builder()
                 .computeEnvironment("computeEnvironment")
                 .order(123)
                 .build()))
         .jobQueueName("jobQueueName")
         .jobQueueType("jobQueueType")
         .jobStateTimeLimitActions(List.of(JobStateTimeLimitActionProperty.builder()
                 .action("action")
                 .maxTimeSeconds(123)
                 .reason("reason")
                 .state("state")
                 .build()))
         .schedulingPolicyArn("schedulingPolicyArn")
         .serviceEnvironmentOrder(List.of(ServiceEnvironmentOrderProperty.builder()
                 .order(123)
                 .serviceEnvironment("serviceEnvironment")
                 .build()))
         .state("state")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnJobQueue

      protected CfnJobQueue(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnJobQueue

      protected CfnJobQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnJobQueue

      @Stability(Stable) public CfnJobQueue(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnJobQueueProps props)
      Create a new AWS::Batch::JobQueue.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrJobQueueArn

      @Stability(Stable) @NotNull public String getAttrJobQueueArn()
      Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getJobQueueRef

      @Stability(Stable) @NotNull public JobQueueReference getJobQueueRef()
      A reference to a JobQueue resource.
      Specified by:
      getJobQueueRef in interface IJobQueueRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getPriority

      @Stability(Stable) @NotNull public Number getPriority()
      The priority of the job queue.

    • setPriority

      @Stability(Stable) public void setPriority(@NotNull Number value)
      The priority of the job queue.

    • getComputeEnvironmentOrder

      @Stability(Stable) @Nullable public Object getComputeEnvironmentOrder()
      The set of compute environments mapped to a job queue and their order relative to each other.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnJobQueue.ComputeEnvironmentOrderProperty>

    • setComputeEnvironmentOrder

      @Stability(Stable) public void setComputeEnvironmentOrder(@Nullable IResolvable value)
      The set of compute environments mapped to a job queue and their order relative to each other.

    • setComputeEnvironmentOrder

      @Stability(Stable) public void setComputeEnvironmentOrder(@Nullable List<Object> value)
      The set of compute environments mapped to a job queue and their order relative to each other.

    • getJobQueueName

      @Stability(Stable) @Nullable public String getJobQueueName()
      The name of the job queue.

    • setJobQueueName

      @Stability(Stable) public void setJobQueueName(@Nullable String value)
      The name of the job queue.

    • getJobQueueType

      @Stability(Stable) @Nullable public String getJobQueueType()
      The type of job queue.

    • setJobQueueType

      @Stability(Stable) public void setJobQueueType(@Nullable String value)
      The type of job queue.

    • getJobStateTimeLimitActions

      @Stability(Stable) @Nullable public Object getJobStateTimeLimitActions()
      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.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnJobQueue.JobStateTimeLimitActionProperty>

    • setJobStateTimeLimitActions

      @Stability(Stable) public void setJobStateTimeLimitActions(@Nullable IResolvable value)
      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.

    • setJobStateTimeLimitActions

      @Stability(Stable) public void setJobStateTimeLimitActions(@Nullable List<Object> value)
      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.

    • getSchedulingPolicyArn

      @Stability(Stable) @Nullable public String getSchedulingPolicyArn()
      The Amazon Resource Name (ARN) of the scheduling policy.

    • setSchedulingPolicyArn

      @Stability(Stable) public void setSchedulingPolicyArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the scheduling policy.

    • getServiceEnvironmentOrder

      @Stability(Stable) @Nullable public Object getServiceEnvironmentOrder()
      The order of the service environment associated with the job queue.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnJobQueue.ServiceEnvironmentOrderProperty>

    • setServiceEnvironmentOrder

      @Stability(Stable) public void setServiceEnvironmentOrder(@Nullable IResolvable value)
      The order of the service environment associated with the job queue.

    • setServiceEnvironmentOrder

      @Stability(Stable) public void setServiceEnvironmentOrder(@Nullable List<Object> value)
      The order of the service environment associated with the job queue.

    • getState

      @Stability(Stable) @Nullable public String getState()
      The state of the job queue.

    • setState

      @Stability(Stable) public void setState(@Nullable String value)
      The state of the job queue.

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      The tags that are applied to the job queue.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      The tags that are applied to the job queue.