software.amazon.awscdk.services.batch

Interface ComputeResources

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ComputeResources.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T17:53:15.613Z")
 @Stability(value=Experimental)
public interface ComputeResources
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for defining the structure of the batch compute cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ComputeResources.Builder A builder for ComputeResources
static class	ComputeResources.Jsii$Proxy An implementation for ComputeResources

Method Summary

Modifier and Type	Method and Description
static ComputeResources.Builder	builder()
default AllocationStrategy	getAllocationStrategy() (experimental) The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated.
default Number	getBidPercentage() (experimental) This property will be ignored if you set the environment type to ON_DEMAND.
default Map<String,String>	getComputeResourcesTags() (experimental) Key-value pair tags to be applied to resources that are launched in the compute environment.
default Number	getDesiredvCpus() (experimental) The desired number of EC2 vCPUS in the compute environment.
default String	getEc2KeyPair() (experimental) The EC2 key pair that is used for instances launched in the compute environment.
default IMachineImage	getImage() (experimental) The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
default String	getInstanceRole() (experimental) The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
default List<InstanceType>	getInstanceTypes() (experimental) The types of EC2 instances that may be launched in the compute environment.
default LaunchTemplateSpecification	getLaunchTemplate() (experimental) An optional launch template to associate with your compute resources.
default Number	getMaxvCpus() (experimental) The maximum number of EC2 vCPUs that an environment can reach.
default Number	getMinvCpus() (experimental) The minimum number of EC2 vCPUs that an environment should maintain (even if the compute environment state is DISABLED).
default String	getPlacementGroup() (experimental) The Amazon EC2 placement group to associate with your compute resources.
default List<ISecurityGroup>	getSecurityGroups() (experimental) The EC2 security group(s) associated with instances launched in the compute environment.
default IRole	getSpotFleetRole() (experimental) This property will be ignored if you set the environment type to ON_DEMAND.
default ComputeResourceType	getType() (experimental) The type of compute environment: ON_DEMAND or SPOT.
IVpc	getVpc() (experimental) The VPC network that all compute resources will be connected to.
default SubnetSelection	getVpcSubnets() (experimental) The VPC subnets into which the compute resources are launched.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getVpc

@Stability(value=Experimental)
 @NotNull
IVpc getVpc()

(experimental) The VPC network that all compute resources will be connected to.

getAllocationStrategy

@Stability(value=Experimental)
 @Nullable
default AllocationStrategy getAllocationStrategy()

(experimental) The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated.

This could be due to availability of the instance type in the region or Amazon EC2 service limits. If this is not specified, the default for the EC2 ComputeResourceType is BEST_FIT, which will use only the best fitting instance type, waiting for additional capacity if it's not available. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM Role must be specified. BEST_FIT_PROGRESSIVE will select an additional instance type that is large enough to meet the requirements of the jobs in the queue, with a preference for an instance type with a lower cost. The default value for the SPOT instance type is SPOT_CAPACITY_OPTIMIZED, which is only available for for this type of compute resources and will select an additional instance type that is large enough to meet the requirements of the jobs in the queue, with a preference for an instance type that is less likely to be interrupted.

Default: AllocationStrategy.BEST_FIT

getBidPercentage

@Stability(value=Experimental)
 @Nullable
default Number getBidPercentage()

(experimental) This property will be ignored if you set the environment type to ON_DEMAND.

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.

Default: 100

getComputeResourcesTags

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getComputeResourcesTags()

(experimental) Key-value pair tags to be applied to resources that are launched in the compute environment.

For AWS Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value—for example, { "Name": "AWS Batch Instance - C4OnDemand" }.

Default: - no tags will be assigned on compute resources.

getDesiredvCpus

@Stability(value=Experimental)
 @Nullable
default Number getDesiredvCpus()

(experimental) The desired number of EC2 vCPUS in the compute environment.

Default: - no desired vcpu value will be used.

getEc2KeyPair

@Stability(value=Experimental)
 @Nullable
default String getEc2KeyPair()

(experimental) The EC2 key pair that is used for instances launched in the compute environment.

If no key is defined, then SSH access is not allowed to provisioned compute resources.

Default: - no SSH access will be possible.

getImage

@Stability(value=Experimental)
 @Nullable
default IMachineImage getImage()

(experimental) The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.

Default: - no image will be used.

getInstanceRole

@Stability(value=Experimental)
 @Nullable
default String getInstanceRole()

(experimental) The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.

You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS Instance Role in the AWS Batch User Guide.

Default: - a new role will be created.

getInstanceTypes

@Stability(value=Experimental)
 @Nullable
default List<InstanceType> getInstanceTypes()

(experimental) The types of EC2 instances that may be launched in the compute environment.

You can specify instance families to launch any instance type within those families (for example, c4 or p3), or you can specify specific sizes within a family (such as c4.8xlarge). You can also choose optimal to pick instance types (from the C, M, and R instance families) on the fly that match the demand of your job queues.

Default: optimal

getLaunchTemplate

@Stability(value=Experimental)
 @Nullable
default LaunchTemplateSpecification getLaunchTemplate()

(experimental) An optional launch template to associate with your compute resources.

For more information, see README file.

Default: - no custom launch template will be used

getMaxvCpus

@Stability(value=Experimental)
 @Nullable
default Number getMaxvCpus()

(experimental) The maximum number of EC2 vCPUs that an environment can reach.

Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

Default: 256

getMinvCpus

@Stability(value=Experimental)
 @Nullable
default Number getMinvCpus()

(experimental) The minimum number of EC2 vCPUs that an environment should maintain (even if the compute environment state is DISABLED).

Each vCPU is equivalent to 1,024 CPU shares. By keeping this set to 0 you will not have instance time wasted when there is no work to be run. If you set this above zero you will maintain that number of vCPUs at all times.

Default: 0

getPlacementGroup

@Stability(value=Experimental)
 @Nullable
default String getPlacementGroup()

(experimental) The Amazon EC2 placement group to associate with your compute resources.

Default: - No placement group will be used.

getSecurityGroups

@Stability(value=Experimental)
 @Nullable
default List<ISecurityGroup> getSecurityGroups()

(experimental) The EC2 security group(s) associated with instances launched in the compute environment.

Default: - AWS default security group.

getSpotFleetRole

@Stability(value=Experimental)
 @Nullable
default IRole getSpotFleetRole()

(experimental) This property will be ignored if you set the environment type to ON_DEMAND.

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. For more information, see Amazon EC2 Spot Fleet Role in the AWS Batch User Guide.

Default: - no fleet role will be used.

getType

@Stability(value=Experimental)
 @Nullable
default ComputeResourceType getType()

(experimental) The type of compute environment: ON_DEMAND or SPOT.

Default: ON_DEMAND

getVpcSubnets

@Stability(value=Experimental)
 @Nullable
default SubnetSelection getVpcSubnets()

(experimental) The VPC subnets into which the compute resources are launched.

Default: - private subnets of the supplied VPC.

builder

@Stability(value=Experimental)
static ComputeResources.Builder builder()

Returns:

a ComputeResources.Builder of ComputeResources