Package software.amazon.awscdk.services.batch

Interface ComputeEnvironmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ComputeEnvironmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.653Z")
@Stability(Experimental)
public interface ComputeEnvironmentProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for creating a new Compute Environment.

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	Interface	Description
static final class	ComputeEnvironmentProps.Builder	A builder for ComputeEnvironmentProps
static final class	ComputeEnvironmentProps.Jsii$Proxy	An implementation for ComputeEnvironmentProps

Method Summary

Modifier and Type	Method	Description
static ComputeEnvironmentProps.Builder	builder()
default String	getComputeEnvironmentName()	(experimental) A name for the compute environment.
default ComputeResources	getComputeResources()	(experimental) The details of the required compute resources for the managed compute environment.
default Boolean	getEnabled()	(experimental) The state of the compute environment.
default Boolean	getManaged()	(experimental) Determines if AWS should manage the allocation of compute resources for processing jobs.
default IRole	getServiceRole()	(experimental) The IAM role used by Batch to make calls to other AWS services on your behalf for managing the resources that you use with the service.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComputeEnvironmentName

@Stability(Experimental)
@Nullable
default String getComputeEnvironmentName()

(experimental) A name for the compute environment.

Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Default: - CloudFormation-generated name

getComputeResources

@Stability(Experimental)
@Nullable
default ComputeResources getComputeResources()

(experimental) The details of the required compute resources for the managed compute environment.

If specified, and this is an unmanaged compute environment, will throw an error.

By default, AWS Batch managed compute environments use a recent, approved version of the Amazon ECS-optimized AMI for compute resources.

Default: - CloudFormation defaults

getEnabled

@Stability(Experimental)
@Nullable
default Boolean getEnabled()

(experimental) The state of the compute environment.

If the state is set to true, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

Default: true

getManaged

@Stability(Experimental)
@Nullable
default Boolean getManaged()

(experimental) Determines if AWS should manage the allocation of compute resources for processing jobs.

If set to false, then you are in charge of providing the compute resource details.

Default: true

getServiceRole

@Stability(Experimental)
@Nullable
default IRole getServiceRole()

(experimental) The IAM role used by Batch to make calls to other AWS services on your behalf for managing the resources that you use with the service.

By default, this role is created for you using the AWS managed service policy for Batch.

Default: - Role using the 'service-role/AWSBatchServiceRole' policy.

builder

@Stability(Experimental)
static ComputeEnvironmentProps.Builder builder()

Returns:

a ComputeEnvironmentProps.Builder of ComputeEnvironmentProps