UnmanagedComputeEnvironment

class aws_cdk.aws_batch.UnmanagedComputeEnvironment(scope, id, *, unmanagedv_cpus=None, compute_environment_name=None, enabled=None, service_role=None)

Bases: Resource

Unmanaged ComputeEnvironments do not provision or manage EC2 instances on your behalf.

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.
from aws_cdk import aws_batch as batch
from aws_cdk import aws_iam as iam

# role: iam.Role

unmanaged_compute_environment = batch.UnmanagedComputeEnvironment(self, "MyUnmanagedComputeEnvironment",
    compute_environment_name="computeEnvironmentName",
    enabled=False,
    service_role=role,
    unmanagedv_cpus=123
)

Parameters:

scope (Construct)
id (str)
unmanagedv_cpus (Union[int, float, None]) – The vCPUs this Compute Environment provides. Used only by the scheduler to schedule jobs in Queue``s that use ``FairshareSchedulingPolicy``s. **If this parameter is not provided on a fairshare queue, no capacity is reserved**; that is, the ``FairshareSchedulingPolicy is ignored. Default: 0
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

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

PROPERTY_INJECTION_ID = 'aws-cdk-lib.aws-batch.UnmanagedComputeEnvironment'

compute_environment_arn: The ARN of this compute environment.

compute_environment_name: The name of the ComputeEnvironment.

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 in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

node: The tree node.

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

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

unmanagedv_cp_us

The vCPUs this Compute Environment provides. Used only by the scheduler to schedule jobs in ``Queue``s that use ``FairshareSchedulingPolicy``s.

If this parameter is not provided on a fairshare queue, no capacity is reserved; that is, the FairshareSchedulingPolicy is ignored.

Static Methods

classmethod from_unmanaged_compute_environment_arn(scope, id, unmanaged_compute_environment_arn)

Import an UnmanagedComputeEnvironment by its arn.

Parameters:

scope (Construct)
id (str)
unmanaged_compute_environment_arn (str)

Return type:

IUnmanagedComputeEnvironment

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