Package software.amazon.awscdk.services.batch

Class ManagedEc2EksComputeEnvironment.Builder

java.lang.Object
software.amazon.awscdk.services.batch.ManagedEc2EksComputeEnvironment.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<ManagedEc2EksComputeEnvironment>
Enclosing class:
ManagedEc2EksComputeEnvironment
@Stability(Stable) public static final class ManagedEc2EksComputeEnvironment.Builder extends Object implements software.amazon.jsii.Builder<ManagedEc2EksComputeEnvironment>
A fluent builder for ManagedEc2EksComputeEnvironment.

  • Method Details

    • create

      @Stability(Stable) public static ManagedEc2EksComputeEnvironment.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of ManagedEc2EksComputeEnvironment.Builder.

    • computeEnvironmentName

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder computeEnvironmentName(String computeEnvironmentName)
      The name of the ComputeEnvironment.

      Default: - generated by CloudFormation

      Parameters:
      computeEnvironmentName - The name of the ComputeEnvironment. This parameter is required.
      Returns:
      this

    • enabled

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder enabled(Boolean enabled)
      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

      Parameters:
      enabled - Whether or not this ComputeEnvironment can accept jobs from a Queue. This parameter is required.
      Returns:
      this

    • serviceRole

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder serviceRole(IRole serviceRole)
      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

      Parameters:
      serviceRole - The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs. This parameter is required.
      Returns:
      this

    • vpc

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder vpc(IVpc vpc)
      VPC in which this Compute Environment will launch Instances.

      Parameters:
      vpc - VPC in which this Compute Environment will launch Instances. This parameter is required.
      Returns:
      this

    • maxvCpus

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder maxvCpus(Number maxvCpus)
      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

      Parameters:
      maxvCpus - The maximum vCpus this ManagedComputeEnvironment can scale up to. Each vCPU is equivalent to 1024 CPU shares. This parameter is required.
      Returns:
      this

    • replaceComputeEnvironment

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder replaceComputeEnvironment(Boolean replaceComputeEnvironment)
      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

      Parameters:
      replaceComputeEnvironment - Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances. This parameter is required.
      Returns:
      this
      See Also:

    • securityGroups

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
      The security groups this Compute Environment will launch instances in.

      Default: new security groups will be created

      Parameters:
      securityGroups - The security groups this Compute Environment will launch instances in. This parameter is required.
      Returns:
      this

    • spot

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder spot(Boolean spot)
      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

      Parameters:
      spot - Whether or not to use spot instances. This parameter is required.
      Returns:
      this

    • terminateOnUpdate

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder terminateOnUpdate(Boolean terminateOnUpdate)
      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

      Parameters:
      terminateOnUpdate - Whether or not any running jobs will be immediately terminated when an infrastructure update occurs. This parameter is required.
      Returns:
      this
      See Also:

    • updateTimeout

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder updateTimeout(Duration updateTimeout)
      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

      Parameters:
      updateTimeout - Only meaningful if terminateOnUpdate is false. This parameter is required.
      Returns:
      this
      See Also:

    • updateToLatestImageVersion

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder updateToLatestImageVersion(Boolean updateToLatestImageVersion)
      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

      Parameters:
      updateToLatestImageVersion - Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs. This parameter is required.
      Returns:
      this
      See Also:

    • vpcSubnets

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder vpcSubnets(SubnetSelection vpcSubnets)
      The VPC Subnets this Compute Environment will launch instances in.

      Default: new subnets will be created

      Parameters:
      vpcSubnets - The VPC Subnets this Compute Environment will launch instances in. This parameter is required.
      Returns:
      this

    • eksCluster

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder eksCluster(ICluster eksCluster)
      The cluster that backs this Compute Environment. Required for Compute Environments running Kubernetes jobs.

      Please ensure that you have followed the steps at

      https://docs.aws.amazon.com/batch/latest/userguide/getting-started-eks.html

      before attempting to deploy a ManagedEc2EksComputeEnvironment that uses this cluster. If you do not follow the steps in the link, the deployment fail with a message that the compute environment did not stabilize.

      Parameters:
      eksCluster - The cluster that backs this Compute Environment. Required for Compute Environments running Kubernetes jobs. This parameter is required.
      Returns:
      this

    • kubernetesNamespace

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder kubernetesNamespace(String kubernetesNamespace)
      The namespace of the Cluster.

      Parameters:
      kubernetesNamespace - The namespace of the Cluster. This parameter is required.
      Returns:
      this

    • allocationStrategy

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder allocationStrategy(AllocationStrategy allocationStrategy)
      The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.

      Default: - `BEST_FIT_PROGRESSIVE` if not using Spot instances, `SPOT_CAPACITY_OPTIMIZED` if using Spot instances.

      Parameters:
      allocationStrategy - The allocation strategy to use if not enough instances of the best fitting instance type can be allocated. This parameter is required.
      Returns:
      this

    • defaultInstanceClasses

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder defaultInstanceClasses(List<? extends DefaultInstanceClass> defaultInstanceClasses)
      Use batch's default instance types.

      A simpler way to choose up-to-date instance classes based on region instead of specifying exact instance classes.

      Default: - choose from instanceTypes and instanceClasses

      Parameters:
      defaultInstanceClasses - Use batch's default instance types. This parameter is required.
      Returns:
      this
      See Also:

    • images

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder images(List<? extends EksMachineImage> images)
      Configure which AMIs this Compute Environment can launch.

      Default: If `imageKubernetesVersion` is specified, - EKS_AL2 for non-GPU instances, EKS_AL2_NVIDIA for GPU instances, Otherwise, - ECS_AL2 for non-GPU instances, ECS_AL2_NVIDIA for GPU instances,

      Parameters:
      images - Configure which AMIs this Compute Environment can launch. This parameter is required.
      Returns:
      this

    • instanceClasses

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder instanceClasses(List<? extends InstanceClass> instanceClasses)
      The instance types that this Compute Environment can launch.

      Which one is chosen depends on the AllocationStrategy used. Batch will automatically choose the instance size.

      Default: - the instances Batch considers will be used (currently C4, M4, and R4)

      Parameters:
      instanceClasses - The instance types that this Compute Environment can launch. This parameter is required.
      Returns:
      this

    • instanceRole

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder instanceRole(IRole instanceRole)
      The execution Role that instances launched by this Compute Environment will use.

      Default: - a role will be created

      Parameters:
      instanceRole - The execution Role that instances launched by this Compute Environment will use. This parameter is required.
      Returns:
      this

    • instanceTypes

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder instanceTypes(List<? extends InstanceType> instanceTypes)
      The instance types that this Compute Environment can launch.

      Which one is chosen depends on the AllocationStrategy used.

      Default: - the instances Batch considers will be used (currently C4, M4, and R4)

      Parameters:
      instanceTypes - The instance types that this Compute Environment can launch. This parameter is required.
      Returns:
      this

    • launchTemplate

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder launchTemplate(ILaunchTemplate launchTemplate)
      The Launch Template that this Compute Environment will use to provision EC2 Instances.

      Note: if securityGroups is specified on both your launch template and this Compute Environment, the securityGroups on the Compute Environment override the ones on the launch template.

      Default: - no launch template

      Parameters:
      launchTemplate - The Launch Template that this Compute Environment will use to provision EC2 Instances. This parameter is required.
      Returns:
      this

    • minvCpus

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder minvCpus(Number minvCpus)
      The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.

      Default: 0

      Parameters:
      minvCpus - The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED. This parameter is required.
      Returns:
      this

    • placementGroup

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder placementGroup(IPlacementGroupRef placementGroup)
      The EC2 placement group to associate with your compute resources.

      If you intend to submit multi-node parallel jobs to this Compute Environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential.

      Default: - no placement group

      Parameters:
      placementGroup - The EC2 placement group to associate with your compute resources. This parameter is required.
      Returns:
      this
      See Also:

    • spotBidPercentage

      @Stability(Stable) public ManagedEc2EksComputeEnvironment.Builder spotBidPercentage(Number spotBidPercentage)
      The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched.

      For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Instance. You always pay the lowest market price and never more than your maximum percentage. For most use cases, Batch recommends leaving this field empty.

      Implies spot == true if set

      Default: - 100%

      Parameters:
      spotBidPercentage - The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. This parameter is required.
      Returns:
      this

    • useOptimalInstanceClasses

      @Stability(Deprecated) @Deprecated public ManagedEc2EksComputeEnvironment.Builder useOptimalInstanceClasses(Boolean useOptimalInstanceClasses)
      Deprecated.
      use defaultInstanceClasses instead
      (deprecated) Whether or not to use batch's optimal instance type.

      The optimal instance type is equivalent to adding the C4, M4, and R4 instance classes. You can specify other instance classes (of the same architecture) in addition to the optimal instance classes.

      Default: true

      Parameters:
      useOptimalInstanceClasses - Whether or not to use batch's optimal instance type. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public ManagedEc2EksComputeEnvironment build()
      Specified by:
      build in interface software.amazon.jsii.Builder<ManagedEc2EksComputeEnvironment>
      Returns:
      a newly built instance of ManagedEc2EksComputeEnvironment.