Package software.amazon.awscdk.services.batch

Interface IManagedEc2EcsComputeEnvironment.Jsii$Default

All Superinterfaces:

IComputeEnvironment, IComputeEnvironment.Jsii$Default, IConnectable, IConnectable.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IManagedComputeEnvironment, IManagedComputeEnvironment.Jsii$Default, IManagedEc2EcsComputeEnvironment, IResource, IResource.Jsii$Default, ITaggable, ITaggable.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IManagedEc2EcsComputeEnvironment.Jsii$Proxy

Enclosing interface:

IManagedEc2EcsComputeEnvironment

@Internal
public static interface IManagedEc2EcsComputeEnvironment.Jsii$Default
extends IManagedEc2EcsComputeEnvironment, IManagedComputeEnvironment.Jsii$Default

Internal default implementation for IManagedEc2EcsComputeEnvironment.

Nested Class Summary

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

IComputeEnvironment.Jsii$Default, IComputeEnvironment.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable

IConnectable.Jsii$Default, IConnectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

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

IManagedComputeEnvironment.Jsii$Default, IManagedComputeEnvironment.Jsii$Proxy

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

IManagedEc2EcsComputeEnvironment.Jsii$Default, IManagedEc2EcsComputeEnvironment.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default void	addInstanceClass(InstanceClass instanceClass)	Add an instance class to this compute environment.
default void	addInstanceType(InstanceType instanceType)	Add an instance type to this compute environment.
default void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
default AllocationStrategy	getAllocationStrategy()	The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.
default String	getComputeEnvironmentArn()	The ARN of this compute environment.
default String	getComputeEnvironmentName()	The name of the ComputeEnvironment.
default Connections	getConnections()	The network connections associated with this resource.
default Boolean	getEnabled()	Whether or not this ComputeEnvironment can accept jobs from a Queue.
default ResourceEnvironment	getEnv()	The environment this resource belongs to.
default List<EcsMachineImage>	getImages()	Configure which AMIs this Compute Environment can launch.
default List<InstanceClass>	getInstanceClasses()	The instance classes that this Compute Environment can launch.
default IRole	getInstanceRole()	The execution Role that instances launched by this Compute Environment will use.
default List<InstanceType>	getInstanceTypes()	The instance types that this Compute Environment can launch.
default ILaunchTemplate	getLaunchTemplate()	The Launch Template that this Compute Environment will use to provision EC2 Instances.
default Number	getMaxvCpus()	The maximum vCpus this ManagedComputeEnvironment can scale up to.
default Number	getMinvCpus()	The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.
default software.constructs.Node	getNode()	The tree node.
default IPlacementGroup	getPlacementGroup()	The EC2 placement group to associate with your compute resources.
default Boolean	getReplaceComputeEnvironment()	Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.
default List<ISecurityGroup>	getSecurityGroups()	The security groups this Compute Environment will launch instances in.
default IRole	getServiceRole()	The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.
default Boolean	getSpot()	Whether or not to use spot instances.
default 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.
default IRole	getSpotFleetRole()	The service-linked role that Spot Fleet needs to launch instances on your behalf.
default Stack	getStack()	The stack in which this resource is defined.
default TagManager	getTags()	TagManager to set, remove and format tags.
default Boolean	getTerminateOnUpdate()	Whether or not any running jobs will be immediately terminated when an infrastructure update occurs.
default Duration	getUpdateTimeout()	Only meaningful if terminateOnUpdate is false.
default Boolean	getUpdateToLatestImageVersion()	Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs.
default Boolean	getUseOptimalInstanceClasses()	Whether or not to use batch's optimal instance type.
default SubnetSelection	getVpcSubnets()	The VPC Subnets this Compute Environment will launch instances in.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNode

@Stability(Stable)
@NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface IComputeEnvironment.Jsii$Default

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IManagedComputeEnvironment.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IComputeEnvironment.Jsii$Default

Specified by:

getEnv in interface IManagedComputeEnvironment.Jsii$Default

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IComputeEnvironment.Jsii$Default

Specified by:

getStack in interface IManagedComputeEnvironment.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getComputeEnvironmentArn

@Stability(Stable)
@NotNull
default String getComputeEnvironmentArn()

The ARN of this compute environment.

Specified by:

getComputeEnvironmentArn in interface IComputeEnvironment

Specified by:

getComputeEnvironmentArn in interface IComputeEnvironment.Jsii$Default

Specified by:

getComputeEnvironmentArn in interface IManagedComputeEnvironment.Jsii$Default

getComputeEnvironmentName

@Stability(Stable)
@NotNull
default String getComputeEnvironmentName()

The name of the ComputeEnvironment.

Specified by:

getComputeEnvironmentName in interface IComputeEnvironment

Specified by:

getComputeEnvironmentName in interface IComputeEnvironment.Jsii$Default

Specified by:

getComputeEnvironmentName in interface IManagedComputeEnvironment.Jsii$Default

getEnabled

@Stability(Stable)
@NotNull
default Boolean getEnabled()

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.

Specified by:

getEnabled in interface IComputeEnvironment

Specified by:

getEnabled in interface IComputeEnvironment.Jsii$Default

Specified by:

getEnabled in interface IManagedComputeEnvironment.Jsii$Default

getServiceRole

@Stability(Stable)
@Nullable
default IRole getServiceRole()

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 IComputeEnvironment

Specified by:

getServiceRole in interface IComputeEnvironment.Jsii$Default

Specified by:

getServiceRole in interface IManagedComputeEnvironment.Jsii$Default

getConnections

@Stability(Stable)
@NotNull
default Connections getConnections()

The network connections associated with this resource.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

Specified by:

getConnections in interface IManagedComputeEnvironment.Jsii$Default

getTags

@Stability(Stable)
@NotNull
default TagManager getTags()

TagManager to set, remove and format tags.

Specified by:

getTags in interface IManagedComputeEnvironment.Jsii$Default

Specified by:

getTags in interface ITaggable

Specified by:

getTags in interface ITaggable.Jsii$Default

getMaxvCpus

@Stability(Stable)
@NotNull
default Number getMaxvCpus()

The maximum vCpus this ManagedComputeEnvironment can scale up to.

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.

Specified by:

getMaxvCpus in interface IManagedComputeEnvironment

Specified by:

getMaxvCpus in interface IManagedComputeEnvironment.Jsii$Default

getSecurityGroups

@Stability(Stable)
@NotNull
default List<ISecurityGroup> getSecurityGroups()

The security groups this Compute Environment will launch instances in.

Specified by:

getSecurityGroups in interface IManagedComputeEnvironment

Specified by:

getSecurityGroups in interface IManagedComputeEnvironment.Jsii$Default

getReplaceComputeEnvironment

@Stability(Stable)
@Nullable
default Boolean getReplaceComputeEnvironment()

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:

Specified by:

getReplaceComputeEnvironment in interface IManagedComputeEnvironment

Specified by:

getReplaceComputeEnvironment in interface IManagedComputeEnvironment.Jsii$Default

See Also:

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

getSpot

@Stability(Stable)
@Nullable
default Boolean getSpot()

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 IManagedComputeEnvironment

Specified by:

getSpot in interface IManagedComputeEnvironment.Jsii$Default

getTerminateOnUpdate

@Stability(Stable)
@Nullable
default Boolean getTerminateOnUpdate()

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 IManagedComputeEnvironment

Specified by:

getTerminateOnUpdate in interface IManagedComputeEnvironment.Jsii$Default

See Also:

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

getUpdateTimeout

@Stability(Stable)
@Nullable
default Duration getUpdateTimeout()

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 IManagedComputeEnvironment

Specified by:

getUpdateTimeout in interface IManagedComputeEnvironment.Jsii$Default

See Also:

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

getUpdateToLatestImageVersion

@Stability(Stable)
@Nullable
default Boolean getUpdateToLatestImageVersion()

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 IManagedComputeEnvironment

Specified by:

getUpdateToLatestImageVersion in interface IManagedComputeEnvironment.Jsii$Default

See Also:

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

getVpcSubnets

@Stability(Stable)
@Nullable
default SubnetSelection getVpcSubnets()

The VPC Subnets this Compute Environment will launch instances in.

Specified by:

getVpcSubnets in interface IManagedComputeEnvironment

Specified by:

getVpcSubnets in interface IManagedComputeEnvironment.Jsii$Default

getInstanceClasses

@Stability(Stable)
@NotNull
default List<InstanceClass> getInstanceClasses()

The instance classes that this Compute Environment can launch.

Which one is chosen depends on the AllocationStrategy used. Batch will automatically choose the size.

Specified by:

getInstanceClasses in interface IManagedEc2EcsComputeEnvironment

getInstanceTypes

@Stability(Stable)
@NotNull
default List<InstanceType> getInstanceTypes()

The instance types that this Compute Environment can launch.

Which one is chosen depends on the AllocationStrategy used.

Specified by:

getInstanceTypes in interface IManagedEc2EcsComputeEnvironment

getAllocationStrategy

@Stability(Stable)
@Nullable
default AllocationStrategy getAllocationStrategy()

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 IManagedEc2EcsComputeEnvironment

getImages

@Stability(Stable)
@Nullable
default List<EcsMachineImage> getImages()

Configure which AMIs this Compute Environment can launch.

Leave this undefined to allow Batch to choose the latest AMIs it supports for each instance that it launches.

Default: - ECS_AL2 compatible AMI ids for non-GPU instances, ECS_AL2_NVIDIA compatible AMI ids for GPU instances

Specified by:

getImages in interface IManagedEc2EcsComputeEnvironment

getInstanceRole

@Stability(Stable)
@Nullable
default IRole getInstanceRole()

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

Default: - a role will be created

Specified by:

getInstanceRole in interface IManagedEc2EcsComputeEnvironment

getLaunchTemplate

@Stability(Stable)
@Nullable
default ILaunchTemplate getLaunchTemplate()

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 IManagedEc2EcsComputeEnvironment

getMinvCpus

@Stability(Stable)
@Nullable
default Number getMinvCpus()

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

Default: 0

Specified by:

getMinvCpus in interface IManagedEc2EcsComputeEnvironment

getPlacementGroup

@Stability(Stable)
@Nullable
default IPlacementGroup getPlacementGroup()

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 IManagedEc2EcsComputeEnvironment

See Also:

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

getSpotBidPercentage

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

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.

Default: - 100%

Specified by:

getSpotBidPercentage in interface IManagedEc2EcsComputeEnvironment

getSpotFleetRole

@Stability(Stable)
@Nullable
default IRole getSpotFleetRole()

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 IManagedEc2EcsComputeEnvironment

See Also:

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

getUseOptimalInstanceClasses

@Stability(Stable)
@Nullable
default Boolean getUseOptimalInstanceClasses()

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 IManagedEc2EcsComputeEnvironment

applyRemovalPolicy

@Stability(Stable)
default void applyRemovalPolicy(@NotNull
 RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IComputeEnvironment.Jsii$Default

Specified by:

applyRemovalPolicy in interface IManagedComputeEnvironment.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

addInstanceClass

@Stability(Stable)
default void addInstanceClass(@NotNull
 InstanceClass instanceClass)

Add an instance class to this compute environment.

Specified by:

addInstanceClass in interface IManagedEc2EcsComputeEnvironment

Parameters:

instanceClass - This parameter is required.

addInstanceType

@Stability(Stable)
default void addInstanceType(@NotNull
 InstanceType instanceType)

Add an instance type to this compute environment.

Specified by:

addInstanceType in interface IManagedEc2EcsComputeEnvironment

Parameters:

instanceType - This parameter is required.