This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-autoscaling-common

AWS AutoScaling Common Library

This is a sister package to @aws-cdk/aws-autoscaling and @aws-cdk/aws-applicationautoscaling. It contains shared implementation details between them.

It does not need to be used directly.

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.AutoScaling.Common" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.AutoScaling.Common --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.AutoScaling.Common" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:autoscaling-common:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="autoscaling-common" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>autoscaling-common</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:autoscaling-common:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='autoscaling-common', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-autoscaling-common@0.25.3

package.json:

{
  "@aws-cdk/aws-autoscaling-common": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-autoscaling-common@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-autoscaling-common@0.25.3

package.json:

{
  "@aws-cdk/aws-autoscaling-common": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-autoscaling-common@0.25.3

Alarms (interface)

class @aws-cdk/aws-autoscaling-common.Alarms

Language-specific names:

using Amazon.CDK.AWS.AutoScaling.Common;
import software.amazon.awscdk.services.autoscaling.common.Alarms;
// Alarms is an interface
import { Alarms } from '@aws-cdk/aws-autoscaling-common';
lowerAlarmIntervalIndex
Type:number (optional)
upperAlarmIntervalIndex
Type:number (optional)

ArbitraryIntervals (interface)

class @aws-cdk/aws-autoscaling-common.ArbitraryIntervals

Language-specific names:

using Amazon.CDK.AWS.AutoScaling.Common;
import software.amazon.awscdk.services.autoscaling.common.ArbitraryIntervals;
// ArbitraryIntervals is an interface
import { ArbitraryIntervals } from '@aws-cdk/aws-autoscaling-common';
absolute
Type:boolean
intervals
Type:ScalingInterval[]

CompleteScalingInterval (interface)

class @aws-cdk/aws-autoscaling-common.CompleteScalingInterval

Language-specific names:

using Amazon.CDK.AWS.AutoScaling.Common;
import software.amazon.awscdk.services.autoscaling.common.CompleteScalingInterval;
// CompleteScalingInterval is an interface
import { CompleteScalingInterval } from '@aws-cdk/aws-autoscaling-common';
lower
Type:number
upper
Type:number
change
Type:number (optional)

IRandomGenerator (interface)

class @aws-cdk/aws-autoscaling-common.IRandomGenerator

Language-specific names:

using Amazon.CDK.AWS.AutoScaling.Common;
import software.amazon.awscdk.services.autoscaling.common.IRandomGenerator;
// IRandomGenerator is an interface
import { IRandomGenerator } from '@aws-cdk/aws-autoscaling-common';
nextBoolean() → boolean
Return type:boolean
Abstract:Yes
nextInt(min, max) → number
Parameters:
  • min (number) –
  • max (number) –
Return type:

number

Abstract:

Yes

ScalingInterval (interface)

class @aws-cdk/aws-autoscaling-common.ScalingInterval

Language-specific names:

using Amazon.CDK.AWS.AutoScaling.Common;
import software.amazon.awscdk.services.autoscaling.common.ScalingInterval;
// ScalingInterval is an interface
import { ScalingInterval } from '@aws-cdk/aws-autoscaling-common';

A range of metric values in which to apply a certain scaling operation

change

The capacity adjustment to apply in this interval

The number is interpreted differently based on AdjustmentType:

  • ChangeInCapacity: add the adjustment to the current capacity.

    The number can be positive or negative.

  • PercentChangeInCapacity: add or remove the given percentage of the current

    capacity to itself. The number can be in the range [-100..100].

  • ExactCapacity: set the capacity to this number. The number must

    be positive.

Type:number
lower

The lower bound of the interval.

The scaling adjustment will be applied if the metric is higher than this value.

Type:number (optional)
Default:Threshold automatically derived from neighbouring intervals
upper

The upper bound of the interval.

The scaling adjustment will be applied if the metric is lower than this value.

Type:number (optional)
Default:Threshold automatically derived from neighbouring intervals