aws-cdk-lib.aws_autoscaling.RollingUpdateOptions

interface RollingUpdateOptions

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

Options for customizing the rolling update.

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';
const rollingUpdateOptions: autoscaling.RollingUpdateOptions = {
  maxBatchSize: 123,
  minInstancesInService: 123,
  minSuccessPercentage: 123,
  pauseTime: cdk.Duration.minutes(30),
  suspendProcesses: [autoscaling.ScalingProcess.LAUNCH],
  waitOnResourceSignals: false,
};

Properties

NameTypeDescription
maxBatchSize?numberThe maximum number of instances that AWS CloudFormation updates at once.
minInstancesInService?numberThe minimum number of instances that must be in service before more instances are replaced.
minSuccessPercentage?numberThe percentage of instances that must signal success for the update to succeed.
pauseTime?DurationThe pause time after making a change to a batch of instances.
suspendProcesses?ScalingProcess[]Specifies the Auto Scaling processes to suspend during a stack update.
waitOnResourceSignals?booleanSpecifies whether the Auto Scaling group waits on signals from new instances during an update.

maxBatchSize?

Type: number (optional, default: 1)

The maximum number of instances that AWS CloudFormation updates at once.

This number affects the speed of the replacement.


minInstancesInService?

Type: number (optional, default: 0)

The minimum number of instances that must be in service before more instances are replaced.

This number affects the speed of the replacement.


minSuccessPercentage?

Type: number (optional, default: The minSuccessPercentage configured for signals on the AutoScalingGroup)

The percentage of instances that must signal success for the update to succeed.


pauseTime?

Type: Duration (optional, default: The timeout configured for signals on the AutoScalingGroup)

The pause time after making a change to a batch of instances.


suspendProcesses?

Type: ScalingProcess[] (optional, default: HealthCheck, ReplaceUnhealthy, AZRebalance, AlarmNotification, ScheduledActions.)

Specifies the Auto Scaling processes to suspend during a stack update.

Suspending processes prevents Auto Scaling from interfering with a stack update.


waitOnResourceSignals?

Type: boolean (optional, default: true if you configured signals on the AutoScalingGroup, false otherwise)

Specifies whether the Auto Scaling group waits on signals from new instances during an update.