Package software.amazon.awscdk.services.batch

Class IJobQueue.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.batch.IJobQueue.Jsii$Proxy
All Implemented Interfaces:
IResource, IResource.Jsii$Default, IJobQueue, IJobQueue.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default
Enclosing interface:
IJobQueue
@Internal public static final class IJobQueue.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements IJobQueue.Jsii$Default
A proxy class which represents a concrete javascript instance of this type.

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IDependable

    software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IJobQueue

    IJobQueue.Jsii$Default, IJobQueue.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default, IResource.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    addComputeEnvironment(IComputeEnvironment computeEnvironment, Number order)
    Add a ComputeEnvironment to this Queue.
    final void
    applyRemovalPolicy(RemovalPolicy policy)
    Apply the given removal policy to this resource.
    final List<OrderedComputeEnvironment>
    getComputeEnvironments()
    The set of compute environments mapped to a job queue and their order relative to each other.
    final Boolean
    getEnabled()
    If the job queue is enabled, it is able to accept jobs.
    final ResourceEnvironment
    getEnv()
    The environment this resource belongs to.
    final String
    getJobQueueArn()
    The ARN of this job queue.
    final String
    getJobQueueName()
    The name of the job queue.
    final software.constructs.Node
    getNode()
    The tree node.
    final Number
    getPriority()
    The priority of the job queue.
    final ISchedulingPolicy
    getSchedulingPolicy()
    The SchedulingPolicy for this JobQueue.
    final Stack
    getStack()
    The stack in which this resource is defined.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

  • Method Details

    • getNode

      @Stability(Stable) @NotNull public final software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IJobQueue.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull public final ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IJobQueue.Jsii$Default
      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull public final Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IJobQueue.Jsii$Default
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getComputeEnvironments

      @Stability(Stable) @NotNull public final List<OrderedComputeEnvironment> getComputeEnvironments()
      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.

      Note: 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.

      Specified by:
      getComputeEnvironments in interface IJobQueue
      Specified by:
      getComputeEnvironments in interface IJobQueue.Jsii$Default

    • getJobQueueArn

      @Stability(Stable) @NotNull public final String getJobQueueArn()
      The ARN of this job queue.
      Specified by:
      getJobQueueArn in interface IJobQueue
      Specified by:
      getJobQueueArn in interface IJobQueue.Jsii$Default

    • getJobQueueName

      @Stability(Stable) @NotNull public final String getJobQueueName()
      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 (_)

      Specified by:
      getJobQueueName in interface IJobQueue
      Specified by:
      getJobQueueName in interface IJobQueue.Jsii$Default

    • getPriority

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

      Job queues with a higher priority 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.

      Specified by:
      getPriority in interface IJobQueue
      Specified by:
      getPriority in interface IJobQueue.Jsii$Default

    • getEnabled

      @Stability(Stable) @Nullable public final Boolean getEnabled()
      If the job queue is enabled, it is able to accept jobs.

      Otherwise, new jobs can't be added to the queue, but jobs already in the queue can finish.

      Default: true

      Specified by:
      getEnabled in interface IJobQueue
      Specified by:
      getEnabled in interface IJobQueue.Jsii$Default

    • getSchedulingPolicy

      @Stability(Stable) @Nullable public final ISchedulingPolicy getSchedulingPolicy()
      The SchedulingPolicy for this JobQueue.

      Instructs the Scheduler how to schedule different jobs.

      Default: - no scheduling policy

      Specified by:
      getSchedulingPolicy in interface IJobQueue
      Specified by:
      getSchedulingPolicy in interface IJobQueue.Jsii$Default

    • applyRemovalPolicy

      @Stability(Stable) public final void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IJobQueue.Jsii$Default
      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • addComputeEnvironment

      @Stability(Stable) public final void addComputeEnvironment(@NotNull IComputeEnvironment computeEnvironment, @NotNull Number order)
      Add a ComputeEnvironment to this Queue.

      The Queue will prefer lower-order ComputeEnvironments.

      Specified by:
      addComputeEnvironment in interface IJobQueue
      Specified by:
      addComputeEnvironment in interface IJobQueue.Jsii$Default
      Parameters:
      computeEnvironment - This parameter is required.
      order - This parameter is required.