RollingUpdateConfiguration

class aws_cdk.aws_autoscaling.RollingUpdateConfiguration(*, max_batch_size=None, min_instances_in_service=None, min_successful_instances_percent=None, pause_time=None, suspend_processes=None, wait_on_resource_signals=None)

Bases: object

__init__(*, max_batch_size=None, min_instances_in_service=None, min_successful_instances_percent=None, pause_time=None, suspend_processes=None, wait_on_resource_signals=None)

Additional settings when a rolling update is selected.

Parameters
  • max_batch_size (Union[int, float, None]) – The maximum number of instances that AWS CloudFormation updates at once. Default: 1

  • min_instances_in_service (Union[int, float, None]) – The minimum number of instances that must be in service before more instances are replaced. This number affects the speed of the replacement. Default: 0

  • min_successful_instances_percent (Union[int, float, None]) – The percentage of instances that must signal success for an update to succeed. 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

  • pause_time (Optional[Duration]) – The pause time after making a change to a batch of instances. 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

  • suspend_processes (Optional[List[ScalingProcess]]) – Specifies the Auto Scaling processes to suspend during a stack update. Suspending processes prevents Auto Scaling from interfering with a stack update. Default: HealthCheck, ReplaceUnhealthy, AZRebalance, AlarmNotification, ScheduledActions.

  • wait_on_resource_signals (Optional[bool]) – Specifies whether the Auto Scaling group waits on signals from new instances during an update. 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

Attributes

max_batch_size

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

default :default: 1

Return type

Union[int, float, None]

min_instances_in_service

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

This number affects the speed of the replacement.

default :default: 0

Return type

Union[int, float, None]

min_successful_instances_percent

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

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 :default: 100

Return type

Union[int, float, None]

pause_time

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

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 :default: Duration.minutes(5) if the waitOnResourceSignals property is true, otherwise 0

Return type

Optional[Duration]

suspend_processes

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

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

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

Return type

Optional[List[ScalingProcess]]

wait_on_resource_signals

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

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 :default: true if you specified the minSuccessfulInstancesPercent property, false otherwise

Return type

Optional[bool]