ComputeResource (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.batch.model.ComputeResource

All Implemented Interfaces:

Serializable, Cloneable
```
public class ComputeResource
extends Object
implements Serializable, Cloneable
```
An object representing an AWS Batch compute resource.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ComputeResource()

Constructors
Constructor and Description
`ComputeResource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ComputeResource`	`addTagsEntry(String key, String value)`
`ComputeResource`	`clearTagsEntries()` Removes all the entries added into Tags.
`ComputeResource`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getBidPercentage()` 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.
`Integer`	`getDesiredvCpus()` The desired number of EC2 vCPUS in the compute environment.
`String`	`getEc2KeyPair()` The EC2 key pair that is used for instances launched in the compute environment.
`String`	`getInstanceRole()` The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.
`List<String>`	`getInstanceTypes()` The instances types that may launched.
`Integer`	`getMaxvCpus()` The maximum number of EC2 vCPUs that an environment can reach.
`Integer`	`getMinvCpus()` The minimum number of EC2 vCPUs that an environment should maintain.
`List<String>`	`getSecurityGroupIds()` The EC2 security group that is associated with instances launched in the compute environment.
`String`	`getSpotIamFleetRole()` The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a `SPOT` compute environment.
`List<String>`	`getSubnets()` The VPC subnets into which the compute resources are launched.
`Map<String,String>`	`getTags()` Key-value pair tags to be applied to resources that are launched in the compute environment.
`String`	`getType()` The type of compute environment.
`int`	`hashCode()`
`void`	`setBidPercentage(Integer bidPercentage)` 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.
`void`	`setDesiredvCpus(Integer desiredvCpus)` The desired number of EC2 vCPUS in the compute environment.
`void`	`setEc2KeyPair(String ec2KeyPair)` The EC2 key pair that is used for instances launched in the compute environment.
`void`	`setInstanceRole(String instanceRole)` The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.
`void`	`setInstanceTypes(Collection<String> instanceTypes)` The instances types that may launched.
`void`	`setMaxvCpus(Integer maxvCpus)` The maximum number of EC2 vCPUs that an environment can reach.
`void`	`setMinvCpus(Integer minvCpus)` The minimum number of EC2 vCPUs that an environment should maintain.
`void`	`setSecurityGroupIds(Collection<String> securityGroupIds)` The EC2 security group that is associated with instances launched in the compute environment.
`void`	`setSpotIamFleetRole(String spotIamFleetRole)` The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a `SPOT` compute environment.
`void`	`setSubnets(Collection<String> subnets)` The VPC subnets into which the compute resources are launched.
`void`	`setTags(Map<String,String> tags)` Key-value pair tags to be applied to resources that are launched in the compute environment.
`void`	`setType(CRType type)` The type of compute environment.
`void`	`setType(String type)` The type of compute environment.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ComputeResource`	`withBidPercentage(Integer bidPercentage)` 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.
`ComputeResource`	`withDesiredvCpus(Integer desiredvCpus)` The desired number of EC2 vCPUS in the compute environment.
`ComputeResource`	`withEc2KeyPair(String ec2KeyPair)` The EC2 key pair that is used for instances launched in the compute environment.
`ComputeResource`	`withInstanceRole(String instanceRole)` The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.
`ComputeResource`	`withInstanceTypes(Collection<String> instanceTypes)` The instances types that may launched.
`ComputeResource`	`withInstanceTypes(String... instanceTypes)` The instances types that may launched.
`ComputeResource`	`withMaxvCpus(Integer maxvCpus)` The maximum number of EC2 vCPUs that an environment can reach.
`ComputeResource`	`withMinvCpus(Integer minvCpus)` The minimum number of EC2 vCPUs that an environment should maintain.
`ComputeResource`	`withSecurityGroupIds(Collection<String> securityGroupIds)` The EC2 security group that is associated with instances launched in the compute environment.
`ComputeResource`	`withSecurityGroupIds(String... securityGroupIds)` The EC2 security group that is associated with instances launched in the compute environment.
`ComputeResource`	`withSpotIamFleetRole(String spotIamFleetRole)` The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a `SPOT` compute environment.
`ComputeResource`	`withSubnets(Collection<String> subnets)` The VPC subnets into which the compute resources are launched.
`ComputeResource`	`withSubnets(String... subnets)` The VPC subnets into which the compute resources are launched.
`ComputeResource`	`withTags(Map<String,String> tags)` Key-value pair tags to be applied to resources that are launched in the compute environment.
`ComputeResource`	`withType(CRType type)` The type of compute environment.
`ComputeResource`	`withType(String type)` The type of compute environment.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ComputeResource
```
public ComputeResource()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    The type of compute environment.
    
    Parameters:
    
    type - The type of compute environment.
    
    See Also:
    
    CRType
  - getType
```
public String getType()
```
    The type of compute environment.
    
    Returns:
    
    The type of compute environment.
    
    See Also:
    
    CRType
  - withType
```
public ComputeResource withType(String type)
```
    The type of compute environment.
    
    Parameters:
    
    type - The type of compute environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CRType
  - setType
```
public void setType(CRType type)
```
    The type of compute environment.
    
    Parameters:
    
    type - The type of compute environment.
    
    See Also:
    
    CRType
  - withType
```
public ComputeResource withType(CRType type)
```
    The type of compute environment.
    
    Parameters:
    
    type - The type of compute environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CRType
  - setMinvCpus
```
public void setMinvCpus(Integer minvCpus)
```
    The minimum number of EC2 vCPUs that an environment should maintain.
    
    Parameters:
    
    minvCpus - The minimum number of EC2 vCPUs that an environment should maintain.
  - getMinvCpus
```
public Integer getMinvCpus()
```
    The minimum number of EC2 vCPUs that an environment should maintain.
    
    Returns:
    
    The minimum number of EC2 vCPUs that an environment should maintain.
  - withMinvCpus
```
public ComputeResource withMinvCpus(Integer minvCpus)
```
    The minimum number of EC2 vCPUs that an environment should maintain.
    
    Parameters:
    
    minvCpus - The minimum number of EC2 vCPUs that an environment should maintain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxvCpus
```
public void setMaxvCpus(Integer maxvCpus)
```
    The maximum number of EC2 vCPUs that an environment can reach.
    
    Parameters:
    
    maxvCpus - The maximum number of EC2 vCPUs that an environment can reach.
  - getMaxvCpus
```
public Integer getMaxvCpus()
```
    The maximum number of EC2 vCPUs that an environment can reach.
    
    Returns:
    
    The maximum number of EC2 vCPUs that an environment can reach.
  - withMaxvCpus
```
public ComputeResource withMaxvCpus(Integer maxvCpus)
```
    The maximum number of EC2 vCPUs that an environment can reach.
    
    Parameters:
    
    maxvCpus - The maximum number of EC2 vCPUs that an environment can reach.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDesiredvCpus
```
public void setDesiredvCpus(Integer desiredvCpus)
```
    The desired number of EC2 vCPUS in the compute environment.
    
    Parameters:
    
    desiredvCpus - The desired number of EC2 vCPUS in the compute environment.
  - getDesiredvCpus
```
public Integer getDesiredvCpus()
```
    The desired number of EC2 vCPUS in the compute environment.
    
    Returns:
    
    The desired number of EC2 vCPUS in the compute environment.
  - withDesiredvCpus
```
public ComputeResource withDesiredvCpus(Integer desiredvCpus)
```
    The desired number of EC2 vCPUS in the compute environment.
    
    Parameters:
    
    desiredvCpus - The desired number of EC2 vCPUS in the compute environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInstanceTypes
```
public List<String> getInstanceTypes()
```
    The instances types that may launched.
    
    Returns:
    
    The instances types that may launched.
  - setInstanceTypes
```
public void setInstanceTypes(Collection<String> instanceTypes)
```
    The instances types that may launched.
    
    Parameters:
    
    instanceTypes - The instances types that may launched.
  - withInstanceTypes
```
public ComputeResource withInstanceTypes(String... instanceTypes)
```
    The instances types that may launched.
    
    NOTE: This method appends the values to the existing list (if any). Use setInstanceTypes(java.util.Collection) or withInstanceTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    instanceTypes - The instances types that may launched.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInstanceTypes
```
public ComputeResource withInstanceTypes(Collection<String> instanceTypes)
```
    The instances types that may launched.
    
    Parameters:
    
    instanceTypes - The instances types that may launched.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSubnets
```
public List<String> getSubnets()
```
    The VPC subnets into which the compute resources are launched.
    
    Returns:
    
    The VPC subnets into which the compute resources are launched.
  - setSubnets
```
public void setSubnets(Collection<String> subnets)
```
    The VPC subnets into which the compute resources are launched.
    
    Parameters:
    
    subnets - The VPC subnets into which the compute resources are launched.
  - withSubnets
```
public ComputeResource withSubnets(String... subnets)
```
    The VPC subnets into which the compute resources are launched.
    
    NOTE: This method appends the values to the existing list (if any). Use setSubnets(java.util.Collection) or withSubnets(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    subnets - The VPC subnets into which the compute resources are launched.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSubnets
```
public ComputeResource withSubnets(Collection<String> subnets)
```
    The VPC subnets into which the compute resources are launched.
    
    Parameters:
    
    subnets - The VPC subnets into which the compute resources are launched.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSecurityGroupIds
```
public List<String> getSecurityGroupIds()
```
    The EC2 security group that is associated with instances launched in the compute environment.
    
    Returns:
    
    The EC2 security group that is associated with instances launched in the compute environment.
  - setSecurityGroupIds
```
public void setSecurityGroupIds(Collection<String> securityGroupIds)
```
    The EC2 security group that is associated with instances launched in the compute environment.
    
    Parameters:
    
    securityGroupIds - The EC2 security group that is associated with instances launched in the compute environment.
  - withSecurityGroupIds
```
public ComputeResource withSecurityGroupIds(String... securityGroupIds)
```
    The EC2 security group that is associated with instances launched in the compute environment.
    
    NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    securityGroupIds - The EC2 security group that is associated with instances launched in the compute environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSecurityGroupIds
```
public ComputeResource withSecurityGroupIds(Collection<String> securityGroupIds)
```
    The EC2 security group that is associated with instances launched in the compute environment.
    
    Parameters:
    
    securityGroupIds - The EC2 security group that is associated with instances launched in the compute environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEc2KeyPair
```
public void setEc2KeyPair(String ec2KeyPair)
```
    The EC2 key pair that is used for instances launched in the compute environment.
    
    Parameters:
    
    ec2KeyPair - The EC2 key pair that is used for instances launched in the compute environment.
  - getEc2KeyPair
```
public String getEc2KeyPair()
```
    The EC2 key pair that is used for instances launched in the compute environment.
    
    Returns:
    
    The EC2 key pair that is used for instances launched in the compute environment.
  - withEc2KeyPair
```
public ComputeResource withEc2KeyPair(String ec2KeyPair)
```
    The EC2 key pair that is used for instances launched in the compute environment.
    
    Parameters:
    
    ec2KeyPair - The EC2 key pair that is used for instances launched in the compute environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceRole
```
public void setInstanceRole(String instanceRole)
```
    The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.
    
    Parameters:
    
    instanceRole - The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.
  - getInstanceRole
```
public String getInstanceRole()
```
    The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.
    
    Returns:
    
    The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.
  - withInstanceRole
```
public ComputeResource withInstanceRole(String instanceRole)
```
    The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.
    
    Parameters:
    
    instanceRole - The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    Key-value pair tags to be applied to resources that are launched in the compute environment.
    
    Returns:
    
    Key-value pair tags to be applied to resources that are launched in the compute environment.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Key-value pair tags to be applied to resources that are launched in the compute environment.
    
    Parameters:
    
    tags - Key-value pair tags to be applied to resources that are launched in the compute environment.
  - withTags
```
public ComputeResource withTags(Map<String,String> tags)
```
    Key-value pair tags to be applied to resources that are launched in the compute environment.
    
    Parameters:
    
    tags - Key-value pair tags to be applied to resources that are launched in the compute environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public ComputeResource addTagsEntry(String key,
                                    String value)
```
  - clearTagsEntries
```
public ComputeResource clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBidPercentage
```
public void setBidPercentage(Integer bidPercentage)
```
    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.
    
    Parameters:
    
    bidPercentage - 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.
  - getBidPercentage
```
public Integer getBidPercentage()
```
    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:
    
    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.
  - withBidPercentage
```
public ComputeResource withBidPercentage(Integer bidPercentage)
```
    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.
    
    Parameters:
    
    bidPercentage - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSpotIamFleetRole
```
public void setSpotIamFleetRole(String spotIamFleetRole)
```
    The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.
    
    Parameters:
    
    spotIamFleetRole - The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.
  - getSpotIamFleetRole
```
public String getSpotIamFleetRole()
```
    The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.
  - withSpotIamFleetRole
```
public ComputeResource withSpotIamFleetRole(String spotIamFleetRole)
```
    The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.
    
    Parameters:
    
    spotIamFleetRole - The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ComputeResource clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class ComputeResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ComputeResource

Method Detail

setType

getType

withType

setType

withType

setMinvCpus

getMinvCpus

withMinvCpus

setMaxvCpus

getMaxvCpus

withMaxvCpus

setDesiredvCpus

getDesiredvCpus

withDesiredvCpus

getInstanceTypes

setInstanceTypes

withInstanceTypes

withInstanceTypes

getSubnets

setSubnets

withSubnets

withSubnets

getSecurityGroupIds

setSecurityGroupIds

withSecurityGroupIds

withSecurityGroupIds

setEc2KeyPair

getEc2KeyPair

withEc2KeyPair

setInstanceRole

getInstanceRole

withInstanceRole

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setBidPercentage

getBidPercentage

withBidPercentage

setSpotIamFleetRole

getSpotIamFleetRole

withSpotIamFleetRole

toString

equals

hashCode

clone