AWS Batch
API Reference (API Version 2016-08-10)

ComputeResource

An object representing an AWS Batch compute resource.

Contents

bidPercentage

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.

Type: Integer

Required: No

desiredvCpus

The desired number of EC2 vCPUS in the compute environment.

Type: Integer

Required: No

ec2KeyPair

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

Type: String

Required: No

imageId

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

Type: String

Required: No

instanceRole

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.

Type: String

Required: Yes

instanceTypes

The instances types that may be launched. 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 latest C, M, and R instance families) on the fly that match the demand of your job queues.

Type: Array of strings

Required: Yes

launchTemplate

The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both.

Type: LaunchTemplateSpecification object

Required: No

maxvCpus

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

Type: Integer

Required: Yes

minvCpus

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

Type: Integer

Required: Yes

placementGroup

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

Type: String

Required: No

securityGroupIds

The EC2 security group that is associated with instances launched in the compute environment.

Type: Array of strings

Required: No

spotIamFleetRole

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.

Type: String

Required: No

subnets

The VPC subnets into which the compute resources are launched.

Type: Array of strings

Required: Yes

tags

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

Type: String to string map

Required: No

type

The type of compute environment.

Type: String

Valid Values: EC2 | SPOT

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: