Package software.amazon.awscdk.services.batch

Class ManagedEc2EcsComputeEnvironmentProps.Builder

java.lang.Object

software.amazon.awscdk.services.batch.ManagedEc2EcsComputeEnvironmentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ManagedEc2EcsComputeEnvironmentProps>

Enclosing interface:

ManagedEc2EcsComputeEnvironmentProps

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

A builder for ManagedEc2EcsComputeEnvironmentProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ManagedEc2EcsComputeEnvironmentProps.Builder	allocationStrategy(AllocationStrategy allocationStrategy)	Sets the value of ManagedEc2EcsComputeEnvironmentProps.getAllocationStrategy()
ManagedEc2EcsComputeEnvironmentProps	build()	Builds the configured instance.
ManagedEc2EcsComputeEnvironmentProps.Builder	computeEnvironmentName(String computeEnvironmentName)	Sets the value of ComputeEnvironmentProps.getComputeEnvironmentName()
ManagedEc2EcsComputeEnvironmentProps.Builder	enabled(Boolean enabled)	Sets the value of ComputeEnvironmentProps.getEnabled()
ManagedEc2EcsComputeEnvironmentProps.Builder	images(List<? extends EcsMachineImage> images)	Sets the value of ManagedEc2EcsComputeEnvironmentProps.getImages()
ManagedEc2EcsComputeEnvironmentProps.Builder	instanceClasses(List<? extends InstanceClass> instanceClasses)	Sets the value of ManagedEc2EcsComputeEnvironmentProps.getInstanceClasses()
ManagedEc2EcsComputeEnvironmentProps.Builder	instanceRole(IRole instanceRole)	Sets the value of ManagedEc2EcsComputeEnvironmentProps.getInstanceRole()
ManagedEc2EcsComputeEnvironmentProps.Builder	instanceTypes(List<? extends InstanceType> instanceTypes)	Sets the value of ManagedEc2EcsComputeEnvironmentProps.getInstanceTypes()
ManagedEc2EcsComputeEnvironmentProps.Builder	launchTemplate(ILaunchTemplate launchTemplate)	Sets the value of ManagedEc2EcsComputeEnvironmentProps.getLaunchTemplate()
ManagedEc2EcsComputeEnvironmentProps.Builder	maxvCpus(Number maxvCpus)	Sets the value of ManagedComputeEnvironmentProps.getMaxvCpus()
ManagedEc2EcsComputeEnvironmentProps.Builder	minvCpus(Number minvCpus)	Sets the value of ManagedEc2EcsComputeEnvironmentProps.getMinvCpus()
ManagedEc2EcsComputeEnvironmentProps.Builder	placementGroup(IPlacementGroup placementGroup)	Sets the value of ManagedEc2EcsComputeEnvironmentProps.getPlacementGroup()
ManagedEc2EcsComputeEnvironmentProps.Builder	replaceComputeEnvironment(Boolean replaceComputeEnvironment)	Sets the value of ManagedComputeEnvironmentProps.getReplaceComputeEnvironment()
ManagedEc2EcsComputeEnvironmentProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of ManagedComputeEnvironmentProps.getSecurityGroups()
ManagedEc2EcsComputeEnvironmentProps.Builder	serviceRole(IRole serviceRole)	Sets the value of ComputeEnvironmentProps.getServiceRole()
ManagedEc2EcsComputeEnvironmentProps.Builder	spot(Boolean spot)	Sets the value of ManagedComputeEnvironmentProps.getSpot()
ManagedEc2EcsComputeEnvironmentProps.Builder	spotBidPercentage(Number spotBidPercentage)	Sets the value of ManagedEc2EcsComputeEnvironmentProps.getSpotBidPercentage()
ManagedEc2EcsComputeEnvironmentProps.Builder	spotFleetRole(IRole spotFleetRole)	Sets the value of ManagedEc2EcsComputeEnvironmentProps.getSpotFleetRole()
ManagedEc2EcsComputeEnvironmentProps.Builder	terminateOnUpdate(Boolean terminateOnUpdate)	Sets the value of ManagedComputeEnvironmentProps.getTerminateOnUpdate()
ManagedEc2EcsComputeEnvironmentProps.Builder	updateTimeout(Duration updateTimeout)	Sets the value of ManagedComputeEnvironmentProps.getUpdateTimeout()
ManagedEc2EcsComputeEnvironmentProps.Builder	updateToLatestImageVersion(Boolean updateToLatestImageVersion)	Sets the value of ManagedComputeEnvironmentProps.getUpdateToLatestImageVersion()
ManagedEc2EcsComputeEnvironmentProps.Builder	useOptimalInstanceClasses(Boolean useOptimalInstanceClasses)	Sets the value of ManagedEc2EcsComputeEnvironmentProps.getUseOptimalInstanceClasses()
ManagedEc2EcsComputeEnvironmentProps.Builder	vpc(IVpc vpc)	Sets the value of ManagedComputeEnvironmentProps.getVpc()
ManagedEc2EcsComputeEnvironmentProps.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

allocationStrategy

@Stability(Stable)
public ManagedEc2EcsComputeEnvironmentProps.Builder allocationStrategy(AllocationStrategy allocationStrategy)

Sets the value of ManagedEc2EcsComputeEnvironmentProps.getAllocationStrategy()

Parameters:

allocationStrategy - The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.

Returns:

this

images

@Stability(Stable)
public ManagedEc2EcsComputeEnvironmentProps.Builder images(List<? extends EcsMachineImage> images)

Sets the value of ManagedEc2EcsComputeEnvironmentProps.getImages()

Parameters:

images - Configure which AMIs this Compute Environment can launch. If you specify this property with only image specified, then the imageType will default to ECS_AL2. If your image needs GPU resources, specify ECS_AL2_NVIDIA; otherwise, the instances will not be able to properly join the ComputeEnvironment.

Returns:

this

instanceClasses

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

Sets the value of ManagedEc2EcsComputeEnvironmentProps.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

instanceRole

@Stability(Stable)
public ManagedEc2EcsComputeEnvironmentProps.Builder instanceRole(IRole instanceRole)

Sets the value of ManagedEc2EcsComputeEnvironmentProps.getInstanceRole()

Parameters:

instanceRole - The execution Role that instances launched by this Compute Environment will use.

Returns:

this

instanceTypes

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

Sets the value of ManagedEc2EcsComputeEnvironmentProps.getInstanceTypes()

Parameters:

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

Returns:

this

launchTemplate

@Stability(Stable)
public ManagedEc2EcsComputeEnvironmentProps.Builder launchTemplate(ILaunchTemplate launchTemplate)

Sets the value of ManagedEc2EcsComputeEnvironmentProps.getLaunchTemplate()

Parameters:

launchTemplate - The Launch Template that this Compute Environment will use to provision EC2 Instances. Note: if securityGroups is specified on both your launch template and this Compute Environment, **the securityGroups on the Compute Environment override the ones on the launch template.

Returns:

this

minvCpus

@Stability(Stable)
public ManagedEc2EcsComputeEnvironmentProps.Builder minvCpus(Number minvCpus)

Sets the value of ManagedEc2EcsComputeEnvironmentProps.getMinvCpus()

Parameters:

minvCpus - The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.

Returns:

this

placementGroup

@Stability(Stable)
public ManagedEc2EcsComputeEnvironmentProps.Builder placementGroup(IPlacementGroup placementGroup)

Sets the value of ManagedEc2EcsComputeEnvironmentProps.getPlacementGroup()

Parameters:

placementGroup - The EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to this Compute Environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential.

Returns:

this

spotBidPercentage

@Stability(Stable)
public ManagedEc2EcsComputeEnvironmentProps.Builder spotBidPercentage(Number spotBidPercentage)

Sets the value of ManagedEc2EcsComputeEnvironmentProps.getSpotBidPercentage()

Parameters:

spotBidPercentage - The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Instance. You always pay the lowest market price and never more than your maximum percentage. For most use cases, Batch recommends leaving this field empty.

Implies spot == true if set

Returns:

this

spotFleetRole

@Stability(Stable)
public ManagedEc2EcsComputeEnvironmentProps.Builder spotFleetRole(IRole spotFleetRole)

Sets the value of ManagedEc2EcsComputeEnvironmentProps.getSpotFleetRole()

Parameters:

spotFleetRole - The service-linked role that Spot Fleet needs to launch instances on your behalf.

Returns:

this

useOptimalInstanceClasses

@Stability(Stable)
public ManagedEc2EcsComputeEnvironmentProps.Builder useOptimalInstanceClasses(Boolean useOptimalInstanceClasses)

Sets the value of ManagedEc2EcsComputeEnvironmentProps.getUseOptimalInstanceClasses()

Parameters:

useOptimalInstanceClasses - Whether or not to use batch's optimal instance type. The optimal instance type is equivalent to adding the C4, M4, and R4 instance classes. You can specify other instance classes (of the same architecture) in addition to the optimal instance classes.

Returns:

this

vpc

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

Returns:

this

vpcSubnets

@Stability(Stable)
public ManagedEc2EcsComputeEnvironmentProps.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 ManagedEc2EcsComputeEnvironmentProps.Builder computeEnvironmentName(String computeEnvironmentName)

Sets the value of ComputeEnvironmentProps.getComputeEnvironmentName()

Parameters:

computeEnvironmentName - The name of the ComputeEnvironment.

Returns:

this

enabled

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ManagedEc2EcsComputeEnvironmentProps

Throws:

NullPointerException - if any required attribute was not provided