Package software.amazon.awscdk.services.batch

Class FargateComputeEnvironment.Builder

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

  • Method Details

    • create

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

    • computeEnvironmentName

      @Stability(Stable) public FargateComputeEnvironment.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 FargateComputeEnvironment.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 FargateComputeEnvironment.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 FargateComputeEnvironment.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 FargateComputeEnvironment.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 FargateComputeEnvironment.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 FargateComputeEnvironment.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 FargateComputeEnvironment.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 FargateComputeEnvironment.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 FargateComputeEnvironment.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 FargateComputeEnvironment.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 FargateComputeEnvironment.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

    • build

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