class Aws::Batch::Types::ComputeResource

An object representing an Batch compute resource. For more information, see [Compute Environments] in the *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/compute_environments.html

@note When making an API call, you may pass ComputeResource

data as a hash:

    {
      type: "EC2", # required, accepts EC2, SPOT, FARGATE, FARGATE_SPOT
      allocation_strategy: "BEST_FIT", # accepts BEST_FIT, BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED
      minv_cpus: 1,
      maxv_cpus: 1, # required
      desiredv_cpus: 1,
      instance_types: ["String"],
      image_id: "String",
      subnets: ["String"], # required
      security_group_ids: ["String"],
      ec2_key_pair: "String",
      instance_role: "String",
      tags: {
        "String" => "String",
      },
      placement_group: "String",
      bid_percentage: 1,
      spot_iam_fleet_role: "String",
      launch_template: {
        launch_template_id: "String",
        launch_template_name: "String",
        version: "String",
      },
      ec2_configuration: [
        {
          image_type: "ImageType", # required
          image_id_override: "ImageIdOverride",
        },
      ],
    }

@!attribute [rw] type

The type of compute environment: `EC2`, `SPOT`, `FARGATE`, or
`FARGATE_SPOT`. For more information, see [Compute Environments][1]
in the *Batch User Guide*.

If you choose `SPOT`, you must also specify an Amazon EC2 Spot Fleet
role with the `spotIamFleetRole` parameter. For more information,
see [Amazon EC2 Spot Fleet role][2] in the *Batch User Guide*.

[1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
[2]: https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html
@return [String]

@!attribute [rw] allocation_strategy

The allocation strategy to use for the compute resource if not
enough instances of the best fitting instance type can be allocated.
This might be because of availability of the instance type in the
Region or [Amazon EC2 service limits][1]. For more information, see
[Allocation Strategies][2] in the *Batch User Guide*.

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources, and shouldn't be specified.

 </note>

BEST\_FIT (default)

: Batch selects an instance type that best fits the needs of the
  jobs with a preference for the lowest-cost instance type. If
  additional instances of the selected instance type aren't
  available, Batch waits for the additional instances to be
  available. If there aren't enough instances available, or if the
  user is reaching [Amazon EC2 service limits][1] then additional
  jobs aren't run until the currently running jobs have completed.
  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

: Batch will select additional instance types that are large enough
  to meet the requirements of the jobs in the queue, with a
  preference for instance types with a lower cost per unit vCPU. If
  additional instances of the previously selected instance types
  aren't available, Batch will select new instance types.

SPOT\_CAPACITY\_OPTIMIZED

: Batch will select one or more instance types that are large enough
  to meet the requirements of the jobs in the queue, with a
  preference for instance types that are less likely to be
  interrupted. This allocation strategy is only available for Spot
  Instance compute resources.

With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
strategies, Batch might need to go above `maxvCpus` to meet your
capacity requirements. In this event, Batch never exceeds `maxvCpus`
by more than a single instance.

[1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html
[2]: https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html
@return [String]

@!attribute [rw] minv_cpus

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

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources, and shouldn't be specified.

 </note>
@return [Integer]

@!attribute [rw] maxv_cpus

The maximum number of Amazon EC2 vCPUs that a compute environment
can reach.

<note markdown="1"> With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
allocation strategies, Batch might need to exceed `maxvCpus` to meet
your capacity requirements. In this event, Batch never exceeds
`maxvCpus` by more than a single instance. For example, no more than
a single instance from among those specified in your compute
environment is allocated.

 </note>
@return [Integer]

@!attribute [rw] desiredv_cpus

The desired number of Amazon EC2 vCPUS in the compute environment.
Batch modifies this value between the minimum and maximum values,
based on job queue demand.

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources, and shouldn't be specified.

 </note>
@return [Integer]

@!attribute [rw] instance_types

The instances types that can be launched. You can specify instance
families to launch any instance type within those families (for
example, `c5` or `p3`), or you can specify specific sizes within a
family (such as `c5.8xlarge`). You can also choose `optimal` to
select instance types (from the C4, M4, and R4 instance families)
that match the demand of your job queues.

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources, and shouldn't be specified.

 </note>

<note markdown="1"> When you create a compute environment, the instance types that you
select for the compute environment must share the same architecture.
For example, you can't mix x86 and ARM instances in the same
compute environment.

 </note>

<note markdown="1"> Currently, `optimal` uses instance types from the C4, M4, and R4
instance families. In Regions that don't have instance types from
those instance families, instance types from the C5, M5. and R5
instance families are used.

 </note>
@return [Array<String>]

@!attribute [rw] image_id

The Amazon Machine Image (AMI) ID used for instances launched in the
compute environment. This parameter is overridden by the
`imageIdOverride` member of the `Ec2Configuration` structure.

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources, and shouldn't be specified.

 </note>

<note markdown="1"> The AMI that you choose for a compute environment must match the
architecture of the instance types that you intend to use for that
compute environment. For example, if your compute environment uses
A1 instance types, the compute resource AMI that you choose must
support ARM instances. Amazon ECS vends both x86 and ARM versions of
the Amazon ECS-optimized Amazon Linux 2 AMI. For more information,
see [Amazon ECS-optimized Amazon Linux 2 AMI][1] in the *Amazon
Elastic Container Service Developer Guide*.

 </note>

[1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html
@return [String]

@!attribute [rw] subnets

The VPC subnets where the compute resources are launched. These
subnets must be within the same VPC. Fargate compute resources can
contain up to 16 subnets. For more information, see [VPCs and
Subnets][1] in the *Amazon VPC User Guide*.

[1]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html
@return [Array<String>]

@!attribute [rw] security_group_ids

The Amazon EC2 security groups associated with instances launched in
the compute environment. One or more security groups must be
specified, either in `securityGroupIds` or using a launch template
referenced in `launchTemplate`. This parameter is required for jobs
that are running on Fargate resources and must contain at least one
security group. Fargate doesn't support launch templates. If
security groups are specified using both `securityGroupIds` and
`launchTemplate`, the values in `securityGroupIds` are used.
@return [Array<String>]

@!attribute [rw] ec2_key_pair

The Amazon EC2 key pair that's used for instances launched in the
compute environment. You can use this key pair to log in to your
instances with SSH.

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources, and shouldn't be specified.

 </note>
@return [String]

@!attribute [rw] instance_role

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][1] in the
*Batch User Guide*.

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources, and shouldn't be specified.

 </note>

[1]: https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html
@return [String]

@!attribute [rw] tags

Key-value pair tags to be applied to EC2 resources that are launched
in the compute environment. For Batch, these take the form of
"String1": "String2", where String1 is the tag key and String2
is the tag value−for example, `\{ "Name": "Batch Instance -
C4OnDemand" \}`. This is helpful for recognizing your Batch
instances in the Amazon EC2 console. These tags can't be updated or
removed after the compute environment is created.Aany changes to
these tags require that you create a new compute environment and
remove the old compute environment. These tags aren't seen when
using the Batch `ListTagsForResource` API operation.

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources, and shouldn't be specified.

 </note>
@return [Hash<String,String>]

@!attribute [rw] placement_group

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][1] in the
*Amazon EC2 User Guide for Linux Instances*.

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources, and shouldn't be specified.

 </note>

[1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
@return [String]

@!attribute [rw] bid_percentage

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 less than 20% of the current
On-Demand price for that Amazon 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.

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources, and shouldn't be specified.

 </note>
@return [Integer]

@!attribute [rw] spot_iam_fleet_role

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role
applied to a `SPOT` compute environment. This role is required if
the allocation strategy set to `BEST_FIT` or if the allocation
strategy isn't specified. For more information, see [Amazon EC2
Spot Fleet Role][1] in the *Batch User Guide*.

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources, and shouldn't be specified.

 </note>

To tag your Spot Instances on creation, the Spot Fleet IAM role
specified here must use the newer **AmazonEC2SpotFleetTaggingRole**
managed policy. The previously recommended
**AmazonEC2SpotFleetRole** managed policy doesn't have the required
permissions to tag Spot Instances. For more information, see [Spot
Instances not tagged on creation][2] in the *Batch User Guide*.

[1]: https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html
[2]: https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#spot-instance-no-tag
@return [String]

@!attribute [rw] launch_template

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. For more
information, see [Launch Template Support][1] in the *Batch User
Guide*.

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources, and shouldn't be specified.

 </note>

[1]: https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html
@return [Types::LaunchTemplateSpecification]

@!attribute [rw] ec2_configuration

Provides information used to select Amazon Machine Images (AMIs) for
EC2 instances in the compute environment. If `Ec2Configuration`
isn't specified, the default is `ECS_AL1`.

<note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
resources, and shouldn't be specified.

 </note>
@return [Array<Types::Ec2Configuration>]

@see docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ComputeResource AWS API Documentation

Constants

SENSITIVE