software.amazon.awscdk.services.autoscaling

Class AutoScalingGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.autoscaling.AutoScalingGroup

All Implemented Interfaces:

IConstruct, IDependable, IResource, IAutoScalingGroup, IConnectable, ILoadBalancerTarget, IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget, IGrantable

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:42.229Z")
public class AutoScalingGroup
extends Resource
implements ILoadBalancerTarget, IConnectable, IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget, IAutoScalingGroup

A Fleet represents a managed set of EC2 instances.

The Fleet models a number of AutoScalingGroups, a launch configuration, a security group and an instance role.

It allows adding arbitrary commands to the startup scripts of the instances in the fleet.

The ASG spans the availability zones specified by vpcSubnets, falling back to the Vpc default strategy if not specified.

Example:

 Vpc vpc;
 SecurityGroup mySecurityGroup = SecurityGroup.Builder.create(this, "SecurityGroup").vpc(vpc).build();
 AutoScalingGroup.Builder.create(this, "ASG")
         .vpc(vpc)
         .instanceType(InstanceType.of(InstanceClass.BURSTABLE2, InstanceSize.MICRO))
         .machineImage(new AmazonLinuxImage())
         .securityGroup(mySecurityGroup)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoScalingGroup.Builder A fluent builder for AutoScalingGroup.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancing.ILoadBalancerTarget

ILoadBalancerTarget.Jsii$Default, ILoadBalancerTarget.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationLoadBalancerTarget

IApplicationLoadBalancerTarget.Jsii$Default, IApplicationLoadBalancerTarget.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.INetworkLoadBalancerTarget

INetworkLoadBalancerTarget.Jsii$Default, INetworkLoadBalancerTarget.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.autoscaling.IAutoScalingGroup

IAutoScalingGroup.Jsii$Default, IAutoScalingGroup.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AutoScalingGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AutoScalingGroup(software.amazon.jsii.JsiiObjectRef objRef)
	AutoScalingGroup(software.constructs.Construct scope, java.lang.String id, AutoScalingGroupProps props)

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	addSecurityGroup(ISecurityGroup securityGroup) Add the security group to all instances via the launch configuration security groups array.
void	addToRolePolicy(PolicyStatement statement) Adds a statement to the IAM role assumed by instances of this fleet.
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.
void	applyCloudFormationInit(CloudFormationInit init) Use a CloudFormation Init configuration at instance startup.
void	applyCloudFormationInit(CloudFormationInit init, ApplyCloudFormationInitOptions options) Use a CloudFormation Init configuration at instance startup.
java.lang.Boolean	areNewInstancesProtectedFromScaleIn() Returns `true` if newly-launched instances are protected from scale-in.
LoadBalancerTargetProps	attachToApplicationTargetGroup(IApplicationTargetGroup targetGroup) Attach to ELBv2 Application Target Group.
void	attachToClassicLB(LoadBalancer loadBalancer) Attach to a classic load balancer.
LoadBalancerTargetProps	attachToNetworkTargetGroup(INetworkTargetGroup targetGroup) Attach to ELBv2 Application Target Group.
static IAutoScalingGroup	fromAutoScalingGroupName(software.constructs.Construct scope, java.lang.String id, java.lang.String autoScalingGroupName)
protected ApplicationTargetGroup	getAlbTargetGroup()
java.lang.String	getAutoScalingGroupArn() Arn of the AutoScalingGroup.
java.lang.String	getAutoScalingGroupName() Name of the AutoScalingGroup.
Connections	getConnections() The network connections associated with this resource.
IPrincipal	getGrantPrincipal() The principal to grant permissions to.
Duration	getMaxInstanceLifetime() The maximum amount of time that an instance can be in service.
protected java.lang.Boolean	getNewInstancesProtectedFromScaleIn()
OperatingSystemType	getOsType() The type of OS instances of this fleet are running.
IRole	getRole() The IAM Role in the instance profile.
java.lang.String	getSpotPrice() The maximum spot price configured for the autoscaling group.
UserData	getUserData() The Base64-encoded user data to make available to the launched EC2 instances.
void	protectNewInstancesFromScaleIn() Ensures newly-launched instances are protected from scale-in.
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.
TargetTrackingScalingPolicy	scaleOnRequestCount(java.lang.String id, RequestCountScalingProps props) Scale out or in to achieve a target request handling 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.
protected void	setAlbTargetGroup(ApplicationTargetGroup value)
protected void	setNewInstancesProtectedFromScaleIn(java.lang.Boolean value)

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

applyRemovalPolicy, getEnv, getStack

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

getNode

Constructor Detail

AutoScalingGroup

protected AutoScalingGroup(software.amazon.jsii.JsiiObjectRef objRef)

AutoScalingGroup

protected AutoScalingGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AutoScalingGroup

public AutoScalingGroup(software.constructs.Construct scope,
                        java.lang.String id,
                        AutoScalingGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromAutoScalingGroupName

public static IAutoScalingGroup fromAutoScalingGroupName(software.constructs.Construct scope,
                                                         java.lang.String id,
                                                         java.lang.String autoScalingGroupName)

Parameters:

scope - This parameter is required.

id - This parameter is required.

autoScalingGroupName - This parameter is required.

addLifecycleHook

public LifecycleHook addLifecycleHook(java.lang.String id,
                                      BasicLifecycleHookProps props)

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

Specified by:

addLifecycleHook in interface IAutoScalingGroup

Parameters:

id - This parameter is required.

props - This parameter is required.

addSecurityGroup

public void addSecurityGroup(ISecurityGroup securityGroup)

Add the security group to all instances via the launch configuration security groups array.

Parameters:

securityGroup - : The security group to add. This parameter is required.

addToRolePolicy

public void addToRolePolicy(PolicyStatement statement)

Adds a statement to the IAM role assumed by instances of this fleet.

Parameters:

statement - This parameter is required.

addUserData

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

Specified by:

addUserData in interface IAutoScalingGroup

Parameters:

commands - This parameter is required.

addWarmPool

public WarmPool addWarmPool(WarmPoolOptions options)

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

Specified by:

addWarmPool in interface IAutoScalingGroup

Parameters:

options -

addWarmPool

public WarmPool addWarmPool()

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

Specified by:

addWarmPool in interface IAutoScalingGroup

applyCloudFormationInit

public void applyCloudFormationInit(CloudFormationInit init,
                                    ApplyCloudFormationInitOptions options)

Use a CloudFormation Init configuration at instance startup.

This does the following:

• Attaches the CloudFormation Init metadata to the AutoScalingGroup resource.
• Add commands to the UserData to run cfn-init and cfn-signal.
• Update the instance's CreationPolicy to wait for cfn-init to finish before reporting success.

Parameters:

init - This parameter is required.

options -

applyCloudFormationInit

public void applyCloudFormationInit(CloudFormationInit init)

Use a CloudFormation Init configuration at instance startup.

This does the following:

• Attaches the CloudFormation Init metadata to the AutoScalingGroup resource.
• Add commands to the UserData to run cfn-init and cfn-signal.
• Update the instance's CreationPolicy to wait for cfn-init to finish before reporting success.

Parameters:

init - This parameter is required.

areNewInstancesProtectedFromScaleIn

public java.lang.Boolean areNewInstancesProtectedFromScaleIn()

Returns `true` if newly-launched instances are protected from scale-in.

attachToApplicationTargetGroup

public LoadBalancerTargetProps attachToApplicationTargetGroup(IApplicationTargetGroup targetGroup)

Attach to ELBv2 Application Target Group.

Specified by:

attachToApplicationTargetGroup in interface IApplicationLoadBalancerTarget

Parameters:

targetGroup - This parameter is required.

attachToClassicLB

public void attachToClassicLB(LoadBalancer loadBalancer)

Attach to a classic load balancer.

Specified by:

attachToClassicLB in interface ILoadBalancerTarget

Parameters:

loadBalancer - This parameter is required.

attachToNetworkTargetGroup

public LoadBalancerTargetProps attachToNetworkTargetGroup(INetworkTargetGroup targetGroup)

Attach to ELBv2 Application Target Group.

Specified by:

attachToNetworkTargetGroup in interface INetworkLoadBalancerTarget

Parameters:

targetGroup - This parameter is required.

protectNewInstancesFromScaleIn

public void protectNewInstancesFromScaleIn()

Ensures newly-launched instances are protected from scale-in.

scaleOnCpuUtilization

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

Scale out or in to achieve a target CPU utilization.

Specified by:

scaleOnCpuUtilization in interface IAutoScalingGroup

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnIncomingBytes

public TargetTrackingScalingPolicy scaleOnIncomingBytes(java.lang.String id,
                                                        NetworkUtilizationScalingProps props)

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

Specified by:

scaleOnIncomingBytes in interface IAutoScalingGroup

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnMetric

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

Scale out or in, in response to a metric.

Specified by:

scaleOnMetric in interface IAutoScalingGroup

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnOutgoingBytes

public TargetTrackingScalingPolicy scaleOnOutgoingBytes(java.lang.String id,
                                                        NetworkUtilizationScalingProps props)

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

Specified by:

scaleOnOutgoingBytes in interface IAutoScalingGroup

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnRequestCount

public TargetTrackingScalingPolicy scaleOnRequestCount(java.lang.String id,
                                                       RequestCountScalingProps props)

Scale out or in to achieve a target request handling rate.

The AutoScalingGroup must have been attached to an Application Load Balancer in order to be able to call this.

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnSchedule

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

Scale out or in based on time.

Specified by:

scaleOnSchedule in interface IAutoScalingGroup

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleToTrackMetric

public TargetTrackingScalingPolicy scaleToTrackMetric(java.lang.String id,
                                                      MetricTargetTrackingProps props)

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

Specified by:

scaleToTrackMetric in interface IAutoScalingGroup

Parameters:

id - This parameter is required.

props - This parameter is required.

getAutoScalingGroupArn

public java.lang.String getAutoScalingGroupArn()

Arn of the AutoScalingGroup.

Specified by:

getAutoScalingGroupArn in interface IAutoScalingGroup

getAutoScalingGroupName

public java.lang.String getAutoScalingGroupName()

Name of the AutoScalingGroup.

Specified by:

getAutoScalingGroupName in interface IAutoScalingGroup

getConnections

public Connections getConnections()

The network connections associated with this resource.

Specified by:

getConnections in interface IConnectable

getGrantPrincipal

public IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

getOsType

public OperatingSystemType getOsType()

The type of OS instances of this fleet are running.

Specified by:

getOsType in interface IAutoScalingGroup

getRole

public IRole getRole()

The IAM Role in the instance profile.

getUserData

public UserData getUserData()

The Base64-encoded user data to make available to the launched EC2 instances.

getMaxInstanceLifetime

public Duration getMaxInstanceLifetime()

The maximum amount of time that an instance can be in service.

getSpotPrice

public java.lang.String getSpotPrice()

The maximum spot price configured for the autoscaling group.

undefined indicates that this group uses on-demand capacity.

getAlbTargetGroup

protected ApplicationTargetGroup getAlbTargetGroup()

setAlbTargetGroup

protected void setAlbTargetGroup(ApplicationTargetGroup value)

getNewInstancesProtectedFromScaleIn

protected java.lang.Boolean getNewInstancesProtectedFromScaleIn()

setNewInstancesProtectedFromScaleIn

protected void setNewInstancesProtectedFromScaleIn(java.lang.Boolean value)