ComputeEnvironmentProps

class aws_cdk.aws_batch.ComputeEnvironmentProps(*, compute_environment_name=None, enabled=None, service_role=None)

Bases: object

Props common to all ComputeEnvironments.

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

ExampleMetadata:

fixture=_generated

Example:

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

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

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