Package software.amazon.awscdk.services.autoscaling

Interface SignalsOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SignalsOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-04-10T22:22:24.160Z")
@Stability(Stable)
public interface SignalsOptions
extends software.amazon.jsii.JsiiSerializable

Customization options for Signal handling.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SignalsOptions.Builder	A builder for SignalsOptions
static final class	SignalsOptions.Jsii$Proxy	An implementation for SignalsOptions

Method Summary

Modifier and Type	Method	Description
static SignalsOptions.Builder	builder()
default Number	getMinSuccessPercentage()	The percentage of signals that need to be successful.
default Duration	getTimeout()	How long to wait for the signals to be sent.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMinSuccessPercentage

@Stability(Stable)
@Nullable
default Number getMinSuccessPercentage()

The percentage of signals that need to be successful.

If this number is less than 100, a percentage of signals may be failure signals while still succeeding the creation or update in CloudFormation.

Default: 100

getTimeout

@Stability(Stable)
@Nullable
default Duration getTimeout()

How long to wait for the signals to be sent.

This should reflect how long it takes your instances to start up (including instance start time and instance initialization time).

Default: Duration.minutes(5)

builder

@Stability(Stable)
static SignalsOptions.Builder builder()

Returns:

a SignalsOptions.Builder of SignalsOptions