Package software.amazon.awscdk.services.batch

Class ManagedEc2EcsComputeEnvironmentProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.batch.ManagedEc2EcsComputeEnvironmentProps.Jsii$Proxy

All Implemented Interfaces:

ComputeEnvironmentProps, ManagedComputeEnvironmentProps, ManagedEc2EcsComputeEnvironmentProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

ManagedEc2EcsComputeEnvironmentProps

@Stability(Stable)
@Internal
public static final class ManagedEc2EcsComputeEnvironmentProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ManagedEc2EcsComputeEnvironmentProps

An implementation for ManagedEc2EcsComputeEnvironmentProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.ManagedEc2EcsComputeEnvironmentProps

ManagedEc2EcsComputeEnvironmentProps.Builder, ManagedEc2EcsComputeEnvironmentProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(ManagedEc2EcsComputeEnvironmentProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the ManagedEc2EcsComputeEnvironmentProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final AllocationStrategy	getAllocationStrategy()	The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.
final String	getComputeEnvironmentName()	The name of the ComputeEnvironment.
final List<DefaultInstanceClass>	getDefaultInstanceClasses()	Use batch's default instance types.
final Boolean	getEnabled()	Whether or not this ComputeEnvironment can accept jobs from a Queue.
final List<EcsMachineImage>	getImages()	Configure which AMIs this Compute Environment can launch.
final List<InstanceClass>	getInstanceClasses()	The instance classes that this Compute Environment can launch.
final IRole	getInstanceRole()	The execution Role that instances launched by this Compute Environment will use.
final List<InstanceType>	getInstanceTypes()	The instance types that this Compute Environment can launch.
final ILaunchTemplate	getLaunchTemplate()	The Launch Template that this Compute Environment will use to provision EC2 Instances.
final Number	getMaxvCpus()	The maximum vCpus this ManagedComputeEnvironment can scale up to.
final Number	getMinvCpus()	The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.
final IPlacementGroupRef	getPlacementGroup()	The EC2 placement group to associate with your compute resources.
final Boolean	getReplaceComputeEnvironment()	Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.
final List<ISecurityGroup>	getSecurityGroups()	The security groups this Compute Environment will launch instances in.
final IRole	getServiceRole()	The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.
final Boolean	getSpot()	Whether or not to use spot instances.
final Number	getSpotBidPercentage()	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.
final IRole	getSpotFleetRole()	The service-linked role that Spot Fleet needs to launch instances on your behalf.
final Boolean	getTerminateOnUpdate()	Whether or not any running jobs will be immediately terminated when an infrastructure update occurs.
final Duration	getUpdateTimeout()	Only meaningful if terminateOnUpdate is false.
final Boolean	getUpdateToLatestImageVersion()	Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs.
final Boolean	getUseOptimalInstanceClasses()	(deprecated) Whether or not to use batch's optimal instance type.
final IVpc	getVpc()	VPC in which this Compute Environment will launch Instances.
final SubnetSelection	getVpcSubnets()	The VPC Subnets this Compute Environment will launch instances in.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(ManagedEc2EcsComputeEnvironmentProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the ManagedEc2EcsComputeEnvironmentProps.Builder.

Method Details

getAllocationStrategy

public final AllocationStrategy getAllocationStrategy()

Description copied from interface: ManagedEc2EcsComputeEnvironmentProps

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

Default: - `BEST_FIT_PROGRESSIVE` if not using Spot instances, `SPOT_CAPACITY_OPTIMIZED` if using Spot instances.

Specified by:

getAllocationStrategy in interface ManagedEc2EcsComputeEnvironmentProps

getDefaultInstanceClasses

public final List<DefaultInstanceClass> getDefaultInstanceClasses()

Description copied from interface: ManagedEc2EcsComputeEnvironmentProps

Use batch's default instance types.

A simpler way to choose up-to-date instance classes based on region instead of specifying exact instance classes.

Default: - choose from instanceTypes and instanceClasses

Specified by:

getDefaultInstanceClasses in interface ManagedEc2EcsComputeEnvironmentProps

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/instance-type-compute-table.html

getImages

public final List<EcsMachineImage> getImages()

Description copied from interface: ManagedEc2EcsComputeEnvironmentProps

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.

Default: - ECS_AL2 for non-GPU instances, ECS_AL2_NVIDIA for GPU instances

Specified by:

getImages in interface ManagedEc2EcsComputeEnvironmentProps

getInstanceClasses

public final List<InstanceClass> getInstanceClasses()

Description copied from interface: ManagedEc2EcsComputeEnvironmentProps

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.

Default: - the instances Batch considers will be used (currently C4, M4, and R4)

Specified by:

getInstanceClasses in interface ManagedEc2EcsComputeEnvironmentProps

getInstanceRole

public final IRole getInstanceRole()

Description copied from interface: ManagedEc2EcsComputeEnvironmentProps

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

Default: - a role will be created

Specified by:

getInstanceRole in interface ManagedEc2EcsComputeEnvironmentProps

getInstanceTypes

public final List<InstanceType> getInstanceTypes()

Description copied from interface: ManagedEc2EcsComputeEnvironmentProps

The instance types that this Compute Environment can launch.

Which one is chosen depends on the AllocationStrategy used.

Default: - the instances Batch considers will be used (currently C4, M4, and R4)

Specified by:

getInstanceTypes in interface ManagedEc2EcsComputeEnvironmentProps

getLaunchTemplate

public final ILaunchTemplate getLaunchTemplate()

Description copied from interface: ManagedEc2EcsComputeEnvironmentProps

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.

Default: no launch template

Specified by:

getLaunchTemplate in interface ManagedEc2EcsComputeEnvironmentProps

getMinvCpus

public final Number getMinvCpus()

Description copied from interface: ManagedEc2EcsComputeEnvironmentProps

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

Default: 0

Specified by:

getMinvCpus in interface ManagedEc2EcsComputeEnvironmentProps

getPlacementGroup

public final IPlacementGroupRef getPlacementGroup()

Description copied from interface: ManagedEc2EcsComputeEnvironmentProps

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.

Default: - no placement group

Specified by:

getPlacementGroup in interface ManagedEc2EcsComputeEnvironmentProps

See Also:

• https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html

getSpotBidPercentage

public final Number getSpotBidPercentage()

Description copied from interface: ManagedEc2EcsComputeEnvironmentProps

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

Default: 100%

Specified by:

getSpotBidPercentage in interface ManagedEc2EcsComputeEnvironmentProps

getSpotFleetRole

public final IRole getSpotFleetRole()

Description copied from interface: ManagedEc2EcsComputeEnvironmentProps

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

Default: - a new role will be created

Specified by:

getSpotFleetRole in interface ManagedEc2EcsComputeEnvironmentProps

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html

getUseOptimalInstanceClasses

public final Boolean getUseOptimalInstanceClasses()

Description copied from interface: ManagedEc2EcsComputeEnvironmentProps

(deprecated) 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.

Default: true

Specified by:

getUseOptimalInstanceClasses in interface ManagedEc2EcsComputeEnvironmentProps

getVpc

public final IVpc getVpc()

Description copied from interface: ManagedComputeEnvironmentProps

VPC in which this Compute Environment will launch Instances.

Specified by:

getVpc in interface ManagedComputeEnvironmentProps

getMaxvCpus

public final Number getMaxvCpus()

Description copied from interface: ManagedComputeEnvironmentProps

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.

Default: 256

Specified by:

getMaxvCpus in interface ManagedComputeEnvironmentProps

getReplaceComputeEnvironment

public final Boolean getReplaceComputeEnvironment()

Description copied from interface: ManagedComputeEnvironmentProps

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:

Default: false

Specified by:

getReplaceComputeEnvironment in interface ManagedComputeEnvironmentProps

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html

getSecurityGroups

public final List<ISecurityGroup> getSecurityGroups()

Description copied from interface: ManagedComputeEnvironmentProps

The security groups this Compute Environment will launch instances in.

Default: new security groups will be created

Specified by:

getSecurityGroups in interface ManagedComputeEnvironmentProps

getSpot

public final Boolean getSpot()

Description copied from interface: ManagedComputeEnvironmentProps

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.

Default: false

Specified by:

getSpot in interface ManagedComputeEnvironmentProps

getTerminateOnUpdate

public final Boolean getTerminateOnUpdate()

Description copied from interface: ManagedComputeEnvironmentProps

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.

Default: false

Specified by:

getTerminateOnUpdate in interface ManagedComputeEnvironmentProps

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

getUpdateTimeout

public final Duration getUpdateTimeout()

Description copied from interface: ManagedComputeEnvironmentProps

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.

Default: 30 minutes

Specified by:

getUpdateTimeout in interface ManagedComputeEnvironmentProps

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

getUpdateToLatestImageVersion

public final Boolean getUpdateToLatestImageVersion()

Description copied from interface: ManagedComputeEnvironmentProps

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.

Default: false

Specified by:

getUpdateToLatestImageVersion in interface ManagedComputeEnvironmentProps

See Also:

• https://github.com/aws/aws-cdk/issues/27054

getVpcSubnets

public final SubnetSelection getVpcSubnets()

Description copied from interface: ManagedComputeEnvironmentProps

The VPC Subnets this Compute Environment will launch instances in.

Default: new subnets will be created

Specified by:

getVpcSubnets in interface ManagedComputeEnvironmentProps

getComputeEnvironmentName

public final String getComputeEnvironmentName()

Description copied from interface: ComputeEnvironmentProps

The name of the ComputeEnvironment.

Default: - generated by CloudFormation

Specified by:

getComputeEnvironmentName in interface ComputeEnvironmentProps

getEnabled

public final Boolean getEnabled()

Description copied from interface: ComputeEnvironmentProps

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.

Default: true

Specified by:

getEnabled in interface ComputeEnvironmentProps

getServiceRole

public final IRole getServiceRole()

Description copied from interface: ComputeEnvironmentProps

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

Default: - a serviceRole will be created for managed CEs, none for unmanaged CEs

Specified by:

getServiceRole in interface ComputeEnvironmentProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object