Package software.amazon.awscdk.services.batch

Class ComputeEnvironment.Builder

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

  • Method Details

    • create

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

    • computeEnvironmentName

      @Stability(Experimental) public ComputeEnvironment.Builder computeEnvironmentName(String computeEnvironmentName)
      (experimental) A name for the compute environment.

      Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

      Default: - CloudFormation-generated name

      Parameters:
      computeEnvironmentName - A name for the compute environment. This parameter is required.
      Returns:
      this

    • computeResources

      @Stability(Experimental) public ComputeEnvironment.Builder computeResources(ComputeResources computeResources)
      (experimental) The details of the required compute resources for the managed compute environment.

      If specified, and this is an unmanaged compute environment, will throw an error.

      By default, AWS Batch managed compute environments use a recent, approved version of the Amazon ECS-optimized AMI for compute resources.

      Default: - CloudFormation defaults

      Parameters:
      computeResources - The details of the required compute resources for the managed compute environment. This parameter is required.
      Returns:
      this

    • enabled

      @Stability(Experimental) public ComputeEnvironment.Builder enabled(Boolean enabled)
      (experimental) The state of the compute environment.

      If the state is set to true, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

      Default: true

      Parameters:
      enabled - The state of the compute environment. This parameter is required.
      Returns:
      this

    • managed

      @Stability(Experimental) public ComputeEnvironment.Builder managed(Boolean managed)
      (experimental) Determines if AWS should manage the allocation of compute resources for processing jobs.

      If set to false, then you are in charge of providing the compute resource details.

      Default: true

      Parameters:
      managed - Determines if AWS should manage the allocation of compute resources for processing jobs. This parameter is required.
      Returns:
      this

    • serviceRole

      @Stability(Experimental) public ComputeEnvironment.Builder serviceRole(IRole serviceRole)
      (experimental) The IAM role used by Batch to make calls to other AWS services on your behalf for managing the resources that you use with the service.

      By default, this role is created for you using the AWS managed service policy for Batch.

      Default: - Role using the 'service-role/AWSBatchServiceRole' policy.

      Parameters:
      serviceRole - The IAM role used by Batch to make calls to other AWS services on your behalf for managing the resources that you use with the service. This parameter is required.
      Returns:
      this

    • build

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