Package software.amazon.awscdk.services.batch

Class CfnComputeEnvironment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.batch.CfnComputeEnvironment
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-12-27T17:01:57.723Z") @Stability(Stable) public class CfnComputeEnvironment extends CfnResource implements IInspectable, ITaggable
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:

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.services.batch.*;
 CfnComputeEnvironment cfnComputeEnvironment = CfnComputeEnvironment.Builder.create(this, "MyCfnComputeEnvironment")
         .type("type")
         // the properties below are optional
         .computeEnvironmentName("computeEnvironmentName")
         .computeResources(ComputeResourcesProperty.builder()
                 .maxvCpus(123)
                 .subnets(List.of("subnets"))
                 .type("type")
                 // the properties below are optional
                 .allocationStrategy("allocationStrategy")
                 .bidPercentage(123)
                 .desiredvCpus(123)
                 .ec2Configuration(List.of(Ec2ConfigurationObjectProperty.builder()
                         .imageType("imageType")
                         // the properties below are optional
                         .imageIdOverride("imageIdOverride")
                         .imageKubernetesVersion("imageKubernetesVersion")
                         .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"))
                                 .version("version")
                                 .build()))
                         .version("version")
                         .build())
                 .minvCpus(123)
                 .placementGroup("placementGroup")
                 .securityGroupIds(List.of("securityGroupIds"))
                 .spotIamFleetRole("spotIamFleetRole")
                 .tags(Map.of(
                         "tagsKey", "tags"))
                 .updateToLatestImageVersion(false)
                 .build())
         .context("context")
         .eksConfiguration(EksConfigurationProperty.builder()
                 .eksClusterArn("eksClusterArn")
                 .kubernetesNamespace("kubernetesNamespace")
                 .build())
         .replaceComputeEnvironment(false)
         .serviceRole("serviceRole")
         .state("state")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .unmanagedvCpus(123)
         .updatePolicy(UpdatePolicyProperty.builder()
                 .jobExecutionTimeoutMinutes(123)
                 .terminateJobsOnUpdate(false)
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnComputeEnvironment

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

    • CfnComputeEnvironment

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

    • CfnComputeEnvironment

      @Stability(Stable) public CfnComputeEnvironment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnComputeEnvironmentProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrComputeEnvironmentArn

      @Stability(Stable) @NotNull public String getAttrComputeEnvironmentArn()
      Returns the compute environment ARN, such as batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName* .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of the compute environment: MANAGED or UNMANAGED .

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of the compute environment: MANAGED or UNMANAGED .

    • getComputeEnvironmentName

      @Stability(Stable) @Nullable public String getComputeEnvironmentName()
      The name for your compute environment.

    • setComputeEnvironmentName

      @Stability(Stable) public void setComputeEnvironmentName(@Nullable String value)
      The name for your compute environment.

    • getComputeResources

      @Stability(Stable) @Nullable public Object getComputeResources()
      The ComputeResources property type specifies details of the compute resources managed by the compute environment.

    • setComputeResources

      @Stability(Stable) public void setComputeResources(@Nullable IResolvable value)
      The ComputeResources property type specifies details of the compute resources managed by the compute environment.

    • setComputeResources

      @Stability(Stable) public void setComputeResources(@Nullable CfnComputeEnvironment.ComputeResourcesProperty value)
      The ComputeResources property type specifies details of the compute resources managed by the compute environment.

    • getContext

      @Stability(Stable) @Nullable public String getContext()
      Reserved.

    • setContext

      @Stability(Stable) public void setContext(@Nullable String value)
      Reserved.

    • getEksConfiguration

      @Stability(Stable) @Nullable public Object getEksConfiguration()
      The details for the Amazon EKS cluster that supports the compute environment.

    • setEksConfiguration

      @Stability(Stable) public void setEksConfiguration(@Nullable IResolvable value)
      The details for the Amazon EKS cluster that supports the compute environment.

    • setEksConfiguration

      @Stability(Stable) public void setEksConfiguration(@Nullable CfnComputeEnvironment.EksConfigurationProperty value)
      The details for the Amazon EKS cluster that supports the compute environment.

    • getReplaceComputeEnvironment

      @Stability(Stable) @Nullable public Object getReplaceComputeEnvironment()
      Specifies whether the compute environment is replaced if an update is made that requires replacing the instances in the compute environment.

    • setReplaceComputeEnvironment

      @Stability(Stable) public void setReplaceComputeEnvironment(@Nullable Boolean value)
      Specifies whether the compute environment is replaced if an update is made that requires replacing the instances in the compute environment.

    • setReplaceComputeEnvironment

      @Stability(Stable) public void setReplaceComputeEnvironment(@Nullable IResolvable value)
      Specifies whether the compute environment is replaced if an update is made that requires replacing the instances in the compute environment.

    • getServiceRole

      @Stability(Stable) @Nullable public String getServiceRole()
      The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

    • setServiceRole

      @Stability(Stable) public void setServiceRole(@Nullable String value)
      The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

    • getState

      @Stability(Stable) @Nullable public String getState()
      The state of the compute environment.

    • setState

      @Stability(Stable) public void setState(@Nullable String value)
      The state of the compute environment.

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      The tags applied to the compute environment.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      The tags applied to the compute environment.

    • getUnmanagedvCpus

      @Stability(Stable) @Nullable public Number getUnmanagedvCpus()
      The maximum number of vCPUs for an unmanaged compute environment.

    • setUnmanagedvCpus

      @Stability(Stable) public void setUnmanagedvCpus(@Nullable Number value)
      The maximum number of vCPUs for an unmanaged compute environment.

    • getUpdatePolicy

      @Stability(Stable) @Nullable public Object getUpdatePolicy()
      Specifies the infrastructure update policy for the compute environment.

    • setUpdatePolicy

      @Stability(Stable) public void setUpdatePolicy(@Nullable IResolvable value)
      Specifies the infrastructure update policy for the compute environment.

    • setUpdatePolicy

      @Stability(Stable) public void setUpdatePolicy(@Nullable CfnComputeEnvironment.UpdatePolicyProperty value)
      Specifies the infrastructure update policy for the compute environment.