Package software.amazon.awscdk.services.batch

Class ManagedEc2ComputeEnvironmentProps.Builder

java.lang.Object

software.amazon.awscdk.services.batch.ManagedEc2ComputeEnvironmentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ManagedEc2ComputeEnvironmentProps>

Enclosing interface:

ManagedEc2ComputeEnvironmentProps

@Stability(Stable)
public static final class ManagedEc2ComputeEnvironmentProps.Builder
extends Object
implements software.amazon.jsii.Builder<ManagedEc2ComputeEnvironmentProps>

A builder for ManagedEc2ComputeEnvironmentProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ManagedEc2ComputeEnvironmentProps	build()	Builds the configured instance.
ManagedEc2ComputeEnvironmentProps.Builder	computeEnvironmentName(String computeEnvironmentName)	Sets the value of ComputeEnvironmentProps.getComputeEnvironmentName()
ManagedEc2ComputeEnvironmentProps.Builder	enabled(Boolean enabled)	Sets the value of ComputeEnvironmentProps.getEnabled()
ManagedEc2ComputeEnvironmentProps.Builder	instanceClasses(List<? extends InstanceClass> instanceClasses)	Sets the value of ManagedEc2ComputeEnvironmentProps.getInstanceClasses()
ManagedEc2ComputeEnvironmentProps.Builder	instanceTypes(List<? extends InstanceType> instanceTypes)	Sets the value of ManagedEc2ComputeEnvironmentProps.getInstanceTypes()
ManagedEc2ComputeEnvironmentProps.Builder	maxvCpus(Number maxvCpus)	Sets the value of ManagedComputeEnvironmentProps.getMaxvCpus()
ManagedEc2ComputeEnvironmentProps.Builder	replaceComputeEnvironment(Boolean replaceComputeEnvironment)	Sets the value of ManagedComputeEnvironmentProps.getReplaceComputeEnvironment()
ManagedEc2ComputeEnvironmentProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of ManagedComputeEnvironmentProps.getSecurityGroups()
ManagedEc2ComputeEnvironmentProps.Builder	serviceRole(IRole serviceRole)	Sets the value of ComputeEnvironmentProps.getServiceRole()
ManagedEc2ComputeEnvironmentProps.Builder	spot(Boolean spot)	Sets the value of ManagedComputeEnvironmentProps.getSpot()
ManagedEc2ComputeEnvironmentProps.Builder	terminateOnUpdate(Boolean terminateOnUpdate)	Sets the value of ManagedComputeEnvironmentProps.getTerminateOnUpdate()
ManagedEc2ComputeEnvironmentProps.Builder	updateTimeout(Duration updateTimeout)	Sets the value of ManagedComputeEnvironmentProps.getUpdateTimeout()
ManagedEc2ComputeEnvironmentProps.Builder	updateToLatestImageVersion(Boolean updateToLatestImageVersion)	Sets the value of ManagedComputeEnvironmentProps.getUpdateToLatestImageVersion()
ManagedEc2ComputeEnvironmentProps.Builder	vpc(IVpc vpc)	Sets the value of ManagedComputeEnvironmentProps.getVpc()
ManagedEc2ComputeEnvironmentProps.Builder	vpcSubnets(SubnetSelection vpcSubnets)	Sets the value of ManagedComputeEnvironmentProps.getVpcSubnets()

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

instanceClasses

@Stability(Stable)
public ManagedEc2ComputeEnvironmentProps.Builder instanceClasses(List<? extends InstanceClass> instanceClasses)

Sets the value of ManagedEc2ComputeEnvironmentProps.getInstanceClasses()

Parameters:

instanceClasses - The instance classes that this Compute Environment can launch. Which one is chosen depends on the AllocationStrategy used. Batch will automatically choose the instance size.

Returns:

this

instanceTypes

@Stability(Stable)
public ManagedEc2ComputeEnvironmentProps.Builder instanceTypes(List<? extends InstanceType> instanceTypes)

Sets the value of ManagedEc2ComputeEnvironmentProps.getInstanceTypes()

Parameters:

instanceTypes - The instance types that this Compute Environment can launch. Which one is chosen depends on the AllocationStrategy used.

Returns:

this

vpc

@Stability(Stable)
public ManagedEc2ComputeEnvironmentProps.Builder vpc(IVpc vpc)

Sets the value of ManagedComputeEnvironmentProps.getVpc()

Parameters:

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

Returns:

this

maxvCpus

@Stability(Stable)
public ManagedEc2ComputeEnvironmentProps.Builder maxvCpus(Number maxvCpus)

Sets the value of ManagedComputeEnvironmentProps.getMaxvCpus()

Parameters:

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.

Returns:

this

replaceComputeEnvironment

@Stability(Stable)
public ManagedEc2ComputeEnvironmentProps.Builder replaceComputeEnvironment(Boolean replaceComputeEnvironment)

Sets the value of ManagedComputeEnvironmentProps.getReplaceComputeEnvironment()

Parameters:

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:

Returns:

this

securityGroups

@Stability(Stable)
public ManagedEc2ComputeEnvironmentProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Sets the value of ManagedComputeEnvironmentProps.getSecurityGroups()

Parameters:

securityGroups - The security groups this Compute Environment will launch instances in.

Returns:

this

spot

@Stability(Stable)
public ManagedEc2ComputeEnvironmentProps.Builder spot(Boolean spot)

Sets the value of ManagedComputeEnvironmentProps.getSpot()

Parameters:

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.

Returns:

this

terminateOnUpdate

@Stability(Stable)
public ManagedEc2ComputeEnvironmentProps.Builder terminateOnUpdate(Boolean terminateOnUpdate)

Sets the value of ManagedComputeEnvironmentProps.getTerminateOnUpdate()

Parameters:

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.

Returns:

this

updateTimeout

@Stability(Stable)
public ManagedEc2ComputeEnvironmentProps.Builder updateTimeout(Duration updateTimeout)

Sets the value of ManagedComputeEnvironmentProps.getUpdateTimeout()

Parameters:

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.

Returns:

this

updateToLatestImageVersion

@Stability(Stable)
public ManagedEc2ComputeEnvironmentProps.Builder updateToLatestImageVersion(Boolean updateToLatestImageVersion)

Sets the value of ManagedComputeEnvironmentProps.getUpdateToLatestImageVersion()

Parameters:

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.

Returns:

this

vpcSubnets

@Stability(Stable)
public ManagedEc2ComputeEnvironmentProps.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of ManagedComputeEnvironmentProps.getVpcSubnets()

Parameters:

vpcSubnets - The VPC Subnets this Compute Environment will launch instances in.

Returns:

this

computeEnvironmentName

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

Sets the value of ComputeEnvironmentProps.getComputeEnvironmentName()

Parameters:

computeEnvironmentName - The name of the ComputeEnvironment.

Returns:

this

enabled

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ManagedEc2ComputeEnvironmentProps

Throws:

NullPointerException - if any required attribute was not provided