Package software.amazon.awscdk.services.batch

Interface ManagedComputeEnvironmentProps

All Superinterfaces:
ComputeEnvironmentProps, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
FargateComputeEnvironmentProps, ManagedEc2EcsComputeEnvironmentProps, ManagedEc2EksComputeEnvironmentProps
All Known Implementing Classes:
FargateComputeEnvironmentProps.Jsii$Proxy, ManagedComputeEnvironmentProps.Jsii$Proxy, ManagedEc2EcsComputeEnvironmentProps.Jsii$Proxy, ManagedEc2EksComputeEnvironmentProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-09-11T18:01:12.064Z") @Stability(Stable) public interface ManagedComputeEnvironmentProps extends software.amazon.jsii.JsiiSerializable, ComputeEnvironmentProps
Props for a ManagedComputeEnvironment.

Example: 

 // 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.iam.*;
 Role role;
 SecurityGroup securityGroup;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Vpc vpc;
 ManagedComputeEnvironmentProps managedComputeEnvironmentProps = ManagedComputeEnvironmentProps.builder()
         .vpc(vpc)
         // the properties below are optional
         .computeEnvironmentName("computeEnvironmentName")
         .enabled(false)
         .maxvCpus(123)
         .replaceComputeEnvironment(false)
         .securityGroups(List.of(securityGroup))
         .serviceRole(role)
         .spot(false)
         .terminateOnUpdate(false)
         .updateTimeout(Duration.minutes(30))
         .updateToLatestImageVersion(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();

  • Method Details

    • getVpc

      @Stability(Stable) @NotNull IVpc getVpc()
      VPC in which this Compute Environment will launch Instances.

    • getMaxvCpus

      @Stability(Stable) @Nullable default Number getMaxvCpus()
      The maximum vCpus this ManagedComputeEnvironment can scale up to. Each vCPU is equivalent to 1024 CPU shares.

      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.

      Default: 256

    • 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:

      Default: false

      See Also:

    • getSecurityGroups

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

      Default: new security groups will be created

    • 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.

      Default: true

    • getVpcSubnets

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

      Default: new subnets will be created

    • builder

      @Stability(Stable) static ManagedComputeEnvironmentProps.Builder builder()
      Returns:
      a ManagedComputeEnvironmentProps.Builder of ManagedComputeEnvironmentProps