Class: AWSCDK::Batch::ManagedEC2EKSComputeEnvironment

Inherits:
Resource
  • Object
show all
Includes:
IComputeEnvironment, IManagedComputeEnvironment
Defined in:
batch/managed_ec2_eks_compute_environment.rb

Overview

A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ ManagedEC2EKSComputeEnvironment

Returns a new instance of ManagedEC2EKSComputeEnvironment.

Parameters:



13
14
15
16
17
18
19
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 13

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

Class Method Details

.jsii_overridable_methods ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 21

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_environment_arn => { kind: :property, name: "computeEnvironmentArn", is_optional: false },
    :compute_environment_name => { kind: :property, name: "computeEnvironmentName", is_optional: false },
    :compute_environment_ref => { kind: :property, name: "computeEnvironmentRef", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :eks_cluster => { kind: :property, name: "eksCluster", is_optional: false },
    :enabled => { kind: :property, name: "enabled", is_optional: false },
    :instance_classes => { kind: :property, name: "instanceClasses", is_optional: false },
    :instance_types => { kind: :property, name: "instanceTypes", is_optional: false },
    :maxv_cpus => { kind: :property, name: "maxvCpus", is_optional: false },
    :security_groups => { kind: :property, name: "securityGroups", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :allocation_strategy => { kind: :property, name: "allocationStrategy", is_optional: true },
    :images => { kind: :property, name: "images", is_optional: true },
    :instance_role => { kind: :property, name: "instanceRole", is_optional: true },
    :kubernetes_namespace => { kind: :property, name: "kubernetesNamespace", is_optional: true },
    :launch_template => { kind: :property, name: "launchTemplate", is_optional: true },
    :minv_cpus => { kind: :property, name: "minvCpus", is_optional: true },
    :placement_group => { kind: :property, name: "placementGroup", is_optional: true },
    :replace_compute_environment => { kind: :property, name: "replaceComputeEnvironment", is_optional: true },
    :service_role => { kind: :property, name: "serviceRole", is_optional: true },
    :spot => { kind: :property, name: "spot", is_optional: true },
    :spot_bid_percentage => { kind: :property, name: "spotBidPercentage", is_optional: true },
    :terminate_on_update => { kind: :property, name: "terminateOnUpdate", is_optional: true },
    :update_timeout => { kind: :property, name: "updateTimeout", is_optional: true },
    :update_to_latest_image_version => { kind: :property, name: "updateToLatestImageVersion", 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_instance_class => { kind: :method, name: "addInstanceClass", is_optional: false },
    :add_instance_type => { kind: :method, name: "addInstanceType", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


110
111
112
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 110

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

Instance Method Details

#add_instance_class(instance_class) ⇒ void

This method returns an undefined value.

Add an instance class to this compute environment.

Parameters:



458
459
460
461
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 458

def add_instance_class(instance_class)
  Jsii::Type.check_type(instance_class, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkluc3RhbmNlQ2xhc3MifQ==")), "instanceClass")
  jsii_call_method("addInstanceClass", [instance_class])
end

#add_instance_type(instance_type) ⇒ void

This method returns an undefined value.

Add an instance type to this compute environment.

Parameters:



467
468
469
470
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 467

def add_instance_type(instance_type)
  Jsii::Type.check_type(instance_type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkluc3RhbmNlVHlwZSJ9")), "instanceType")
  jsii_call_method("addInstanceType", [instance_type])
end

#allocation_strategy ⇒ AWSCDK::Batch::AllocationStrategy?

The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.

Returns:



222
223
224
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 222

def allocation_strategy()
  jsii_get_property("allocationStrategy")
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:



397
398
399
400
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 397

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:



414
415
416
417
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 414

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

#compute_environment_arn ⇒ String

The ARN of this compute environment.

Returns:

  • (String) 


117
118
119
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 117

def compute_environment_arn()
  jsii_get_property("computeEnvironmentArn")
end

#compute_environment_name ⇒ String

The name of the ComputeEnvironment.

Returns:

  • (String) 


124
125
126
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 124

def compute_environment_name()
  jsii_get_property("computeEnvironmentName")
end

#compute_environment_ref ⇒ AWSCDK::Interfaces::AWSBatch::ComputeEnvironmentReference

A reference to a ComputeEnvironment resource.

Returns:



131
132
133
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 131

def compute_environment_ref()
  jsii_get_property("computeEnvironmentRef")
end

#connections ⇒ AWSCDK::EC2::Connections

The network connections associated with this resource.

Returns:



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

def connections()
  jsii_get_property("connections")
end

#eks_cluster ⇒ AWSCDK::EKS::ICluster

The cluster that backs this Compute Environment. Required for Compute Environments running Kubernetes jobs.

Please ensure that you have followed the steps at

https://docs.aws.amazon.com/batch/latest/userguide/getting-started-eks.html

before attempting to deploy a ManagedEc2EksComputeEnvironment that uses this cluster. If you do not follow the steps in the link, the deployment fail with a message that the compute environment did not stabilize.

Returns:



153
154
155
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 153

def eks_cluster()
  jsii_get_property("eksCluster")
end

#enabled ⇒ Boolean

Whether or not this ComputeEnvironment can accept jobs from a Queue.

Enabled ComputeEnvironments can accept jobs from a Queue and can scale instances up or down. Disabled ComputeEnvironments cannot accept jobs from a Queue or scale instances up or down.

If you change a ComputeEnvironment from enabled to disabled while it is executing jobs, Jobs in the STARTED or RUNNING states will not be interrupted. As jobs complete, the ComputeEnvironment will scale instances down to minv_cpus.

To ensure you aren't billed for unused capacity, set minv_cpus to 0.

Returns:

  • (Boolean) 


171
172
173
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 171

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:



82
83
84
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 82

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


420
421
422
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 420

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) 


434
435
436
437
438
439
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 434

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) 


449
450
451
452
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 449

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

#images ⇒ Array<AWSCDK::Batch::EKSMachineImage>?

Configure which AMIs this Compute Environment can launch.

Returns:



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

def images()
  jsii_get_property("images")
end

#instance_classes ⇒ Array<AWSCDK::EC2::InstanceClass>

The instance classes that this Compute Environment can launch.

Which one is chosen depends on the AllocationStrategy used.

Returns:



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

def instance_classes()
  jsii_get_property("instanceClasses")
end

#instance_role ⇒ AWSCDK::IAM::IRole?

The execution Role that instances launched by this Compute Environment will use.

Returns:



236
237
238
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 236

def instance_role()
  jsii_get_property("instanceRole")
end

#instance_types ⇒ Array<AWSCDK::EC2::InstanceType>

The instance types that this Compute Environment can launch.

Which one is chosen depends on the AllocationStrategy used.

Returns:



189
190
191
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 189

def instance_types()
  jsii_get_property("instanceTypes")
end

#kubernetes_namespace ⇒ String?

The namespace of the Cluster.

Cannot be 'default', start with 'kube-', or be longer than 64 characters.

Returns:

  • (String, nil) 


245
246
247
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 245

def kubernetes_namespace()
  jsii_get_property("kubernetesNamespace")
end

#launch_template ⇒ AWSCDK::EC2::ILaunchTemplate?

The Launch Template that this Compute Environment will use to provision EC2 Instances.

Note: if security_groups is specified on both your launch template and this Compute Environment, **the security_groups on the Compute Environment override the ones on the launch template.

Returns:



257
258
259
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 257

def launch_template()
  jsii_get_property("launchTemplate")
end

#maxv_cpus ⇒ Numeric

The maximum vCpus this ManagedComputeEnvironment can scale up to.

Note: if this Compute Environment uses EC2 resources (not Fargate) with either AllocationStrategy.BEST_FIT_PROGRESSIVE or AllocationStrategy.SPOT_CAPACITY_OPTIMIZED, or AllocationStrategy.BEST_FIT with Spot instances, The scheduler may exceed this number by at most one of the instances specified in instance_types or instance_classes.

Returns:

  • (Numeric) 


201
202
203
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 201

def maxv_cpus()
  jsii_get_property("maxvCpus")
end

#minv_cpus ⇒ Numeric?

The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.

Returns:

  • (Numeric, nil) 


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

def minv_cpus()
  jsii_get_property("minvCpus")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


67
68
69
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 67

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) 


96
97
98
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 96

def physical_name()
  jsii_get_property("physicalName")
end

#placement_group ⇒ AWSCDK::EC2::IPlacementGroup?

The EC2 placement group to associate with your compute resources.

If you intend to submit multi-node parallel jobs to this Compute Environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential.

Returns:



276
277
278
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 276

def placement_group()
  jsii_get_property("placementGroup")
end

#replace_compute_environment ⇒ Boolean?

Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.

To enable more properties to be updated, set this property to false. When changing the value of this property to false, do not change any other properties at the same time. If other properties are changed at the same time, and the change needs to be rolled back but it can't, it's possible for the stack to go into the UPDATE_ROLLBACK_FAILED state. You can't update a stack that is in the UPDATE_ROLLBACK_FAILED state. However, if you can continue to roll it back, you can return the stack to its original settings and then try to update it again.

The properties which require a replacement of the Compute Environment are:

Returns:

  • (Boolean, nil) 


295
296
297
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 295

def replace_compute_environment()
  jsii_get_property("replaceComputeEnvironment")
end

#security_groups ⇒ Array<AWSCDK::EC2::ISecurityGroup>

The security groups this Compute Environment will launch instances in.

Returns:



208
209
210
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 208

def security_groups()
  jsii_get_property("securityGroups")
end

#service_role ⇒ AWSCDK::IAM::IRole?

The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.

Returns:



302
303
304
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 302

def service_role()
  jsii_get_property("serviceRole")
end

#spot ⇒ Boolean?

Whether or not to use spot instances.

Spot instances are less expensive EC2 instances that can be reclaimed by EC2 at any time; your job will be given two minutes of notice before reclamation.

Returns:

  • (Boolean, nil) 


313
314
315
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 313

def spot()
  jsii_get_property("spot")
end

#spot_bid_percentage ⇒ Numeric?

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched.

For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Instance. You always pay the lowest market price and never more than your maximum percentage. For most use cases, Batch recommends leaving this field empty.

Implies spot == true if set

Returns:

  • (Numeric, nil) 


327
328
329
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 327

def spot_bid_percentage()
  jsii_get_property("spotBidPercentage")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



103
104
105
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 103

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

TagManager to set, remove and format tags.

Returns:



215
216
217
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 215

def tags()
  jsii_get_property("tags")
end

#terminate_on_update ⇒ Boolean?

Whether or not any running jobs will be immediately terminated when an infrastructure update occurs.

If this is enabled, any terminated jobs may be retried, depending on the job's retry policy.

Returns:

  • (Boolean, nil) 


337
338
339
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 337

def terminate_on_update()
  jsii_get_property("terminateOnUpdate")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


367
368
369
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 367

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

#update_timeout ⇒ AWSCDK::Duration?

Only meaningful if terminateOnUpdate is false.

If so, when an infrastructure update is triggered, any running jobs will be allowed to run until update_timeout has expired.

Returns:



348
349
350
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 348

def update_timeout()
  jsii_get_property("updateTimeout")
end

#update_to_latest_image_version ⇒ Boolean?

Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs.

If you specify a specific AMI, this property will be ignored.

Note: the CDK will never set this value by default, false will set by CFN. This is to avoid a deployment failure that occurs when this value is set.

Returns:

  • (Boolean, nil) 


360
361
362
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 360

def update_to_latest_image_version()
  jsii_get_property("updateToLatestImageVersion")
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) 


380
381
382
383
384
385
 
# File 'batch/managed_ec2_eks_compute_environment.rb', line 380

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