/* * 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.autoscaling.model; import java.io.Serializable; import javax.annotation.Generated; /** *

* Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances * policy: *

*
* Override the instance type that is specified in the launch template. *
*
*
* Use multiple instance types. *
*

* Specify the instance types that you want, or define your instance requirements instead and let Amazon EC2 Auto * Scaling provision the available instance types that meet your requirements. This can provide Amazon EC2 Auto Scaling * with a larger selection of instance types to choose from when fulfilling Spot and On-Demand capacities. You can view * which instance types are matched before you apply the instance requirements to your Auto Scaling group. *

* After you define your instance requirements, you don't have to keep updating these settings to get new EC2 instance * types automatically. Amazon EC2 Auto Scaling uses the instance requirements of the Auto Scaling group to determine * whether a new EC2 instance type can be used. *

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

* The instance type, such as m3.xlarge. You must specify an instance type that is supported in your * requested Region and Availability Zones. For more information, see Instance types in the * Amazon Elastic Compute Cloud User Guide. *

* You can specify up to 40 instance types per Auto Scaling group. *

*/ private String instanceType; /** *

* If you provide a list of instance types to use, you can specify the number of capacity units provided by each * instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance * characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired * capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if * this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 * Auto Scaling can only launch an instance with a WeightedCapacity of five units, the instance is * launched, and the desired capacity is exceeded by three units. For more information, see Configuring instance weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. * Value must be in the range of 1–999. *

* If you specify a value for WeightedCapacity for one instance type, you must specify a value for * WeightedCapacity for all of them. *

* *

* Every Auto Scaling group has three size parameters (DesiredCapacity, MaxSize, and * MinSize). Usually, you set these sizes based on a specific number of instances. However, if you * configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with * the same units that you use for weighting instances. *

* */ private String weightedCapacity; /** *

* Provides a launch template for the specified instance type or set of instance requirements. For example, some * instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling * uses the launch template that's specified in the LaunchTemplate definition. For more information, * see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User * Guide. *

* You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides * and in the LaunchTemplate definition count towards this limit. *

*/ private LaunchTemplateSpecification launchTemplateSpecification; /** *

* The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. * Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. *

* You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for * provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, * create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance * requirements for each launch template. *

* *

* If you specify InstanceRequirements, you can't specify InstanceType. *

* */ private InstanceRequirements instanceRequirements; /** *

* You can specify up to 40 instance types per Auto Scaling group. *

* * @param instanceType * The instance type, such as m3.xlarge. You must specify an instance type that is supported in * your requested Region and Availability Zones. For more information, see Instance types in the * Amazon Elastic Compute Cloud User Guide.

* You can specify up to 40 instance types per Auto Scaling group. */ public void setInstanceType(String instanceType) { this.instanceType = instanceType; } /** *

* You can specify up to 40 instance types per Auto Scaling group. *

* * @return The instance type, such as m3.xlarge. You must specify an instance type that is supported in * your requested Region and Availability Zones. For more information, see Instance types in the * Amazon Elastic Compute Cloud User Guide.

* You can specify up to 40 instance types per Auto Scaling group. */ public String getInstanceType() { return this.instanceType; } /** *

* You can specify up to 40 instance types per Auto Scaling group. *

* You can specify up to 40 instance types per Auto Scaling group. * @return Returns a reference to this object so that method calls can be chained together. */ public LaunchTemplateOverrides withInstanceType(String instanceType) { setInstanceType(instanceType); return this; } /** *

* If you specify a value for WeightedCapacity for one instance type, you must specify a value for * WeightedCapacity for all of them. *

* *

* * * @param weightedCapacity * If you provide a list of instance types to use, you can specify the number of capacity units provided by * each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance * characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired * capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even * if this results in an overage. For example, if there are two units remaining to fulfill capacity, and * Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five units, * the instance is launched, and the desired capacity is exceeded by three units. For more information, see * Configuring instance weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User * Guide. Value must be in the range of 1–999.

* If you specify a value for WeightedCapacity for one instance type, you must specify a value * for WeightedCapacity for all of them. *

* *

* Every Auto Scaling group has three size parameters (DesiredCapacity, MaxSize, * and MinSize). Usually, you set these sizes based on a specific number of instances. However, * if you configure a mixed instances policy that defines weights for the instance types, you must specify * these sizes with the same units that you use for weighting instances. *

*/ public void setWeightedCapacity(String weightedCapacity) { this.weightedCapacity = weightedCapacity; } /** *

* If you specify a value for WeightedCapacity for one instance type, you must specify a value for * WeightedCapacity for all of them. *

* *

* * * @return If you provide a list of instance types to use, you can specify the number of capacity units provided by * each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance * characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the * desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally * fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill * capacity, and Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of * five units, the instance is launched, and the desired capacity is exceeded by three units. For more * information, see Configuring instance weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User * Guide. Value must be in the range of 1–999.

* If you specify a value for WeightedCapacity for one instance type, you must specify a value * for WeightedCapacity for all of them. *

* *

*/ public String getWeightedCapacity() { return this.weightedCapacity; } /** *

* If you specify a value for WeightedCapacity for one instance type, you must specify a value for * WeightedCapacity for all of them. *

* *

* If you specify a value for WeightedCapacity for one instance type, you must specify a value * for WeightedCapacity for all of them. *

* *

* @return Returns a reference to this object so that method calls can be chained together. */ public LaunchTemplateOverrides withWeightedCapacity(String weightedCapacity) { setWeightedCapacity(weightedCapacity); return this; } /** *

* You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides * and in the LaunchTemplate definition count towards this limit. *

* * @param launchTemplateSpecification * Provides a launch template for the specified instance type or set of instance requirements. For example, * some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto * Scaling uses the launch template that's specified in the LaunchTemplate definition. For more * information, see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User * Guide.

* You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the * overrides and in the LaunchTemplate definition count towards this limit. */ public void setLaunchTemplateSpecification(LaunchTemplateSpecification launchTemplateSpecification) { this.launchTemplateSpecification = launchTemplateSpecification; } /** *

* You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides * and in the LaunchTemplate definition count towards this limit. *

* * @return Provides a launch template for the specified instance type or set of instance requirements. For example, * some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 * Auto Scaling uses the launch template that's specified in the LaunchTemplate definition. For * more information, see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User * Guide.

* You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides * and in the LaunchTemplate definition count towards this limit. *

* You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the * overrides and in the LaunchTemplate definition count towards this limit. * @return Returns a reference to this object so that method calls can be chained together. */ public LaunchTemplateOverrides withLaunchTemplateSpecification(LaunchTemplateSpecification launchTemplateSpecification) { setLaunchTemplateSpecification(launchTemplateSpecification); return this; } /** *

* *

* If you specify InstanceRequirements, you can't specify InstanceType. *

* * * @param instanceRequirements * The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance * types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance * types.

* You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful * for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To * do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of * instance requirements for each launch template. *

* *

* If you specify InstanceRequirements, you can't specify InstanceType. *

*/ public void setInstanceRequirements(InstanceRequirements instanceRequirements) { this.instanceRequirements = instanceRequirements; } /** *

* *

* If you specify InstanceRequirements, you can't specify InstanceType. *

* * * @return The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance * types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these * instance types.

* *

* If you specify InstanceRequirements, you can't specify InstanceType. *

*/ public InstanceRequirements getInstanceRequirements() { return this.instanceRequirements; } /** *

* *

* If you specify InstanceRequirements, you can't specify InstanceType. *

* *

* If you specify InstanceRequirements, you can't specify InstanceType. *

* @return Returns a reference to this object so that method calls can be chained together. */ public LaunchTemplateOverrides withInstanceRequirements(InstanceRequirements instanceRequirements) { setInstanceRequirements(instanceRequirements); 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 (getInstanceType() != null) sb.append("InstanceType: ").append(getInstanceType()).append(","); if (getWeightedCapacity() != null) sb.append("WeightedCapacity: ").append(getWeightedCapacity()).append(","); if (getLaunchTemplateSpecification() != null) sb.append("LaunchTemplateSpecification: ").append(getLaunchTemplateSpecification()).append(","); if (getInstanceRequirements() != null) sb.append("InstanceRequirements: ").append(getInstanceRequirements()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof LaunchTemplateOverrides == false) return false; LaunchTemplateOverrides other = (LaunchTemplateOverrides) obj; if (other.getInstanceType() == null ^ this.getInstanceType() == null) return false; if (other.getInstanceType() != null && other.getInstanceType().equals(this.getInstanceType()) == false) return false; if (other.getWeightedCapacity() == null ^ this.getWeightedCapacity() == null) return false; if (other.getWeightedCapacity() != null && other.getWeightedCapacity().equals(this.getWeightedCapacity()) == false) return false; if (other.getLaunchTemplateSpecification() == null ^ this.getLaunchTemplateSpecification() == null) return false; if (other.getLaunchTemplateSpecification() != null && other.getLaunchTemplateSpecification().equals(this.getLaunchTemplateSpecification()) == false) return false; if (other.getInstanceRequirements() == null ^ this.getInstanceRequirements() == null) return false; if (other.getInstanceRequirements() != null && other.getInstanceRequirements().equals(this.getInstanceRequirements()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getInstanceType() == null) ? 0 : getInstanceType().hashCode()); hashCode = prime * hashCode + ((getWeightedCapacity() == null) ? 0 : getWeightedCapacity().hashCode()); hashCode = prime * hashCode + ((getLaunchTemplateSpecification() == null) ? 0 : getLaunchTemplateSpecification().hashCode()); hashCode = prime * hashCode + ((getInstanceRequirements() == null) ? 0 : getInstanceRequirements().hashCode()); return hashCode; } @Override public LaunchTemplateOverrides clone() { try { return (LaunchTemplateOverrides) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }