Interface IRollingUpdateOptions

Namespace

Amazon.CDK.AWS.AutoScaling

Assembly

Amazon.CDK.AWS.AutoScaling.dll

Options for customizing the rolling update.

public interface IRollingUpdateOptions

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.AutoScaling;
            using Amazon.CDK;
            var rollingUpdateOptions = new RollingUpdateOptions {
                MaxBatchSize = 123,
                MinInstancesInService = 123,
                MinSuccessPercentage = 123,
                PauseTime = Duration.Minutes(30),
                SuspendProcesses = new [] { ScalingProcess.LAUNCH },
                WaitOnResourceSignals = false
            };

Remarks

ExampleMetadata: fixture=_generated

Properties

MaxBatchSize

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

double? MaxBatchSize { get; }

Property Value

double?

Remarks

This number affects the speed of the replacement.

Default: 1

MinInstancesInService

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

double? MinInstancesInService { get; }

Property Value

double?

Remarks

This number affects the speed of the replacement.

Default: 0

MinSuccessPercentage

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

double? MinSuccessPercentage { get; }

Property Value

double?

Remarks

Default: - The minSuccessPercentage configured for signals on the AutoScalingGroup

PauseTime

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

Duration? PauseTime { get; }

Property Value

Duration

Remarks

Default: - The timeout configured for signals on the AutoScalingGroup

SuspendProcesses

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

ScalingProcess[]? SuspendProcesses { get; }

Property Value

ScalingProcess[]

Remarks

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

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

WaitOnResourceSignals

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

bool? WaitOnResourceSignals { get; }

Property Value

bool?

Remarks

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