software.amazon.awscdk.services.autoscaling

Interface IAutoScalingGroup

All Superinterfaces:

IConstruct, IDependable, IGrantable, IResource

All Known Subinterfaces:

IAutoScalingGroup.Jsii$Default

All Known Implementing Classes:

AutoScalingGroup, IAutoScalingGroup.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:14.396Z")
public interface IAutoScalingGroup
extends IResource, IGrantable

An AutoScalingGroup.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
LifecycleHook	addLifecycleHook(java.lang.String id, BasicLifecycleHookProps props) Send a message to either an SQS queue or SNS topic when instances launch or terminate.
void	addUserData(java.lang.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.
java.lang.String	getAutoScalingGroupArn() The arn of the AutoScalingGroup.
java.lang.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(java.lang.String id, CpuUtilizationScalingProps props) Scale out or in to achieve a target CPU utilization.
TargetTrackingScalingPolicy	scaleOnIncomingBytes(java.lang.String id, NetworkUtilizationScalingProps props) Scale out or in to achieve a target network ingress rate.
StepScalingPolicy	scaleOnMetric(java.lang.String id, BasicStepScalingPolicyProps props) Scale out or in, in response to a metric.
TargetTrackingScalingPolicy	scaleOnOutgoingBytes(java.lang.String id, NetworkUtilizationScalingProps props) Scale out or in to achieve a target network egress rate.
ScheduledAction	scaleOnSchedule(java.lang.String id, BasicScheduledActionProps props) Scale out or in based on time.
TargetTrackingScalingPolicy	scaleToTrackMetric(java.lang.String id, MetricTargetTrackingProps props) Scale out or in in order to keep a metric around a target value.

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

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

getGrantPrincipal

Method Detail

getAutoScalingGroupArn

java.lang.String getAutoScalingGroupArn()

The arn of the AutoScalingGroup.

getAutoScalingGroupName

java.lang.String getAutoScalingGroupName()

The name of the AutoScalingGroup.

getOsType

OperatingSystemType getOsType()

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

Is 'UNKNOWN' for imported ASGs.

addLifecycleHook

LifecycleHook addLifecycleHook(java.lang.String id,
                               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

void addUserData(java.lang.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

WarmPool addWarmPool(WarmPoolOptions options)

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

Parameters:

options -

addWarmPool

WarmPool addWarmPool()

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

scaleOnCpuUtilization

TargetTrackingScalingPolicy scaleOnCpuUtilization(java.lang.String id,
                                                  CpuUtilizationScalingProps props)

Scale out or in to achieve a target CPU utilization.

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnIncomingBytes

TargetTrackingScalingPolicy scaleOnIncomingBytes(java.lang.String id,
                                                 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

StepScalingPolicy scaleOnMetric(java.lang.String id,
                                BasicStepScalingPolicyProps props)

Scale out or in, in response to a metric.

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnOutgoingBytes

TargetTrackingScalingPolicy scaleOnOutgoingBytes(java.lang.String id,
                                                 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

ScheduledAction scaleOnSchedule(java.lang.String id,
                                BasicScheduledActionProps props)

Scale out or in based on time.

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleToTrackMetric

TargetTrackingScalingPolicy scaleToTrackMetric(java.lang.String id,
                                               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.