IManagedEc2EcsComputeEnvironment

class aws_cdk.aws_batch.IManagedEc2EcsComputeEnvironment(*args, **kwargs)

Bases: IManagedComputeEnvironment, Protocol

A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.

Methods

add_instance_class(instance_class)

Add an instance class to this compute environment.

Parameters:

instance_class (InstanceClass) –

Return type:

None

add_instance_type(instance_type)

Add an instance type to this compute environment.

Parameters:

instance_type (InstanceType) –

Return type:

None

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

Parameters:

policy (RemovalPolicy) –

Return type:

None

Attributes

allocation_strategy

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

Default:

BEST_FIT_PROGRESSIVE if not using Spot instances,

SPOT_CAPACITY_OPTIMIZED if using Spot instances.

compute_environment_arn

The ARN of this compute environment.

Attribute:: true

compute_environment_name

The name of the ComputeEnvironment.

Attribute:: true

connections: The network connections associated with this resource.

enabled

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

To ensure you aren’t billed for unused capacity, set minvCpus to 0.

env

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.

images

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.

Default:

ECS_AL2 compatible AMI ids for non-GPU instances, ECS_AL2_NVIDIA compatible AMI ids for GPU instances

instance_classes

The instance classes that this Compute Environment can launch.

Which one is chosen depends on the AllocationStrategy used. Batch will automatically choose the size.

instance_role

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

Default:

a role will be created

instance_types

The instance types that this Compute Environment can launch.

Which one is chosen depends on the AllocationStrategy used.

launch_template

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

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

Default:: no launch template

maxv_cpus

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 instanceTypes or instanceClasses.

minv_cpus

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

Default:: 0

node: The tree node.

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.

Default:

no placement group

See:

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html

replace_compute_environment

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:

See:: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html

security_groups: The security groups this Compute Environment will launch instances in.

service_role

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

Default:

a serviceRole will be created for managed CEs, none for unmanaged CEs

spot

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.

Default:: false

spot_bid_percentage

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.

Default:

100%

spot_fleet_role

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

Default:

a new Role will be created

See:

https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html

stack: The stack in which this resource is defined.

tags: TagManager to set, remove and format tags.

terminate_on_update

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.

Default:: false
See:: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

update_timeout

Only meaningful if terminateOnUpdate is false.

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

Default:: 30 minutes
See:: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

update_to_latest_image_version

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.

Default:: false
See:: https://github.com/aws/aws-cdk/issues/27054

use_optimal_instance_classes

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.

Default:: true

vpc_subnets: The VPC Subnets this Compute Environment will launch instances in.