Class RollingUpdateConfiguration
(deprecated) Additional settings when a rolling update is selected.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.AWS.AutoScaling.dll
Syntax (csharp)
public class RollingUpdateConfiguration : Object, IRollingUpdateConfiguration
Syntax (vb)
Public Class RollingUpdateConfiguration
Inherits Object
Implements IRollingUpdateConfiguration
Remarks
Stability: Deprecated
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 rollingUpdateConfiguration = new RollingUpdateConfiguration {
MaxBatchSize = 123,
MinInstancesInService = 123,
MinSuccessfulInstancesPercent = 123,
PauseTime = Duration.Minutes(30),
SuspendProcesses = new [] { ScalingProcess.LAUNCH },
WaitOnResourceSignals = false
};
Synopsis
Constructors
RollingUpdateConfiguration() |
Properties
MaxBatchSize | (deprecated) The maximum number of instances that AWS CloudFormation updates at once. |
MinInstancesInService | (deprecated) The minimum number of instances that must be in service before more instances are replaced. |
MinSuccessfulInstancesPercent | (deprecated) The percentage of instances that must signal success for an update to succeed. |
PauseTime | (deprecated) The pause time after making a change to a batch of instances. |
SuspendProcesses | (deprecated) Specifies the Auto Scaling processes to suspend during a stack update. |
WaitOnResourceSignals | (deprecated) Specifies whether the Auto Scaling group waits on signals from new instances during an update. |
Constructors
RollingUpdateConfiguration()
public RollingUpdateConfiguration()
Properties
MaxBatchSize
(deprecated) The maximum number of instances that AWS CloudFormation updates at once.
public Nullable<double> MaxBatchSize { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 1
Stability: Deprecated
MinInstancesInService
(deprecated) The minimum number of instances that must be in service before more instances are replaced.
public Nullable<double> MinInstancesInService { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This number affects the speed of the replacement.
Default: 0
Stability: Deprecated
MinSuccessfulInstancesPercent
(deprecated) The percentage of instances that must signal success for an update to succeed.
public Nullable<double> MinSuccessfulInstancesPercent { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
If an instance doesn't send a signal within the time specified in the pauseTime property, AWS CloudFormation assumes that the instance wasn't updated.
This number affects the success of the replacement.
If you specify this property, you must also enable the waitOnResourceSignals and pauseTime properties.
Default: 100
Stability: Deprecated
PauseTime
(deprecated) The pause time after making a change to a batch of instances.
public Duration PauseTime { get; set; }
Property Value
Remarks
This is intended to give those instances time to start software applications.
Specify PauseTime in the ISO8601 duration format (in the format PT#H#M#S, where each # is the number of hours, minutes, and seconds, respectively). The maximum PauseTime is one hour (PT1H).
Default: Duration.minutes(5) if the waitOnResourceSignals property is true, otherwise 0
Stability: Deprecated
SuspendProcesses
(deprecated) Specifies the Auto Scaling processes to suspend during a stack update.
public ScalingProcess[] SuspendProcesses { get; set; }
Property Value
Remarks
Suspending processes prevents Auto Scaling from interfering with a stack update.
Default: HealthCheck, ReplaceUnhealthy, AZRebalance, AlarmNotification, ScheduledActions.
Stability: Deprecated
WaitOnResourceSignals
(deprecated) Specifies whether the Auto Scaling group waits on signals from new instances during an update.
public Nullable<bool> WaitOnResourceSignals { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
AWS CloudFormation must receive a signal from each new instance within the specified PauseTime before continuing the update.
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.
Default: true if you specified the minSuccessfulInstancesPercent property, false otherwise
Stability: Deprecated