Class: AWSCDK::Batch::FairshareSchedulingPolicy

Inherits:
Resource
  • Object
show all
Includes:
IFairshareSchedulingPolicy, ISchedulingPolicy
Defined in:
batch/fairshare_scheduling_policy.rb

Overview

Represents a Fairshare Scheduling Policy. Instructs the scheduler to allocate ComputeEnvironment vCPUs based on Job shareIdentifiers.

The Faireshare Scheduling Policy ensures that each share gets a certain amount of vCPUs. The scheduler does this by deciding how many Jobs of each share to schedule relative to how many jobs of each share are currently being executed by the ComputeEnvironment. The weight factors associated with each share determine the ratio of vCPUs allocated; see the readme for a more in-depth discussion of fairshare policies.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of FairshareSchedulingPolicy.

Parameters:



19
20
21
22
23
24
25
 
# File 'batch/fairshare_scheduling_policy.rb', line 19

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Batch::FairshareSchedulingPolicyProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmF0Y2guRmFpcnNoYXJlU2NoZWR1bGluZ1BvbGljeVByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_fairshare_scheduling_policy_arn(scope, id, fairshare_scheduling_policy_arn) ⇒ AWSCDK::Batch::IFairshareSchedulingPolicy

Reference an existing Scheduling Policy by its ARN.

Parameters:

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

Returns:



56
57
58
59
60
61
 
# File 'batch/fairshare_scheduling_policy.rb', line 56

def self.from_fairshare_scheduling_policy_arn(scope, id, fairshare_scheduling_policy_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(fairshare_scheduling_policy_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fairshareSchedulingPolicyArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_batch.FairshareSchedulingPolicy", "fromFairshareSchedulingPolicyArn", [scope, id, fairshare_scheduling_policy_arn])
end

.jsii_overridable_methods ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'batch/fairshare_scheduling_policy.rb', line 27

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 },
    :scheduling_policy_arn => { kind: :property, name: "schedulingPolicyArn", is_optional: false },
    :scheduling_policy_name => { kind: :property, name: "schedulingPolicyName", is_optional: false },
    :scheduling_policy_ref => { kind: :property, name: "schedulingPolicyRef", is_optional: false },
    :shares => { kind: :property, name: "shares", is_optional: false },
    :compute_reservation => { kind: :property, name: "computeReservation", is_optional: true },
    :share_decay => { kind: :property, name: "shareDecay", 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_share => { kind: :method, name: "addShare", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


109
110
111
 
# File 'batch/fairshare_scheduling_policy.rb', line 109

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

Instance Method Details

#add_share(share) ⇒ void

This method returns an undefined value.

Add a share this to this Fairshare SchedulingPolicy.

Parameters:



271
272
273
274
275
 
# File 'batch/fairshare_scheduling_policy.rb', line 271

def add_share(share)
  share = share.is_a?(Hash) ? ::AWSCDK::Batch::Share.new(**share.transform_keys(&:to_sym)) : share
  Jsii::Type.check_type(share, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmF0Y2guU2hhcmUifQ==")), "share")
  jsii_call_method("addShare", [share])
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:



210
211
212
213
 
# File 'batch/fairshare_scheduling_policy.rb', line 210

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:



227
228
229
230
 
# File 'batch/fairshare_scheduling_policy.rb', line 227

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

#compute_reservation ⇒ Numeric?

Used to calculate the percentage of the maximum available vCPU to reserve for share identifiers not present in the Queue.

The percentage reserved is defined by the Scheduler as: (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.

For example, a computeReservation value of 50 indicates that AWS Batch reserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers.

A computeReservation value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

Returns:

  • (Numeric, nil) 


160
161
162
 
# File 'batch/fairshare_scheduling_policy.rb', line 160

def compute_reservation()
  jsii_get_property("computeReservation")
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:



81
82
83
 
# File 'batch/fairshare_scheduling_policy.rb', line 81

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


233
234
235
 
# File 'batch/fairshare_scheduling_policy.rb', line 233

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) 


247
248
249
250
251
252
 
# File 'batch/fairshare_scheduling_policy.rb', line 247

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) 


262
263
264
265
 
# File 'batch/fairshare_scheduling_policy.rb', line 262

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


66
67
68
 
# File 'batch/fairshare_scheduling_policy.rb', line 66

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) 


95
96
97
 
# File 'batch/fairshare_scheduling_policy.rb', line 95

def physical_name()
  jsii_get_property("physicalName")
end

#scheduling_policy_arn ⇒ String

The arn of this scheduling policy.

Returns:

  • (String) 


116
117
118
 
# File 'batch/fairshare_scheduling_policy.rb', line 116

def scheduling_policy_arn()
  jsii_get_property("schedulingPolicyArn")
end

#scheduling_policy_name ⇒ String

The name of this scheduling policy.

Returns:

  • (String) 


123
124
125
 
# File 'batch/fairshare_scheduling_policy.rb', line 123

def scheduling_policy_name()
  jsii_get_property("schedulingPolicyName")
end

#scheduling_policy_ref ⇒ AWSCDK::Interfaces::AWSBatch::SchedulingPolicyReference

A reference to a SchedulingPolicy resource.

Returns:



130
131
132
 
# File 'batch/fairshare_scheduling_policy.rb', line 130

def scheduling_policy_ref()
  jsii_get_property("schedulingPolicyRef")
end

#share_decay ⇒ AWSCDK::Duration?

The amount of time to use to measure the usage of each job.

The usage is used to calculate a fair share percentage for each fair share identifier currently in the Queue. A value of zero (0) indicates that only current usage is measured. The decay is linear and gives preference to newer jobs.

The maximum supported value is 604800 seconds (1 week).

Returns:



173
174
175
 
# File 'batch/fairshare_scheduling_policy.rb', line 173

def share_decay()
  jsii_get_property("shareDecay")
end

#shares ⇒ Array<AWSCDK::Batch::Share>

The shares that this Scheduling Policy applies to.

Note: It is possible to submit Jobs to the queue with Share Identifiers that are not recognized by the Scheduling Policy.

Returns:



140
141
142
 
# File 'batch/fairshare_scheduling_policy.rb', line 140

def shares()
  jsii_get_property("shares")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



102
103
104
 
# File 'batch/fairshare_scheduling_policy.rb', line 102

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


180
181
182
 
# File 'batch/fairshare_scheduling_policy.rb', line 180

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) 


193
194
195
196
197
198
 
# File 'batch/fairshare_scheduling_policy.rb', line 193

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