Package software.amazon.awscdk.services.batch

Interface ComputeEnvironmentProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
FargateComputeEnvironmentProps, ManagedComputeEnvironmentProps, ManagedEc2EcsComputeEnvironmentProps, ManagedEc2EksComputeEnvironmentProps, UnmanagedComputeEnvironmentProps
All Known Implementing Classes:
ComputeEnvironmentProps.Jsii$Proxy, FargateComputeEnvironmentProps.Jsii$Proxy, ManagedComputeEnvironmentProps.Jsii$Proxy, ManagedEc2EcsComputeEnvironmentProps.Jsii$Proxy, ManagedEc2EksComputeEnvironmentProps.Jsii$Proxy, UnmanagedComputeEnvironmentProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:03.359Z") @Stability(Stable) public interface ComputeEnvironmentProps extends software.amazon.jsii.JsiiSerializable
Props common to all ComputeEnvironments.

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.*;
 import software.amazon.awscdk.services.iam.*;
 Role role;
 ComputeEnvironmentProps computeEnvironmentProps = ComputeEnvironmentProps.builder()
         .computeEnvironmentName("computeEnvironmentName")
         .enabled(false)
         .serviceRole(role)
         .build();

  • Method Details

    • getComputeEnvironmentName

      @Stability(Stable) @Nullable default String getComputeEnvironmentName()
      The name of the ComputeEnvironment.

      Default: - generated by CloudFormation

    • getEnabled

      @Stability(Stable) @Nullable default Boolean getEnabled()
      Whether or not this ComputeEnvironment can accept jobs from a Queue.

      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.

      Default: true

    • getServiceRole

      @Stability(Stable) @Nullable default IRole getServiceRole()
      The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.

      Default: - a serviceRole will be created for managed CEs, none for unmanaged CEs

    • builder

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