You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:

Struct

Object
Struct
Aws::Batch::Types::ComputeResource

show all

Defined in:: gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

Note:

When making an API call, you may pass ComputeResource data as a hash:

{
  type: "EC2", # required, accepts EC2, SPOT
  allocation_strategy: "BEST_FIT", # accepts BEST_FIT, BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED
  minv_cpus: 1, # required
  maxv_cpus: 1, # required
  desiredv_cpus: 1,
  instance_types: ["String"], # required
  image_id: "String",
  subnets: ["String"], # required
  security_group_ids: ["String"],
  ec2_key_pair: "String",
  instance_role: "String", # required
  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",
  },
}

An object representing an AWS Batch compute resource.

Instance Attribute Summary collapse

#allocation_strategy ⇒ String
The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated.
#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.
#desiredv_cpus ⇒ Integer
The desired number of Amazon EC2 vCPUS in the compute environment.
#ec2_key_pair ⇒ String
The Amazon EC2 key pair that is used for instances launched in the compute environment.
#image_id ⇒ String
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
#instance_role ⇒ String
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
#instance_types ⇒ Array<String>
The instances types that may be launched.
#launch_template ⇒ Types::LaunchTemplateSpecification
The launch template to use for your compute resources.
#maxv_cpus ⇒ Integer
The maximum number of Amazon EC2 vCPUs that an environment can reach.
#minv_cpus ⇒ Integer
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
#placement_group ⇒ String
The Amazon EC2 placement group to associate with your compute resources.
#security_group_ids ⇒ Array<String>
The Amazon EC2 security groups associated with instances launched in the compute environment.
#spot_iam_fleet_role ⇒ String
The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.
#subnets ⇒ Array<String>
The VPC subnets into which the compute resources are launched.
#tags ⇒ Hash<String,String>
Key-value pair tags to be applied to resources that are launched in the compute environment.
#type ⇒ String
The type of compute environment: EC2 or SPOT.

Instance Attribute Details

#allocation_strategy ⇒ `String`

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 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 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 vCPU. SPOT_CAPACITY_OPTIMIZED is only available for Spot Instance compute resources and 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 that are less likely to be interrupted. For more information, see Allocation Strategies in the AWS Batch User Guide.

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  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 below 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.

Returns:

(Integer)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  include Aws::Structure
end

#desiredv_cpus ⇒ `Integer`

The desired number of Amazon EC2 vCPUS in the compute environment.

Returns:

(Integer)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  include Aws::Structure
end

#ec2_key_pair ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  include Aws::Structure
end

#image_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  include Aws::Structure
end

#instance_role ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  include Aws::Structure
end

#instance_types ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  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 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 AWS Batch User Guide.

Returns:

(Types::LaunchTemplateSpecification)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  include Aws::Structure
end

#maxv_cpus ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  include Aws::Structure
end

#minv_cpus ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  include Aws::Structure
end

#security_group_ids ⇒ `Array<String>`

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. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds will be used.

Returns:

(Array<String>)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  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 is not specified. For more information, see Amazon EC2 Spot Fleet Role in the AWS Batch User Guide.

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  include Aws::Structure
end

#subnets ⇒ `Array<String>`

The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets in the Amazon VPC User Guide.

Returns:

(Array<String>)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

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" \}.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  include Aws::Structure
end

#type ⇒ `String`

The type of compute environment: EC2 or SPOT.

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 491

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)
  include Aws::Structure
end

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#allocation_strategy ⇒ String

#bid_percentage ⇒ Integer

#desiredv_cpus ⇒ Integer

#ec2_key_pair ⇒ String

#image_id ⇒ String

#instance_role ⇒ String

#instance_types ⇒ Array<String>

#launch_template ⇒ Types::LaunchTemplateSpecification

#maxv_cpus ⇒ Integer

#minv_cpus ⇒ Integer

#placement_group ⇒ String

#security_group_ids ⇒ Array<String>

#spot_iam_fleet_role ⇒ String

#subnets ⇒ Array<String>

#tags ⇒ Hash<String,String>

#type ⇒ String

#allocation_strategy ⇒ `String`

#bid_percentage ⇒ `Integer`

#desiredv_cpus ⇒ `Integer`

#ec2_key_pair ⇒ `String`

#image_id ⇒ `String`

#instance_role ⇒ `String`

#instance_types ⇒ `Array<String>`

#launch_template ⇒ `Types::LaunchTemplateSpecification`

#maxv_cpus ⇒ `Integer`

#minv_cpus ⇒ `Integer`

#placement_group ⇒ `String`

#security_group_ids ⇒ `Array<String>`

#spot_iam_fleet_role ⇒ `String`

#subnets ⇒ `Array<String>`

#tags ⇒ `Hash<String,String>`

#type ⇒ `String`