2.173.4

interface CommonAutoScalingGroupProps

LanguageType name
.NETAmazon.CDK.AWS.AutoScaling.CommonAutoScalingGroupProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsautoscaling#CommonAutoScalingGroupProps
Javasoftware.amazon.awscdk.services.autoscaling.CommonAutoScalingGroupProps
Pythonaws_cdk.aws_autoscaling.CommonAutoScalingGroupProps
TypeScript (source)aws-cdk-lib » aws_autoscaling » CommonAutoScalingGroupProps

Basic properties of an AutoScalingGroup, except the exact machines to run and where they should run.

Constructs that want to create AutoScalingGroups can inherit this interface and specialize the essential parts in various ways.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_sns as sns } from 'aws-cdk-lib';

declare const blockDeviceVolume: autoscaling.BlockDeviceVolume;
declare const groupMetrics: autoscaling.GroupMetrics;
declare const healthCheck: autoscaling.HealthCheck;
declare const keyPair: ec2.KeyPair;
declare const scalingEvents: autoscaling.ScalingEvents;
declare const signals: autoscaling.Signals;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const topic: sns.Topic;
declare const updatePolicy: autoscaling.UpdatePolicy;
const commonAutoScalingGroupProps: autoscaling.CommonAutoScalingGroupProps = {
  allowAllOutbound: false,
  associatePublicIpAddress: false,
  autoScalingGroupName: 'autoScalingGroupName',
  blockDevices: [{
    deviceName: 'deviceName',
    volume: blockDeviceVolume,
  }],
  capacityRebalance: false,
  cooldown: cdk.Duration.minutes(30),
  defaultInstanceWarmup: cdk.Duration.minutes(30),
  desiredCapacity: 123,
  groupMetrics: [groupMetrics],
  healthCheck: healthCheck,
  ignoreUnmodifiedSizeProperties: false,
  instanceMonitoring: autoscaling.Monitoring.BASIC,
  keyName: 'keyName',
  keyPair: keyPair,
  maxCapacity: 123,
  maxInstanceLifetime: cdk.Duration.minutes(30),
  minCapacity: 123,
  newInstancesProtectedFromScaleIn: false,
  notifications: [{
    topic: topic,

    // the properties below are optional
    scalingEvents: scalingEvents,
  }],
  signals: signals,
  spotPrice: 'spotPrice',
  ssmSessionPermissions: false,
  terminationPolicies: [autoscaling.TerminationPolicy.ALLOCATION_STRATEGY],
  terminationPolicyCustomLambdaFunctionArn: 'terminationPolicyCustomLambdaFunctionArn',
  updatePolicy: updatePolicy,
  vpcSubnets: {
    availabilityZones: ['availabilityZones'],
    onePerAz: false,
    subnetFilters: [subnetFilter],
    subnetGroupName: 'subnetGroupName',
    subnets: [subnet],
    subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
  },
};

Properties

NameTypeDescription
allowAllOutbound?booleanWhether the instances can initiate connections to anywhere by default.
associatePublicIpAddress?booleanWhether instances in the Auto Scaling Group should have public IP addresses associated with them.
autoScalingGroupName?stringThe name of the Auto Scaling group.
blockDevices?BlockDevice[]Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
capacityRebalance?booleanIndicates whether Capacity Rebalancing is enabled.
cooldown?DurationDefault scaling cooldown for this AutoScalingGroup.
defaultInstanceWarmup?DurationThe amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics.
desiredCapacity?numberInitial amount of instances in the fleet.
groupMetrics?GroupMetrics[]Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.
healthCheck?HealthCheckConfiguration for health checks.
ignoreUnmodifiedSizeProperties?booleanIf the ASG has scheduled actions, don't reset unchanged group sizes.
instanceMonitoring?MonitoringControls whether instances in this group are launched with detailed or basic monitoring.
keyName?⚠️stringName of SSH keypair to grant access to instances.
keyPair?IKeyPairThe SSH keypair to grant access to the instance.
maxCapacity?numberMaximum number of instances in the fleet.
maxInstanceLifetime?DurationThe maximum amount of time that an instance can be in service.
minCapacity?numberMinimum number of instances in the fleet.
newInstancesProtectedFromScaleIn?booleanWhether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
notifications?NotificationConfiguration[]Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).
signals?SignalsConfigure waiting for signals during deployment.
spotPrice?stringThe maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.
ssmSessionPermissions?booleanAdd SSM session permissions to the instance role.
terminationPolicies?TerminationPolicy[]A policy or a list of policies that are used to select the instances to terminate.
terminationPolicyCustomLambdaFunctionArn?stringA lambda function Arn that can be used as a custom termination policy to select the instances to terminate.
updatePolicy?UpdatePolicyWhat to do when an AutoScalingGroup's instance configuration is changed.
vpcSubnets?SubnetSelectionWhere to place instances within the VPC.

allowAllOutbound?

Type: boolean (optional, default: true)

Whether the instances can initiate connections to anywhere by default.

associatePublicIpAddress?

Type: boolean (optional, default: Use subnet setting.)

Whether instances in the Auto Scaling Group should have public IP addresses associated with them.

launchTemplate and mixedInstancesPolicy must not be specified when this property is specified

autoScalingGroupName?

Type: string (optional, default: Auto generated by CloudFormation)

The name of the Auto Scaling group.

This name must be unique per Region per account.

blockDevices?

Type: BlockDevice[] (optional, default: Uses the block device mapping of the AMI)

Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.

Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.

launchTemplate and mixedInstancesPolicy must not be specified when this property is specified

See also: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html

capacityRebalance?

Type: boolean (optional, default: false)

Indicates whether Capacity Rebalancing is enabled.

When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-capacityrebalance

cooldown?

Type: Duration (optional, default: Duration.minutes(5))

Default scaling cooldown for this AutoScalingGroup.

defaultInstanceWarmup?

Type: Duration (optional, default: None)

The amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics.

This delay lets an instance finish initializing before Amazon EC2 Auto Scaling aggregates instance metrics, resulting in more reliable usage data. Set this value equal to the amount of time that it takes for resource consumption to become stable after an instance reaches the InService state.

To optimize the performance of scaling policies that scale continuously, such as target tracking and step scaling policies, we strongly recommend that you enable the default instance warmup, even if its value is set to 0 seconds

Default instance warmup will not be added if no value is specified

See also: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html

desiredCapacity?

Type: number (optional, default: minCapacity, and leave unchanged during deployment)

Initial amount of instances in the fleet.

If this is set to a number, every deployment will reset the amount of instances to this number. It is recommended to leave this value blank.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity

groupMetrics?

Type: GroupMetrics[] (optional, default: no group metrics will be reported)

Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.

To report all group metrics use GroupMetrics.all() Group metrics are reported in a granularity of 1 minute at no additional charge.

healthCheck?

Type: HealthCheck (optional, default: HealthCheck.ec2 with no grace period)

Configuration for health checks.

ignoreUnmodifiedSizeProperties?

Type: boolean (optional, default: true)

If the ASG has scheduled actions, don't reset unchanged group sizes.

Only used if the ASG has scheduled actions (which may scale your ASG up or down regardless of cdk deployments). If true, the size of the group will only be reset if it has been changed in the CDK app. If false, the sizes will always be changed back to what they were in the CDK app on deployment.

instanceMonitoring?

Type: Monitoring (optional, default: Monitoring.DETAILED)

Controls whether instances in this group are launched with detailed or basic monitoring.

When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes.

launchTemplate and mixedInstancesPolicy must not be specified when this property is specified

See also: https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics

keyName?⚠️

⚠️ Deprecated: - Use keyPair instead - https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2-readme.html#using-an-existing-ec2-key-pair

Type: string (optional, default: No SSH access will be possible.)

Name of SSH keypair to grant access to instances.

launchTemplate and mixedInstancesPolicy must not be specified when this property is specified

You can either specify keyPair or keyName, not both.

keyPair?

Type: IKeyPair (optional, default: No SSH access will be possible.)

The SSH keypair to grant access to the instance.

Feature flag AUTOSCALING_GENERATE_LAUNCH_TEMPLATE must be enabled to use this property.

launchTemplate and mixedInstancesPolicy must not be specified when this property is specified.

You can either specify keyPair or keyName, not both.

maxCapacity?

Type: number (optional, default: desiredCapacity)

Maximum number of instances in the fleet.

maxInstanceLifetime?

Type: Duration (optional, default: none)

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

The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again.

You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined.

See also: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html

minCapacity?

Type: number (optional, default: 1)

Minimum number of instances in the fleet.

newInstancesProtectedFromScaleIn?

Type: boolean (optional, default: false)

Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

By default, Auto Scaling can terminate an instance at any time after launch when scaling in an Auto Scaling Group, subject to the group's termination policy. However, you may wish to protect newly-launched instances from being scaled in if they are going to run critical applications that should not be prematurely terminated.

This flag must be enabled if the Auto Scaling Group will be associated with an ECS Capacity Provider with managed termination protection.

notifications?

Type: NotificationConfiguration[] (optional, default: No fleet change notifications will be sent.)

Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations

signals?

Type: Signals (optional, default: Do not wait for signals)

Configure waiting for signals during deployment.

Use this to pause the CloudFormation deployment to wait for the instances in the AutoScalingGroup to report successful startup during creation and updates. The UserData script needs to invoke cfn-signal with a success or failure code after it is done setting up the instance.

Without waiting for signals, the CloudFormation deployment will proceed as soon as the AutoScalingGroup has been created or updated but before the instances in the group have been started.

For example, to have instances wait for an Elastic Load Balancing health check before they signal success, add a health-check verification by using the cfn-init helper script. For an example, see the verify_instance_health command in the Auto Scaling rolling updates sample template:

https://github.com/awslabs/aws-cloudformation-templates/blob/master/aws/services/AutoScaling/AutoScalingRollingUpdates.yaml

spotPrice?

Type: string (optional, default: none)

The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.

Spot Instances are launched when the price you specify exceeds the current Spot market price.

launchTemplate and mixedInstancesPolicy must not be specified when this property is specified

ssmSessionPermissions?

Type: boolean (optional, default: false)

Add SSM session permissions to the instance role.

Setting this to true adds the necessary permissions to connect to the instance using SSM Session Manager. You can do this from the AWS Console.

NOTE: Setting this flag to true may not be enough by itself. You must also use an AMI that comes with the SSM Agent, or install the SSM Agent yourself. See Working with SSM Agent in the SSM Developer Guide.

terminationPolicies?

Type: TerminationPolicy[] (optional, default: TerminationPolicy.DEFAULT)

A policy or a list of policies that are used to select the instances to terminate.

The policies are executed in the order that you list them.

See also: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html

terminationPolicyCustomLambdaFunctionArn?

Type: string (optional, default: No lambda function Arn will be supplied)

A lambda function Arn that can be used as a custom termination policy to select the instances to terminate.

This property must be specified if the TerminationPolicy.CUSTOM_LAMBDA_FUNCTION is used.

See also: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lambda-custom-termination-policy.html

updatePolicy?

Type: UpdatePolicy (optional, default: UpdatePolicy.rollingUpdate() if using init, UpdatePolicy.none() otherwise)

What to do when an AutoScalingGroup's instance configuration is changed.

This is applied when any of the settings on the ASG are changed that affect how the instances should be created (VPC, instance type, startup scripts, etc.). It indicates how the existing instances should be replaced with new instances matching the new config. By default, nothing is done and only new instances are launched with the new config.

vpcSubnets?

Type: SubnetSelection (optional, default: All Private subnets.)

Where to place instances within the VPC.

← PreviousNext →