Class: AWSCDK::Batch::JobQueue

Inherits:
Resource
  • Object
show all
Includes:
IJobQueue
Defined in:
batch/job_queue.rb

Overview

JobQueues can receive Jobs, which are removed from the queue when sent to the linked ComputeEnvironment(s) to be executed.

Jobs exit the queue in FIFO order unless a SchedulingPolicy is linked.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ JobQueue

Returns a new instance of JobQueue.

Parameters:



14
15
16
17
18
19
20
 
# File 'batch/job_queue.rb', line 14

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Batch::JobQueueProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmF0Y2guSm9iUXVldWVQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_job_queue_arn(scope, id, job_queue_arn) ⇒ AWSCDK::Batch::IJobQueue

refer to an existing JobQueue by its arn.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • job_queue_arn (String)

Returns:



52
53
54
55
56
57
 
# File 'batch/job_queue.rb', line 52

def self.from_job_queue_arn(scope, id, job_queue_arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(job_queue_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobQueueArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_batch.JobQueue", "fromJobQueueArn", [scope, id, job_queue_arn])
end

.jsii_overridable_methods ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'batch/job_queue.rb', line 22

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :compute_environments => { kind: :property, name: "computeEnvironments", is_optional: false },
    :job_queue_arn => { kind: :property, name: "jobQueueArn", is_optional: false },
    :job_queue_name => { kind: :property, name: "jobQueueName", is_optional: false },
    :job_queue_ref => { kind: :property, name: "jobQueueRef", is_optional: false },
    :priority => { kind: :property, name: "priority", is_optional: false },
    :enabled => { kind: :property, name: "enabled", is_optional: true },
    :scheduling_policy => { kind: :property, name: "schedulingPolicy", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_compute_environment => { kind: :method, name: "addComputeEnvironment", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


105
106
107
 
# File 'batch/job_queue.rb', line 105

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_batch.JobQueue", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_compute_environment(compute_environment, order) ⇒ void

This method returns an undefined value.

Add a ComputeEnvironment to this Queue.

The Queue will prefer lower-order ComputeEnvironments.

Parameters:



275
276
277
278
279
 
# File 'batch/job_queue.rb', line 275

def add_compute_environment(compute_environment, order)
  Jsii::Type.check_type(compute_environment, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iYXRjaC5JQ29tcHV0ZUVudmlyb25tZW50UmVmIn0=")), "computeEnvironment")
  Jsii::Type.check_type(order, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "order")
  jsii_call_method("addComputeEnvironment", [compute_environment, order])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



211
212
213
214
 
# File 'batch/job_queue.rb', line 211

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

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

Parameters:



228
229
230
231
 
# File 'batch/job_queue.rb', line 228

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#compute_environments ⇒ Array<AWSCDK::Batch::OrderedComputeEnvironment>

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.

Returns:



121
122
123
 
# File 'batch/job_queue.rb', line 121

def compute_environments()
  jsii_get_property("computeEnvironments")
end

#enabled ⇒ Boolean?

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.

Returns:

  • (Boolean, nil) 


165
166
167
 
# File 'batch/job_queue.rb', line 165

def enabled()
  jsii_get_property("enabled")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



77
78
79
 
# File 'batch/job_queue.rb', line 77

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


234
235
236
 
# File 'batch/job_queue.rb', line 234

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


248
249
250
251
252
253
 
# File 'batch/job_queue.rb', line 248

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


263
264
265
266
 
# File 'batch/job_queue.rb', line 263

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#job_queue_arn ⇒ String

The ARN of this job queue.

Returns:

  • (String) 


128
129
130
 
# File 'batch/job_queue.rb', line 128

def job_queue_arn()
  jsii_get_property("jobQueueArn")
end

#job_queue_name ⇒ 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 (_)

Returns:

  • (String) 


138
139
140
 
# File 'batch/job_queue.rb', line 138

def job_queue_name()
  jsii_get_property("jobQueueName")
end

#job_queue_ref ⇒ AWSCDK::Interfaces::AWSBatch::JobQueueReference

A reference to a JobQueue resource.

Returns:



145
146
147
 
# File 'batch/job_queue.rb', line 145

def job_queue_ref()
  jsii_get_property("jobQueueRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


62
63
64
 
# File 'batch/job_queue.rb', line 62

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


91
92
93
 
# File 'batch/job_queue.rb', line 91

def physical_name()
  jsii_get_property("physicalName")
end

#priority ⇒ Numeric

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.

Returns:

  • (Numeric) 


156
157
158
 
# File 'batch/job_queue.rb', line 156

def priority()
  jsii_get_property("priority")
end

#scheduling_policy ⇒ AWSCDK::Batch::ISchedulingPolicy?

The SchedulingPolicy for this JobQueue.

Instructs the Scheduler how to schedule different jobs.

Returns:



174
175
176
 
# File 'batch/job_queue.rb', line 174

def scheduling_policy()
  jsii_get_property("schedulingPolicy")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



98
99
100
 
# File 'batch/job_queue.rb', line 98

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


181
182
183
 
# File 'batch/job_queue.rb', line 181

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


194
195
196
197
198
199
 
# File 'batch/job_queue.rb', line 194

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end