software.amazon.awscdk.services.autoscaling

Class Signals

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.autoscaling.Signals

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:08.877Z")
public abstract class Signals
extends software.amazon.jsii.JsiiObject

Configure whether the AutoScalingGroup waits for signals.

If you do configure waiting for signals, you should make sure the instances invoke cfn-signal somewhere in their UserData to signal that they have started up (either successfully or unsuccessfully).

Signals are used both during intial creation and subsequent updates.

Example:

 Vpc vpc;
 InstanceType instanceType;
 IMachineImage machineImage;
 AutoScalingGroup.Builder.create(this, "ASG")
         .vpc(vpc)
         .instanceType(instanceType)
         .machineImage(machineImage)
         // ...
         .init(CloudFormationInit.fromElements(InitFile.fromString("/etc/my_instance", "This got written during instance startup")))
         .signals(Signals.waitForAll(SignalsOptions.builder()
                 .timeout(Duration.minutes(10))
                 .build()))
         .build();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Signals()
protected	Signals(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Signals(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected CfnCreationPolicy	doRender(SignalsOptions options) Helper to render the actual creation policy, as the logic between them is quite similar.
protected CfnCreationPolicy	doRender(SignalsOptions options, java.lang.Number count) Helper to render the actual creation policy, as the logic between them is quite similar.
abstract CfnCreationPolicy	renderCreationPolicy(RenderSignalsOptions renderOptions) Render the ASG's CreationPolicy.
static Signals	waitForAll() Wait for the desiredCapacity of the AutoScalingGroup amount of signals to have been received.
static Signals	waitForAll(SignalsOptions options) Wait for the desiredCapacity of the AutoScalingGroup amount of signals to have been received.
static Signals	waitForCount(java.lang.Number count) Wait for a specific amount of signals to have been received.
static Signals	waitForCount(java.lang.Number count, SignalsOptions options) Wait for a specific amount of signals to have been received.
static Signals	waitForMinCapacity() Wait for the minCapacity of the AutoScalingGroup amount of signals to have been received.
static Signals	waitForMinCapacity(SignalsOptions options) Wait for the minCapacity of the AutoScalingGroup amount of signals to have been received.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Signals

protected Signals(software.amazon.jsii.JsiiObjectRef objRef)

Signals

protected Signals(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Signals

protected Signals()

Method Detail

waitForAll

public static Signals waitForAll(SignalsOptions options)

Wait for the desiredCapacity of the AutoScalingGroup amount of signals to have been received.

If no desiredCapacity has been configured, wait for minCapacity signals intead.

This number is used during initial creation and during replacing updates. During rolling updates, all updated instances must send a signal.

Parameters:

options -

waitForAll

public static Signals waitForAll()

Wait for the desiredCapacity of the AutoScalingGroup amount of signals to have been received.

If no desiredCapacity has been configured, wait for minCapacity signals intead.

This number is used during initial creation and during replacing updates. During rolling updates, all updated instances must send a signal.

waitForCount

public static Signals waitForCount(java.lang.Number count,
                                   SignalsOptions options)

Wait for a specific amount of signals to have been received.

You should send one signal per instance, so this represents the number of instances to wait for.

This number is used during initial creation and during replacing updates. During rolling updates, all updated instances must send a signal.

Parameters:

count - This parameter is required.

options -

waitForCount

public static Signals waitForCount(java.lang.Number count)

Wait for a specific amount of signals to have been received.

You should send one signal per instance, so this represents the number of instances to wait for.

This number is used during initial creation and during replacing updates. During rolling updates, all updated instances must send a signal.

Parameters:

count - This parameter is required.

waitForMinCapacity

public static Signals waitForMinCapacity(SignalsOptions options)

Wait for the minCapacity of the AutoScalingGroup amount of signals to have been received.

This number is used during initial creation and during replacing updates. During rolling updates, all updated instances must send a signal.

Parameters:

options -

waitForMinCapacity

public static Signals waitForMinCapacity()

Wait for the minCapacity of the AutoScalingGroup amount of signals to have been received.

This number is used during initial creation and during replacing updates. During rolling updates, all updated instances must send a signal.

doRender

protected CfnCreationPolicy doRender(SignalsOptions options,
                                     java.lang.Number count)

Helper to render the actual creation policy, as the logic between them is quite similar.

Parameters:

options - This parameter is required.

count -

doRender

protected CfnCreationPolicy doRender(SignalsOptions options)

Helper to render the actual creation policy, as the logic between them is quite similar.

Parameters:

options - This parameter is required.

renderCreationPolicy

public abstract CfnCreationPolicy renderCreationPolicy(RenderSignalsOptions renderOptions)

Render the ASG's CreationPolicy.

Parameters:

renderOptions - This parameter is required.