aws-cdk-lib.aws_batch.ComputeEnvironmentProps

ComputeEnvironmentProps Struct

Props common to all ComputeEnvironments.

Source

aws-batch/lib/compute-environment-base.ts

Type last changed

v2.96.0 · 13 Sep 2023

Example

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

declare const role: iam.Role;
const computeEnvironmentProps: batch.ComputeEnvironmentProps = {
  computeEnvironmentName: 'computeEnvironmentName',
  enabled: false,
  serviceRole: role,
};

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

# role: iam.Role

compute_environment_props = batch.ComputeEnvironmentProps(
    compute_environment_name="computeEnvironmentName",
    enabled=False,
    service_role=role
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.batch.*;
import software.amazon.awscdk.services.iam.*;

Role role;

ComputeEnvironmentProps computeEnvironmentProps = ComputeEnvironmentProps.builder()
        .computeEnvironmentName("computeEnvironmentName")
        .enabled(false)
        .serviceRole(role)
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Batch;
using Amazon.CDK.AWS.IAM;

Role role;

var computeEnvironmentProps = new ComputeEnvironmentProps {
    ComputeEnvironmentName = "computeEnvironmentName",
    Enabled = false,
    ServiceRole = role
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var role Role

computeEnvironmentProps := &ComputeEnvironmentProps{
	ComputeEnvironmentName: jsii.String("computeEnvironmentName"),
	Enabled: jsii.Boolean(false),
	ServiceRole: role,
}

Properties

computeEnvironmentName?optionalstringcompute_environment_name?optionalstrcomputeEnvironmentName?optionalStringComputeEnvironmentName?optionalstringComputeEnvironmentName?optional*string#

The name of the ComputeEnvironment.

Default: generated by CloudFormation

enabled?optionalbooleanenabled?optionalboolenabled?optionalBooleanEnabled?optionalboolEnabled?optional*bool= true#

Whether or not this ComputeEnvironment can accept jobs from a Queue.

notes

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.

serviceRole?optionalIRoleservice_role?optionalIRoleserviceRole?optionalIRoleServiceRole?optionalIRoleServiceRole?optionalIRole#

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