Package software.amazon.awscdk.cfnpropertymixins.services.batch

Class CfnComputeEnvironmentPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.batch.CfnComputeEnvironmentPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.304Z")
@Stability(Stable)
public class CfnComputeEnvironmentPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::Batch::ComputeEnvironment resource defines your AWS Batch compute environment.

You can define MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources. UNMANAGED compute environments can only use EC2 resources. For more information, see Compute Environments in the ** .

In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. You can choose either to use EC2 On-Demand Instances and EC2 Spot Instances, or to use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price.

Multi-node parallel jobs are not supported on Spot Instances.

In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMI. However, you need to verify that your AMI meets the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide . After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide .

To create a compute environment that uses EKS resources, the caller must have permissions to call eks:DescribeCluster . > AWS Batch doesn't upgrade the AMIs in a compute environment after it's created except under specific conditions. For example, it doesn't automatically update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your AWS Batch jobs. The original method is to complete these steps:

• Create a new compute environment with the new AMI.
• Add the compute environment to an existing job queue.
• Remove the earlier compute environment from your job queue.
• Delete the earlier compute environment.

In April 2022, AWS Batch added enhanced support for updating compute environments. For example, the UpdateComputeEnvironent API lets you use the ReplaceComputeEnvironment property to dynamically update compute environment parameters such as the launch template or instance type without replacement. For more information, see Updating compute environments in the AWS Batch User Guide .

To use the enhanced updating of compute environments to update AMIs, follow these rules:

• Either do not set the ServiceRole property or set it to the AWSServiceRoleForBatch service-linked role.
• Set the AllocationStrategy property to BEST_FIT_PROGRESSIVE or SPOT_CAPACITY_OPTIMIZED .
• Set the ReplaceComputeEnvironment property to false .

Set the ReplaceComputeEnvironment property to true if the compute environment uses the BEST_FIT allocation strategy. > If the ReplaceComputeEnvironment property is set to false , you might receive an error message when you update the CFN template for a compute environment. This issue occurs if the updated desiredvcpus value is less than the current desiredvcpus value. As a workaround, delete the desiredvcpus value from the updated template or use the minvcpus property to manage the number of vCPUs. For information, see Error message when you update the DesiredvCpus setting .

• Set the UpdateToLatestImageVersion property to true . This property is used when you update a compute environment. The UpdateToLatestImageVersion property is ignored when you create a compute environment.
• Either do not specify an image ID in ImageId or ImageIdOverride properties, or in the launch template identified by the Launch Template property. In that case AWS Batch will select the latest Amazon ECS optimized AMI supported by AWS Batch at the time the infrastructure update is initiated. Alternatively you can specify the AMI ID in the ImageId or ImageIdOverride properties, or the launch template identified by the LaunchTemplate properties. Changing any of these properties will trigger an infrastructure update.

If these rules are followed, any update that triggers an infrastructure update will cause the AMI ID to be re-selected. If the Version property of the LaunchTemplateSpecification is set to $Latest or $Default , the latest or default version of the launch template will be evaluated up at the time of the infrastructure update, even if the LaunchTemplateSpecification was not updated.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.batch.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnComputeEnvironmentPropsMixin cfnComputeEnvironmentPropsMixin = CfnComputeEnvironmentPropsMixin.Builder.create(CfnComputeEnvironmentMixinProps.builder()
         .computeEnvironmentName("computeEnvironmentName")
         .computeResources(ComputeResourcesProperty.builder()
                 .allocationStrategy("allocationStrategy")
                 .bidPercentage(123)
                 .desiredvCpus(123)
                 .ec2Configuration(List.of(Ec2ConfigurationObjectProperty.builder()
                         .imageIdOverride("imageIdOverride")
                         .imageKubernetesVersion("imageKubernetesVersion")
                         .imageType("imageType")
                         .build()))
                 .ec2KeyPair("ec2KeyPair")
                 .imageId("imageId")
                 .instanceRole("instanceRole")
                 .instanceTypes(List.of("instanceTypes"))
                 .launchTemplate(LaunchTemplateSpecificationProperty.builder()
                         .launchTemplateId("launchTemplateId")
                         .launchTemplateName("launchTemplateName")
                         .overrides(List.of(LaunchTemplateSpecificationOverrideProperty.builder()
                                 .launchTemplateId("launchTemplateId")
                                 .launchTemplateName("launchTemplateName")
                                 .targetInstanceTypes(List.of("targetInstanceTypes"))
                                 .userdataType("userdataType")
                                 .version("version")
                                 .build()))
                         .userdataType("userdataType")
                         .version("version")
                         .build())
                 .maxvCpus(123)
                 .minvCpus(123)
                 .placementGroup("placementGroup")
                 .scalingPolicy(ComputeScalingPolicyProperty.builder()
                         .minScaleDownDelayMinutes(123)
                         .build())
                 .securityGroupIds(List.of("securityGroupIds"))
                 .spotIamFleetRole("spotIamFleetRole")
                 .subnets(List.of("subnets"))
                 .tags(Map.of(
                         "tagsKey", "tags"))
                 .type("type")
                 .updateToLatestImageVersion(false)
                 .build())
         .context("context")
         .eksConfiguration(EksConfigurationProperty.builder()
                 .eksClusterArn("eksClusterArn")
                 .kubernetesNamespace("kubernetesNamespace")
                 .build())
         .replaceComputeEnvironment(false)
         .serviceRole("serviceRole")
         .state("state")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .type("type")
         .unmanagedvCpus(123)
         .updatePolicy(UpdatePolicyProperty.builder()
                 .jobExecutionTimeoutMinutes(123)
                 .terminateJobsOnUpdate(false)
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnComputeEnvironmentPropsMixin.Builder	A fluent builder for CfnComputeEnvironmentPropsMixin.
static interface	CfnComputeEnvironmentPropsMixin.ComputeResourcesProperty	Details about the compute resources managed by the compute environment.
static interface	CfnComputeEnvironmentPropsMixin.ComputeScalingPolicyProperty	Example:
static interface	CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty	Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment.
static interface	CfnComputeEnvironmentPropsMixin.EksConfigurationProperty	Configuration for the Amazon EKS cluster that supports the AWS Batch compute environment.
static interface	CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty	An object that represents a launch template to use in place of the default launch template.
static interface	CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty	An object that represents a launch template that's associated with a compute resource.
static interface	CfnComputeEnvironmentPropsMixin.UpdatePolicyProperty	Specifies the infrastructure update policy for the Amazon EC2 compute environment.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnComputeEnvironmentPropsMixin(CfnComputeEnvironmentMixinProps props)	Create a mixin to apply properties to AWS::Batch::ComputeEnvironment.
	CfnComputeEnvironmentPropsMixin(CfnComputeEnvironmentMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Batch::ComputeEnvironment.
protected	CfnComputeEnvironmentPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnComputeEnvironmentPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnComputeEnvironmentMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnComputeEnvironmentPropsMixin

protected CfnComputeEnvironmentPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnComputeEnvironmentPropsMixin

protected CfnComputeEnvironmentPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnComputeEnvironmentPropsMixin

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin(@NotNull
 CfnComputeEnvironmentMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Batch::ComputeEnvironment.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnComputeEnvironmentPropsMixin

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin(@NotNull
 CfnComputeEnvironmentMixinProps props)

Create a mixin to apply properties to AWS::Batch::ComputeEnvironment.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnComputeEnvironmentMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()