aws-cdk-lib.aws_batch.ManagedEc2EksComputeEnvironmentProps

ManagedEc2EksComputeEnvironmentProps Struct

Props for a ManagedEc2EksComputeEnvironment.

ManagedEc2EksComputeEnvironmentProps

extends

• ManagedEc2ComputeEnvironmentProps

used as props by

• ManagedEc2EksComputeEnvironment

Source

aws-batch/lib/managed-compute-environment.ts

Type last changed

v2.249.0 · 13 Apr 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_batch as batch } from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_eks as eks } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_ec2 as interfaces_ec2 } from 'aws-cdk-lib/interfaces';

declare const cluster: eks.Cluster;
declare const instanceType: ec2.InstanceType;
declare const launchTemplate: ec2.LaunchTemplate;
declare const machineImage: ec2.IMachineImage;
declare const placementGroupRef: interfaces_ec2.IPlacementGroupRef;
declare const role: iam.Role;
declare const securityGroup: ec2.SecurityGroup;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const vpc: ec2.Vpc;
const managedEc2EksComputeEnvironmentProps: batch.ManagedEc2EksComputeEnvironmentProps = {
  eksCluster: cluster,
  kubernetesNamespace: 'kubernetesNamespace',
  vpc: vpc,

  // the properties below are optional
  allocationStrategy: batch.AllocationStrategy.BEST_FIT,
  computeEnvironmentName: 'computeEnvironmentName',
  defaultInstanceClasses: [batch.DefaultInstanceClass.X86_64],
  enabled: false,
  images: [{
    image: machineImage,
    imageType: batch.EksMachineImageType.EKS_AL2,
  }],
  instanceClasses: [ec2.InstanceClass.STANDARD3],
  instanceRole: role,
  instanceTypes: [instanceType],
  launchTemplate: launchTemplate,
  maxvCpus: 123,
  minvCpus: 123,
  placementGroup: placementGroupRef,
  replaceComputeEnvironment: false,
  securityGroups: [securityGroup],
  serviceRole: role,
  spot: false,
  spotBidPercentage: 123,
  terminateOnUpdate: false,
  updateTimeout: cdk.Duration.minutes(30),
  updateToLatestImageVersion: false,
  useOptimalInstanceClasses: false,
  vpcSubnets: {
    availabilityZones: ['availabilityZones'],
    onePerAz: false,
    subnetFilters: [subnetFilter],
    subnetGroupName: 'subnetGroupName',
    subnets: [subnet],
    subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
  },
};

Properties

allocationStrategy?optionalAllocationStrategyallocation_strategy?optionalAllocationStrategyallocationStrategy?optionalAllocationStrategyAllocationStrategy?optionalAllocationStrategyAllocationStrategy?optionalAllocationStrategy#

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_PRICE_CAPACITY_OPTIMIZED if using Spot instances.

computeEnvironmentName?optionalstringcompute_environment_name?optionalstrcomputeEnvironmentName?optionalStringComputeEnvironmentName?optionalstringComputeEnvironmentName?optional*string#

The name of the ComputeEnvironment.

Default: generated by CloudFormation

defaultInstanceClasses?optionalDefaultInstanceClass[]default_instance_classes?optionaltyping.List[DefaultInstanceClass]defaultInstanceClasses?optionalList<DefaultInstanceClass>DefaultInstanceClasses?optionalDefaultInstanceClass[]DefaultInstanceClasses?optional*[]DefaultInstanceClass#

Use batch's default instance types.

Default: choose from instanceTypes and instanceClasses

A simpler way to choose up-to-date instance classes based on region instead of specifying exact instance classes.

eksClusterIClustereks_clusterIClustereksClusterIClusterEksClusterIClusterEksClusterIClusterrequired#

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

notes

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.

enabled?optionalbooleanenabled?optionalboolenabled?optionalBooleanEnabled?optionalboolEnabled?optional*bool= true#

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

notes

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.

images?optionalEksMachineImage[]images?optionaltyping.List[EksMachineImage]images?optionalList<EksMachineImage>Images?optionalEksMachineImage[]Images?optional*[]EksMachineImage#

Configure which AMIs this Compute Environment can launch.

Default: If imageKubernetesVersion is specified, - EKS_AL2 for non-GPU instances, EKS_AL2_NVIDIA for GPU instances. Otherwise, - ECS_AL2 for non-GPU instances, ECS_AL2_NVIDIA for GPU instances. If the '@aws-cdk/aws-batch:defaultToAL2023' feature flag is set, EKS_AL2023 / ECS_AL2023 will be used instead.

instanceClasses?optionalInstanceClass[]instance_classes?optionaltyping.List[InstanceClass]instanceClasses?optionalList<InstanceClass>InstanceClasses?optionalInstanceClass[]InstanceClasses?optional*[]InstanceClass#

The instance classes that this Compute Environment can launch.

Default: the instances Batch considers will be used (currently C4, M4, and R4)

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

instanceRole?optionalIRoleinstance_role?optionalIRoleinstanceRole?optionalIRoleInstanceRole?optionalIRoleInstanceRole?optionalIRole#

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

Default: a role will be created

instanceTypes?optionalInstanceType[]instance_types?optionaltyping.List[InstanceType]instanceTypes?optionalList<InstanceType>InstanceTypes?optionalInstanceType[]InstanceTypes?optional*[]InstanceType#

The instance types that this Compute Environment can launch.

Default: the instances Batch considers will be used (currently C4, M4, and R4)

Which one is chosen depends on the AllocationStrategy used.

kubernetesNamespacestringkubernetes_namespacestrkubernetesNamespaceStringKubernetesNamespacestringKubernetesNamespace*stringrequired#

The namespace of the Cluster.

launchTemplate?optionalILaunchTemplatelaunch_template?optionalILaunchTemplatelaunchTemplate?optionalILaunchTemplateLaunchTemplate?optionalILaunchTemplateLaunchTemplate?optionalILaunchTemplate#

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

Default: no launch template

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

maxvCpus?optionalnumbermaxv_cpus?optionalint | floatmaxvCpus?optionalNumberMaxvCpus?optionaldoubleMaxvCpus?optional*float64= 256#

The maximum vCpus this `ManagedComputeEnvironment` can scale up to. Each vCPU is equivalent to 1024 CPU shares.

notes

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.

minvCpus?optionalnumberminv_cpus?optionalint | floatminvCpus?optionalNumberMinvCpus?optionaldoubleMinvCpus?optional*float64= 0#

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

placementGroup?optionalIPlacementGroupRefplacement_group?optionalIPlacementGroupRefplacementGroup?optionalIPlacementGroupRefPlacementGroup?optionalIPlacementGroupRefPlacementGroup?optionalIPlacementGroupRef#

The EC2 placement group to associate with your compute resources.

Default: no placement group

notes

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.

replaceComputeEnvironment?optionalbooleanreplace_compute_environment?optionalboolreplaceComputeEnvironment?optionalBooleanReplaceComputeEnvironment?optionalboolReplaceComputeEnvironment?optional*bool= false#

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

notes

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:

securityGroups?optionalISecurityGroup[]security_groups?optionaltyping.List[ISecurityGroup]securityGroups?optionalList<ISecurityGroup>SecurityGroups?optionalISecurityGroup[]SecurityGroups?optional*[]ISecurityGroup#

The security groups this Compute Environment will launch instances in.

Default: new security groups will be created

serviceRole?optionalIRoleservice_role?optionalIRoleserviceRole?optionalIRoleServiceRole?optionalIRoleServiceRole?optionalIRole#

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?optionalbooleanspot?optionalboolspot?optionalBooleanSpot?optionalboolSpot?optional*bool= 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.

spotBidPercentage?optionalnumberspot_bid_percentage?optionalint | floatspotBidPercentage?optionalNumberSpotBidPercentage?optionaldoubleSpotBidPercentage?optional*float64= 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.

notes

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

terminateOnUpdate?optionalbooleanterminate_on_update?optionalboolterminateOnUpdate?optionalBooleanTerminateOnUpdate?optionalboolTerminateOnUpdate?optional*bool= 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.

updateTimeout?optionalDurationupdate_timeout?optionalDurationupdateTimeout?optionalDurationUpdateTimeout?optionalDurationUpdateTimeout?optionalDuration#

Only meaningful if `terminateOnUpdate` is `false`.

Default: 30 minutes

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

updateToLatestImageVersion?optionalbooleanupdate_to_latest_image_version?optionalboolupdateToLatestImageVersion?optionalBooleanUpdateToLatestImageVersion?optionalboolUpdateToLatestImageVersion?optional*bool= 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.

useOptimalInstanceClasses?optionalbooleanuse_optimal_instance_classes?optionalbooluseOptimalInstanceClasses?optionalBooleanUseOptimalInstanceClasses?optionalboolUseOptimalInstanceClasses?optional*bool= 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.

vpcIVpcvpcIVpcvpcIVpcVpcIVpcVpcIVpcrequired#

VPC in which this Compute Environment will launch Instances.

vpcSubnets?optionalSubnetSelectionvpc_subnets?optionalSubnetSelectionvpcSubnets?optionalSubnetSelectionVpcSubnets?optionalSubnetSelectionVpcSubnets?optionalSubnetSelection#

The VPC Subnets this Compute Environment will launch instances in.

Default: new subnets will be created