ManagedComputeEnvironmentProps

class aws_cdk.aws_batch.ManagedComputeEnvironmentProps(*, compute_environment_name=None, enabled=None, service_role=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)

Bases: ComputeEnvironmentProps

Props for a ManagedComputeEnvironment.

Parameters:

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
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

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_iam as iam

# role: iam.Role
# security_group: ec2.SecurityGroup
# subnet: ec2.Subnet
# subnet_filter: ec2.SubnetFilter
# vpc: ec2.Vpc

managed_compute_environment_props = batch.ManagedComputeEnvironmentProps(
    vpc=vpc,

    # the properties below are optional
    compute_environment_name="computeEnvironmentName",
    enabled=False,
    maxv_cpus=123,
    replace_compute_environment=False,
    security_groups=[security_group],
    service_role=role,
    spot=False,
    terminate_on_update=False,
    update_timeout=cdk.Duration.minutes(30),
    update_to_latest_image_version=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
    )
)

Attributes

compute_environment_name

The name of the ComputeEnvironment.

Default:

generated by CloudFormation

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.

Default:: true

maxv_cpus

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

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
See:: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html

security_groups

The security groups this Compute Environment will launch instances in.

Default:: new security groups will be created

service_role

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

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.

Default:: false

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.

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

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.

Default:: 30 minutes
See:: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

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.

Default:: true

vpc: VPC in which this Compute Environment will launch Instances.

vpc_subnets

The VPC Subnets this Compute Environment will launch instances in.

Default:: new subnets will be created