/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.batch.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* An object that represents an Batch compute resource. For more information, see Compute environments in the * Batch User Guide. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ComputeResource implements Serializable, Cloneable, StructuredPojo { /** *

* The type of compute environment: EC2, SPOT, FARGATE, or * FARGATE_SPOT. For more information, see Compute environments in * the 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 Batch User Guide. *

*/ private String type; /** *

* 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 Batch User Guide. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

BEST_FIT (default): *
* 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, Batch waits for the * additional instances to be available. If there aren't enough instances available or the user is reaching Amazon EC2 service * limits, additional jobs aren't run until the currently running jobs are completed. This allocation strategy * keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, the Spot Fleet * IAM Role must be specified. Compute resources that use a BEST_FIT allocation strategy don't support * infrastructure updates and can't update some parameters. For more information, see Updating compute * environments in the Batch User Guide. *
*
BEST_FIT_PROGRESSIVE: *
* Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. * Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected * instance types aren't available, Batch selects new instance types. *
*
SPOT_CAPACITY_OPTIMIZED: *
* Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. * Its preference is 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 using On-Demand * or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed * maxvCpus to meet your capacity requirements. In this event, Batch never exceeds * maxvCpus by more than a single instance. *

*/ private String allocationStrategy; /** *

* The minimum number of vCPUs that a compute environment should maintain (even if the compute environment is * DISABLED). *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* */ private Integer minvCpus; /** *

* The maximum number of vCPUs that a compute environment can support. *

* *

* With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies using * On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to * exceed maxvCpus to meet your capacity requirements. In this event, 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. *

* */ private Integer maxvCpus; /** *

* The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum * values based on job queue demand. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* */ private Integer desiredvCpus; /** *

* 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 that are running on Fargate resources. Don't specify it. *

* *

* 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. *

* */ private java.util.List instanceTypes; /** *

* 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 that are running on Fargate resources. Don't specify it. *

* *

* 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 private String imageId; /** *

* The VPC subnets where 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. *

* *

* Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see * Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local * Zones in the Amazon EKS User Guide and * Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS * Developer Guide. *

* Batch on Fargate doesn't currently support Local Zones. *

* */ private java.util.List subnets; /** *

* The Amazon EC2 security groups that are 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 that are 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 are used. *

*/ private java.util.List securityGroupIds; /** *

* 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 that are running on Fargate resources. Don't specify it. *

* */ private String ec2KeyPair; /** *

* 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 Batch User Guide. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* */ private String instanceRole; /** *

* Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch, these * take the form of "String1": "String2", where String1 is the tag key and * String2 is the tag value-for example, { "Name": "Batch Instance - C4OnDemand" }. This * is helpful for recognizing your Batch instances in the Amazon EC2 console. Updating these tags requires an * infrastructure update to the compute environment. For more information, see Updating compute * environments in the Batch User Guide. These tags aren't seen when using the Batch * ListTagsForResource API operation. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* */ private java.util.Map tags; /** *

* 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 that are running on Fargate resources. Don't specify it. *

* */ private String placementGroup; /** *

* 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. For most use cases, we recommend leaving this field empty. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* */ private Integer bidPercentage; /** *

* 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 Batch User Guide. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

* 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 Batch User Guide. *

* */ private String spotIamFleetRole; /** *

* 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 Batch User Guide. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* */ private LaunchTemplateSpecification launchTemplate; /** *

* Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in the compute * environment. If Ec2Configuration isn't specified, the default is ECS_AL2. *

* One or two values can be provided. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* */ private java.util.List ec2Configuration; /** *

* The type of compute environment: EC2, SPOT, FARGATE, or * FARGATE_SPOT. For more information, see Compute environments in * the Batch User Guide. *

* * @param type * The type of compute environment: EC2, SPOT, FARGATE, or * FARGATE_SPOT. For more information, see Compute * environments in the Batch User Guide.

* The type of compute environment: EC2, SPOT, FARGATE, or * FARGATE_SPOT. For more information, see Compute environments in * the Batch User Guide. *

* * @return The type of compute environment: EC2, SPOT, FARGATE, or * FARGATE_SPOT. For more information, see Compute * environments in the Batch User Guide.

* The type of compute environment: EC2, SPOT, FARGATE, or * FARGATE_SPOT. For more information, see Compute environments in * the Batch User Guide. *

* * @param type * The type of compute environment: EC2, SPOT, FARGATE, or * FARGATE_SPOT. For more information, see Compute * environments in the 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 Batch User Guide. * @return Returns a reference to this object so that method calls can be chained together. * @see CRType */ public ComputeResource withType(String type) { setType(type); return this; } /** *

* The type of compute environment: EC2, SPOT, FARGATE, or * FARGATE_SPOT. For more information, see Compute environments in * the Batch User Guide. *

* * @param type * The type of compute environment: EC2, SPOT, FARGATE, or * FARGATE_SPOT. For more information, see Compute * environments in the Batch User Guide.

* The type of compute environment: EC2, SPOT, FARGATE, or * FARGATE_SPOT. For more information, see Compute environments in * the Batch User Guide. *

* * @param type * The type of compute environment: EC2, SPOT, FARGATE, or * FARGATE_SPOT. For more information, see Compute * environments in the Batch User Guide.

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

BEST_FIT (default): *
* 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, Batch waits for the * additional instances to be available. If there aren't enough instances available or the user is reaching Amazon EC2 service * limits, additional jobs aren't run until the currently running jobs are completed. This allocation strategy * keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, the Spot Fleet * IAM Role must be specified. Compute resources that use a BEST_FIT allocation strategy don't support * infrastructure updates and can't update some parameters. For more information, see Updating compute * environments in the Batch User Guide. *
*
BEST_FIT_PROGRESSIVE: *
* Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. * Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected * instance types aren't available, Batch selects new instance types. *
*
SPOT_CAPACITY_OPTIMIZED: *
* Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. * Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only * available for Spot Instance compute resources. *
*

* * @param 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 Batch User Guide.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

BEST_FIT (default): *
* 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, Batch waits for the * additional instances to be available. If there aren't enough instances available or the user is reaching * Amazon EC2 service * limits, additional jobs aren't run until the currently running jobs are completed. This allocation * strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, * the Spot Fleet IAM Role must be specified. Compute resources that use a BEST_FIT allocation * strategy don't support infrastructure updates and can't update some parameters. For more information, see * Updating * compute environments in the Batch User Guide. *
*
BEST_FIT_PROGRESSIVE: *
* Batch selects additional instance types that are large enough to meet the requirements of the jobs in the * queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the * previously selected instance types aren't available, Batch selects new instance types. *
*
SPOT_CAPACITY_OPTIMIZED: *
* Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the * queue. Its preference is 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 using * On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need * to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds * maxvCpus by more than a single instance. * @see CRAllocationStrategy */ public void setAllocationStrategy(String allocationStrategy) { this.allocationStrategy = allocationStrategy; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

BEST_FIT (default): *
* 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, Batch waits for the * additional instances to be available. If there aren't enough instances available or the user is reaching Amazon EC2 service * limits, additional jobs aren't run until the currently running jobs are completed. This allocation strategy * keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, the Spot Fleet * IAM Role must be specified. Compute resources that use a BEST_FIT allocation strategy don't support * infrastructure updates and can't update some parameters. For more information, see Updating compute * environments in the Batch User Guide. *
*
BEST_FIT_PROGRESSIVE: *
* Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. * Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected * instance types aren't available, Batch selects new instance types. *
*
SPOT_CAPACITY_OPTIMIZED: *
* Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. * Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only * available for Spot Instance compute resources. *
*

* * @return 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 Batch User Guide.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

BEST_FIT (default): *
* 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, Batch waits for * the additional instances to be available. If there aren't enough instances available or the user is * reaching Amazon * EC2 service limits, additional jobs aren't run until the currently running jobs are completed. This * allocation strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with * BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use a * BEST_FIT allocation strategy don't support infrastructure updates and can't update some * parameters. For more information, see Updating * compute environments in the Batch User Guide. *
*
BEST_FIT_PROGRESSIVE: *
* Batch selects additional instance types that are large enough to meet the requirements of the jobs in the * queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the * previously selected instance types aren't available, Batch selects new instance types. *
*
SPOT_CAPACITY_OPTIMIZED: *
* Batch selects one or more instance types that are large enough to meet the requirements of the jobs in * the queue. Its preference is 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 using * On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might * need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never * exceeds maxvCpus by more than a single instance. * @see CRAllocationStrategy */ public String getAllocationStrategy() { return this.allocationStrategy; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

BEST_FIT (default): *
* 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, Batch waits for the * additional instances to be available. If there aren't enough instances available or the user is reaching Amazon EC2 service * limits, additional jobs aren't run until the currently running jobs are completed. This allocation strategy * keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, the Spot Fleet * IAM Role must be specified. Compute resources that use a BEST_FIT allocation strategy don't support * infrastructure updates and can't update some parameters. For more information, see Updating compute * environments in the Batch User Guide. *
*
BEST_FIT_PROGRESSIVE: *
* Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. * Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected * instance types aren't available, Batch selects new instance types. *
*
SPOT_CAPACITY_OPTIMIZED: *
* Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. * Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only * available for Spot Instance compute resources. *
*

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

BEST_FIT (default): *
* 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, Batch waits for the * additional instances to be available. If there aren't enough instances available or the user is reaching * Amazon EC2 service * limits, additional jobs aren't run until the currently running jobs are completed. This allocation * strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, * the Spot Fleet IAM Role must be specified. Compute resources that use a BEST_FIT allocation * strategy don't support infrastructure updates and can't update some parameters. For more information, see * Updating * compute environments in the Batch User Guide. *
*
BEST_FIT_PROGRESSIVE: *
* Batch selects additional instance types that are large enough to meet the requirements of the jobs in the * queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the * previously selected instance types aren't available, Batch selects new instance types. *
*
SPOT_CAPACITY_OPTIMIZED: *
* Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the * queue. Its preference is 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 using * On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need * to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds * maxvCpus by more than a single instance. * @return Returns a reference to this object so that method calls can be chained together. * @see CRAllocationStrategy */ public ComputeResource withAllocationStrategy(String allocationStrategy) { setAllocationStrategy(allocationStrategy); return this; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

BEST_FIT (default): *
* 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, Batch waits for the * additional instances to be available. If there aren't enough instances available or the user is reaching Amazon EC2 service * limits, additional jobs aren't run until the currently running jobs are completed. This allocation strategy * keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, the Spot Fleet * IAM Role must be specified. Compute resources that use a BEST_FIT allocation strategy don't support * infrastructure updates and can't update some parameters. For more information, see Updating compute * environments in the Batch User Guide. *
*
BEST_FIT_PROGRESSIVE: *
* Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. * Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected * instance types aren't available, Batch selects new instance types. *
*
SPOT_CAPACITY_OPTIMIZED: *
* Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. * Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only * available for Spot Instance compute resources. *
*

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

BEST_FIT (default): *
* 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, Batch waits for the * additional instances to be available. If there aren't enough instances available or the user is reaching * Amazon EC2 service * limits, additional jobs aren't run until the currently running jobs are completed. This allocation * strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, * the Spot Fleet IAM Role must be specified. Compute resources that use a BEST_FIT allocation * strategy don't support infrastructure updates and can't update some parameters. For more information, see * Updating * compute environments in the Batch User Guide. *
*
BEST_FIT_PROGRESSIVE: *
* Batch selects additional instance types that are large enough to meet the requirements of the jobs in the * queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the * previously selected instance types aren't available, Batch selects new instance types. *
*
SPOT_CAPACITY_OPTIMIZED: *
* Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the * queue. Its preference is 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 using * On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need * to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds * maxvCpus by more than a single instance. * @see CRAllocationStrategy */ public void setAllocationStrategy(CRAllocationStrategy allocationStrategy) { withAllocationStrategy(allocationStrategy); } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

BEST_FIT (default): *
* 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, Batch waits for the * additional instances to be available. If there aren't enough instances available or the user is reaching Amazon EC2 service * limits, additional jobs aren't run until the currently running jobs are completed. This allocation strategy * keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, the Spot Fleet * IAM Role must be specified. Compute resources that use a BEST_FIT allocation strategy don't support * infrastructure updates and can't update some parameters. For more information, see Updating compute * environments in the Batch User Guide. *
*
BEST_FIT_PROGRESSIVE: *
* Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. * Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected * instance types aren't available, Batch selects new instance types. *
*
SPOT_CAPACITY_OPTIMIZED: *
* Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. * Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only * available for Spot Instance compute resources. *
*

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

BEST_FIT (default): *
* 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, Batch waits for the * additional instances to be available. If there aren't enough instances available or the user is reaching * Amazon EC2 service * limits, additional jobs aren't run until the currently running jobs are completed. This allocation * strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, * the Spot Fleet IAM Role must be specified. Compute resources that use a BEST_FIT allocation * strategy don't support infrastructure updates and can't update some parameters. For more information, see * Updating * compute environments in the Batch User Guide. *
*
BEST_FIT_PROGRESSIVE: *
* Batch selects additional instance types that are large enough to meet the requirements of the jobs in the * queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the * previously selected instance types aren't available, Batch selects new instance types. *
*
SPOT_CAPACITY_OPTIMIZED: *
* Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the * queue. Its preference is 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 using * On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need * to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds * maxvCpus by more than a single instance. * @return Returns a reference to this object so that method calls can be chained together. * @see CRAllocationStrategy */ public ComputeResource withAllocationStrategy(CRAllocationStrategy allocationStrategy) { this.allocationStrategy = allocationStrategy.toString(); return this; } /** *

* The minimum number of vCPUs that a compute environment should maintain (even if the compute environment is * DISABLED). *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @param minvCpus * The minimum number of vCPUs that a compute environment should maintain (even if the compute environment is * DISABLED).

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

*/ public void setMinvCpus(Integer minvCpus) { this.minvCpus = minvCpus; } /** *

* The minimum number of vCPUs that a compute environment should maintain (even if the compute environment is * DISABLED). *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @return The minimum number of vCPUs that a compute environment should maintain (even if the compute environment * is DISABLED).

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

*/ public Integer getMinvCpus() { return this.minvCpus; } /** *

* The minimum number of vCPUs that a compute environment should maintain (even if the compute environment is * DISABLED). *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @param minvCpus * The minimum number of vCPUs that a compute environment should maintain (even if the compute environment is * DISABLED).

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withMinvCpus(Integer minvCpus) { setMinvCpus(minvCpus); return this; } /** *

* The maximum number of vCPUs that a compute environment can support. *

* *

* * * @param maxvCpus * The maximum number of vCPUs that a compute environment can support.

* With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies * using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch * might need to exceed maxvCpus to meet your capacity requirements. In this event, 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 setMaxvCpus(Integer maxvCpus) { this.maxvCpus = maxvCpus; } /** *

* The maximum number of vCPUs that a compute environment can support. *

* *

* * * @return The maximum number of vCPUs that a compute environment can support.

* With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation * strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot * Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this * event, 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() { return this.maxvCpus; } /** *

* The maximum number of vCPUs that a compute environment can support. *

* *

* * * @param maxvCpus * The maximum number of vCPUs that a compute environment can support.

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withMaxvCpus(Integer maxvCpus) { setMaxvCpus(maxvCpus); return this; } /** *

* The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum * values based on job queue demand. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @param desiredvCpus * The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and * maximum values based on job queue demand.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

*/ public void setDesiredvCpus(Integer desiredvCpus) { this.desiredvCpus = desiredvCpus; } /** *

* The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum * values based on job queue demand. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @return The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and * maximum values based on job queue demand.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

*/ public Integer getDesiredvCpus() { return this.desiredvCpus; } /** *

* The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum * values based on job queue demand. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @param desiredvCpus * The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and * maximum values based on job queue demand.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withDesiredvCpus(Integer desiredvCpus) { setDesiredvCpus(desiredvCpus); return this; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

* * * @return 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 that are running on Fargate resources. Don't specify it. *

* *

* 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 java.util.List getInstanceTypes() { return instanceTypes; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

* * * @param 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 that are running on Fargate resources. Don't specify it. *

* *

* 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. *

* *

*/ public void setInstanceTypes(java.util.Collection instanceTypes) { if (instanceTypes == null) { this.instanceTypes = null; return; } this.instanceTypes = new java.util.ArrayList(instanceTypes); } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setInstanceTypes(java.util.Collection)} or {@link #withInstanceTypes(java.util.Collection)} if you want * to override the existing values. *

* * @param 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 that are running on Fargate resources. Don't specify it. *

* *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withInstanceTypes(String... instanceTypes) { if (this.instanceTypes == null) { setInstanceTypes(new java.util.ArrayList(instanceTypes.length)); } for (String ele : instanceTypes) { this.instanceTypes.add(ele); } return this; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withInstanceTypes(java.util.Collection instanceTypes) { setInstanceTypes(instanceTypes); return this; } /** *

* 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 that are running on Fargate resources. Don't specify it. *

* *

* * * @param 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 that are running on Fargate resources. Don't specify it. *

* *

* 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 void setImageId(String imageId) { this.imageId = 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 that are running on Fargate resources. Don't specify it. *

* *

* * * @return 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 that are running on Fargate resources. Don't specify it. *

* *

*/ @Deprecated public String getImageId() { return this.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 that are running on Fargate resources. Don't specify it. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

* @return Returns a reference to this object so that method calls can be chained together. */ @Deprecated public ComputeResource withImageId(String imageId) { setImageId(imageId); return this; } /** *

* *

* Batch on Fargate doesn't currently support Local Zones. *

* * * @return The VPC subnets where 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.

* Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web * Services Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the * Amazon ECS Developer Guide. *

* Batch on Fargate doesn't currently support Local Zones. *

*/ public java.util.List getSubnets() { return subnets; } /** *

* *

* Batch on Fargate doesn't currently support Local Zones. *

* * * @param subnets * The VPC subnets where 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.

* Batch on Fargate doesn't currently support Local Zones. *

*/ public void setSubnets(java.util.Collection subnets) { if (subnets == null) { this.subnets = null; return; } this.subnets = new java.util.ArrayList(subnets); } /** *

* *

* Batch on Fargate doesn't currently support Local Zones. *

* *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setSubnets(java.util.Collection)} or {@link #withSubnets(java.util.Collection)} if you want to override * the existing values. *

* * @param subnets * The VPC subnets where 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.

* Batch on Fargate doesn't currently support Local Zones. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withSubnets(String... subnets) { if (this.subnets == null) { setSubnets(new java.util.ArrayList(subnets.length)); } for (String ele : subnets) { this.subnets.add(ele); } return this; } /** *

* *

* Batch on Fargate doesn't currently support Local Zones. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withSubnets(java.util.Collection subnets) { setSubnets(subnets); return this; } /** *

* * @return The Amazon EC2 security groups that are 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 that are 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 are used. */ public java.util.List getSecurityGroupIds() { return securityGroupIds; } /** *

* * @param securityGroupIds * The Amazon EC2 security groups that are 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 that are 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 are used. */ public void setSecurityGroupIds(java.util.Collection securityGroupIds) { if (securityGroupIds == null) { this.securityGroupIds = null; return; } this.securityGroupIds = new java.util.ArrayList(securityGroupIds); } /** *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setSecurityGroupIds(java.util.Collection)} or {@link #withSecurityGroupIds(java.util.Collection)} if you * want to override the existing values. *

* * @param securityGroupIds * The Amazon EC2 security groups that are 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 that are 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 are used. * @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withSecurityGroupIds(String... securityGroupIds) { if (this.securityGroupIds == null) { setSecurityGroupIds(new java.util.ArrayList(securityGroupIds.length)); } for (String ele : securityGroupIds) { this.securityGroupIds.add(ele); } return this; } /** *

* * @param securityGroupIds * The Amazon EC2 security groups that are 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 that are 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 are used. * @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withSecurityGroupIds(java.util.Collection securityGroupIds) { setSecurityGroupIds(securityGroupIds); return this; } /** *

* 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 that are running on Fargate resources. Don't specify it. *

* * * @param 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 that are running on Fargate resources. Don't specify it. *

*/ public void setEc2KeyPair(String ec2KeyPair) { this.ec2KeyPair = 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 that are running on Fargate resources. Don't specify it. *

* * * @return 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 that are running on Fargate resources. Don't specify it. *

*/ public String getEc2KeyPair() { return this.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 that are running on Fargate resources. Don't specify it. *

* * * @param 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 that are running on Fargate resources. Don't specify it. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withEc2KeyPair(String ec2KeyPair) { setEc2KeyPair(ec2KeyPair); return this; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @param 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 Batch User Guide.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

*/ public void setInstanceRole(String instanceRole) { this.instanceRole = instanceRole; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @return 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 Batch User Guide.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

*/ public String getInstanceRole() { return this.instanceRole; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withInstanceRole(String instanceRole) { setInstanceRole(instanceRole); return this; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @return Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For * Batch, these take the form of "String1": "String2", where String1 is the tag * key and String2 is the tag value-for example, * { "Name": "Batch Instance - C4OnDemand" }. This is helpful for recognizing your Batch * instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to the compute * environment. For more information, see Updating * compute environments in the Batch User Guide. These tags aren't seen when using the Batch * ListTagsForResource API operation.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

*/ public java.util.Map getTags() { return tags; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @param tags * Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For * Batch, these take the form of "String1": "String2", where String1 is the tag key * and String2 is the tag value-for example, * { "Name": "Batch Instance - C4OnDemand" }. This is helpful for recognizing your Batch * instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to the compute * environment. For more information, see Updating * compute environments in the Batch User Guide. These tags aren't seen when using the Batch * ListTagsForResource API operation.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

*/ public void setTags(java.util.Map tags) { this.tags = tags; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withTags(java.util.Map tags) { setTags(tags); return this; } /** * Add a single Tags entry * * @see ComputeResource#withTags * @returns a reference to this object so that method calls can be chained together. */ public ComputeResource addTagsEntry(String key, String value) { if (null == this.tags) { this.tags = new java.util.HashMap(); } if (this.tags.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.tags.put(key, value); return this; } /** * Removes all the entries added into Tags. * * @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource clearTagsEntries() { this.tags = null; return this; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @param 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 that are running on Fargate resources. Don't specify it. *

*/ public void setPlacementGroup(String placementGroup) { this.placementGroup = placementGroup; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @return 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 that are running on Fargate resources. Don't specify it. *

*/ public String getPlacementGroup() { return this.placementGroup; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withPlacementGroup(String placementGroup) { setPlacementGroup(placementGroup); return this; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @param 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. For most use cases, we recommend leaving this field * empty.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

*/ public void setBidPercentage(Integer bidPercentage) { this.bidPercentage = bidPercentage; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @return 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. For most use cases, we recommend leaving this field * empty.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

*/ public Integer getBidPercentage() { return this.bidPercentage; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withBidPercentage(Integer bidPercentage) { setBidPercentage(bidPercentage); return this; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

* * * @param 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 Batch User Guide.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

* 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 Batch User Guide. *

*/ public void setSpotIamFleetRole(String spotIamFleetRole) { this.spotIamFleetRole = spotIamFleetRole; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

* * * @return 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 Batch User Guide.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

* 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 Batch User Guide. *

*/ public String getSpotIamFleetRole() { return this.spotIamFleetRole; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

* 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 Batch User Guide. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withSpotIamFleetRole(String spotIamFleetRole) { setSpotIamFleetRole(spotIamFleetRole); return this; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @param 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 Batch User Guide.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

*/ public void setLaunchTemplate(LaunchTemplateSpecification launchTemplate) { this.launchTemplate = launchTemplate; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @return 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 Batch User Guide.

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

*/ public LaunchTemplateSpecification getLaunchTemplate() { return this.launchTemplate; } /** *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withLaunchTemplate(LaunchTemplateSpecification launchTemplate) { setLaunchTemplate(launchTemplate); return this; } /** *

* Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in the compute * environment. If Ec2Configuration isn't specified, the default is ECS_AL2. *

* One or two values can be provided. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @return Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in the compute * environment. If Ec2Configuration isn't specified, the default is ECS_AL2.

* One or two values can be provided. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

*/ public java.util.List getEc2Configuration() { return ec2Configuration; } /** *

* Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in the compute * environment. If Ec2Configuration isn't specified, the default is ECS_AL2. *

* One or two values can be provided. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* * * @param ec2Configuration * Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in the compute * environment. If Ec2Configuration isn't specified, the default is ECS_AL2.

* One or two values can be provided. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

*/ public void setEc2Configuration(java.util.Collection ec2Configuration) { if (ec2Configuration == null) { this.ec2Configuration = null; return; } this.ec2Configuration = new java.util.ArrayList(ec2Configuration); } /** *

* Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in the compute * environment. If Ec2Configuration isn't specified, the default is ECS_AL2. *

* One or two values can be provided. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setEc2Configuration(java.util.Collection)} or {@link #withEc2Configuration(java.util.Collection)} if you * want to override the existing values. *

* * @param ec2Configuration * Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in the compute * environment. If Ec2Configuration isn't specified, the default is ECS_AL2.

* One or two values can be provided. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withEc2Configuration(Ec2Configuration... ec2Configuration) { if (this.ec2Configuration == null) { setEc2Configuration(new java.util.ArrayList(ec2Configuration.length)); } for (Ec2Configuration ele : ec2Configuration) { this.ec2Configuration.add(ele); } return this; } /** *

* Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in the compute * environment. If Ec2Configuration isn't specified, the default is ECS_AL2. *

* One or two values can be provided. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* One or two values can be provided. *

* *

* This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ComputeResource withEc2Configuration(java.util.Collection ec2Configuration) { setEc2Configuration(ec2Configuration); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getType() != null) sb.append("Type: ").append(getType()).append(","); if (getAllocationStrategy() != null) sb.append("AllocationStrategy: ").append(getAllocationStrategy()).append(","); if (getMinvCpus() != null) sb.append("MinvCpus: ").append(getMinvCpus()).append(","); if (getMaxvCpus() != null) sb.append("MaxvCpus: ").append(getMaxvCpus()).append(","); if (getDesiredvCpus() != null) sb.append("DesiredvCpus: ").append(getDesiredvCpus()).append(","); if (getInstanceTypes() != null) sb.append("InstanceTypes: ").append(getInstanceTypes()).append(","); if (getImageId() != null) sb.append("ImageId: ").append(getImageId()).append(","); if (getSubnets() != null) sb.append("Subnets: ").append(getSubnets()).append(","); if (getSecurityGroupIds() != null) sb.append("SecurityGroupIds: ").append(getSecurityGroupIds()).append(","); if (getEc2KeyPair() != null) sb.append("Ec2KeyPair: ").append(getEc2KeyPair()).append(","); if (getInstanceRole() != null) sb.append("InstanceRole: ").append(getInstanceRole()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()).append(","); if (getPlacementGroup() != null) sb.append("PlacementGroup: ").append(getPlacementGroup()).append(","); if (getBidPercentage() != null) sb.append("BidPercentage: ").append(getBidPercentage()).append(","); if (getSpotIamFleetRole() != null) sb.append("SpotIamFleetRole: ").append(getSpotIamFleetRole()).append(","); if (getLaunchTemplate() != null) sb.append("LaunchTemplate: ").append(getLaunchTemplate()).append(","); if (getEc2Configuration() != null) sb.append("Ec2Configuration: ").append(getEc2Configuration()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ComputeResource == false) return false; ComputeResource other = (ComputeResource) obj; if (other.getType() == null ^ this.getType() == null) return false; if (other.getType() != null && other.getType().equals(this.getType()) == false) return false; if (other.getAllocationStrategy() == null ^ this.getAllocationStrategy() == null) return false; if (other.getAllocationStrategy() != null && other.getAllocationStrategy().equals(this.getAllocationStrategy()) == false) return false; if (other.getMinvCpus() == null ^ this.getMinvCpus() == null) return false; if (other.getMinvCpus() != null && other.getMinvCpus().equals(this.getMinvCpus()) == false) return false; if (other.getMaxvCpus() == null ^ this.getMaxvCpus() == null) return false; if (other.getMaxvCpus() != null && other.getMaxvCpus().equals(this.getMaxvCpus()) == false) return false; if (other.getDesiredvCpus() == null ^ this.getDesiredvCpus() == null) return false; if (other.getDesiredvCpus() != null && other.getDesiredvCpus().equals(this.getDesiredvCpus()) == false) return false; if (other.getInstanceTypes() == null ^ this.getInstanceTypes() == null) return false; if (other.getInstanceTypes() != null && other.getInstanceTypes().equals(this.getInstanceTypes()) == false) return false; if (other.getImageId() == null ^ this.getImageId() == null) return false; if (other.getImageId() != null && other.getImageId().equals(this.getImageId()) == false) return false; if (other.getSubnets() == null ^ this.getSubnets() == null) return false; if (other.getSubnets() != null && other.getSubnets().equals(this.getSubnets()) == false) return false; if (other.getSecurityGroupIds() == null ^ this.getSecurityGroupIds() == null) return false; if (other.getSecurityGroupIds() != null && other.getSecurityGroupIds().equals(this.getSecurityGroupIds()) == false) return false; if (other.getEc2KeyPair() == null ^ this.getEc2KeyPair() == null) return false; if (other.getEc2KeyPair() != null && other.getEc2KeyPair().equals(this.getEc2KeyPair()) == false) return false; if (other.getInstanceRole() == null ^ this.getInstanceRole() == null) return false; if (other.getInstanceRole() != null && other.getInstanceRole().equals(this.getInstanceRole()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; if (other.getPlacementGroup() == null ^ this.getPlacementGroup() == null) return false; if (other.getPlacementGroup() != null && other.getPlacementGroup().equals(this.getPlacementGroup()) == false) return false; if (other.getBidPercentage() == null ^ this.getBidPercentage() == null) return false; if (other.getBidPercentage() != null && other.getBidPercentage().equals(this.getBidPercentage()) == false) return false; if (other.getSpotIamFleetRole() == null ^ this.getSpotIamFleetRole() == null) return false; if (other.getSpotIamFleetRole() != null && other.getSpotIamFleetRole().equals(this.getSpotIamFleetRole()) == false) return false; if (other.getLaunchTemplate() == null ^ this.getLaunchTemplate() == null) return false; if (other.getLaunchTemplate() != null && other.getLaunchTemplate().equals(this.getLaunchTemplate()) == false) return false; if (other.getEc2Configuration() == null ^ this.getEc2Configuration() == null) return false; if (other.getEc2Configuration() != null && other.getEc2Configuration().equals(this.getEc2Configuration()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode()); hashCode = prime * hashCode + ((getAllocationStrategy() == null) ? 0 : getAllocationStrategy().hashCode()); hashCode = prime * hashCode + ((getMinvCpus() == null) ? 0 : getMinvCpus().hashCode()); hashCode = prime * hashCode + ((getMaxvCpus() == null) ? 0 : getMaxvCpus().hashCode()); hashCode = prime * hashCode + ((getDesiredvCpus() == null) ? 0 : getDesiredvCpus().hashCode()); hashCode = prime * hashCode + ((getInstanceTypes() == null) ? 0 : getInstanceTypes().hashCode()); hashCode = prime * hashCode + ((getImageId() == null) ? 0 : getImageId().hashCode()); hashCode = prime * hashCode + ((getSubnets() == null) ? 0 : getSubnets().hashCode()); hashCode = prime * hashCode + ((getSecurityGroupIds() == null) ? 0 : getSecurityGroupIds().hashCode()); hashCode = prime * hashCode + ((getEc2KeyPair() == null) ? 0 : getEc2KeyPair().hashCode()); hashCode = prime * hashCode + ((getInstanceRole() == null) ? 0 : getInstanceRole().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); hashCode = prime * hashCode + ((getPlacementGroup() == null) ? 0 : getPlacementGroup().hashCode()); hashCode = prime * hashCode + ((getBidPercentage() == null) ? 0 : getBidPercentage().hashCode()); hashCode = prime * hashCode + ((getSpotIamFleetRole() == null) ? 0 : getSpotIamFleetRole().hashCode()); hashCode = prime * hashCode + ((getLaunchTemplate() == null) ? 0 : getLaunchTemplate().hashCode()); hashCode = prime * hashCode + ((getEc2Configuration() == null) ? 0 : getEc2Configuration().hashCode()); return hashCode; } @Override public ComputeResource clone() { try { return (ComputeResource) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.batch.model.transform.ComputeResourceMarshaller.getInstance().marshall(this, protocolMarshaller); } }