software.amazon.awscdk.services.autoscaling

Class IAutoScalingGroup.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.autoscaling.IAutoScalingGroup.Jsii$Proxy

All Implemented Interfaces:

IResource, IResource.Jsii$Default, IAutoScalingGroup, IAutoScalingGroup.Jsii$Default, IGrantable, IGrantable.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default

Enclosing interface:

IAutoScalingGroup

@Internal
public static final class IAutoScalingGroup.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IAutoScalingGroup.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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.autoscaling.IAutoScalingGroup

IAutoScalingGroup.Jsii$Default, IAutoScalingGroup.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and 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(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	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
String	getAutoScalingGroupArn() The arn of the AutoScalingGroup.
String	getAutoScalingGroupName() The name of the AutoScalingGroup.
ResourceEnvironment	getEnv() The environment this resource belongs to.
IPrincipal	getGrantPrincipal() The principal to grant permissions to.
software.constructs.Node	getNode() The tree node.
OperatingSystemType	getOsType() The operating system family that the instances in this auto-scaling group belong to.
Stack	getStack() The stack in which this resource is defined.
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 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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
public final software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IAutoScalingGroup.Jsii$Default

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
public final ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IAutoScalingGroup.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IAutoScalingGroup.Jsii$Default

getGrantPrincipal

@Stability(value=Stable)
 @NotNull
public final IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IAutoScalingGroup.Jsii$Default

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

getAutoScalingGroupArn

@Stability(value=Stable)
 @NotNull
public final String getAutoScalingGroupArn()

The arn of the AutoScalingGroup.

Specified by:

getAutoScalingGroupArn in interface IAutoScalingGroup

Specified by:

getAutoScalingGroupArn in interface IAutoScalingGroup.Jsii$Default

getAutoScalingGroupName

@Stability(value=Stable)
 @NotNull
public final String getAutoScalingGroupName()

The name of the AutoScalingGroup.

Specified by:

getAutoScalingGroupName in interface IAutoScalingGroup

Specified by:

getAutoScalingGroupName in interface IAutoScalingGroup.Jsii$Default

getOsType

@Stability(value=Stable)
 @NotNull
public final OperatingSystemType getOsType()

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

Is 'UNKNOWN' for imported ASGs.

Specified by:

getOsType in interface IAutoScalingGroup

Specified by:

getOsType in interface IAutoScalingGroup.Jsii$Default

applyRemovalPolicy

@Stability(value=Stable)
public final void applyRemovalPolicy(@NotNull
                                                              RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface IAutoScalingGroup.Jsii$Default

Parameters:

policy - This parameter is required.

addLifecycleHook

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

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

Specified by:

addLifecycleHook in interface IAutoScalingGroup

Specified by:

addLifecycleHook in interface IAutoScalingGroup.Jsii$Default

Parameters:

id - This parameter is required.

props - This parameter is required.

addUserData

@Stability(value=Stable)
public final void addUserData(@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.

Specified by:

addUserData in interface IAutoScalingGroup

Specified by:

addUserData in interface IAutoScalingGroup.Jsii$Default

Parameters:

commands - This parameter is required.

addWarmPool

@Stability(value=Stable)
 @NotNull
public final WarmPool addWarmPool(@Nullable
                                                                     WarmPoolOptions options)

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

Specified by:

addWarmPool in interface IAutoScalingGroup

Specified by:

addWarmPool in interface IAutoScalingGroup.Jsii$Default

Parameters:

options -

addWarmPool

@Stability(value=Stable)
 @NotNull
public final WarmPool addWarmPool()

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

Specified by:

addWarmPool in interface IAutoScalingGroup

scaleOnCpuUtilization

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

Scale out or in to achieve a target CPU utilization.

Specified by:

scaleOnCpuUtilization in interface IAutoScalingGroup

Specified by:

scaleOnCpuUtilization in interface IAutoScalingGroup.Jsii$Default

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnIncomingBytes

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

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

Specified by:

scaleOnIncomingBytes in interface IAutoScalingGroup

Specified by:

scaleOnIncomingBytes in interface IAutoScalingGroup.Jsii$Default

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnMetric

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

Scale out or in, in response to a metric.

Specified by:

scaleOnMetric in interface IAutoScalingGroup

Specified by:

scaleOnMetric in interface IAutoScalingGroup.Jsii$Default

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnOutgoingBytes

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

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

Specified by:

scaleOnOutgoingBytes in interface IAutoScalingGroup

Specified by:

scaleOnOutgoingBytes in interface IAutoScalingGroup.Jsii$Default

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleOnSchedule

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

Scale out or in based on time.

Specified by:

scaleOnSchedule in interface IAutoScalingGroup

Specified by:

scaleOnSchedule in interface IAutoScalingGroup.Jsii$Default

Parameters:

id - This parameter is required.

props - This parameter is required.

scaleToTrackMetric

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

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

Specified by:

scaleToTrackMetric in interface IAutoScalingGroup

Specified by:

scaleToTrackMetric in interface IAutoScalingGroup.Jsii$Default

Parameters:

id - This parameter is required.

props - This parameter is required.