Class ManagedEc2EcsComputeEnvironment
- All Implemented Interfaces:
IResource
,ITaggable
,IComputeEnvironment
,IManagedComputeEnvironment
,IManagedEc2EcsComputeEnvironment
,IConnectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
Example:
IManagedEc2EcsComputeEnvironment computeEnv; Vpc vpc = new Vpc(this, "VPC"); computeEnv.addInstanceClass(InstanceClass.M5AD); // Or, specify it on the constructor: // Or, specify it on the constructor: ManagedEc2EcsComputeEnvironment.Builder.create(this, "myEc2ComputeEnv") .vpc(vpc) .instanceClasses(List.of(InstanceClass.R4)) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forManagedEc2EcsComputeEnvironment
.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.IComputeEnvironment
IComputeEnvironment.Jsii$Default, IComputeEnvironment.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
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
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ManagedEc2EcsComputeEnvironment
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
ManagedEc2EcsComputeEnvironment
(software.amazon.jsii.JsiiObjectRef objRef) ManagedEc2EcsComputeEnvironment
(software.constructs.Construct scope, String id, ManagedEc2EcsComputeEnvironmentProps props) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addInstanceClass
(InstanceClass instanceClass) Add an instance class to this compute environment.void
addInstanceType
(InstanceType instanceType) Add an instance type to this compute environment.fromManagedEc2EcsComputeEnvironmentArn
(software.constructs.Construct scope, String id, String managedEc2EcsComputeEnvironmentArn) refer to an existing ComputeEnvironment by its arn.The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.The ARN of this compute environment.The name of the ComputeEnvironment.The network connections associated with this resource.Whether or not this ComputeEnvironment can accept jobs from a Queue.Configure which AMIs this Compute Environment can launch.The instance classes that this Compute Environment can launch.The execution Role that instances launched by this Compute Environment will use.The instance types that this Compute Environment can launch.The Launch Template that this Compute Environment will use to provision EC2 Instances.The maximum vCpus thisManagedComputeEnvironment
can scale up to.The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.The EC2 placement group to associate with your compute resources.Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.The security groups this Compute Environment will launch instances in.The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.getSpot()
Whether or not to use spot instances.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.The service-linked role that Spot Fleet needs to launch instances on your behalf.getTags()
TagManager to set, remove and format tags.Whether or not any running jobs will be immediately terminated when an infrastructure update occurs.Only meaningful ifterminateOnUpdate
isfalse
.Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs.Methods inherited from class software.amazon.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource
Methods inherited from class software.constructs.Construct
getNode, isConstruct, toString
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.services.batch.IManagedComputeEnvironment
getVpcSubnets
Methods inherited from interface software.amazon.awscdk.services.batch.IManagedEc2EcsComputeEnvironment
getUseOptimalInstanceClasses
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
ManagedEc2EcsComputeEnvironment
protected ManagedEc2EcsComputeEnvironment(software.amazon.jsii.JsiiObjectRef objRef) -
ManagedEc2EcsComputeEnvironment
protected ManagedEc2EcsComputeEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
ManagedEc2EcsComputeEnvironment
@Stability(Stable) public ManagedEc2EcsComputeEnvironment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ManagedEc2EcsComputeEnvironmentProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
fromManagedEc2EcsComputeEnvironmentArn
@Stability(Stable) @NotNull public static IManagedEc2EcsComputeEnvironment fromManagedEc2EcsComputeEnvironmentArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String managedEc2EcsComputeEnvironmentArn) refer to an existing ComputeEnvironment by its arn.- Parameters:
scope
- This parameter is required.id
- This parameter is required.managedEc2EcsComputeEnvironmentArn
- This parameter is required.
-
addInstanceClass
Add an instance class to this compute environment.- Specified by:
addInstanceClass
in interfaceIManagedEc2EcsComputeEnvironment
- Parameters:
instanceClass
- This parameter is required.
-
addInstanceType
Add an instance type to this compute environment.- Specified by:
addInstanceType
in interfaceIManagedEc2EcsComputeEnvironment
- Parameters:
instanceType
- This parameter is required.
-
getComputeEnvironmentArn
The ARN of this compute environment.- Specified by:
getComputeEnvironmentArn
in interfaceIComputeEnvironment
-
getComputeEnvironmentName
The name of the ComputeEnvironment.- Specified by:
getComputeEnvironmentName
in interfaceIComputeEnvironment
-
getConnections
The network connections associated with this resource.- Specified by:
getConnections
in interfaceIConnectable
-
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
orRUNNING
states will not be interrupted. As jobs complete, the ComputeEnvironment will scale instances down tominvCpus
.To ensure you aren't billed for unused capacity, set
minvCpus
to0
.- Specified by:
getEnabled
in interfaceIComputeEnvironment
-
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 interfaceIManagedEc2EcsComputeEnvironment
-
getInstanceTypes
The instance types that this Compute Environment can launch.Which one is chosen depends on the
AllocationStrategy
used.- Specified by:
getInstanceTypes
in interfaceIManagedEc2EcsComputeEnvironment
-
getMaxvCpus
The maximum vCpus thisManagedComputeEnvironment
can scale up to.Note: if this Compute Environment uses EC2 resources (not Fargate) with either
AllocationStrategy.BEST_FIT_PROGRESSIVE
orAllocationStrategy.SPOT_CAPACITY_OPTIMIZED
, orAllocationStrategy.BEST_FIT
with Spot instances, The scheduler may exceed this number by at most one of the instances specified ininstanceTypes
orinstanceClasses
.- Specified by:
getMaxvCpus
in interfaceIManagedComputeEnvironment
-
getSecurityGroups
The security groups this Compute Environment will launch instances in.- Specified by:
getSecurityGroups
in interfaceIManagedComputeEnvironment
-
getTags
TagManager to set, remove and format tags. -
getAllocationStrategy
The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.- Specified by:
getAllocationStrategy
in interfaceIManagedEc2EcsComputeEnvironment
-
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.- Specified by:
getImages
in interfaceIManagedEc2EcsComputeEnvironment
-
getInstanceRole
The execution Role that instances launched by this Compute Environment will use.- Specified by:
getInstanceRole
in interfaceIManagedEc2EcsComputeEnvironment
-
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, **thesecurityGroup
s on the Compute Environment override the ones on the launch template.- Specified by:
getLaunchTemplate
in interfaceIManagedEc2EcsComputeEnvironment
-
getMinvCpus
The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.- Specified by:
getMinvCpus
in interfaceIManagedEc2EcsComputeEnvironment
-
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.
- Specified by:
getPlacementGroup
in interfaceIManagedEc2EcsComputeEnvironment
- See Also:
-
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 interfaceIManagedComputeEnvironment
- See Also:
-
getServiceRole
The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.- Specified by:
getServiceRole
in interfaceIComputeEnvironment
-
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.
- Specified by:
getSpot
in interfaceIManagedComputeEnvironment
-
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.
- Specified by:
getSpotBidPercentage
in interfaceIManagedEc2EcsComputeEnvironment
-
getSpotFleetRole
The service-linked role that Spot Fleet needs to launch instances on your behalf.- Specified by:
getSpotFleetRole
in interfaceIManagedEc2EcsComputeEnvironment
- See Also:
-
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.
- Specified by:
getTerminateOnUpdate
in interfaceIManagedComputeEnvironment
- See Also:
-
getUpdateTimeout
Only meaningful ifterminateOnUpdate
isfalse
.If so, when an infrastructure update is triggered, any running jobs will be allowed to run until
updateTimeout
has expired.- Specified by:
getUpdateTimeout
in interfaceIManagedComputeEnvironment
- See Also:
-
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.- Specified by:
getUpdateToLatestImageVersion
in interfaceIManagedComputeEnvironment
- See Also:
-