Package software.amazon.awscdk.services.autoscaling

Interface LaunchTemplateOverrides

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LaunchTemplateOverrides.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:45.376Z")
@Stability(Stable)
public interface LaunchTemplateOverrides
extends software.amazon.jsii.JsiiSerializable

LaunchTemplateOverrides is a subproperty of LaunchTemplate that describes an override for a launch template.

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.*;
 import software.amazon.awscdk.services.ec2.*;
 InstanceType instanceType;
 LaunchTemplate launchTemplate;
 LaunchTemplateOverrides launchTemplateOverrides = LaunchTemplateOverrides.builder()
         .instanceType(instanceType)
         // the properties below are optional
         .launchTemplate(launchTemplate)
         .weightedCapacity(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static LaunchTemplateOverrides.Builder	builder()
InstanceType	getInstanceType()	The instance type, such as m3.xlarge.
default ILaunchTemplate	getLaunchTemplate()	Provides the launch template to be used when launching the instance type.
default Number	getWeightedCapacity()	The number of capacity units provided by the specified 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 Details

getInstanceType

@Stability(Stable)
@NotNull
InstanceType getInstanceType()

The instance type, such as m3.xlarge. You must use an instance type that is supported in your requested Region and Availability Zones.

Default: - Do not override instance type

getLaunchTemplate

@Stability(Stable)
@Nullable
default ILaunchTemplate getLaunchTemplate()

Provides the launch template to be used when launching the instance type.

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 defined for your mixed instances policy.

Default: - Do not override launch template

getWeightedCapacity

@Stability(Stable)
@Nullable
default Number getWeightedCapacity()

The number of capacity units provided by the specified instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic.

When a Spot or On-Demand Instance is provisioned, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling provisions instances until the desired capacity is totally fulfilled, even if this results in an overage. Value must be in the range of 1 to 999.

For example, If there are 2 units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the desired capacity is exceeded by 3 units.

Default: - Do not provide weight

See Also:

• https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html

builder

@Stability(Stable)
static LaunchTemplateOverrides.Builder builder()

Returns:

a LaunchTemplateOverrides.Builder of LaunchTemplateOverrides