Package 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(Stable)
public static final class ComputeEnvironmentProps.Builder
extends Object
implements software.amazon.jsii.Builder<ComputeEnvironmentProps>

A builder for ComputeEnvironmentProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ComputeEnvironmentProps	build()	Builds the configured instance.
ComputeEnvironmentProps.Builder	computeEnvironmentName(String computeEnvironmentName)	Sets the value of ComputeEnvironmentProps.getComputeEnvironmentName()
ComputeEnvironmentProps.Builder	enabled(Boolean enabled)	Sets the value of ComputeEnvironmentProps.getEnabled()
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 Details

Builder

public Builder()

Method Details

computeEnvironmentName

@Stability(Stable)
public ComputeEnvironmentProps.Builder computeEnvironmentName(String computeEnvironmentName)

Sets the value of ComputeEnvironmentProps.getComputeEnvironmentName()

Parameters:

computeEnvironmentName - The name of the ComputeEnvironment.

Returns:

this

enabled

@Stability(Stable)
public ComputeEnvironmentProps.Builder enabled(Boolean enabled)

Sets the value of ComputeEnvironmentProps.getEnabled()

Parameters:

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.

Returns:

this

serviceRole

@Stability(Stable)
public ComputeEnvironmentProps.Builder serviceRole(IRole serviceRole)

Sets the value of ComputeEnvironmentProps.getServiceRole()

Parameters:

serviceRole - The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.

Returns:

this

build

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