ManagedEc2EksComputeEnvironment

class aws_cdk.aws_batch.ManagedEc2EksComputeEnvironment(scope, id, *, eks_cluster, kubernetes_namespace, allocation_strategy=None, images=None, instance_classes=None, instance_role=None, instance_types=None, launch_template=None, minv_cpus=None, placement_group=None, spot_bid_percentage=None, use_optimal_instance_classes=None, vpc, maxv_cpus=None, replace_compute_environment=None, security_groups=None, spot=None, terminate_on_update=None, update_timeout=None, update_to_latest_image_version=None, vpc_subnets=None, compute_environment_name=None, enabled=None, service_role=None)

Bases: Resource

A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.

Resource:: AWS::Batch::ComputeEnvironment
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_batch as batch
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_eks as eks
from aws_cdk import aws_iam as iam

# cluster: eks.Cluster
# instance_type: ec2.InstanceType
# launch_template: ec2.LaunchTemplate
# machine_image: ec2.IMachineImage
# placement_group: ec2.PlacementGroup
# role: iam.Role
# security_group: ec2.SecurityGroup
# subnet: ec2.Subnet
# subnet_filter: ec2.SubnetFilter
# vpc: ec2.Vpc

managed_ec2_eks_compute_environment = batch.ManagedEc2EksComputeEnvironment(self, "MyManagedEc2EksComputeEnvironment",
    eks_cluster=cluster,
    kubernetes_namespace="kubernetesNamespace",
    vpc=vpc,

    # the properties below are optional
    allocation_strategy=batch.AllocationStrategy.BEST_FIT,
    compute_environment_name="computeEnvironmentName",
    enabled=False,
    images=[batch.EksMachineImage(
        image=machine_image,
        image_type=batch.EksMachineImageType.EKS_AL2
    )],
    instance_classes=[ec2.InstanceClass.STANDARD3],
    instance_role=role,
    instance_types=[instance_type],
    launch_template=launch_template,
    maxv_cpus=123,
    minv_cpus=123,
    placement_group=placement_group,
    replace_compute_environment=False,
    security_groups=[security_group],
    service_role=role,
    spot=False,
    spot_bid_percentage=123,
    terminate_on_update=False,
    update_timeout=cdk.Duration.minutes(30),
    update_to_latest_image_version=False,
    use_optimal_instance_classes=False,
    vpc_subnets=ec2.SubnetSelection(
        availability_zones=["availabilityZones"],
        one_per_az=False,
        subnet_filters=[subnet_filter],
        subnet_group_name="subnetGroupName",
        subnets=[subnet],
        subnet_type=ec2.SubnetType.PRIVATE_ISOLATED
    )
)

Parameters:

scope (Construct) –
id (str) –
eks_cluster (ICluster) – 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.
kubernetes_namespace (str) – The namespace of the Cluster.
allocation_strategy (Optional[AllocationStrategy]) – 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.
images (Optional[Sequence[Union[EksMachineImage, Dict[str, Any]]]]) – Configure which AMIs this Compute Environment can launch. Default: If imageKubernetesVersion is specified, - EKS_AL2 for non-GPU instances, EKS_AL2_NVIDIA for GPU instances, Otherwise, - ECS_AL2 for non-GPU instances, ECS_AL2_NVIDIA for GPU instances,
instance_classes (Optional[Sequence[InstanceClass]]) – The instance types 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)
instance_role (Optional[IRole]) – The execution Role that instances launched by this Compute Environment will use. Default: - a role will be created
instance_types (Optional[Sequence[InstanceType]]) – 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)
launch_template (Optional[ILaunchTemplate]) – 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 ``securityGroup``s on the Compute Environment override the ones on the launch template. Default: - no launch template
minv_cpus (Union[int, float, None]) – The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED. Default: 0
placement_group (Optional[IPlacementGroup]) – 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
spot_bid_percentage (Union[int, float, None]) – 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%
use_optimal_instance_classes (Optional[bool]) – 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
vpc (IVpc) – VPC in which this Compute Environment will launch Instances.
maxv_cpus (Union[int, float, None]) – 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
replace_compute_environment (Optional[bool]) – 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
security_groups (Optional[Sequence[ISecurityGroup]]) – The security groups this Compute Environment will launch instances in. Default: new security groups will be created
spot (Optional[bool]) – 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
terminate_on_update (Optional[bool]) – 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
update_timeout (Optional[Duration]) – 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
update_to_latest_image_version (Optional[bool]) – 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. Default: true
vpc_subnets (Union[SubnetSelection, Dict[str, Any], None]) – The VPC Subnets this Compute Environment will launch instances in. Default: new subnets will be created
compute_environment_name (Optional[str]) – The name of the ComputeEnvironment. Default: - generated by CloudFormation
enabled (Optional[bool]) – 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
service_role (Optional[IRole]) – 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

Methods

add_instance_class(instance_class)

Add an instance class to this compute environment.

Parameters:

instance_class (InstanceClass) –

Return type:

None

add_instance_type(instance_type)

Add an instance type to this compute environment.

Parameters:

instance_type (InstanceType) –

Return type:

None

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

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

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

compute_environment_arn: The ARN of this compute environment.

compute_environment_name: The name of the ComputeEnvironment.

connections: The network connections associated with this resource.

eks_cluster

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.

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.

env

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.

images: Configure which AMIs this Compute Environment can launch.

instance_classes

The instance types that this Compute Environment can launch.

Which one is chosen depends on the AllocationStrategy used.

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

instance_types

The instance types that this Compute Environment can launch.

Which one is chosen depends on the AllocationStrategy used.

kubernetes_namespace

The namespace of the Cluster.

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

launch_template

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 ``securityGroup``s on the Compute Environment override the ones on the launch template.

maxv_cpus

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.

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

node: The tree node.

placement_group

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.

replace_compute_environment

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:

security_groups: The security groups this Compute Environment will launch instances in.

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

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.

spot_bid_percentage

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

stack: The stack in which this resource is defined.

tags: TagManager to set, remove and format tags.

terminate_on_update

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.

update_timeout

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.

update_to_latest_image_version

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.

Static Methods

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool