Class: Aws::Batch::Types::ComputeResource

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-batch/types.rb

Overview

An object that represents 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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocation_strategy ⇒ String

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]. 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. Don’t specify it.

</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 the user
is reaching [Amazon EC2 service limits][1], additional jobs
aren't run until the currently running jobs are completed. This
allocation strategy keeps costs lower but can limit scaling. If
you're using Spot Fleets with `BEST_FIT`, the Spot Fleet IAM Role
must be specified. Compute resources that use a `BEST_FIT`
allocation strategy don't support infrastructure updates and
can't update some parameters. For more information, see [Updating
compute environments][3] in the *Batch User Guide*.

BEST_FIT_PROGRESSIVE

: Batch selects additional instance types that are large enough to

meet the requirements of the jobs in the queue. Its preference is
for instance types with lower cost vCPUs. If additional instances
of the previously selected instance types aren't available, Batch
selects new instance types.

SPOT_CAPACITY_OPTIMIZED

: Batch selects one or more instance types that are large enough to

meet the requirements of the jobs in the queue. Its preference is
for instance types that are less likely to be interrupted. This
allocation strategy is only available for Spot Instance compute
resources.

SPOT_PRICE_CAPACITY_OPTIMIZED

: The price and capacity optimized allocation strategy looks at both

price and capacity to select the Spot Instance pools that are the
least likely to be interrupted and have the lowest possible price.
This allocation strategy is only available for Spot Instance
compute resources.

With ‘BEST_FIT_PROGRESSIVE`,`SPOT_CAPACITY_OPTIMIZED` and `SPOT_PRICE_CAPACITY_OPTIMIZED` (recommended) strategies using On-Demand or Spot Instances, and the `BEST_FIT` strategy using Spot Instances, Batch might need to exceed `maxvCpus` to meet your capacity requirements. In this event, Batch never exceeds `maxvCpus` by more than a single instance.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html [2]: docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html [3]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:

  • (String) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#bid_percentage ⇒ Integer

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. For most use cases, we recommend leaving this field empty.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

Returns:

  • (Integer) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#desiredv_cpus ⇒ Integer

The desired number of 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. Don’t specify it.

</note>

Returns:

  • (Integer) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_configuration ⇒ Array<Types::Ec2Configuration>

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

One or two values can be provided.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

Returns:



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_key_pair ⇒ String

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. Don’t specify it.

</note>

Returns:

  • (String) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#image_id ⇒ String

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. Don’t specify it.

</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] in the *Amazon Elastic Container Service Developer Guide*.

</note>

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

Returns:

  • (String) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#instance_role ⇒ String

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This parameter is required for Amazon EC2 instances types. 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 *Batch User Guide*.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

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

Returns:

  • (String) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#instance_types ⇒ Array<String>

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. Don’t specify it.

</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>

Returns:

  • (Array<String>) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#launch_template ⇒ Types::LaunchTemplateSpecification

The launch template to use for your compute resources. Any other compute resource parameters that you specify in a

CreateComputeEnvironment][1

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

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

[1]: docs.aws.amazon.com/batch/latest/APIReference/API_CreateComputeEnvironment.html [2]: docs.aws.amazon.com/batch/latest/userguide/launch-templates.html

Returns:



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#maxv_cpus ⇒ Integer

The maximum number of vCPUs that a compute environment can support.

<note markdown=“1”> With ‘BEST_FIT_PROGRESSIVE`,`SPOT_CAPACITY_OPTIMIZED` and `SPOT_PRICE_CAPACITY_OPTIMIZED` (recommended) strategies using On-Demand or Spot Instances, and the `BEST_FIT` strategy using Spot Instances, Batch might need to exceed `maxvCpus` to meet your capacity requirements. In this event, Batch never exceeds `maxvCpus` by more than a single instance.

</note>

Returns:

  • (Integer) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#minv_cpus ⇒ Integer

The minimum number of vCPUs that a compute 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. Don’t specify it.

</note>

Returns:

  • (Integer) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#placement_group ⇒ String

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*.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

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

Returns:

  • (String) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

The Amazon EC2 security groups that are 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.

Returns:

  • (Array<String>) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#spot_iam_fleet_role ⇒ String

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

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

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

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

Returns:

  • (String) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#subnets ⇒ Array<String>

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] in the *Amazon VPC User Guide*.

<note markdown=“1”> Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see [ Local Zones] in the *Amazon EC2 User Guide for Linux Instances*, [Amazon EKS and Amazon Web Services Local Zones] in the *Amazon EKS User Guide* and [ Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts] in the *Amazon ECS Developer Guide*.

Batch on Fargate doesn't currently support Local Zones.

</note>

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones [3]: docs.aws.amazon.com/eks/latest/userguide/local-zones.html [4]: docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-regions-zones.html#clusters-local-zones

Returns:

  • (Array<String>) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Key-value pair tags to be applied to Amazon 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. Updating these tags requires an infrastructure update to the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*. 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. Don’t specify it.

</note>

[1]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:

  • (Hash<String,String>) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of compute environment: ‘EC2`, `SPOT`, `FARGATE`, or `FARGATE_SPOT`. For more information, see [Compute environments] 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] in the *Batch User Guide*.

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

Returns:

  • (String) 


822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-batch/types.rb', line 822

class ComputeResource < Struct.new(
  :type,
  :allocation_strategy,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :spot_iam_fleet_role,
  :launch_template,
  :ec2_configuration)
  SENSITIVE = []
  include Aws::Structure
end