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, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)", date="2023-11-02T10:21:14.648Z") @Stability(Stable) public class CfnJobQueue extends CfnResource implements IInspectable, 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")
         .computeEnvironmentOrder(List.of(ComputeEnvironmentOrderProperty.builder()
                 .computeEnvironment("computeEnvironment")
                 .order(123)
                 .build()))
         .priority(123)
         // the properties below are optional
         .jobQueueName("jobQueueName")
         .schedulingPolicyArn("schedulingPolicyArn")
         .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)
      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

    • getTags

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

    • getComputeEnvironmentOrder

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

    • setComputeEnvironmentOrder

      @Stability(Stable) public void setComputeEnvironmentOrder(@NotNull 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(@NotNull List<Object> value)
      The set of compute environments mapped to a job queue and their order relative to each other.

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

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

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

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