@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. For more information, see Compute Environments in the AWS Batch User Guide.
| Constructor and Description |
|---|
ComputeResource() |
| 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 if 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.
|
List<Ec2Configuration> |
getEc2Configuration()
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.
|
String |
getEc2KeyPair()
The Amazon EC2 key pair that's used for instances launched in the compute environment.
|
String |
getImageId()
Deprecated.
|
String |
getInstanceRole()
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
|
List<String> |
getInstanceTypes()
The instances types that can be launched.
|
LaunchTemplateSpecification |
getLaunchTemplate()
The launch template to use for your compute resources.
|
Integer |
getMaxvCpus()
The maximum number of Amazon EC2 vCPUs that a compute 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 EC2 resources that are launched in the compute environment.
|
String |
getType()
The type of compute environment:
EC2, SPOT, FARGATE, or
FARGATE_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 if 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 if 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 |
setEc2Configuration(Collection<Ec2Configuration> ec2Configuration)
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.
|
void |
setEc2KeyPair(String ec2KeyPair)
The Amazon EC2 key pair that's used for instances launched in the compute environment.
|
void |
setImageId(String imageId)
Deprecated.
|
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 can 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 a compute 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 EC2 resources that are launched in the compute environment.
|
void |
setType(CRType type)
The type of compute environment:
EC2, SPOT, FARGATE, or
FARGATE_SPOT. |
void |
setType(String type)
The type of compute environment:
EC2, SPOT, FARGATE, or
FARGATE_SPOT. |
String |
toString()
Returns a string representation of this object.
|
ComputeResource |
withAllocationStrategy(CRAllocationStrategy allocationStrategy)
The allocation strategy to use for the compute resource if 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 if 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 |
withEc2Configuration(Collection<Ec2Configuration> ec2Configuration)
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.
|
ComputeResource |
withEc2Configuration(Ec2Configuration... ec2Configuration)
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.
|
ComputeResource |
withEc2KeyPair(String ec2KeyPair)
The Amazon EC2 key pair that's used for instances launched in the compute environment.
|
ComputeResource |
withImageId(String imageId)
Deprecated.
|
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 can be launched.
|
ComputeResource |
withInstanceTypes(String... instanceTypes)
The instances types that can 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 a compute 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 EC2 resources that are launched in the compute environment.
|
ComputeResource |
withType(CRType type)
The type of compute environment:
EC2, SPOT, FARGATE, or
FARGATE_SPOT. |
ComputeResource |
withType(String type)
The type of compute environment:
EC2, SPOT, FARGATE, or
FARGATE_SPOT. |
public void setType(String type)
The type of compute environment: EC2, SPOT, FARGATE, or
FARGATE_SPOT. For more information, see Compute Environments in
the AWS Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet role
in the AWS Batch User Guide.
type - The type of compute environment: EC2, SPOT, FARGATE, or
FARGATE_SPOT. For more information, see Compute
Environments in the AWS Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet
role in the AWS Batch User Guide.
CRTypepublic String getType()
The type of compute environment: EC2, SPOT, FARGATE, or
FARGATE_SPOT. For more information, see Compute Environments in
the AWS Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet role
in the AWS Batch User Guide.
EC2, SPOT, FARGATE, or
FARGATE_SPOT. For more information, see Compute
Environments in the AWS Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet
role in the AWS Batch User Guide.
CRTypepublic ComputeResource withType(String type)
The type of compute environment: EC2, SPOT, FARGATE, or
FARGATE_SPOT. For more information, see Compute Environments in
the AWS Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet role
in the AWS Batch User Guide.
type - The type of compute environment: EC2, SPOT, FARGATE, or
FARGATE_SPOT. For more information, see Compute
Environments in the AWS Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet
role in the AWS Batch User Guide.
CRTypepublic void setType(CRType type)
The type of compute environment: EC2, SPOT, FARGATE, or
FARGATE_SPOT. For more information, see Compute Environments in
the AWS Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet role
in the AWS Batch User Guide.
type - The type of compute environment: EC2, SPOT, FARGATE, or
FARGATE_SPOT. For more information, see Compute
Environments in the AWS Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet
role in the AWS Batch User Guide.
CRTypepublic ComputeResource withType(CRType type)
The type of compute environment: EC2, SPOT, FARGATE, or
FARGATE_SPOT. For more information, see Compute Environments in
the AWS Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet role
in the AWS Batch User Guide.
type - The type of compute environment: EC2, SPOT, FARGATE, or
FARGATE_SPOT. For more information, see Compute
Environments in the AWS Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet
role in the AWS Batch User Guide.
CRTypepublic void setAllocationStrategy(String allocationStrategy)
The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation Strategies in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost
instance type. If additional instances of the selected instance type aren't available, AWS Batch waits for the
additional instances to be available. If there aren't enough instances available, or if the user is hitting Amazon EC2 service limits
then additional jobs aren't run until the currently running jobs have completed. 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.
AWS Batch 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 unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
AWS Batch will select one or more 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. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS Batch might
need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds
maxvCpus by more than a single instance.
allocationStrategy - The allocation strategy to use for the compute resource if not enough instances of the best fitting
instance type can be allocated. This might be because of availability of the instance type in the Region
or Amazon EC2
service limits. For more information, see Allocation
Strategies in the AWS Batch User Guide. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the
lowest-cost instance type. If additional instances of the selected instance type aren't available, AWS
Batch waits for the additional instances to be available. If there aren't enough instances available, or
if the user is hitting Amazon EC2 service
limits then additional jobs aren't run until the currently running jobs have completed. 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.
AWS Batch 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 unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
AWS Batch will select one or more 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. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS Batch
might need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch
never exceeds maxvCpus by more than a single instance.
CRAllocationStrategypublic String getAllocationStrategy()
The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation Strategies in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost
instance type. If additional instances of the selected instance type aren't available, AWS Batch waits for the
additional instances to be available. If there aren't enough instances available, or if the user is hitting Amazon EC2 service limits
then additional jobs aren't run until the currently running jobs have completed. 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.
AWS Batch 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 unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
AWS Batch will select one or more 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. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS Batch might
need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds
maxvCpus by more than a single instance.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the
lowest-cost instance type. If additional instances of the selected instance type aren't available, AWS
Batch waits for the additional instances to be available. If there aren't enough instances available, or
if the user is hitting Amazon EC2 service
limits then additional jobs aren't run until the currently running jobs have completed. 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.
AWS Batch 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 unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
AWS Batch will select one or more 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. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS
Batch might need to go above maxvCpus to meet your capacity requirements. In this event, AWS
Batch never exceeds maxvCpus by more than a single instance.
CRAllocationStrategypublic ComputeResource withAllocationStrategy(String allocationStrategy)
The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation Strategies in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost
instance type. If additional instances of the selected instance type aren't available, AWS Batch waits for the
additional instances to be available. If there aren't enough instances available, or if the user is hitting Amazon EC2 service limits
then additional jobs aren't run until the currently running jobs have completed. 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.
AWS Batch 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 unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
AWS Batch will select one or more 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. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS Batch might
need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds
maxvCpus by more than a single instance.
allocationStrategy - The allocation strategy to use for the compute resource if not enough instances of the best fitting
instance type can be allocated. This might be because of availability of the instance type in the Region
or Amazon EC2
service limits. For more information, see Allocation
Strategies in the AWS Batch User Guide. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the
lowest-cost instance type. If additional instances of the selected instance type aren't available, AWS
Batch waits for the additional instances to be available. If there aren't enough instances available, or
if the user is hitting Amazon EC2 service
limits then additional jobs aren't run until the currently running jobs have completed. 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.
AWS Batch 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 unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
AWS Batch will select one or more 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. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS Batch
might need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch
never exceeds maxvCpus by more than a single instance.
CRAllocationStrategypublic void setAllocationStrategy(CRAllocationStrategy allocationStrategy)
The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation Strategies in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost
instance type. If additional instances of the selected instance type aren't available, AWS Batch waits for the
additional instances to be available. If there aren't enough instances available, or if the user is hitting Amazon EC2 service limits
then additional jobs aren't run until the currently running jobs have completed. 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.
AWS Batch 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 unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
AWS Batch will select one or more 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. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS Batch might
need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds
maxvCpus by more than a single instance.
allocationStrategy - The allocation strategy to use for the compute resource if not enough instances of the best fitting
instance type can be allocated. This might be because of availability of the instance type in the Region
or Amazon EC2
service limits. For more information, see Allocation
Strategies in the AWS Batch User Guide. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the
lowest-cost instance type. If additional instances of the selected instance type aren't available, AWS
Batch waits for the additional instances to be available. If there aren't enough instances available, or
if the user is hitting Amazon EC2 service
limits then additional jobs aren't run until the currently running jobs have completed. 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.
AWS Batch 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 unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
AWS Batch will select one or more 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. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS Batch
might need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch
never exceeds maxvCpus by more than a single instance.
CRAllocationStrategypublic ComputeResource withAllocationStrategy(CRAllocationStrategy allocationStrategy)
The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation Strategies in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost
instance type. If additional instances of the selected instance type aren't available, AWS Batch waits for the
additional instances to be available. If there aren't enough instances available, or if the user is hitting Amazon EC2 service limits
then additional jobs aren't run until the currently running jobs have completed. 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.
AWS Batch 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 unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
AWS Batch will select one or more 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. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS Batch might
need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds
maxvCpus by more than a single instance.
allocationStrategy - The allocation strategy to use for the compute resource if not enough instances of the best fitting
instance type can be allocated. This might be because of availability of the instance type in the Region
or Amazon EC2
service limits. For more information, see Allocation
Strategies in the AWS Batch User Guide. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the
lowest-cost instance type. If additional instances of the selected instance type aren't available, AWS
Batch waits for the additional instances to be available. If there aren't enough instances available, or
if the user is hitting Amazon EC2 service
limits then additional jobs aren't run until the currently running jobs have completed. 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.
AWS Batch 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 unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
AWS Batch will select one or more 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. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS Batch
might need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch
never exceeds maxvCpus by more than a single instance.
CRAllocationStrategypublic void setMinvCpus(Integer minvCpus)
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is
DISABLED).
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
minvCpus - The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute
environment is DISABLED). This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public Integer getMinvCpus()
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is
DISABLED).
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
DISABLED). This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public ComputeResource withMinvCpus(Integer minvCpus)
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is
DISABLED).
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
minvCpus - The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute
environment is DISABLED). This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public void setMaxvCpus(Integer maxvCpus)
The maximum number of Amazon EC2 vCPUs that a compute environment can reach.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, AWS
Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch
never exceeds maxvCpus by more than a single instance. For example, no more than a single instance
from among those specified in your compute environment is allocated.
maxvCpus - The maximum number of Amazon EC2 vCPUs that a compute environment can reach.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation
strategies, AWS Batch might need to exceed maxvCpus to meet your capacity requirements. In
this event, AWS Batch never exceeds maxvCpus by more than a single instance. For example, no
more than a single instance from among those specified in your compute environment is allocated.
public Integer getMaxvCpus()
The maximum number of Amazon EC2 vCPUs that a compute environment can reach.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, AWS
Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch
never exceeds maxvCpus by more than a single instance. For example, no more than a single instance
from among those specified in your compute environment is allocated.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation
strategies, AWS Batch might need to exceed maxvCpus to meet your capacity requirements. In
this event, AWS Batch never exceeds maxvCpus by more than a single instance. For example, no
more than a single instance from among those specified in your compute environment is allocated.
public ComputeResource withMaxvCpus(Integer maxvCpus)
The maximum number of Amazon EC2 vCPUs that a compute environment can reach.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, AWS
Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch
never exceeds maxvCpus by more than a single instance. For example, no more than a single instance
from among those specified in your compute environment is allocated.
maxvCpus - The maximum number of Amazon EC2 vCPUs that a compute environment can reach.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation
strategies, AWS Batch might need to exceed maxvCpus to meet your capacity requirements. In
this event, AWS Batch never exceeds maxvCpus by more than a single instance. For example, no
more than a single instance from among those specified in your compute environment is allocated.
public void setDesiredvCpus(Integer desiredvCpus)
The desired number of Amazon EC2 vCPUS in the compute environment. AWS Batch modifies this value between the minimum and maximum values, based on job queue demand.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
desiredvCpus - The desired number of Amazon EC2 vCPUS in the compute environment. AWS Batch modifies this value between
the minimum and maximum values, based on job queue demand. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public Integer getDesiredvCpus()
The desired number of Amazon EC2 vCPUS in the compute environment. AWS Batch modifies this value between the minimum and maximum values, based on job queue demand.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public ComputeResource withDesiredvCpus(Integer desiredvCpus)
The desired number of Amazon EC2 vCPUS in the compute environment. AWS Batch modifies this value between the minimum and maximum values, based on job queue demand.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
desiredvCpus - The desired number of Amazon EC2 vCPUS in the compute environment. AWS Batch modifies this value between
the minimum and maximum values, based on job queue demand. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public List<String> getInstanceTypes()
The instances types that can 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 select instance types (from
the C4, M4, and R4 instance families) that match the demand of your job queues.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that
don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families
are used.
c5 or p3), or you can specify specific
sizes within a family (such as c5.8xlarge). You can also choose optimal to
select instance types (from the C4, M4, and R4 instance families) that match the demand of your job
queues. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions
that don't have instance types from those instance families, instance types from the C5, M5. and R5
instance families are used.
public void setInstanceTypes(Collection<String> instanceTypes)
The instances types that can 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 select instance types (from
the C4, M4, and R4 instance families) that match the demand of your job queues.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that
don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families
are used.
instanceTypes - The instances types that can 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 select
instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions
that don't have instance types from those instance families, instance types from the C5, M5. and R5
instance families are used.
public ComputeResource withInstanceTypes(String... instanceTypes)
The instances types that can 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 select instance types (from
the C4, M4, and R4 instance families) that match the demand of your job queues.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that
don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families
are used.
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.
instanceTypes - The instances types that can 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 select
instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions
that don't have instance types from those instance families, instance types from the C5, M5. and R5
instance families are used.
public ComputeResource withInstanceTypes(Collection<String> instanceTypes)
The instances types that can 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 select instance types (from
the C4, M4, and R4 instance families) that match the demand of your job queues.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that
don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families
are used.
instanceTypes - The instances types that can 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 select
instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions
that don't have instance types from those instance families, instance types from the C5, M5. and R5
instance families are used.
@Deprecated public void setImageId(String imageId)
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is
overridden by the imageIdOverride member of the Ec2Configuration structure.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
imageId - The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter
is overridden by the imageIdOverride member of the Ec2Configuration
structure. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
@Deprecated public String getImageId()
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is
overridden by the imageIdOverride member of the Ec2Configuration structure.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
imageIdOverride member of the Ec2Configuration
structure. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
@Deprecated public ComputeResource withImageId(String imageId)
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is
overridden by the imageIdOverride member of the Ec2Configuration structure.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
imageId - The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter
is overridden by the imageIdOverride member of the Ec2Configuration
structure. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
public List<String> getSubnets()
The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
public void setSubnets(Collection<String> subnets)
The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
subnets - The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC.
Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and Subnets in the
Amazon VPC User Guide.public ComputeResource withSubnets(String... subnets)
The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. 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.
subnets - The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC.
Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and Subnets in the
Amazon VPC User Guide.public ComputeResource withSubnets(Collection<String> subnets)
The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
subnets - The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC.
Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and Subnets in the
Amazon VPC User Guide.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. This parameter is required for jobs running on Fargate resources and must contain
at least one security group. Fargate doesn't support launch templates. If security groups are specified using
both securityGroupIds and launchTemplate, the values in securityGroupIds
is used.
securityGroupIds or using a launch template
referenced in launchTemplate. This parameter is required for jobs running on Fargate
resources and must contain at least one security group. Fargate doesn't support launch templates. If
security groups are specified using both securityGroupIds and launchTemplate,
the values in securityGroupIds is used.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. This parameter is required for jobs running on Fargate resources and must contain
at least one security group. Fargate doesn't support launch templates. If security groups are specified using
both securityGroupIds and launchTemplate, the values in securityGroupIds
is used.
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. This parameter is required for jobs running on Fargate
resources and must contain at least one security group. Fargate doesn't support launch templates. If
security groups are specified using both securityGroupIds and launchTemplate,
the values in securityGroupIds is used.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. This parameter is required for jobs running on Fargate resources and must contain
at least one security group. Fargate doesn't support launch templates. If security groups are specified using
both securityGroupIds and launchTemplate, the values in securityGroupIds
is 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.
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. This parameter is required for jobs running on Fargate
resources and must contain at least one security group. Fargate doesn't support launch templates. If
security groups are specified using both securityGroupIds and launchTemplate,
the values in securityGroupIds is used.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. This parameter is required for jobs running on Fargate resources and must contain
at least one security group. Fargate doesn't support launch templates. If security groups are specified using
both securityGroupIds and launchTemplate, the values in securityGroupIds
is used.
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. This parameter is required for jobs running on Fargate
resources and must contain at least one security group. Fargate doesn't support launch templates. If
security groups are specified using both securityGroupIds and launchTemplate,
the values in securityGroupIds is used.public void setEc2KeyPair(String ec2KeyPair)
The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
ec2KeyPair - The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this
key pair to log in to your instances with SSH. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public String getEc2KeyPair()
The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public ComputeResource withEc2KeyPair(String ec2KeyPair)
The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
ec2KeyPair - The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this
key pair to log in to your instances with SSH. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public Map<String,String> getTags()
Key-value pair tags to be applied to EC2 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" }. This is helpful for recognizing your AWS Batch instances
in the Amazon EC2 console. These tags can't 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
aren't seen when using the AWS Batch ListTagsForResource API operation.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
ListTagsForResource API
operation. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public void setTags(Map<String,String> tags)
Key-value pair tags to be applied to EC2 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" }. This is helpful for recognizing your AWS Batch instances
in the Amazon EC2 console. These tags can't 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
aren't seen when using the AWS Batch ListTagsForResource API operation.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
tags - Key-value pair tags to be applied to EC2 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" }. This is helpful for recognizing your AWS
Batch instances in the Amazon EC2 console. These tags can't 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 aren't seen when using the AWS Batch ListTagsForResource API
operation. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public ComputeResource withTags(Map<String,String> tags)
Key-value pair tags to be applied to EC2 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" }. This is helpful for recognizing your AWS Batch instances
in the Amazon EC2 console. These tags can't 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
aren't seen when using the AWS Batch ListTagsForResource API operation.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
tags - Key-value pair tags to be applied to EC2 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" }. This is helpful for recognizing your AWS
Batch instances in the Amazon EC2 console. These tags can't 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 aren't seen when using the AWS Batch ListTagsForResource API
operation. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public ComputeResource addTagsEntry(String key, String value)
public ComputeResource clearTagsEntries()
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.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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 less than 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.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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 less than 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. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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 less than 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.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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 less than 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.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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 less than 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. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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 isn't specified. For more information, see Amazon EC2 Spot Fleet Role
in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot Instances not tagged on creation in the AWS Batch User Guide.
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 isn't specified. For more information, see Amazon EC2 Spot Fleet
Role in the AWS Batch User Guide. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot Instances not tagged on creation in the AWS Batch User Guide.
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 isn't specified. For more information, see Amazon EC2 Spot Fleet Role
in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot Instances not tagged on creation in the AWS Batch User Guide.
SPOT
compute environment. This role is required if the allocation strategy set to BEST_FIT or if
the allocation strategy isn't specified. For more information, see Amazon EC2 Spot Fleet
Role in the AWS Batch User Guide. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot Instances not tagged on creation in the AWS Batch User Guide.
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 isn't specified. For more information, see Amazon EC2 Spot Fleet Role
in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot Instances not tagged on creation in the AWS Batch User Guide.
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 isn't specified. For more information, see Amazon EC2 Spot Fleet
Role in the AWS Batch User Guide. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot Instances not tagged on creation in the AWS Batch User Guide.
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.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
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. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public List<Ec2Configuration> getEc2Configuration()
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If
Ec2Configuration isn't specified, the default is ECS_AL1.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
Ec2Configuration isn't specified, the default is ECS_AL1.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public void setEc2Configuration(Collection<Ec2Configuration> ec2Configuration)
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If
Ec2Configuration isn't specified, the default is ECS_AL1.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
ec2Configuration - Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute
environment. If Ec2Configuration isn't specified, the default is ECS_AL1.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public ComputeResource withEc2Configuration(Ec2Configuration... ec2Configuration)
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If
Ec2Configuration isn't specified, the default is ECS_AL1.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
NOTE: This method appends the values to the existing list (if any). Use
setEc2Configuration(java.util.Collection) or withEc2Configuration(java.util.Collection) if you
want to override the existing values.
ec2Configuration - Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute
environment. If Ec2Configuration isn't specified, the default is ECS_AL1.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public ComputeResource withEc2Configuration(Collection<Ec2Configuration> ec2Configuration)
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If
Ec2Configuration isn't specified, the default is ECS_AL1.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
ec2Configuration - Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute
environment. If Ec2Configuration isn't specified, the default is ECS_AL1.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
public String toString()
toString in class ObjectObject.toString()public ComputeResource clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.