Package software.amazon.awscdk.services.batch

Class ManagedEc2EksComputeEnvironment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.batch.ManagedEc2EksComputeEnvironment
All Implemented Interfaces:
IResource, ITaggable, IComputeEnvironment, IManagedComputeEnvironment, IConnectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-31T21:09:02.903Z") @Stability(Stable) public class ManagedEc2EksComputeEnvironment extends Resource implements IManagedComputeEnvironment, IComputeEnvironment
A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.batch.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.eks.*;
 import software.amazon.awscdk.services.iam.*;
 Cluster cluster;
 InstanceType instanceType;
 LaunchTemplate launchTemplate;
 IMachineImage machineImage;
 PlacementGroup placementGroup;
 Role role;
 SecurityGroup securityGroup;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Vpc vpc;
 ManagedEc2EksComputeEnvironment managedEc2EksComputeEnvironment = ManagedEc2EksComputeEnvironment.Builder.create(this, "MyManagedEc2EksComputeEnvironment")
         .eksCluster(cluster)
         .kubernetesNamespace("kubernetesNamespace")
         .vpc(vpc)
         // the properties below are optional
         .allocationStrategy(AllocationStrategy.BEST_FIT)
         .computeEnvironmentName("computeEnvironmentName")
         .enabled(false)
         .images(List.of(EksMachineImage.builder()
                 .image(machineImage)
                 .imageType(EksMachineImageType.EKS_AL2)
                 .build()))
         .instanceClasses(List.of(InstanceClass.STANDARD3))
         .instanceRole(role)
         .instanceTypes(List.of(instanceType))
         .launchTemplate(launchTemplate)
         .maxvCpus(123)
         .minvCpus(123)
         .placementGroup(placementGroup)
         .replaceComputeEnvironment(false)
         .securityGroups(List.of(securityGroup))
         .serviceRole(role)
         .spot(false)
         .spotBidPercentage(123)
         .terminateOnUpdate(false)
         .updateTimeout(Duration.minutes(30))
         .updateToLatestImageVersion(false)
         .useOptimalInstanceClasses(false)
         .vpcSubnets(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.PRIVATE_ISOLATED)
                 .build())
         .build();

  • Constructor Details

    • ManagedEc2EksComputeEnvironment

      protected ManagedEc2EksComputeEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

    • ManagedEc2EksComputeEnvironment

      protected ManagedEc2EksComputeEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • ManagedEc2EksComputeEnvironment

      @Stability(Stable) public ManagedEc2EksComputeEnvironment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ManagedEc2EksComputeEnvironmentProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • addInstanceClass

      @Stability(Stable) public void addInstanceClass(@NotNull InstanceClass instanceClass)
      Add an instance class to this compute environment.

      Parameters:
      instanceClass - This parameter is required.

    • addInstanceType

      @Stability(Stable) public void addInstanceType(@NotNull InstanceType instanceType)
      Add an instance type to this compute environment.

      Parameters:
      instanceType - This parameter is required.

    • getComputeEnvironmentArn

      @Stability(Stable) @NotNull public String getComputeEnvironmentArn()
      The ARN of this compute environment.
      Specified by:
      getComputeEnvironmentArn in interface IComputeEnvironment

    • getComputeEnvironmentName

      @Stability(Stable) @NotNull public String getComputeEnvironmentName()
      The name of the ComputeEnvironment.
      Specified by:
      getComputeEnvironmentName in interface IComputeEnvironment

    • getConnections

      @Stability(Stable) @NotNull public Connections getConnections()
      The network connections associated with this resource.
      Specified by:
      getConnections in interface IConnectable

    • getEksCluster

      @Stability(Stable) @NotNull public ICluster getEksCluster()
      The cluster that backs this Compute Environment. Required for Compute Environments running Kubernetes jobs.

      Please ensure that you have followed the steps at

      https://docs.aws.amazon.com/batch/latest/userguide/getting-started-eks.html

      before attempting to deploy a ManagedEc2EksComputeEnvironment that uses this cluster. If you do not follow the steps in the link, the deployment fail with a message that the compute environment did not stabilize.

    • getEnabled

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

    • getInstanceClasses

      @Stability(Stable) @NotNull public List<InstanceClass> getInstanceClasses()
      The instance types that this Compute Environment can launch.

      Which one is chosen depends on the AllocationStrategy used.

    • getInstanceTypes

      @Stability(Stable) @NotNull public List<InstanceType> getInstanceTypes()
      The instance types that this Compute Environment can launch.

      Which one is chosen depends on the AllocationStrategy used.

    • getMaxvCpus

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

    • getSecurityGroups

      @Stability(Stable) @NotNull public List<ISecurityGroup> getSecurityGroups()
      The security groups this Compute Environment will launch instances in.
      Specified by:
      getSecurityGroups in interface IManagedComputeEnvironment

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      TagManager to set, remove and format tags.
      Specified by:
      getTags in interface ITaggable

    • getAllocationStrategy

      @Stability(Stable) @Nullable public AllocationStrategy getAllocationStrategy()
      The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.

    • getImages

      @Stability(Stable) @Nullable public List<EksMachineImage> getImages()
      Configure which AMIs this Compute Environment can launch.

    • getInstanceRole

      @Stability(Stable) @Nullable public IRole getInstanceRole()
      The execution Role that instances launched by this Compute Environment will use.

    • getKubernetesNamespace

      @Stability(Stable) @Nullable public String getKubernetesNamespace()
      The namespace of the Cluster.

      Cannot be 'default', start with 'kube-', or be longer than 64 characters.

    • getLaunchTemplate

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

    • getMinvCpus

      @Stability(Stable) @Nullable public Number getMinvCpus()
      The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.

    • getPlacementGroup

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

    • getReplaceComputeEnvironment

      @Stability(Stable) @Nullable public 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
      See Also:

    • getServiceRole

      @Stability(Stable) @Nullable public IRole 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 interface IComputeEnvironment

    • getSpot

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

      Specified by:
      getSpot in interface IManagedComputeEnvironment

    • getSpotBidPercentage

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

      Implies spot == true if set

    • getTerminateOnUpdate

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

      Specified by:
      getTerminateOnUpdate in interface IManagedComputeEnvironment
      See Also:

    • getUpdateTimeout

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

      Specified by:
      getUpdateTimeout in interface IManagedComputeEnvironment
      See Also:

    • getUpdateToLatestImageVersion

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

      Specified by:
      getUpdateToLatestImageVersion in interface IManagedComputeEnvironment
      See Also: