ManagedEc2EcsComputeEnvironmentProps Struct
Props for a ManagedEc2EcsComputeEnvironment.
Example
declare const vpc: ec2.IVpc;
const computeEnv = new batch.ManagedEc2EcsComputeEnvironment(this, 'Ec2ComputeEnv', {
vpc,
instanceTypes: [ec2.InstanceType.of(ec2.InstanceClass.M5AD, ec2.InstanceSize.LARGE)],
// useOptimalInstanceClasses: true (default)
});
// Result: ['m5ad.large', 'optimal']
Properties
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.
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.
imagesoptionalEcsMachineImage[]imagesoptionaltyping.List[EcsMachineImage]imagesoptionalList<EcsMachineImage>ImagesoptionalEcsMachineImage[]Imagesoptional*[]EcsMachineImage#Default: ECS_AL2 for non-GPU instances, ECS_AL2_NVIDIA for GPU instances. If the '@aws-cdk/aws-batch:defaultToAL2023' feature flag is set, ECS_AL2023 will be used instead of ECS_AL2.
notes
If you specify this property with only image specified, then the imageType will default to ECS_AL2 (or ECS_AL2023 if the @aws-cdk/aws-batch:defaultToAL2023 feature flag is set). If your image needs GPU resources, specify ECS_AL2_NVIDIA or ECS_AL2023_NVIDIA; otherwise, the instances will not be able to properly join the ComputeEnvironment.
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.
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
spotFleetRoleoptionalIRolespot_fleet_roleoptionalIRolespotFleetRoleoptionalIRoleSpotFleetRoleoptionalIRoleSpotFleetRoleoptionalIRole#Default: a new role will be created
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