ComputeResource (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ComputeResource
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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)` Add a single Tags entry
`ComputeResource`	`clearTagsEntries()` Removes all the entries added into Tags.
`ComputeResource`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAllocationStrategy()` The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated.
`Integer`	`getBidPercentage()` 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.
`Integer`	`getDesiredvCpus()` The desired number of Amazon EC2 vCPUS in the compute environment.
`String`	`getEc2KeyPair()` The Amazon EC2 key pair that is used for instances launched in the compute environment.
`String`	`getImageId()` The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
`String`	`getInstanceRole()` The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
`List<String>`	`getInstanceTypes()` The instances types that may be launched.
`LaunchTemplateSpecification`	`getLaunchTemplate()` The launch template to use for your compute resources.
`Integer`	`getMaxvCpus()` The maximum number of Amazon EC2 vCPUs that an environment can reach.
`Integer`	`getMinvCpus()` The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is `DISABLED`).
`String`	`getPlacementGroup()` The Amazon EC2 placement group to associate with your compute resources.
`List<String>`	`getSecurityGroupIds()` The Amazon EC2 security groups 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: `EC2` or `SPOT`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAllocationStrategy(CRAllocationStrategy allocationStrategy)` The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated.
`void`	`setAllocationStrategy(String allocationStrategy)` The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated.
`void`	`setBidPercentage(Integer bidPercentage)` 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.
`void`	`setDesiredvCpus(Integer desiredvCpus)` The desired number of Amazon EC2 vCPUS in the compute environment.
`void`	`setEc2KeyPair(String ec2KeyPair)` The Amazon EC2 key pair that is used for instances launched in the compute environment.
`void`	`setImageId(String imageId)` The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
`void`	`setInstanceRole(String instanceRole)` The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
`void`	`setInstanceTypes(Collection<String> instanceTypes)` The instances types that may be launched.
`void`	`setLaunchTemplate(LaunchTemplateSpecification launchTemplate)` The launch template to use for your compute resources.
`void`	`setMaxvCpus(Integer maxvCpus)` The maximum number of Amazon EC2 vCPUs that an environment can reach.
`void`	`setMinvCpus(Integer minvCpus)` The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is `DISABLED`).
`void`	`setPlacementGroup(String placementGroup)` The Amazon EC2 placement group to associate with your compute resources.
`void`	`setSecurityGroupIds(Collection<String> securityGroupIds)` The Amazon EC2 security groups 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: `EC2` or `SPOT`.
`void`	`setType(String type)` The type of compute environment: `EC2` or `SPOT`.
`String`	`toString()` Returns a string representation of this object.
`ComputeResource`	`withAllocationStrategy(CRAllocationStrategy allocationStrategy)` The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated.
`ComputeResource`	`withAllocationStrategy(String allocationStrategy)` The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated.
`ComputeResource`	`withBidPercentage(Integer bidPercentage)` 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.
`ComputeResource`	`withDesiredvCpus(Integer desiredvCpus)` The desired number of Amazon EC2 vCPUS in the compute environment.
`ComputeResource`	`withEc2KeyPair(String ec2KeyPair)` The Amazon EC2 key pair that is used for instances launched in the compute environment.
`ComputeResource`	`withImageId(String imageId)` The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
`ComputeResource`	`withInstanceRole(String instanceRole)` The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
`ComputeResource`	`withInstanceTypes(Collection<String> instanceTypes)` The instances types that may be launched.
`ComputeResource`	`withInstanceTypes(String... instanceTypes)` The instances types that may be launched.
`ComputeResource`	`withLaunchTemplate(LaunchTemplateSpecification launchTemplate)` The launch template to use for your compute resources.
`ComputeResource`	`withMaxvCpus(Integer maxvCpus)` The maximum number of Amazon EC2 vCPUs that an environment can reach.
`ComputeResource`	`withMinvCpus(Integer minvCpus)` The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is `DISABLED`).
`ComputeResource`	`withPlacementGroup(String placementGroup)` The Amazon EC2 placement group to associate with your compute resources.
`ComputeResource`	`withSecurityGroupIds(Collection<String> securityGroupIds)` The Amazon EC2 security groups associated with instances launched in the compute environment.
`ComputeResource`	`withSecurityGroupIds(String... securityGroupIds)` The Amazon EC2 security groups 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: `EC2` or `SPOT`.
`ComputeResource`	`withType(String type)` The type of compute environment: `EC2` or `SPOT`.

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: EC2 or SPOT.
    
    Parameters:
    
    type - The type of compute environment: EC2 or SPOT.
    
    See Also:
    
    CRType
  - getType
```
public String getType()
```
    The type of compute environment: EC2 or SPOT.
    
    Returns:
    
    The type of compute environment: EC2 or SPOT.
    
    See Also:
    
    CRType
  - withType
```
public ComputeResource withType(String type)
```
    The type of compute environment: EC2 or SPOT.
    
    Parameters:
    
    type - The type of compute environment: EC2 or SPOT.
    
    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: EC2 or SPOT.
    
    Parameters:
    
    type - The type of compute environment: EC2 or SPOT.
    
    See Also:
    
    CRType
  - withType
```
public ComputeResource withType(CRType type)
```
    The type of compute environment: EC2 or SPOT.
    
    Parameters:
    
    type - The type of compute environment: EC2 or SPOT.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CRType
  - setAllocationStrategy
```
public void setAllocationStrategy(String allocationStrategy)
```
    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.
    
    Parameters:
    
    allocationStrategy - 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.
    
    See Also:
    
    CRAllocationStrategy
  - getAllocationStrategy
```
public String getAllocationStrategy()
```
    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:
    
    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.
    
    See Also:
    
    CRAllocationStrategy
  - withAllocationStrategy
```
public ComputeResource withAllocationStrategy(String allocationStrategy)
```
    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.
    
    Parameters:
    
    allocationStrategy - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CRAllocationStrategy
  - setAllocationStrategy
```
public void setAllocationStrategy(CRAllocationStrategy allocationStrategy)
```
    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.
    
    Parameters:
    
    allocationStrategy - 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.
    
    See Also:
    
    CRAllocationStrategy
  - withAllocationStrategy
```
public ComputeResource withAllocationStrategy(CRAllocationStrategy allocationStrategy)
```
    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.
    
    Parameters:
    
    allocationStrategy - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CRAllocationStrategy
  - setMinvCpus
```
public void setMinvCpus(Integer minvCpus)
```
    The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
    
    Parameters:
    
    minvCpus - The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
  - getMinvCpus
```
public Integer getMinvCpus()
```
    The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
    
    Returns:
    
    The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
  - withMinvCpus
```
public ComputeResource withMinvCpus(Integer minvCpus)
```
    The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
    
    Parameters:
    
    minvCpus - The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
    
    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 Amazon EC2 vCPUs that an environment can reach.
    
    Parameters:
    
    maxvCpus - The maximum number of Amazon EC2 vCPUs that an environment can reach.
  - getMaxvCpus
```
public Integer getMaxvCpus()
```
    The maximum number of Amazon EC2 vCPUs that an environment can reach.
    
    Returns:
    
    The maximum number of Amazon EC2 vCPUs that an environment can reach.
  - withMaxvCpus
```
public ComputeResource withMaxvCpus(Integer maxvCpus)
```
    The maximum number of Amazon EC2 vCPUs that an environment can reach.
    
    Parameters:
    
    maxvCpus - The maximum number of Amazon 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 Amazon EC2 vCPUS in the compute environment.
    
    Parameters:
    
    desiredvCpus - The desired number of Amazon EC2 vCPUS in the compute environment.
  - getDesiredvCpus
```
public Integer getDesiredvCpus()
```
    The desired number of Amazon EC2 vCPUS in the compute environment.
    
    Returns:
    
    The desired number of Amazon EC2 vCPUS in the compute environment.
  - withDesiredvCpus
```
public ComputeResource withDesiredvCpus(Integer desiredvCpus)
```
    The desired number of Amazon EC2 vCPUS in the compute environment.
    
    Parameters:
    
    desiredvCpus - The desired number of Amazon 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 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:
    
    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.
  - setInstanceTypes
```
public void setInstanceTypes(Collection<String> instanceTypes)
```
    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.
    
    Parameters:
    
    instanceTypes - 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.
  - withInstanceTypes
```
public ComputeResource withInstanceTypes(String... instanceTypes)
```
    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.
    
    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 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:
    
    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 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.
    
    Parameters:
    
    instanceTypes - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImageId
```
public void setImageId(String imageId)
```
    The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
    
    Parameters:
    
    imageId - The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
  - getImageId
```
public String getImageId()
```
    The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
    
    Returns:
    
    The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
  - withImageId
```
public ComputeResource withImageId(String imageId)
```
    The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
    
    Parameters:
    
    imageId - The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
    
    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. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
    
    Returns:
    
    The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
  - setSubnets
```
public void setSubnets(Collection<String> subnets)
```
    The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
    
    Parameters:
    
    subnets - The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
  - withSubnets
```
public ComputeResource withSubnets(String... subnets)
```
    The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
    
    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. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
    
    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. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
    
    Parameters:
    
    subnets - The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSecurityGroupIds
```
public List<String> getSecurityGroupIds()
```
    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:
    
    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.
  - setSecurityGroupIds
```
public void setSecurityGroupIds(Collection<String> securityGroupIds)
```
    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.
    
    Parameters:
    
    securityGroupIds - 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.
  - withSecurityGroupIds
```
public ComputeResource withSecurityGroupIds(String... securityGroupIds)
```
    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.
    
    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 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSecurityGroupIds
```
public ComputeResource withSecurityGroupIds(Collection<String> securityGroupIds)
```
    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.
    
    Parameters:
    
    securityGroupIds - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEc2KeyPair
```
public void setEc2KeyPair(String ec2KeyPair)
```
    The Amazon EC2 key pair that is used for instances launched in the compute environment.
    
    Parameters:
    
    ec2KeyPair - The Amazon EC2 key pair that is used for instances launched in the compute environment.
  - getEc2KeyPair
```
public String getEc2KeyPair()
```
    The Amazon EC2 key pair that is used for instances launched in the compute environment.
    
    Returns:
    
    The Amazon EC2 key pair that is used for instances launched in the compute environment.
  - withEc2KeyPair
```
public ComputeResource withEc2KeyPair(String ec2KeyPair)
```
    The Amazon EC2 key pair that is used for instances launched in the compute environment.
    
    Parameters:
    
    ec2KeyPair - The Amazon 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 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.
    
    Parameters:
    
    instanceRole - 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.
  - getInstanceRole
```
public String getInstanceRole()
```
    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:
    
    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.
  - withInstanceRole
```
public ComputeResource withInstanceRole(String instanceRole)
```
    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.
    
    Parameters:
    
    instanceRole - 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:
    
    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. 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" }. These tags can not be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags are not seen when using the AWS Batch ListTagsForResource API operation.
    
    Returns:
    
    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" }. These tags can not be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags are not seen when using the AWS Batch ListTagsForResource API operation.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    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" }. These tags can not be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags are not seen when using the AWS Batch ListTagsForResource API operation.
    
    Parameters:
    
    tags - 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" }. These tags can not be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags are not seen when using the AWS Batch ListTagsForResource API operation.
  - withTags
```
public ComputeResource withTags(Map<String,String> tags)
```
    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" }. These tags can not be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags are not seen when using the AWS Batch ListTagsForResource API operation.
    
    Parameters:
    
    tags - 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" }. These tags can not be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags are not seen when using the AWS Batch ListTagsForResource API operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public ComputeResource addTagsEntry(String key,
                                    String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - 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.
  - setPlacementGroup
```
public void setPlacementGroup(String placementGroup)
```
    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.
    
    Parameters:
    
    placementGroup - 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.
  - getPlacementGroup
```
public String getPlacementGroup()
```
    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:
    
    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.
  - withPlacementGroup
```
public ComputeResource withPlacementGroup(String placementGroup)
```
    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.
    
    Parameters:
    
    placementGroup - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBidPercentage
```
public void setBidPercentage(Integer bidPercentage)
```
    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.
    
    Parameters:
    
    bidPercentage - 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.
  - getBidPercentage
```
public Integer getBidPercentage()
```
    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:
    
    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.
  - withBidPercentage
```
public ComputeResource withBidPercentage(Integer bidPercentage)
```
    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.
    
    Parameters:
    
    bidPercentage - 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:
    
    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. 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.
    
    Parameters:
    
    spotIamFleetRole - 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.
  - getSpotIamFleetRole
```
public String getSpotIamFleetRole()
```
    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:
    
    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.
  - 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. 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.
    
    Parameters:
    
    spotIamFleetRole - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLaunchTemplate
```
public void setLaunchTemplate(LaunchTemplateSpecification launchTemplate)
```
    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.
    
    Parameters:
    
    launchTemplate - 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.
  - getLaunchTemplate
```
public LaunchTemplateSpecification getLaunchTemplate()
```
    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:
    
    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.
  - withLaunchTemplate
```
public ComputeResource withLaunchTemplate(LaunchTemplateSpecification launchTemplate)
```
    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.
    
    Parameters:
    
    launchTemplate - 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:
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

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

setAllocationStrategy

getAllocationStrategy

withAllocationStrategy

setAllocationStrategy

withAllocationStrategy

setMinvCpus

getMinvCpus

withMinvCpus

setMaxvCpus

getMaxvCpus

withMaxvCpus

setDesiredvCpus

getDesiredvCpus

withDesiredvCpus

getInstanceTypes

setInstanceTypes

withInstanceTypes

withInstanceTypes

setImageId

getImageId

withImageId

getSubnets

setSubnets

withSubnets

withSubnets

getSecurityGroupIds

setSecurityGroupIds

withSecurityGroupIds

withSecurityGroupIds

setEc2KeyPair

getEc2KeyPair

withEc2KeyPair

setInstanceRole

getInstanceRole

withInstanceRole

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setPlacementGroup

getPlacementGroup

withPlacementGroup

setBidPercentage

getBidPercentage

withBidPercentage

setSpotIamFleetRole

getSpotIamFleetRole

withSpotIamFleetRole

setLaunchTemplate

getLaunchTemplate

withLaunchTemplate

toString

equals

hashCode

clone

marshall