Package software.amazon.awscdk.services.autoscaling

Interface IAutoScalingGroup

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IGrantable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IAutoScalingGroup.Jsii$Default

All Known Implementing Classes:

AutoScalingGroup, IAutoScalingGroup.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:57.421Z")
@Stability(Stable)
public interface IAutoScalingGroup
extends software.amazon.jsii.JsiiSerializable, IResource, IGrantable

An AutoScalingGroup.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IAutoScalingGroup.Jsii$Default	Internal default implementation for IAutoScalingGroup.
static final class	IAutoScalingGroup.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
LifecycleHook	addLifecycleHook(String id, BasicLifecycleHookProps props)	Send a message to either an SQS queue or SNS topic when instances launch or terminate.
void	addUserData(@NotNull String... commands)	Add command to the startup script of fleet instances.
WarmPool	addWarmPool()	Add a pool of pre-initialized EC2 instances that sits alongside an Auto Scaling group.
WarmPool	addWarmPool(WarmPoolOptions options)	Add a pool of pre-initialized EC2 instances that sits alongside an Auto Scaling group.
String	getAutoScalingGroupArn()	The arn of the AutoScalingGroup.
String	getAutoScalingGroupName()	The name of the AutoScalingGroup.
OperatingSystemType	getOsType()	The operating system family that the instances in this auto-scaling group belong to.
TargetTrackingScalingPolicy	scaleOnCpuUtilization(String id, CpuUtilizationScalingProps props)	Scale out or in to achieve a target CPU utilization.
TargetTrackingScalingPolicy	scaleOnIncomingBytes(String id, NetworkUtilizationScalingProps props)	Scale out or in to achieve a target network ingress rate.
StepScalingPolicy	scaleOnMetric(String id, BasicStepScalingPolicyProps props)	Scale out or in, in response to a metric.
TargetTrackingScalingPolicy	scaleOnOutgoingBytes(String id, NetworkUtilizationScalingProps props)	Scale out or in to achieve a target network egress rate.
ScheduledAction	scaleOnSchedule(String id, BasicScheduledActionProps props)	Scale out or in based on time.
TargetTrackingScalingPolicy	scaleToTrackMetric(String id, MetricTargetTrackingProps props)	Scale out or in in order to keep a metric around a target value.

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.services.iam.IGrantable

getGrantPrincipal

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutoScalingGroupArn

@Stability(Stable)
@NotNull
String getAutoScalingGroupArn()

The arn of the AutoScalingGroup.

getAutoScalingGroupName

@Stability(Stable)
@NotNull
String getAutoScalingGroupName()

The name of the AutoScalingGroup.

getOsType

@Stability(Stable)
@NotNull
OperatingSystemType getOsType()

The operating system family that the instances in this auto-scaling group belong to.

Is 'UNKNOWN' for imported ASGs.

addLifecycleHook

@Stability(Stable)
@NotNull
LifecycleHook addLifecycleHook(@NotNull
 String id,
 @NotNull
 BasicLifecycleHookProps props)

Send a message to either an SQS queue or SNS topic when instances launch or terminate.

Parameters:

id - This parameter is required.

props - This parameter is required.

addUserData

@Stability(Stable)
void addUserData(@NotNull
 @NotNull String... commands)

Add command to the startup script of fleet instances.

The command must be in the scripting language supported by the fleet's OS (i.e. Linux/Windows). Does nothing for imported ASGs.

Parameters:

commands - This parameter is required.

addWarmPool

@Stability(Stable)
@NotNull
WarmPool addWarmPool(@Nullable
 WarmPoolOptions options)

Add a pool of pre-initialized EC2 instances that sits alongside an Auto Scaling group.

Parameters:

options -

addWarmPool

@Stability(Stable)
@NotNull
WarmPool addWarmPool()

Add a pool of pre-initialized EC2 instances that sits alongside an Auto Scaling group.

scaleOnCpuUtilization

@Stability(Stable)
@NotNull
TargetTrackingScalingPolicy scaleOnCpuUtilization(@NotNull
 String id,
 @NotNull
 CpuUtilizationScalingProps props)

Scale out or in to achieve a target CPU utilization.

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnIncomingBytes

@Stability(Stable)
@NotNull
TargetTrackingScalingPolicy scaleOnIncomingBytes(@NotNull
 String id,
 @NotNull
 NetworkUtilizationScalingProps props)

Scale out or in to achieve a target network ingress rate.

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnMetric

@Stability(Stable)
@NotNull
StepScalingPolicy scaleOnMetric(@NotNull
 String id,
 @NotNull
 BasicStepScalingPolicyProps props)

Scale out or in, in response to a metric.

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnOutgoingBytes

@Stability(Stable)
@NotNull
TargetTrackingScalingPolicy scaleOnOutgoingBytes(@NotNull
 String id,
 @NotNull
 NetworkUtilizationScalingProps props)

Scale out or in to achieve a target network egress rate.

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnSchedule

@Stability(Stable)
@NotNull
ScheduledAction scaleOnSchedule(@NotNull
 String id,
 @NotNull
 BasicScheduledActionProps props)

Scale out or in based on time.

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleToTrackMetric

@Stability(Stable)
@NotNull
TargetTrackingScalingPolicy scaleToTrackMetric(@NotNull
 String id,
 @NotNull
 MetricTargetTrackingProps props)

Scale out or in in order to keep a metric around a target value.

Parameters:

id - This parameter is required.

props - This parameter is required.