Class LaunchTemplateOverrides
- java.lang.Object
-
- software.amazon.awssdk.services.autoscaling.model.LaunchTemplateOverrides
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LaunchTemplateOverrides.Builder,LaunchTemplateOverrides>
@Generated("software.amazon.awssdk:codegen") public final class LaunchTemplateOverrides extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LaunchTemplateOverrides.Builder,LaunchTemplateOverrides>
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 Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
LaunchTemplateOverrides.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static LaunchTemplateOverrides.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
InstanceRequirements
instanceRequirements()
The instance requirements.String
instanceType()
The instance type, such asm3.xlarge
.LaunchTemplateSpecification
launchTemplateSpecification()
Provides a launch template for the specified instance type or set of instance requirements.List<SdkField<?>>
sdkFields()
static Class<? extends LaunchTemplateOverrides.Builder>
serializableBuilderClass()
LaunchTemplateOverrides.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
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.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
instanceType
public final String 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.
- Returns:
- 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.
-
weightedCapacity
public final String 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 forWeightedCapacity
for all of them.Every Auto Scaling group has three size parameters (
DesiredCapacity
,MaxSize
, andMinSize
). 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.- Returns:
- 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 forWeightedCapacity
for all of them.Every Auto Scaling group has three size parameters (
DesiredCapacity
,MaxSize
, andMinSize
). 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.
-
launchTemplateSpecification
public final LaunchTemplateSpecification 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.- Returns:
- 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.
-
instanceRequirements
public final InstanceRequirements 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 specifyInstanceType
.- Returns:
- 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 specifyInstanceType
.
-
toBuilder
public LaunchTemplateOverrides.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<LaunchTemplateOverrides.Builder,LaunchTemplateOverrides>
-
builder
public static LaunchTemplateOverrides.Builder builder()
-
serializableBuilderClass
public static Class<? extends LaunchTemplateOverrides.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-