Interface IRollingUpdateOptions

Options for customizing the rolling update.

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.AWS.AutoScaling.dll

Syntax (csharp)

public interface IRollingUpdateOptions

Syntax (vb)

Public Interface IRollingUpdateOptions

Remarks

ExampleMetadata: fixture=_generated

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
};

Synopsis

Properties

MaxBatchSize	The maximum number of instances that AWS CloudFormation updates at once.
MinInstancesInService	The minimum number of instances that must be in service before more instances are replaced.
MinSuccessPercentage	The percentage of instances that must signal success for the update to succeed.
PauseTime	The pause time after making a change to a batch of instances.
SuspendProcesses	Specifies the Auto Scaling processes to suspend during a stack update.
WaitOnResourceSignals	Specifies whether the Auto Scaling group waits on signals from new instances during an update.

Properties

MaxBatchSize

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

virtual Nullable<double> MaxBatchSize { get; }

Property Value

System.Nullable<System.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.

virtual Nullable<double> MinInstancesInService { get; }

Property Value

System.Nullable<System.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.

virtual Nullable<double> MinSuccessPercentage { get; }

Property Value

System.Nullable<System.Double>

Remarks

Default: - The minSuccessPercentage configured for signals on the AutoScalingGroup

PauseTime

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

virtual 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.

virtual 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.

virtual Nullable<bool> WaitOnResourceSignals { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

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