UnmanagedComputeEnvironment L2 construct
Unmanaged ComputeEnvironments do not provision or manage EC2 instances on your behalf.
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 unmanagedComputeEnvironment = new batch.UnmanagedComputeEnvironment(this, 'MyUnmanagedComputeEnvironment', /* all optional props */ {
computeEnvironmentName: 'computeEnvironmentName',
enabled: false,
serviceRole: role,
unmanagedvCpus: 123,
});
# 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
)
// 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;
UnmanagedComputeEnvironment unmanagedComputeEnvironment = UnmanagedComputeEnvironment.Builder.create(this, "MyUnmanagedComputeEnvironment")
.computeEnvironmentName("computeEnvironmentName")
.enabled(false)
.serviceRole(role)
.unmanagedvCpus(123)
.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 unmanagedComputeEnvironment = new UnmanagedComputeEnvironment(this, "MyUnmanagedComputeEnvironment", new UnmanagedComputeEnvironmentProps {
ComputeEnvironmentName = "computeEnvironmentName",
Enabled = false,
ServiceRole = role,
UnmanagedvCpus = 123
});
// 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
unmanagedComputeEnvironment := awscdk.Aws_batch.NewUnmanagedComputeEnvironment(this, jsii.String("MyUnmanagedComputeEnvironment"), &UnmanagedComputeEnvironmentProps{
ComputeEnvironmentName: jsii.String("computeEnvironmentName"),
Enabled: jsii.Boolean(false),
ServiceRole: role,
UnmanagedvCpus: jsii.Number(123),
})
Initializer
new UnmanagedComputeEnvironment(scope: Construct, id: string, props?: UnmanagedComputeEnvironmentProps)
UnmanagedComputeEnvironment(scope: Construct, id: str, props: typing.Optional[UnmanagedComputeEnvironmentProps] = None)
new UnmanagedComputeEnvironment(Construct scope, String id, UnmanagedComputeEnvironmentProps props)
new UnmanagedComputeEnvironment(Construct scope, string id, UnmanagedComputeEnvironmentProps? props = null)
NewUnmanagedComputeEnvironment(Scope Construct, Id *string, Props UnmanagedComputeEnvironmentProps)
Construct Props
computeEnvironmentNameoptionalstringcompute_environment_nameoptionalstrcomputeEnvironmentNameoptionalStringComputeEnvironmentNameoptionalstringComputeEnvironmentNameoptional*string#Default: generated by CloudFormation
enabledoptionalbooleanenabledoptionalboolenabledoptionalBooleanEnabledoptionalboolEnabledoptional*bool= true#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.
serviceRoleoptionalIRoleservice_roleoptionalIRoleserviceRoleoptionalIRoleServiceRoleoptionalIRoleServiceRoleoptionalIRole#Default: a serviceRole will be created for managed CEs, none for unmanaged CEs
unmanagedvCpusoptionalnumberunmanagedv_cpusoptionalint | floatunmanagedvCpusoptionalNumberUnmanagedvCpusoptionaldoubleUnmanagedvCpusoptional*float64= 0#If this parameter is not provided on a fairshare queue, no capacity is reserved; that is, the FairshareSchedulingPolicy is ignored.
Properties
computeEnvironmentArnstringcompute_environment_arnstrcomputeEnvironmentArnStringComputeEnvironmentArnstringComputeEnvironmentArn*stringrequired#computeEnvironmentNamestringcompute_environment_namestrcomputeEnvironmentNameStringComputeEnvironmentNamestringComputeEnvironmentName*stringrequired#computeEnvironmentRefComputeEnvironmentReferencecompute_environment_refComputeEnvironmentReferencecomputeEnvironmentRefComputeEnvironmentReferenceComputeEnvironmentRefComputeEnvironmentReferenceComputeEnvironmentRefComputeEnvironmentReferencerequired#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.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
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.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#serviceRolemay be undefinedIRoleservice_rolemay be undefinedIRoleserviceRolemay be undefinedIRoleServiceRolemay be undefinedIRoleServiceRolemay be undefinedIRole#unmanagedvCPUsmay be undefinednumberunmanagedv_cp_usmay be undefinedint | floatunmanagedvCPUsmay be undefinedNumberUnmanagedvCPUsmay be undefineddoubleUnmanagedvCPUsmay be undefined*float64#If this parameter is not provided on a fairshare queue, no capacity is reserved; that is, the FairshareSchedulingPolicy is ignored.
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
fromUnmanagedComputeEnvironmentArn(scope: Construct, id: string, unmanagedComputeEnvironmentArn: string): IUnmanagedComputeEnvironment@staticmethod def from_unmanaged_compute_environment_arn(scope: Construct, id: str, unmanaged_compute_environment_arn: str) -> IUnmanagedComputeEnvironmentpublic static IUnmanagedComputeEnvironment fromUnmanagedComputeEnvironmentArn(Construct scope, String id, String unmanagedComputeEnvironmentArn)public static IUnmanagedComputeEnvironment FromUnmanagedComputeEnvironmentArn(Construct scope, string id, string unmanagedComputeEnvironmentArn)func FromUnmanagedComputeEnvironmentArn(Scope Construct, Id *string, UnmanagedComputeEnvironmentArn *string) IUnmanagedComputeEnvironmentstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
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
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.