software.amazon.awscdk.services.autoscaling

Class AutoScalingGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.autoscaling.AutoScalingGroup

All Implemented Interfaces:

IResource, IAutoScalingGroup, IConnectable, ILoadBalancerTarget, IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget, IGrantable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:01.091Z")
 @Stability(value=Experimental)
public class AutoScalingGroup
extends Resource
implements ILoadBalancerTarget, IConnectable, IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget, IAutoScalingGroup

(experimental) 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.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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
	AutoScalingGroup(software.constructs.Construct scope, String id, AutoScalingGroupProps props)
protected	AutoScalingGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AutoScalingGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
LifecycleHook	addLifecycleHook(String id, BasicLifecycleHookProps props) (experimental) Send a message to either an SQS queue or SNS topic when instances launch or terminate.
void	addSecurityGroup(ISecurityGroup securityGroup) (experimental) Add the security group to all instances via the launch configuration security groups array.
void	addToRolePolicy(PolicyStatement statement) (experimental) Adds a statement to the IAM role assumed by instances of this fleet.
void	addUserData(String... commands) (experimental) Add command to the startup script of fleet instances.
void	applyCloudFormationInit(CloudFormationInit init) (experimental) Use a CloudFormation Init configuration at instance startup.
void	applyCloudFormationInit(CloudFormationInit init, ApplyCloudFormationInitOptions options) (experimental) Use a CloudFormation Init configuration at instance startup.
Boolean	areNewInstancesProtectedFromScaleIn() (experimental) Returns `true` if newly-launched instances are protected from scale-in.
LoadBalancerTargetProps	attachToApplicationTargetGroup(IApplicationTargetGroup targetGroup) (experimental) Attach to ELBv2 Application Target Group.
void	attachToClassicLB(LoadBalancer loadBalancer) (experimental) Attach to a classic load balancer.
LoadBalancerTargetProps	attachToNetworkTargetGroup(INetworkTargetGroup targetGroup) (experimental) Attach to ELBv2 Application Target Group.
static IAutoScalingGroup	fromAutoScalingGroupName(software.constructs.Construct scope, String id, String autoScalingGroupName)
protected ApplicationTargetGroup	getAlbTargetGroup()
String	getAutoScalingGroupArn() (experimental) Arn of the AutoScalingGroup.
String	getAutoScalingGroupName() (experimental) Name of the AutoScalingGroup.
Connections	getConnections() (experimental) Allows specify security group connections for instances of this fleet.
IPrincipal	getGrantPrincipal() (experimental) The principal to grant permissions to.
Duration	getMaxInstanceLifetime() (experimental) The maximum amount of time that an instance can be in service.
protected Boolean	getNewInstancesProtectedFromScaleIn()
OperatingSystemType	getOsType() (experimental) The type of OS instances of this fleet are running.
IRole	getRole() (experimental) The IAM role assumed by instances of this fleet.
String	getSpotPrice() (experimental) The maximum spot price configured for the autoscaling group.
UserData	getUserData() (experimental) UserData for the instances.
void	protectNewInstancesFromScaleIn() (experimental) Ensures newly-launched instances are protected from scale-in.
TargetTrackingScalingPolicy	scaleOnCpuUtilization(String id, CpuUtilizationScalingProps props) (experimental) Scale out or in to achieve a target CPU utilization.
TargetTrackingScalingPolicy	scaleOnIncomingBytes(String id, NetworkUtilizationScalingProps props) (experimental) Scale out or in to achieve a target network ingress rate.
StepScalingPolicy	scaleOnMetric(String id, BasicStepScalingPolicyProps props) (experimental) Scale out or in, in response to a metric.
TargetTrackingScalingPolicy	scaleOnOutgoingBytes(String id, NetworkUtilizationScalingProps props) (experimental) Scale out or in to achieve a target network egress rate.
TargetTrackingScalingPolicy	scaleOnRequestCount(String id, RequestCountScalingProps props) (experimental) Scale out or in to achieve a target request handling rate.
ScheduledAction	scaleOnSchedule(String id, BasicScheduledActionProps props) (experimental) Scale out or in based on time.
TargetTrackingScalingPolicy	scaleToTrackMetric(String id, MetricTargetTrackingProps props) (experimental) Scale out or in in order to keep a metric around a target value.
protected void	setAlbTargetGroup(ApplicationTargetGroup value)
protected void	setNewInstancesProtectedFromScaleIn(Boolean value)

Methods inherited from class software.amazon.awscdk.Resource

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

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.IResource

getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

AutoScalingGroup

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

AutoScalingGroup

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

AutoScalingGroup

@Stability(value=Experimental)
public AutoScalingGroup(@NotNull
                                                       software.constructs.Construct scope,
                                                       @NotNull
                                                       String id,
                                                       @NotNull
                                                       AutoScalingGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromAutoScalingGroupName

@Stability(value=Experimental)
 @NotNull
public static IAutoScalingGroup fromAutoScalingGroupName(@NotNull
                                                                                                  software.constructs.Construct scope,
                                                                                                  @NotNull
                                                                                                  String id,
                                                                                                  @NotNull
                                                                                                  String autoScalingGroupName)

Parameters:

scope - This parameter is required.

id - This parameter is required.

autoScalingGroupName - This parameter is required.

addLifecycleHook

@Stability(value=Experimental)
 @NotNull
public LifecycleHook addLifecycleHook(@NotNull
                                                                               String id,
                                                                               @NotNull
                                                                               BasicLifecycleHookProps props)

(experimental) 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

@Stability(value=Experimental)
public void addSecurityGroup(@NotNull
                                                            ISecurityGroup securityGroup)

(experimental) 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

@Stability(value=Experimental)
public void addToRolePolicy(@NotNull
                                                           PolicyStatement statement)

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

Parameters:

statement - This parameter is required.

addUserData

@Stability(value=Experimental)
public void addUserData(@NotNull
                                                       String... commands)

(experimental) 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.

applyCloudFormationInit

@Stability(value=Experimental)
public void applyCloudFormationInit(@NotNull
                                                                   CloudFormationInit init,
                                                                   @Nullable
                                                                   ApplyCloudFormationInitOptions options)

(experimental) 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

@Stability(value=Experimental)
public void applyCloudFormationInit(@NotNull
                                                                   CloudFormationInit init)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Boolean areNewInstancesProtectedFromScaleIn()

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

attachToApplicationTargetGroup

@Stability(value=Experimental)
 @NotNull
public LoadBalancerTargetProps attachToApplicationTargetGroup(@NotNull
                                                                                                       IApplicationTargetGroup targetGroup)

(experimental) Attach to ELBv2 Application Target Group.

Specified by:

attachToApplicationTargetGroup in interface IApplicationLoadBalancerTarget

Parameters:

targetGroup - This parameter is required.

attachToClassicLB

@Stability(value=Experimental)
public void attachToClassicLB(@NotNull
                                                             LoadBalancer loadBalancer)

(experimental) Attach to a classic load balancer.

Specified by:

attachToClassicLB in interface ILoadBalancerTarget

Parameters:

loadBalancer - This parameter is required.

attachToNetworkTargetGroup

@Stability(value=Experimental)
 @NotNull
public LoadBalancerTargetProps attachToNetworkTargetGroup(@NotNull
                                                                                                   INetworkTargetGroup targetGroup)

(experimental) Attach to ELBv2 Application Target Group.

Specified by:

attachToNetworkTargetGroup in interface INetworkLoadBalancerTarget

Parameters:

targetGroup - This parameter is required.

protectNewInstancesFromScaleIn

@Stability(value=Experimental)
public void protectNewInstancesFromScaleIn()

(experimental) Ensures newly-launched instances are protected from scale-in.

scaleOnCpuUtilization

@Stability(value=Experimental)
 @NotNull
public TargetTrackingScalingPolicy scaleOnCpuUtilization(@NotNull
                                                                                                  String id,
                                                                                                  @NotNull
                                                                                                  CpuUtilizationScalingProps props)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public TargetTrackingScalingPolicy scaleOnIncomingBytes(@NotNull
                                                                                                 String id,
                                                                                                 @NotNull
                                                                                                 NetworkUtilizationScalingProps props)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public StepScalingPolicy scaleOnMetric(@NotNull
                                                                                String id,
                                                                                @NotNull
                                                                                BasicStepScalingPolicyProps props)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public TargetTrackingScalingPolicy scaleOnOutgoingBytes(@NotNull
                                                                                                 String id,
                                                                                                 @NotNull
                                                                                                 NetworkUtilizationScalingProps props)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public TargetTrackingScalingPolicy scaleOnRequestCount(@NotNull
                                                                                                String id,
                                                                                                @NotNull
                                                                                                RequestCountScalingProps props)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public ScheduledAction scaleOnSchedule(@NotNull
                                                                                String id,
                                                                                @NotNull
                                                                                BasicScheduledActionProps props)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public TargetTrackingScalingPolicy scaleToTrackMetric(@NotNull
                                                                                               String id,
                                                                                               @NotNull
                                                                                               MetricTargetTrackingProps props)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public String getAutoScalingGroupArn()

(experimental) Arn of the AutoScalingGroup.

Specified by:

getAutoScalingGroupArn in interface IAutoScalingGroup

getAutoScalingGroupName

@Stability(value=Experimental)
 @NotNull
public String getAutoScalingGroupName()

(experimental) Name of the AutoScalingGroup.

Specified by:

getAutoScalingGroupName in interface IAutoScalingGroup

getConnections

@Stability(value=Experimental)
 @NotNull
public Connections getConnections()

(experimental) Allows specify security group connections for instances of this fleet.

Specified by:

getConnections in interface IConnectable

getGrantPrincipal

@Stability(value=Experimental)
 @NotNull
public IPrincipal getGrantPrincipal()

(experimental) The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

getOsType

@Stability(value=Experimental)
 @NotNull
public OperatingSystemType getOsType()

(experimental) The type of OS instances of this fleet are running.

Specified by:

getOsType in interface IAutoScalingGroup

getRole

@Stability(value=Experimental)
 @NotNull
public IRole getRole()

(experimental) The IAM role assumed by instances of this fleet.

getUserData

@Stability(value=Experimental)
 @NotNull
public UserData getUserData()

(experimental) UserData for the instances.

getMaxInstanceLifetime

@Stability(value=Experimental)
 @Nullable
public Duration getMaxInstanceLifetime()

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

getSpotPrice

@Stability(value=Experimental)
 @Nullable
public String getSpotPrice()

(experimental) The maximum spot price configured for the autoscaling group.

undefined indicates that this group uses on-demand capacity.

getAlbTargetGroup

@Stability(value=Experimental)
 @Nullable
protected ApplicationTargetGroup getAlbTargetGroup()

setAlbTargetGroup

@Stability(value=Experimental)
protected void setAlbTargetGroup(@Nullable
                                                                ApplicationTargetGroup value)

getNewInstancesProtectedFromScaleIn

@Stability(value=Experimental)
 @Nullable
protected Boolean getNewInstancesProtectedFromScaleIn()

setNewInstancesProtectedFromScaleIn

@Stability(value=Experimental)
protected void setNewInstancesProtectedFromScaleIn(@Nullable
                                                                                  Boolean value)