class ManagedEc2EksComputeEnvironment (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Batch.ManagedEc2EksComputeEnvironment |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#ManagedEc2EksComputeEnvironment |
![]() | software.amazon.awscdk.services.batch.ManagedEc2EksComputeEnvironment |
![]() | aws_cdk.aws_batch.ManagedEc2EksComputeEnvironment |
![]() | aws-cdk-lib » aws_batch » ManagedEc2EksComputeEnvironment |
Implements
IConstruct
, IDependable
, IResource
, IManaged
, ICompute
, IConnectable
, ITaggable
A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.
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';
declare const cluster: eks.Cluster;
declare const instanceType: ec2.InstanceType;
declare const launchTemplate: ec2.LaunchTemplate;
declare const machineImage: ec2.IMachineImage;
declare const placementGroup: ec2.PlacementGroup;
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 managedEc2EksComputeEnvironment = new batch.ManagedEc2EksComputeEnvironment(this, 'MyManagedEc2EksComputeEnvironment', {
eksCluster: cluster,
kubernetesNamespace: 'kubernetesNamespace',
vpc: vpc,
// the properties below are optional
allocationStrategy: batch.AllocationStrategy.BEST_FIT,
computeEnvironmentName: 'computeEnvironmentName',
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: placementGroup,
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,
},
});
Initializer
new ManagedEc2EksComputeEnvironment(scope: Construct, id: string, props: ManagedEc2EksComputeEnvironmentProps)
Parameters
- scope
Construct
- id
string
- props
Managed
Ec2 Eks Compute Environment Props
Construct Props
Name | Type | Description |
---|---|---|
eks | ICluster | The cluster that backs this Compute Environment. Required for Compute Environments running Kubernetes jobs. |
kubernetes | string | The namespace of the Cluster. |
vpc | IVpc | VPC in which this Compute Environment will launch Instances. |
allocation | Allocation | The allocation strategy to use if not enough instances of the best fitting instance type can be allocated. |
compute | string | The name of the ComputeEnvironment. |
enabled? | boolean | Whether or not this ComputeEnvironment can accept jobs from a Queue. |
images? | Eks [] | Configure which AMIs this Compute Environment can launch. |
instance | Instance [] | The instance types that this Compute Environment can launch. |
instance | IRole | The execution Role that instances launched by this Compute Environment will use. |
instance | Instance [] | The instance types that this Compute Environment can launch. |
launch | ILaunch | The Launch Template that this Compute Environment will use to provision EC2 Instances. |
maxv | number | The maximum vCpus this ManagedComputeEnvironment can scale up to. Each vCPU is equivalent to 1024 CPU shares. |
minv | number | The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED. |
placement | IPlacement | The EC2 placement group to associate with your compute resources. |
replace | boolean | Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances. |
security | ISecurity [] | The security groups this Compute Environment will launch instances in. |
service | IRole | The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs. |
spot? | boolean | Whether or not to use spot instances. |
spot | number | 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. |
terminate | boolean | Whether or not any running jobs will be immediately terminated when an infrastructure update occurs. |
update | Duration | Only meaningful if terminateOnUpdate is false . |
update | boolean | Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs. |
use | boolean | Whether or not to use batch's optimal instance type. |
vpc | Subnet | The VPC Subnets this Compute Environment will launch instances in. |
eksCluster
Type:
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.
kubernetesNamespace
Type:
string
The namespace of the Cluster.
vpc
Type:
IVpc
VPC in which this Compute Environment will launch Instances.
allocationStrategy?
Type:
Allocation
(optional, default: BEST_FIT_PROGRESSIVE
if not using Spot instances,
SPOT_CAPACITY_OPTIMIZED
if using Spot instances.)
The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.
computeEnvironmentName?
Type:
string
(optional, default: generated by CloudFormation)
The name of the ComputeEnvironment.
enabled?
Type:
boolean
(optional, default: true)
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
.
images?
Type:
Eks
[]
*(optional, 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,)*
Configure which AMIs this Compute Environment can launch.
instanceClasses?
Type:
Instance
[]
(optional, default: the instances Batch considers will be used (currently C4, M4, and R4))
The instance types that this Compute Environment can launch.
Which one is chosen depends on the AllocationStrategy
used.
Batch will automatically choose the instance size.
instanceRole?
Type:
IRole
(optional, default: a role will be created)
The execution Role that instances launched by this Compute Environment will use.
instanceTypes?
Type:
Instance
[]
(optional, default: the instances Batch considers will be used (currently C4, M4, and R4))
The instance types that this Compute Environment can launch.
Which one is chosen depends on the AllocationStrategy
used.
launchTemplate?
Type:
ILaunch
(optional, default: no 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.
maxvCpus?
Type:
number
(optional, default: 256)
The maximum vCpus this ManagedComputeEnvironment
can scale up to. Each vCPU is equivalent to 1024 CPU shares.
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?
Type:
number
(optional, default: 0)
The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.
placementGroup?
Type:
IPlacement
(optional, 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.
See also: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
replaceComputeEnvironment?
Type:
boolean
(optional, default: false)
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:
securityGroups?
Type:
ISecurity
[]
(optional, default: new security groups will be created)
The security groups this Compute Environment will launch instances in.
serviceRole?
Type:
IRole
(optional, 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.
spot?
Type:
boolean
(optional, 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.
spotBidPercentage?
Type:
number
(optional, 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.
Implies spot == true
if set
terminateOnUpdate?
Type:
boolean
(optional, 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.
updateTimeout?
Type:
Duration
(optional, 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 updateTimeout
has expired.
updateToLatestImageVersion?
Type:
boolean
(optional, default: true)
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.
useOptimalInstanceClasses?
Type:
boolean
(optional, 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.
vpcSubnets?
Type:
Subnet
(optional, default: new subnets will be created)
The VPC Subnets this Compute Environment will launch instances in.
Properties
Name | Type | Description |
---|---|---|
compute | string | The ARN of this compute environment. |
compute | string | The name of the ComputeEnvironment. |
connections | Connections | The network connections associated with this resource. |
eks | ICluster | The cluster that backs this Compute Environment. Required for Compute Environments running Kubernetes jobs. |
enabled | boolean | Whether or not this ComputeEnvironment can accept jobs from a Queue. |
env | Resource | The environment this resource belongs to. |
instance | Instance [] | The instance types that this Compute Environment can launch. |
instance | Instance [] | The instance types that this Compute Environment can launch. |
maxv | number | The maximum vCpus this ManagedComputeEnvironment can scale up to. |
node | Node | The tree node. |
security | ISecurity [] | The security groups this Compute Environment will launch instances in. |
stack | Stack | The stack in which this resource is defined. |
tags | Tag | TagManager to set, remove and format tags. |
allocation | Allocation | The allocation strategy to use if not enough instances of the best fitting instance type can be allocated. |
images? | Eks [] | Configure which AMIs this Compute Environment can launch. |
instance | IRole | The execution Role that instances launched by this Compute Environment will use. |
kubernetes | string | The namespace of the Cluster. |
launch | ILaunch | The Launch Template that this Compute Environment will use to provision EC2 Instances. |
minv | number | The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED. |
placement | IPlacement | The EC2 placement group to associate with your compute resources. |
replace | boolean | Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances. |
service | IRole | The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs. |
spot? | boolean | Whether or not to use spot instances. |
spot | number | 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. |
terminate | boolean | Whether or not any running jobs will be immediately terminated when an infrastructure update occurs. |
update | Duration | Only meaningful if terminateOnUpdate is false . |
update | boolean | Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs. |
computeEnvironmentArn
Type:
string
The ARN of this compute environment.
computeEnvironmentName
Type:
string
The name of the ComputeEnvironment.
connections
Type:
Connections
The network connections associated with this resource.
eksCluster
Type:
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.
enabled
Type:
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 minvCpus
.
To ensure you aren't billed for unused capacity, set minvCpus
to 0
.
env
Type:
Resource
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.
instanceClasses
Type:
Instance
[]
The instance types that this Compute Environment can launch.
Which one is chosen depends on the AllocationStrategy
used.
instanceTypes
Type:
Instance
[]
The instance types that this Compute Environment can launch.
Which one is chosen depends on the AllocationStrategy
used.
maxvCpus
Type:
number
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
.
node
Type:
Node
The tree node.
securityGroups
Type:
ISecurity
[]
The security groups this Compute Environment will launch instances in.
stack
Type:
Stack
The stack in which this resource is defined.
tags
Type:
Tag
TagManager to set, remove and format tags.
allocationStrategy?
Type:
Allocation
(optional)
The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.
images?
Type:
Eks
[]
(optional)
Configure which AMIs this Compute Environment can launch.
instanceRole?
Type:
IRole
(optional)
The execution Role that instances launched by this Compute Environment will use.
kubernetesNamespace?
Type:
string
(optional)
The namespace of the Cluster.
Cannot be 'default', start with 'kube-', or be longer than 64 characters.
launchTemplate?
Type:
ILaunch
(optional)
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.
minvCpus?
Type:
number
(optional)
The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.
placementGroup?
Type:
IPlacement
(optional)
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.
replaceComputeEnvironment?
Type:
boolean
(optional)
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:
serviceRole?
Type:
IRole
(optional)
The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.
spot?
Type:
boolean
(optional)
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?
Type:
number
(optional)
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
terminateOnUpdate?
Type:
boolean
(optional)
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?
Type:
Duration
(optional)
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.
updateToLatestImageVersion?
Type:
boolean
(optional)
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.
Methods
Name | Description |
---|---|
add | Add an instance class to this compute environment. |
add | Add an instance type to this compute environment. |
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
addInstanceClass(instanceClass)
public addInstanceClass(instanceClass: InstanceClass): void
Parameters
- instanceClass
Instance
Class
Add an instance class to this compute environment.
addInstanceType(instanceType)
public addInstanceType(instanceType: InstanceType): void
Parameters
- instanceType
Instance
Type
Add an instance type to this compute environment.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
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
).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.