Module: AWSCDK::Batch::IManagedEC2ECSComputeEnvironment

Includes:
IManagedComputeEnvironment
Included in:
ManagedEC2ECSComputeEnvironment
Defined in:
batch/i_managed_ec2_ecs_compute_environment.rb

Overview

A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 358

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :compute_environment_ref => { kind: :property, name: "computeEnvironmentRef", is_optional: false },
    :compute_environment_arn => { kind: :property, name: "computeEnvironmentArn", is_optional: false },
    :compute_environment_name => { kind: :property, name: "computeEnvironmentName", is_optional: false },
    :enabled => { kind: :property, name: "enabled", is_optional: false },
    :service_role => { kind: :property, name: "serviceRole", is_optional: true },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :maxv_cpus => { kind: :property, name: "maxvCpus", is_optional: false },
    :security_groups => { kind: :property, name: "securityGroups", is_optional: false },
    :replace_compute_environment => { kind: :property, name: "replaceComputeEnvironment", is_optional: true },
    :spot => { kind: :property, name: "spot", 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 },
    :vpc_subnets => { kind: :property, name: "vpcSubnets", is_optional: true },
    :instance_classes => { kind: :property, name: "instanceClasses", is_optional: false },
    :instance_types => { kind: :property, name: "instanceTypes", 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 },
    :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 },
    :spot_bid_percentage => { kind: :property, name: "spotBidPercentage", is_optional: true },
    :spot_fleet_role => { kind: :property, name: "spotFleetRole", is_optional: true },
    :use_optimal_instance_classes => { kind: :property, name: "useOptimalInstanceClasses", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :add_instance_class => { kind: :method, name: "addInstanceClass", is_optional: false },
    :add_instance_type => { kind: :method, name: "addInstanceType", is_optional: false },
  }
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:



344
345
346
347
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 344

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:



353
354
355
356
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 353

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?

Note:

Default: - BEST_FIT_PROGRESSIVE if not using Spot instances, SPOT_PRICE_CAPACITY_OPTIMIZED if using Spot instances.

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

Returns:



218
219
220
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 218

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



335
336
337
338
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 335

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) 


47
48
49
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 47

def compute_environment_arn()
  jsii_get_property("computeEnvironmentArn")
end

#compute_environment_name ⇒ String

The name of the ComputeEnvironment.

Returns:

  • (String) 


54
55
56
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 54

def compute_environment_name()
  jsii_get_property("computeEnvironmentName")
end

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

A reference to a ComputeEnvironment resource.

Returns:



40
41
42
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 40

def compute_environment_ref()
  jsii_get_property("computeEnvironmentRef")
end

#connections ⇒ AWSCDK::EC2::Connections

The network connections associated with this resource.

Returns:



87
88
89
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 87

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


72
73
74
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 72

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:



26
27
28
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 26

def env()
  jsii_get_property("env")
end

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

Note:

Default: - ECS_AL2 compatible AMI ids for non-GPU instances, ECS_AL2_NVIDIA compatible AMI ids for GPU instances. If the '@aws-cdk/aws-batch:defaultToAL2023' feature flag is set, ECS_AL2023 will be used instead of ECS_AL2.

Configure which AMIs this Compute Environment can launch.

Leave this undefined to allow Batch to choose the latest AMIs it supports for each instance that it launches.

Returns:



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

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. Batch will automatically choose the size.

Returns:



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

def instance_classes()
  jsii_get_property("instanceClasses")
end

#instance_role ⇒ AWSCDK::IAM::IRole?

Note:

Default: - a role will be created

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

Returns:



236
237
238
 
# File 'batch/i_managed_ec2_ecs_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:



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

def instance_types()
  jsii_get_property("instanceTypes")
end

#launch_template ⇒ AWSCDK::EC2::ILaunchTemplate?

Note:

Default: no launch template

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:



249
250
251
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 249

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) 


106
107
108
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 106

def maxv_cpus()
  jsii_get_property("maxvCpus")
end

#minv_cpus ⇒ Numeric?

Note:

Default: 0

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

Returns:

  • (Numeric, nil) 


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

def minv_cpus()
  jsii_get_property("minvCpus")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


11
12
13
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 11

def node()
  jsii_get_property("node")
end

#placement_group ⇒ AWSCDK::EC2::IPlacementGroup?

Note:

Default: - no placement group

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:

See Also:



271
272
273
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 271

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)

See Also:



133
134
135
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 133

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:



113
114
115
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 113

def security_groups()
  jsii_get_property("securityGroups")
end

#service_role ⇒ AWSCDK::IAM::IRole?

Note:

Default: - a serviceRole will be created for managed CEs, none for unmanaged CEs

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

Returns:



80
81
82
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 80

def service_role()
  jsii_get_property("serviceRole")
end

#spot ⇒ Boolean?

Note:

Default: false

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) 


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

def spot()
  jsii_get_property("spot")
end

#spot_bid_percentage ⇒ Numeric?

Note:

Default: - 100%

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.

Returns:

  • (Numeric, nil) 


284
285
286
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 284

def spot_bid_percentage()
  jsii_get_property("spotBidPercentage")
end

#spot_fleet_role ⇒ AWSCDK::IAM::IRole?

Note:

Default: - a new Role will be created

The service-linked role that Spot Fleet needs to launch instances on your behalf.

Returns:

See Also:



293
294
295
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 293

def spot_fleet_role()
  jsii_get_property("spotFleetRole")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



33
34
35
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 33

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

TagManager to set, remove and format tags.

Returns:



94
95
96
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 94

def tags()
  jsii_get_property("tags")
end

#terminate_on_update ⇒ Boolean?

Note:

Default: false

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)

See Also:



157
158
159
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 157

def terminate_on_update()
  jsii_get_property("terminateOnUpdate")
end

#update_timeout ⇒ AWSCDK::Duration?

Note:

Default: 30 minutes

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:

See Also:



170
171
172
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 170

def update_timeout()
  jsii_get_property("updateTimeout")
end

#update_to_latest_image_version ⇒ Boolean?

Note:

Default: false

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)

See Also:



184
185
186
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 184

def update_to_latest_image_version()
  jsii_get_property("updateToLatestImageVersion")
end

#use_optimal_instance_classes ⇒ Boolean?

Note:

Default: true

Whether or not to use batch's optimal instance type.

The optimal instance type is equivalent to adding the C4, M4, and R4 instance classes. You can specify other instance classes (of the same architecture) in addition to the optimal instance classes.

Returns:

  • (Boolean, nil) 


305
306
307
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 305

def use_optimal_instance_classes()
  jsii_get_property("useOptimalInstanceClasses")
end

#vpc_subnets ⇒ AWSCDK::EC2::SubnetSelection?

The VPC Subnets this Compute Environment will launch instances in.

Returns:



191
192
193
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 191

def vpc_subnets()
  jsii_get_property("vpcSubnets")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



316
317
318
319
320
321
 
# File 'batch/i_managed_ec2_ecs_compute_environment.rb', line 316

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