software.amazon.awscdk.services.autoscaling

Interface CfnAutoScalingGroup.LaunchTemplateOverridesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAutoScalingGroup.LaunchTemplateOverridesProperty.Jsii$Proxy

Enclosing class:

CfnAutoScalingGroup

@Stability(value=Stable)
public static interface CfnAutoScalingGroup.LaunchTemplateOverridesProperty
extends software.amazon.jsii.JsiiSerializable

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.

LaunchTemplateOverrides is a property of the AWS::AutoScaling::AutoScalingGroup LaunchTemplate property type.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.autoscaling.*;
 LaunchTemplateOverridesProperty launchTemplateOverridesProperty = LaunchTemplateOverridesProperty.builder()
         .instanceRequirements(InstanceRequirementsProperty.builder()
                 .acceleratorCount(AcceleratorCountRequestProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .acceleratorManufacturers(List.of("acceleratorManufacturers"))
                 .acceleratorNames(List.of("acceleratorNames"))
                 .acceleratorTotalMemoryMiB(AcceleratorTotalMemoryMiBRequestProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .acceleratorTypes(List.of("acceleratorTypes"))
                 .allowedInstanceTypes(List.of("allowedInstanceTypes"))
                 .bareMetal("bareMetal")
                 .baselineEbsBandwidthMbps(BaselineEbsBandwidthMbpsRequestProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .burstablePerformance("burstablePerformance")
                 .cpuManufacturers(List.of("cpuManufacturers"))
                 .excludedInstanceTypes(List.of("excludedInstanceTypes"))
                 .instanceGenerations(List.of("instanceGenerations"))
                 .localStorage("localStorage")
                 .localStorageTypes(List.of("localStorageTypes"))
                 .memoryGiBPerVCpu(MemoryGiBPerVCpuRequestProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .memoryMiB(MemoryMiBRequestProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .networkBandwidthGbps(NetworkBandwidthGbpsRequestProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .networkInterfaceCount(NetworkInterfaceCountRequestProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .onDemandMaxPricePercentageOverLowestPrice(123)
                 .requireHibernateSupport(false)
                 .spotMaxPricePercentageOverLowestPrice(123)
                 .totalLocalStorageGb(TotalLocalStorageGBRequestProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .vCpuCount(VCpuCountRequestProperty.builder()
                         .max(123)
                         .min(123)
                         .build())
                 .build())
         .instanceType("instanceType")
         .launchTemplateSpecification(LaunchTemplateSpecificationProperty.builder()
                 .version("version")
                 // the properties below are optional
                 .launchTemplateId("launchTemplateId")
                 .launchTemplateName("launchTemplateName")
                 .build())
         .weightedCapacity("weightedCapacity")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAutoScalingGroup.LaunchTemplateOverridesProperty.Builder A builder for CfnAutoScalingGroup.LaunchTemplateOverridesProperty
static class	CfnAutoScalingGroup.LaunchTemplateOverridesProperty.Jsii$Proxy An implementation for CfnAutoScalingGroup.LaunchTemplateOverridesProperty

Method Summary

Modifier and Type	Method and Description
static CfnAutoScalingGroup.LaunchTemplateOverridesProperty.Builder	builder()
default Object	getInstanceRequirements() The instance requirements.
default String	getInstanceType() The instance type, such as `m3.xlarge` .
default Object	getLaunchTemplateSpecification() Provides a launch template for the specified instance type or set of instance requirements.
default String	getWeightedCapacity() 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.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getInstanceRequirements

@Stability(value=Stable)
 @Nullable
default Object getInstanceRequirements()

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 .

getInstanceType

@Stability(value=Stable)
 @Nullable
default String getInstanceType()

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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide* .

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

getLaunchTemplateSpecification

@Stability(value=Stable)
 @Nullable
default Object getLaunchTemplateSpecification()

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.

getWeightedCapacity

@Stability(value=Stable)
 @Nullable
default String getWeightedCapacity()

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

builder

@Stability(value=Stable)
static CfnAutoScalingGroup.LaunchTemplateOverridesProperty.Builder builder()

Returns:

a CfnAutoScalingGroup.LaunchTemplateOverridesProperty.Builder of CfnAutoScalingGroup.LaunchTemplateOverridesProperty