software.amazon.awssdk.services.autoscaling.model

Interface LaunchTemplateOverrides.Builder

All Superinterfaces:

Buildable, CopyableBuilder<LaunchTemplateOverrides.Builder,LaunchTemplateOverrides>, SdkBuilder<LaunchTemplateOverrides.Builder,LaunchTemplateOverrides>, SdkPojo

Enclosing class:

LaunchTemplateOverrides

public static interface LaunchTemplateOverrides.Builder
extends SdkPojo, CopyableBuilder<LaunchTemplateOverrides.Builder,LaunchTemplateOverrides>

Method Summary

Modifier and Type	Method and Description
default LaunchTemplateOverrides.Builder	instanceRequirements(Consumer<InstanceRequirements.Builder> instanceRequirements) The instance requirements.
LaunchTemplateOverrides.Builder	instanceRequirements(InstanceRequirements instanceRequirements) The instance requirements.
LaunchTemplateOverrides.Builder	instanceType(String instanceType) The instance type, such as m3.xlarge.
default LaunchTemplateOverrides.Builder	launchTemplateSpecification(Consumer<LaunchTemplateSpecification.Builder> launchTemplateSpecification) Provides a launch template for the specified instance type or set of instance requirements.
LaunchTemplateOverrides.Builder	launchTemplateSpecification(LaunchTemplateSpecification launchTemplateSpecification) Provides a launch template for the specified instance type or set of instance requirements.
LaunchTemplateOverrides.Builder	weightedCapacity(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 interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

instanceType

LaunchTemplateOverrides.Builder instanceType(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

weightedCapacity

LaunchTemplateOverrides.Builder weightedCapacity(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 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

launchTemplateSpecification

LaunchTemplateOverrides.Builder launchTemplateSpecification(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

launchTemplateSpecification

default LaunchTemplateOverrides.Builder launchTemplateSpecification(Consumer<LaunchTemplateSpecification.Builder> 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.

This is a convenience method that creates an instance of the LaunchTemplateSpecification.Builder avoiding the need to create one manually via LaunchTemplateSpecification.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to launchTemplateSpecification(LaunchTemplateSpecification).

Parameters:

launchTemplateSpecification - a consumer that will call methods on LaunchTemplateSpecification.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

launchTemplateSpecification(LaunchTemplateSpecification)

instanceRequirements

LaunchTemplateOverrides.Builder instanceRequirements(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 specify InstanceType.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceRequirements

default LaunchTemplateOverrides.Builder instanceRequirements(Consumer<InstanceRequirements.Builder> 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.

This is a convenience method that creates an instance of the InstanceRequirements.Builder avoiding the need to create one manually via InstanceRequirements.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceRequirements(InstanceRequirements).

Parameters:

instanceRequirements - a consumer that will call methods on InstanceRequirements.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

instanceRequirements(InstanceRequirements)