Package software.amazon.awscdk.services.batch

Class ComputeEnvironment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.batch.ComputeEnvironment

All Implemented Interfaces:

IConstruct, IDependable, IResource, IComputeEnvironment, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.652Z")
@Stability(Experimental)
public class ComputeEnvironment
extends Resource
implements IComputeEnvironment

(experimental) Batch Compute Environment.

Defines a batch compute environment to run batch jobs on.

Example:

 Vpc vpc;
 ComputeEnvironment myComputeEnv = ComputeEnvironment.Builder.create(this, "ComputeEnv")
         .computeResources(ComputeResources.builder()
                 .image(EcsOptimizedAmi.Builder.create()
                         .generation(AmazonLinuxGeneration.AMAZON_LINUX_2)
                         .build())
                 .vpc(vpc)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ComputeEnvironment.Builder	(experimental) A fluent builder for ComputeEnvironment.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IComputeEnvironment

IComputeEnvironment.Jsii$Default, IComputeEnvironment.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ComputeEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ComputeEnvironment(software.amazon.jsii.JsiiObjectRef objRef)
	ComputeEnvironment(software.constructs.Construct scope, String id)
	ComputeEnvironment(software.constructs.Construct scope, String id, ComputeEnvironmentProps props)

Method Summary

Modifier and Type	Method	Description
static IComputeEnvironment	fromComputeEnvironmentArn(software.constructs.Construct scope, String id, String computeEnvironmentArn)	(experimental) Fetches an existing batch compute environment by its amazon resource name.
String	getComputeEnvironmentArn()	(experimental) The ARN of this compute environment.
String	getComputeEnvironmentName()	(experimental) The name of this compute environment.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ComputeEnvironment

protected ComputeEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

ComputeEnvironment

protected ComputeEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ComputeEnvironment

@Stability(Experimental)
public ComputeEnvironment(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ComputeEnvironmentProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

ComputeEnvironment

@Stability(Experimental)
public ComputeEnvironment(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromComputeEnvironmentArn

@Stability(Experimental)
@NotNull
public static IComputeEnvironment fromComputeEnvironmentArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String computeEnvironmentArn)

(experimental) Fetches an existing batch compute environment by its amazon resource name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

computeEnvironmentArn - This parameter is required.

getComputeEnvironmentArn

@Stability(Experimental)
@NotNull
public String getComputeEnvironmentArn()

(experimental) The ARN of this compute environment.

Specified by:

getComputeEnvironmentArn in interface IComputeEnvironment

getComputeEnvironmentName

@Stability(Experimental)
@NotNull
public String getComputeEnvironmentName()

(experimental) The name of this compute environment.

Specified by:

getComputeEnvironmentName in interface IComputeEnvironment