Package software.amazon.awscdk.services.batch

Interface IManagedComputeEnvironment

All Superinterfaces:
IComputeEnvironment, IConnectable, software.constructs.IConstruct, software.constructs.IDependable, IResource, ITaggable, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IFargateComputeEnvironment, IFargateComputeEnvironment.Jsii$Default, IManagedComputeEnvironment.Jsii$Default, IManagedEc2EcsComputeEnvironment, IManagedEc2EcsComputeEnvironment.Jsii$Default
All Known Implementing Classes:
FargateComputeEnvironment, IFargateComputeEnvironment.Jsii$Proxy, IManagedComputeEnvironment.Jsii$Proxy, IManagedEc2EcsComputeEnvironment.Jsii$Proxy, ManagedEc2EcsComputeEnvironment, ManagedEc2EksComputeEnvironment
@Generated(value="jsii-pacmak/1.102.0 (build e354887)", date="2024-08-29T22:54:14.957Z") @Stability(Stable) public interface IManagedComputeEnvironment extends software.amazon.jsii.JsiiSerializable, IComputeEnvironment, IConnectable, ITaggable
Represents a Managed ComputeEnvironment.

Batch will provision EC2 Instances to meet the requirements of the jobs executing in this ComputeEnvironment.

  • Method Details

    • getMaxvCpus

      @Stability(Stable) @NotNull Number getMaxvCpus()
      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.

    • getSecurityGroups

      @Stability(Stable) @NotNull List<ISecurityGroup> getSecurityGroups()
      The security groups this Compute Environment will launch instances in.

    • getReplaceComputeEnvironment

      @Stability(Stable) @Nullable default Boolean getReplaceComputeEnvironment()
      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:

      See Also:

    • getSpot

      @Stability(Stable) @Nullable default Boolean getSpot()
      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.

      Default: false

    • getTerminateOnUpdate

      @Stability(Stable) @Nullable default Boolean getTerminateOnUpdate()
      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.

      Default: false

      See Also:

    • getUpdateTimeout

      @Stability(Stable) @Nullable default Duration getUpdateTimeout()
      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.

      Default: 30 minutes

      See Also:

    • getUpdateToLatestImageVersion

      @Stability(Stable) @Nullable default Boolean getUpdateToLatestImageVersion()
      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.

      Default: false

      See Also:

    • getVpcSubnets

      @Stability(Stable) @Nullable default SubnetSelection getVpcSubnets()
      The VPC Subnets this Compute Environment will launch instances in.