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
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
  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"], # required
  ec2_key_pair: "String",
  instance_role: "String", # required
  tags: {
    "String" => "String",
  },
  bid_percentage: 1,
  spot_iam_fleet_role: "String",
}

An object representing an AWS Batch compute resource.

Instance Attribute Summary collapse

Instance Attribute Details

#bid_percentageInteger

The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.

Returns:

  • (Integer)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 300

class ComputeResource < Struct.new(
  :type,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :bid_percentage,
  :spot_iam_fleet_role)
  include Aws::Structure
end

#desiredv_cpusInteger

The desired number of EC2 vCPUS in the compute environment.

Returns:

  • (Integer)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 300

class ComputeResource < Struct.new(
  :type,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :bid_percentage,
  :spot_iam_fleet_role)
  include Aws::Structure
end

#ec2_key_pairString

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

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 300

class ComputeResource < Struct.new(
  :type,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :bid_percentage,
  :spot_iam_fleet_role)
  include Aws::Structure
end

#image_idString

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

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 300

class ComputeResource < Struct.new(
  :type,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :bid_percentage,
  :spot_iam_fleet_role)
  include Aws::Structure
end

#instance_roleString

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)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 300

class ComputeResource < Struct.new(
  :type,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :bid_percentage,
  :spot_iam_fleet_role)
  include Aws::Structure
end

#instance_typesArray<String>

The instances types that may launched.

Returns:

  • (Array<String>)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 300

class ComputeResource < Struct.new(
  :type,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :bid_percentage,
  :spot_iam_fleet_role)
  include Aws::Structure
end

#maxv_cpusInteger

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

Returns:

  • (Integer)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 300

class ComputeResource < Struct.new(
  :type,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :bid_percentage,
  :spot_iam_fleet_role)
  include Aws::Structure
end

#minv_cpusInteger

The minimum number of EC2 vCPUs that an environment should maintain.

Returns:

  • (Integer)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 300

class ComputeResource < Struct.new(
  :type,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :bid_percentage,
  :spot_iam_fleet_role)
  include Aws::Structure
end

#security_group_idsArray<String>

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

Returns:

  • (Array<String>)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 300

class ComputeResource < Struct.new(
  :type,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :bid_percentage,
  :spot_iam_fleet_role)
  include Aws::Structure
end

#spot_iam_fleet_roleString

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

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 300

class ComputeResource < Struct.new(
  :type,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :bid_percentage,
  :spot_iam_fleet_role)
  include Aws::Structure
end

#subnetsArray<String>

The VPC subnets into which the compute resources are launched.

Returns:

  • (Array<String>)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 300

class ComputeResource < Struct.new(
  :type,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :bid_percentage,
  :spot_iam_fleet_role)
  include Aws::Structure
end

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 300

class ComputeResource < Struct.new(
  :type,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :bid_percentage,
  :spot_iam_fleet_role)
  include Aws::Structure
end

#typeString

The type of compute environment.

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 300

class ComputeResource < Struct.new(
  :type,
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :instance_types,
  :image_id,
  :subnets,
  :security_group_ids,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :bid_percentage,
  :spot_iam_fleet_role)
  include Aws::Structure
end