Skip to content
v2.274.0

RollingUpdateOptions Struct ​

Options for customizing the rolling update.

Example ​

ts
// 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 ​

maxBatchSizeoptionalnumbermax_batch_sizeoptionalint | floatmaxBatchSizeoptionalNumberMaxBatchSizeoptionaldoubleMaxBatchSizeoptional*float64= 1#
The maximum number of instances that AWS CloudFormation updates at once.

This number affects the speed of the replacement.

minInstancesInServiceoptionalnumbermin_instances_in_serviceoptionalint | floatminInstancesInServiceoptionalNumberMinInstancesInServiceoptionaldoubleMinInstancesInServiceoptional*float64= 0#
The minimum number of instances that must be in service before more instances are replaced.

This number affects the speed of the replacement.

minSuccessPercentageoptionalnumbermin_success_percentageoptionalint | floatminSuccessPercentageoptionalNumberMinSuccessPercentageoptionaldoubleMinSuccessPercentageoptional*float64#
The percentage of instances that must signal success for the update to succeed.

Default: The minSuccessPercentage configured for signals on the AutoScalingGroup

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

Default: The timeout configured for signals on the AutoScalingGroup

suspendProcessesoptionalScalingProcess[]suspend_processesoptionaltyping.List[ScalingProcess]suspendProcessesoptionalList<ScalingProcess>SuspendProcessesoptionalScalingProcess[]SuspendProcessesoptional*[]ScalingProcess#
Specifies the Auto Scaling processes to suspend during a stack update.

Default: HealthCheck, ReplaceUnhealthy, AZRebalance, AlarmNotification, ScheduledActions.

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

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

Default: true if you configured signals on the AutoScalingGroup, false otherwise