software.amazon.awscdk.services.batch

Class ComputeEnvironmentProps.Builder

java.lang.Object

software.amazon.awscdk.services.batch.ComputeEnvironmentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ComputeEnvironmentProps>

Enclosing interface:

ComputeEnvironmentProps

@Stability(value=Experimental)
public static final class ComputeEnvironmentProps.Builder
extends Object
implements software.amazon.jsii.Builder<ComputeEnvironmentProps>

A builder for ComputeEnvironmentProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ComputeEnvironmentProps	build() Builds the configured instance.
ComputeEnvironmentProps.Builder	computeEnvironmentName(String computeEnvironmentName) Sets the value of ComputeEnvironmentProps.getComputeEnvironmentName()
ComputeEnvironmentProps.Builder	computeResources(ComputeResources computeResources) Sets the value of ComputeEnvironmentProps.getComputeResources()
ComputeEnvironmentProps.Builder	enabled(Boolean enabled) Sets the value of ComputeEnvironmentProps.getEnabled()
ComputeEnvironmentProps.Builder	managed(Boolean managed) Sets the value of ComputeEnvironmentProps.getManaged()
ComputeEnvironmentProps.Builder	serviceRole(IRole serviceRole) Sets the value of ComputeEnvironmentProps.getServiceRole()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

computeEnvironmentName

@Stability(value=Experimental)
public ComputeEnvironmentProps.Builder computeEnvironmentName(String computeEnvironmentName)

Sets the value of ComputeEnvironmentProps.getComputeEnvironmentName()

Parameters:

computeEnvironmentName - A name for the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

this

computeResources

@Stability(value=Experimental)
public ComputeEnvironmentProps.Builder computeResources(ComputeResources computeResources)

Sets the value of ComputeEnvironmentProps.getComputeResources()

Parameters:

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

Returns:

this

enabled

@Stability(value=Experimental)
public ComputeEnvironmentProps.Builder enabled(Boolean enabled)

Sets the value of ComputeEnvironmentProps.getEnabled()

Parameters:

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

Returns:

this

managed

@Stability(value=Experimental)
public ComputeEnvironmentProps.Builder managed(Boolean managed)

Sets the value of ComputeEnvironmentProps.getManaged()

Parameters:

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

Returns:

this

serviceRole

@Stability(value=Experimental)
public ComputeEnvironmentProps.Builder serviceRole(IRole serviceRole)

Sets the value of ComputeEnvironmentProps.getServiceRole()

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. By default, this role is created for you using the AWS managed service policy for Batch.

Returns:

this

build

@Stability(value=Experimental)
public ComputeEnvironmentProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ComputeEnvironmentProps>

Returns:

a new instance of ComputeEnvironmentProps

Throws:

NullPointerException - if any required attribute was not provided