ManagedEc2EksComputeEnvironment L2 construct
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';
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 managedEc2EksComputeEnvironment = new batch.ManagedEc2EksComputeEnvironment(this, 'MyManagedEc2EksComputeEnvironment', {
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,
},
});
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_batch as batch
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_eks as eks
from aws_cdk import aws_iam as iam
from aws_cdk.interfaces import aws_ec2 as interfaces_ec2
# cluster: eks.Cluster
# instance_type: ec2.InstanceType
# launch_template: ec2.LaunchTemplate
# machine_image: ec2.IMachineImage
# placement_group_ref: interfaces_ec2.IPlacementGroupRef
# role: iam.Role
# security_group: ec2.SecurityGroup
# subnet: ec2.Subnet
# subnet_filter: ec2.SubnetFilter
# vpc: ec2.Vpc
managed_ec2_eks_compute_environment = batch.ManagedEc2EksComputeEnvironment(self, "MyManagedEc2EksComputeEnvironment",
eks_cluster=cluster,
kubernetes_namespace="kubernetesNamespace",
vpc=vpc,
# the properties below are optional
allocation_strategy=batch.AllocationStrategy.BEST_FIT,
compute_environment_name="computeEnvironmentName",
default_instance_classes=[batch.DefaultInstanceClass.X86_64],
enabled=False,
images=[batch.EksMachineImage(
image=machine_image,
image_type=batch.EksMachineImageType.EKS_AL2
)],
instance_classes=[ec2.InstanceClass.STANDARD3],
instance_role=role,
instance_types=[instance_type],
launch_template=launch_template,
maxv_cpus=123,
minv_cpus=123,
placement_group=placement_group_ref,
replace_compute_environment=False,
security_groups=[security_group],
service_role=role,
spot=False,
spot_bid_percentage=123,
terminate_on_update=False,
update_timeout=cdk.Duration.minutes(30),
update_to_latest_image_version=False,
use_optimal_instance_classes=False,
vpc_subnets=ec2.SubnetSelection(
availability_zones=["availabilityZones"],
one_per_az=False,
subnet_filters=[subnet_filter],
subnet_group_name="subnetGroupName",
subnets=[subnet],
subnet_type=ec2.SubnetType.PRIVATE_ISOLATED
)
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.batch.*;
import software.amazon.awscdk.services.ec2.*;
import software.amazon.awscdk.services.eks.*;
import software.amazon.awscdk.services.iam.*;
import software.amazon.awscdk.interfaces.ec2.*;
Cluster cluster;
InstanceType instanceType;
LaunchTemplate launchTemplate;
IMachineImage machineImage;
IPlacementGroupRef placementGroupRef;
Role role;
SecurityGroup securityGroup;
Subnet subnet;
SubnetFilter subnetFilter;
Vpc vpc;
ManagedEc2EksComputeEnvironment managedEc2EksComputeEnvironment = ManagedEc2EksComputeEnvironment.Builder.create(this, "MyManagedEc2EksComputeEnvironment")
.eksCluster(cluster)
.kubernetesNamespace("kubernetesNamespace")
.vpc(vpc)
// the properties below are optional
.allocationStrategy(AllocationStrategy.BEST_FIT)
.computeEnvironmentName("computeEnvironmentName")
.defaultInstanceClasses(List.of(DefaultInstanceClass.X86_64))
.enabled(false)
.images(List.of(EksMachineImage.builder()
.image(machineImage)
.imageType(EksMachineImageType.EKS_AL2)
.build()))
.instanceClasses(List.of(InstanceClass.STANDARD3))
.instanceRole(role)
.instanceTypes(List.of(instanceType))
.launchTemplate(launchTemplate)
.maxvCpus(123)
.minvCpus(123)
.placementGroup(placementGroupRef)
.replaceComputeEnvironment(false)
.securityGroups(List.of(securityGroup))
.serviceRole(role)
.spot(false)
.spotBidPercentage(123)
.terminateOnUpdate(false)
.updateTimeout(Duration.minutes(30))
.updateToLatestImageVersion(false)
.useOptimalInstanceClasses(false)
.vpcSubnets(SubnetSelection.builder()
.availabilityZones(List.of("availabilityZones"))
.onePerAz(false)
.subnetFilters(List.of(subnetFilter))
.subnetGroupName("subnetGroupName")
.subnets(List.of(subnet))
.subnetType(SubnetType.PRIVATE_ISOLATED)
.build())
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.Batch;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.EKS;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.Interfaces.EC2;
Cluster cluster;
InstanceType instanceType;
LaunchTemplate launchTemplate;
IMachineImage machineImage;
IPlacementGroupRef placementGroupRef;
Role role;
SecurityGroup securityGroup;
Subnet subnet;
SubnetFilter subnetFilter;
Vpc vpc;
var managedEc2EksComputeEnvironment = new ManagedEc2EksComputeEnvironment(this, "MyManagedEc2EksComputeEnvironment", new ManagedEc2EksComputeEnvironmentProps {
EksCluster = cluster,
KubernetesNamespace = "kubernetesNamespace",
Vpc = vpc,
// the properties below are optional
AllocationStrategy = AllocationStrategy.BEST_FIT,
ComputeEnvironmentName = "computeEnvironmentName",
DefaultInstanceClasses = new [] { DefaultInstanceClass.X86_64 },
Enabled = false,
Images = new [] { new EksMachineImage {
Image = machineImage,
ImageType = EksMachineImageType.EKS_AL2
} },
InstanceClasses = new [] { InstanceClass.STANDARD3 },
InstanceRole = role,
InstanceTypes = new [] { instanceType },
LaunchTemplate = launchTemplate,
MaxvCpus = 123,
MinvCpus = 123,
PlacementGroup = placementGroupRef,
ReplaceComputeEnvironment = false,
SecurityGroups = new [] { securityGroup },
ServiceRole = role,
Spot = false,
SpotBidPercentage = 123,
TerminateOnUpdate = false,
UpdateTimeout = Duration.Minutes(30),
UpdateToLatestImageVersion = false,
UseOptimalInstanceClasses = false,
VpcSubnets = new SubnetSelection {
AvailabilityZones = new [] { "availabilityZones" },
OnePerAz = false,
SubnetFilters = new [] { subnetFilter },
SubnetGroupName = "subnetGroupName",
Subnets = new [] { subnet },
SubnetType = SubnetType.PRIVATE_ISOLATED
}
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var cluster Cluster
var instanceType InstanceType
var launchTemplate LaunchTemplate
var machineImage IMachineImage
var placementGroupRef IPlacementGroupRef
var role Role
var securityGroup SecurityGroup
var subnet Subnet
var subnetFilter SubnetFilter
var vpc Vpc
managedEc2EksComputeEnvironment := awscdk.Aws_batch.NewManagedEc2EksComputeEnvironment(this, jsii.String("MyManagedEc2EksComputeEnvironment"), &ManagedEc2EksComputeEnvironmentProps{
EksCluster: cluster,
KubernetesNamespace: jsii.String("kubernetesNamespace"),
Vpc: vpc,
// the properties below are optional
AllocationStrategy: awscdk.*Aws_batch.AllocationStrategy_BEST_FIT,
ComputeEnvironmentName: jsii.String("computeEnvironmentName"),
DefaultInstanceClasses: []DefaultInstanceClass{
awscdk.*Aws_batch.DefaultInstanceClass_X86_64,
},
Enabled: jsii.Boolean(false),
Images: []EksMachineImage{
&EksMachineImage{
Image: machineImage,
ImageType: awscdk.*Aws_batch.EksMachineImageType_EKS_AL2,
},
},
InstanceClasses: []InstanceClass{
awscdk.Aws_ec2.InstanceClass_STANDARD3,
},
InstanceRole: role,
InstanceTypes: []InstanceType{
instanceType,
},
LaunchTemplate: launchTemplate,
MaxvCpus: jsii.Number(123),
MinvCpus: jsii.Number(123),
PlacementGroup: placementGroupRef,
ReplaceComputeEnvironment: jsii.Boolean(false),
SecurityGroups: []ISecurityGroup{
securityGroup,
},
ServiceRole: role,
Spot: jsii.Boolean(false),
SpotBidPercentage: jsii.Number(123),
TerminateOnUpdate: jsii.Boolean(false),
UpdateTimeout: cdk.Duration_Minutes(jsii.Number(30)),
UpdateToLatestImageVersion: jsii.Boolean(false),
UseOptimalInstanceClasses: jsii.Boolean(false),
VpcSubnets: &SubnetSelection{
AvailabilityZones: []*string{
jsii.String("availabilityZones"),
},
OnePerAz: jsii.Boolean(false),
SubnetFilters: []SubnetFilter{
subnetFilter,
},
SubnetGroupName: jsii.String("subnetGroupName"),
Subnets: []ISubnet{
subnet,
},
SubnetType: awscdk.*Aws_ec2.SubnetType_PRIVATE_ISOLATED,
},
})
Initializer
new ManagedEc2EksComputeEnvironment(scope: Construct, id: string, props: ManagedEc2EksComputeEnvironmentProps)
ManagedEc2EksComputeEnvironment(scope: Construct, id: str, props: ManagedEc2EksComputeEnvironmentProps)
new ManagedEc2EksComputeEnvironment(Construct scope, String id, ManagedEc2EksComputeEnvironmentProps props)
new ManagedEc2EksComputeEnvironment(Construct scope, string id, ManagedEc2EksComputeEnvironmentProps props)
NewManagedEc2EksComputeEnvironment(Scope Construct, Id *string, Props ManagedEc2EksComputeEnvironmentProps)
Construct Props
allocationStrategyoptionalAllocationStrategyallocation_strategyoptionalAllocationStrategyallocationStrategyoptionalAllocationStrategyAllocationStrategyoptionalAllocationStrategyAllocationStrategyoptionalAllocationStrategy#Default: BEST_FIT_PROGRESSIVE if not using Spot instances, SPOT_PRICE_CAPACITY_OPTIMIZED if using Spot instances.
computeEnvironmentNameoptionalstringcompute_environment_nameoptionalstrcomputeEnvironmentNameoptionalStringComputeEnvironmentNameoptionalstringComputeEnvironmentNameoptional*string#Default: generated by CloudFormation
defaultInstanceClassesoptionalDefaultInstanceClass[]default_instance_classesoptionaltyping.List[DefaultInstanceClass]defaultInstanceClassesoptionalList<DefaultInstanceClass>DefaultInstanceClassesoptionalDefaultInstanceClass[]DefaultInstanceClassesoptional*[]DefaultInstanceClass#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#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.
enabledoptionalbooleanenabledoptionalboolenabledoptionalBooleanEnabledoptionalboolEnabledoptional*bool= true#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.
imagesoptionalEksMachineImage[]imagesoptionaltyping.List[EksMachineImage]imagesoptionalList<EksMachineImage>ImagesoptionalEksMachineImage[]Imagesoptional*[]EksMachineImage#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.
instanceClassesoptionalInstanceClass[]instance_classesoptionaltyping.List[InstanceClass]instanceClassesoptionalList<InstanceClass>InstanceClassesoptionalInstanceClass[]InstanceClassesoptional*[]InstanceClass#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.
instanceRoleoptionalIRoleinstance_roleoptionalIRoleinstanceRoleoptionalIRoleInstanceRoleoptionalIRoleInstanceRoleoptionalIRole#Default: a role will be created
instanceTypesoptionalInstanceType[]instance_typesoptionaltyping.List[InstanceType]instanceTypesoptionalList<InstanceType>InstanceTypesoptionalInstanceType[]InstanceTypesoptional*[]InstanceType#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#launchTemplateoptionalILaunchTemplatelaunch_templateoptionalILaunchTemplatelaunchTemplateoptionalILaunchTemplateLaunchTemplateoptionalILaunchTemplateLaunchTemplateoptionalILaunchTemplate#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.
maxvCpusoptionalnumbermaxv_cpusoptionalint | floatmaxvCpusoptionalNumberMaxvCpusoptionaldoubleMaxvCpusoptional*float64= 256#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.
minvCpusoptionalnumberminv_cpusoptionalint | floatminvCpusoptionalNumberMinvCpusoptionaldoubleMinvCpusoptional*float64= 0#placementGroupoptionalIPlacementGroupRefplacement_groupoptionalIPlacementGroupRefplacementGroupoptionalIPlacementGroupRefPlacementGroupoptionalIPlacementGroupRefPlacementGroupoptionalIPlacementGroupRef#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.
replaceComputeEnvironmentoptionalbooleanreplace_compute_environmentoptionalboolreplaceComputeEnvironmentoptionalBooleanReplaceComputeEnvironmentoptionalboolReplaceComputeEnvironmentoptional*bool= false#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:
securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup#Default: new security groups will be created
serviceRoleoptionalIRoleservice_roleoptionalIRoleserviceRoleoptionalIRoleServiceRoleoptionalIRoleServiceRoleoptionalIRole#Default: a serviceRole will be created for managed CEs, none for unmanaged CEs
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.
spotBidPercentageoptionalnumberspot_bid_percentageoptionalint | floatspotBidPercentageoptionalNumberSpotBidPercentageoptionaldoubleSpotBidPercentageoptional*float64= 100%#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
terminateOnUpdateoptionalbooleanterminate_on_updateoptionalboolterminateOnUpdateoptionalBooleanTerminateOnUpdateoptionalboolTerminateOnUpdateoptional*bool= false#If this is enabled, any terminated jobs may be retried, depending on the job's retry policy.
updateTimeoutoptionalDurationupdate_timeoutoptionalDurationupdateTimeoutoptionalDurationUpdateTimeoutoptionalDurationUpdateTimeoutoptionalDuration#Default: 30 minutes
If so, when an infrastructure update is triggered, any running jobs will be allowed to run until updateTimeout has expired.
updateToLatestImageVersionoptionalbooleanupdate_to_latest_image_versionoptionalboolupdateToLatestImageVersionoptionalBooleanUpdateToLatestImageVersionoptionalboolUpdateToLatestImageVersionoptional*bool= false#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.
useOptimalInstanceClassesoptionalbooleanuse_optimal_instance_classesoptionalbooluseOptimalInstanceClassesoptionalBooleanUseOptimalInstanceClassesoptionalboolUseOptimalInstanceClassesoptional*bool= true#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.
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection#Default: new subnets will be created
Properties
allocationStrategymay be undefinedAllocationStrategyallocation_strategymay be undefinedAllocationStrategyallocationStrategymay be undefinedAllocationStrategyAllocationStrategymay be undefinedAllocationStrategyAllocationStrategymay be undefinedAllocationStrategy#computeEnvironmentArnstringcompute_environment_arnstrcomputeEnvironmentArnStringComputeEnvironmentArnstringComputeEnvironmentArn*string#computeEnvironmentNamestringcompute_environment_namestrcomputeEnvironmentNameStringComputeEnvironmentNamestringComputeEnvironmentName*string#computeEnvironmentRefComputeEnvironmentReferencecompute_environment_refComputeEnvironmentReferencecomputeEnvironmentRefComputeEnvironmentReferenceComputeEnvironmentRefComputeEnvironmentReferenceComputeEnvironmentRefComputeEnvironmentReference#connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnections#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.
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.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#notes
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.
imagesmay be undefinedEksMachineImage[]imagesmay be undefinedtyping.List[EksMachineImage]imagesmay be undefinedList<EksMachineImage>Imagesmay be undefinedEksMachineImage[]Imagesmay be undefined*[]EksMachineImage#instanceClassesInstanceClass[]instance_classestyping.List[InstanceClass]instanceClassesList<InstanceClass>InstanceClassesInstanceClass[]InstanceClasses*[]InstanceClass#Which one is chosen depends on the AllocationStrategy used.
instanceRolemay be undefinedIRoleinstance_rolemay be undefinedIRoleinstanceRolemay be undefinedIRoleInstanceRolemay be undefinedIRoleInstanceRolemay be undefinedIRole#instanceTypesInstanceType[]instance_typestyping.List[InstanceType]instanceTypesList<InstanceType>InstanceTypesInstanceType[]InstanceTypes*[]InstanceType#Which one is chosen depends on the AllocationStrategy used.
kubernetesNamespacemay be undefinedstringkubernetes_namespacemay be undefinedstrkubernetesNamespacemay be undefinedStringKubernetesNamespacemay be undefinedstringKubernetesNamespacemay be undefined*string#Cannot be 'default', start with 'kube-', or be longer than 64 characters.
launchTemplatemay be undefinedILaunchTemplatelaunch_templatemay be undefinedILaunchTemplatelaunchTemplatemay be undefinedILaunchTemplateLaunchTemplatemay be undefinedILaunchTemplateLaunchTemplatemay be undefinedILaunchTemplate#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.
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.
minvCpusmay be undefinednumberminv_cpusmay be undefinedint | floatminvCpusmay be undefinedNumberMinvCpusmay be undefineddoubleMinvCpusmay be undefined*float64#placementGroupmay be undefinedIPlacementGroupplacement_groupmay be undefinedIPlacementGroupplacementGroupmay be undefinedIPlacementGroupPlacementGroupmay be undefinedIPlacementGroupPlacementGroupmay be undefinedIPlacementGroup#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.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#replaceComputeEnvironmentmay be undefinedbooleanreplace_compute_environmentmay be undefinedboolreplaceComputeEnvironmentmay be undefinedBooleanReplaceComputeEnvironmentmay be undefinedboolReplaceComputeEnvironmentmay be undefined*bool#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:
securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup#serviceRolemay be undefinedIRoleservice_rolemay be undefinedIRoleserviceRolemay be undefinedIRoleServiceRolemay be undefinedIRoleServiceRolemay be undefinedIRole#spotmay be undefinedbooleanspotmay be undefinedboolspotmay be undefinedBooleanSpotmay be undefinedboolSpotmay be undefined*bool#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.
spotBidPercentagemay be undefinednumberspot_bid_percentagemay be undefinedint | floatspotBidPercentagemay be undefinedNumberSpotBidPercentagemay be undefineddoubleSpotBidPercentagemay be undefined*float64#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
terminateOnUpdatemay be undefinedbooleanterminate_on_updatemay be undefinedboolterminateOnUpdatemay be undefinedBooleanTerminateOnUpdatemay be undefinedboolTerminateOnUpdatemay be undefined*bool#If this is enabled, any terminated jobs may be retried, depending on the job's retry policy.
updateTimeoutmay be undefinedDurationupdate_timeoutmay be undefinedDurationupdateTimeoutmay be undefinedDurationUpdateTimeoutmay be undefinedDurationUpdateTimeoutmay be undefinedDuration#If so, when an infrastructure update is triggered, any running jobs will be allowed to run until updateTimeout has expired.
updateToLatestImageVersionmay be undefinedbooleanupdate_to_latest_image_versionmay be undefinedboolupdateToLatestImageVersionmay be undefinedBooleanUpdateToLatestImageVersionmay be undefinedboolUpdateToLatestImageVersionmay be undefined*bool#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
addInstanceClass(instanceClass: InstanceClass): voiddef add_instance_class(self, instance_class: InstanceClass) -> Nonepublic void addInstanceClass(InstanceClass instanceClass)public void AddInstanceClass(InstanceClass instanceClass)func AddInstanceClass(InstanceClass InstanceClass)#addInstanceType(instanceType: InstanceType): voiddef add_instance_type(self, instance_type: InstanceType) -> Nonepublic void addInstanceType(InstanceType instanceType)public void AddInstanceType(InstanceType instanceType)func AddInstanceType(InstanceType InstanceType)#applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
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
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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.