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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ComputeResource as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

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)

    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.

#desiredv_cpusInteger

The desired number of EC2 vCPUS in the compute environment.

Returns:

  • (Integer)

    The desired number of EC2 vCPUS in the compute environment.

#ec2_key_pairString

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

Returns:

  • (String)

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

#image_idString

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

Returns:

  • (String)

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

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

    The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.

#instance_typesArray<String>

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.

Returns:

  • (Array<String>)

    The instances types that may be launched.

#maxv_cpusInteger

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

Returns:

  • (Integer)

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

#minv_cpusInteger

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

Returns:

  • (Integer)

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

#security_group_idsArray<String>

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

Returns:

  • (Array<String>)

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

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

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

#subnetsArray<String>

The VPC subnets into which the compute resources are launched.

Returns:

  • (Array<String>)

    The VPC subnets into which the compute resources are launched.

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)

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

#typeString

The type of compute environment.

Possible values:

  • EC2
  • SPOT

Returns:

  • (String)

    The type of compute environment.