Interface IAutoScalingGroup.Jsii$Default
- All Superinterfaces:
IAutoScalingGroup
,IConstruct
,software.constructs.IConstruct
,IConstruct.Jsii$Default
,software.constructs.IConstruct.Jsii$Default
,IDependable
,IDependable.Jsii$Default
,IGrantable
,IGrantable.Jsii$Default
,IResource
,IResource.Jsii$Default
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
IAutoScalingGroup.Jsii$Proxy
- Enclosing interface:
- IAutoScalingGroup
IAutoScalingGroup
.-
Nested Class Summary
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.autoscaling.IAutoScalingGroup
IAutoScalingGroup.Jsii$Default, IAutoScalingGroup.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default, IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable
IDependable.Jsii$Default, IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable
IGrantable.Jsii$Default, IGrantable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
-
Method Summary
Modifier and TypeMethodDescriptiondefault LifecycleHook
addLifecycleHook
(String id, BasicLifecycleHookProps props) Send a message to either an SQS queue or SNS topic when instances launch or terminate.default void
addUserData
(@NotNull String... commands) Add command to the startup script of fleet instances.default WarmPool
addWarmPool
(WarmPoolOptions options) Add a pool of pre-initialized EC2 instances that sits alongside an Auto Scaling group.default void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.default String
The arn of the AutoScalingGroup.default String
The name of the AutoScalingGroup.default ResourceEnvironment
getEnv()
The environment this resource belongs to.default IPrincipal
The principal to grant permissions to.default ConstructNode
getNode()
The construct tree node for this construct.default OperatingSystemType
The operating system family that the instances in this auto-scaling group belong to.default Stack
getStack()
The stack in which this resource is defined.default TargetTrackingScalingPolicy
Scale out or in to achieve a target CPU utilization.default TargetTrackingScalingPolicy
Scale out or in to achieve a target network ingress rate.default StepScalingPolicy
scaleOnMetric
(String id, BasicStepScalingPolicyProps props) Scale out or in, in response to a metric.default TargetTrackingScalingPolicy
Scale out or in to achieve a target network egress rate.default ScheduledAction
scaleOnSchedule
(String id, BasicScheduledActionProps props) Scale out or in based on time.default 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.amazon.awscdk.services.autoscaling.IAutoScalingGroup
addWarmPool
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getNode
The construct tree node for this construct.- Specified by:
getNode
in interfaceIConstruct
- Specified by:
getNode
in interfaceIConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
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 interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getGrantPrincipal
The principal to grant permissions to.- Specified by:
getGrantPrincipal
in interfaceIGrantable
- Specified by:
getGrantPrincipal
in interfaceIGrantable.Jsii$Default
-
getAutoScalingGroupArn
The arn of the AutoScalingGroup.- Specified by:
getAutoScalingGroupArn
in interfaceIAutoScalingGroup
-
getAutoScalingGroupName
The name of the AutoScalingGroup.- Specified by:
getAutoScalingGroupName
in interfaceIAutoScalingGroup
-
getOsType
The operating system family that the instances in this auto-scaling group belong to.Is 'UNKNOWN' for imported ASGs.
- Specified by:
getOsType
in interfaceIAutoScalingGroup
-
applyRemovalPolicy
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 interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
addLifecycleHook
@Stability(Stable) @NotNull default 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 interfaceIAutoScalingGroup
- Parameters:
id
- This parameter is required.props
- This parameter is required.
-
addUserData
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 interfaceIAutoScalingGroup
- Parameters:
commands
- This parameter is required.
-
addWarmPool
Add a pool of pre-initialized EC2 instances that sits alongside an Auto Scaling group.- Specified by:
addWarmPool
in interfaceIAutoScalingGroup
- Parameters:
options
-
-
scaleOnCpuUtilization
@Stability(Stable) @NotNull default TargetTrackingScalingPolicy scaleOnCpuUtilization(@NotNull String id, @NotNull CpuUtilizationScalingProps props) Scale out or in to achieve a target CPU utilization.- Specified by:
scaleOnCpuUtilization
in interfaceIAutoScalingGroup
- Parameters:
id
- This parameter is required.props
- This parameter is required.
-
scaleOnIncomingBytes
@Stability(Stable) @NotNull default TargetTrackingScalingPolicy scaleOnIncomingBytes(@NotNull String id, @NotNull NetworkUtilizationScalingProps props) Scale out or in to achieve a target network ingress rate.- Specified by:
scaleOnIncomingBytes
in interfaceIAutoScalingGroup
- Parameters:
id
- This parameter is required.props
- This parameter is required.
-
scaleOnMetric
@Stability(Stable) @NotNull default StepScalingPolicy scaleOnMetric(@NotNull String id, @NotNull BasicStepScalingPolicyProps props) Scale out or in, in response to a metric.- Specified by:
scaleOnMetric
in interfaceIAutoScalingGroup
- Parameters:
id
- This parameter is required.props
- This parameter is required.
-
scaleOnOutgoingBytes
@Stability(Stable) @NotNull default TargetTrackingScalingPolicy scaleOnOutgoingBytes(@NotNull String id, @NotNull NetworkUtilizationScalingProps props) Scale out or in to achieve a target network egress rate.- Specified by:
scaleOnOutgoingBytes
in interfaceIAutoScalingGroup
- Parameters:
id
- This parameter is required.props
- This parameter is required.
-
scaleOnSchedule
@Stability(Stable) @NotNull default ScheduledAction scaleOnSchedule(@NotNull String id, @NotNull BasicScheduledActionProps props) Scale out or in based on time.- Specified by:
scaleOnSchedule
in interfaceIAutoScalingGroup
- Parameters:
id
- This parameter is required.props
- This parameter is required.
-
scaleToTrackMetric
@Stability(Stable) @NotNull default 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 interfaceIAutoScalingGroup
- Parameters:
id
- This parameter is required.props
- This parameter is required.
-