2.168.0

interface ManagedComputeEnvironmentProps

LanguageType name
.NETAmazon.CDK.AWS.Batch.ManagedComputeEnvironmentProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsbatch#ManagedComputeEnvironmentProps
Javasoftware.amazon.awscdk.services.batch.ManagedComputeEnvironmentProps
Pythonaws_cdk.aws_batch.ManagedComputeEnvironmentProps
TypeScript (source)aws-cdk-lib » aws_batch » ManagedComputeEnvironmentProps

Props for a ManagedComputeEnvironment.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_batch as batch } from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';

declare const role: iam.Role;
declare const securityGroup: ec2.SecurityGroup;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const vpc: ec2.Vpc;
const managedComputeEnvironmentProps: batch.ManagedComputeEnvironmentProps = {
  vpc: vpc,

  // the properties below are optional
  computeEnvironmentName: 'computeEnvironmentName',
  enabled: false,
  maxvCpus: 123,
  replaceComputeEnvironment: false,
  securityGroups: [securityGroup],
  serviceRole: role,
  spot: false,
  terminateOnUpdate: false,
  updateTimeout: cdk.Duration.minutes(30),
  updateToLatestImageVersion: false,
  vpcSubnets: {
    availabilityZones: ['availabilityZones'],
    onePerAz: false,
    subnetFilters: [subnetFilter],
    subnetGroupName: 'subnetGroupName',
    subnets: [subnet],
    subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
  },
};

Properties

NameTypeDescription
vpcIVpcVPC in which this Compute Environment will launch Instances.
computeEnvironmentName?stringThe name of the ComputeEnvironment.
enabled?booleanWhether or not this ComputeEnvironment can accept jobs from a Queue.
maxvCpus?numberThe maximum vCpus this ManagedComputeEnvironment can scale up to. Each vCPU is equivalent to 1024 CPU shares.
replaceComputeEnvironment?booleanSpecifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.
securityGroups?ISecurityGroup[]The security groups this Compute Environment will launch instances in.
serviceRole?IRoleThe role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.
spot?booleanWhether or not to use spot instances.
terminateOnUpdate?booleanWhether or not any running jobs will be immediately terminated when an infrastructure update occurs.
updateTimeout?DurationOnly meaningful if terminateOnUpdate is false.
updateToLatestImageVersion?booleanWhether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs.
vpcSubnets?SubnetSelectionThe VPC Subnets this Compute Environment will launch instances in.

vpc

Type: IVpc

VPC in which this Compute Environment will launch Instances.

computeEnvironmentName?

Type: string (optional, default: generated by CloudFormation)

The name of the ComputeEnvironment.

enabled?

Type: boolean (optional, default: true)

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.

maxvCpus?

Type: number (optional, default: 256)

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.

replaceComputeEnvironment?

Type: boolean (optional, default: false)

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:

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

securityGroups?

Type: ISecurityGroup[] (optional, default: new security groups will be created)

The security groups this Compute Environment will launch instances in.

serviceRole?

Type: IRole (optional, default: a serviceRole will be created for managed CEs, none for unmanaged CEs)

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

spot?

Type: boolean (optional, default: false)

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.

terminateOnUpdate?

Type: boolean (optional, default: false)

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.

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

updateTimeout?

Type: Duration (optional, default: 30 minutes)

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.

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

updateToLatestImageVersion?

Type: boolean (optional, default: true)

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.

vpcSubnets?

Type: SubnetSelection (optional, default: new subnets will be created)

The VPC Subnets this Compute Environment will launch instances in.

← PreviousNext →