aws-cdk-lib.aws_autoscaling.HealthChecks

HealthChecks Class

Health check settings for multiple types.

Source

aws-autoscaling/lib/auto-scaling-group.ts

Type last changed

v2.182.0 · 5 Mar 2025

Example

declare const vpc: ec2.Vpc;

new autoscaling.AutoScalingGroup(this, 'ASG', {
  vpc,
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.MICRO),
  machineImage: ec2.MachineImage.latestAmazonLinux2(),
  healthChecks: autoscaling.HealthChecks.ec2({
    gracePeriod: Duration.seconds(100),
  }),
});

Properties

gracePeriod?may be undefinedDurationgrace_period?may be undefinedDurationgracePeriod?may be undefinedDurationGracePeriod?may be undefinedDurationGracePeriod?may be undefinedDuration#

typesstring[]typestyping.List[str]typesList<String>Typesstring[]Types*[]*string#

Methods

ec2(options?: Ec2HealthChecksOptions): HealthChecks // chainable@staticmethod def ec2(options: typing.Optional[Ec2HealthChecksOptions] = None) -> HealthCheckspublic static HealthChecks ec2(Ec2HealthChecksOptions options)public static HealthChecks Ec2(Ec2HealthChecksOptions? options = null)func Ec2(Options Ec2HealthChecksOptions) HealthChecksstatic#

Use EC2 only for health checks.

1 parameter

Parameters

• optionsoptionsoptionsoptionsOptions — EC2 health checks options.

withAdditionalChecks(options: AdditionalHealthChecksOptions): HealthChecks // chainable@staticmethod def with_additional_checks(options: AdditionalHealthChecksOptions) -> HealthCheckspublic static HealthChecks withAdditionalChecks(AdditionalHealthChecksOptions options)public static HealthChecks WithAdditionalChecks(AdditionalHealthChecksOptions options)func WithAdditionalChecks(Options AdditionalHealthChecksOptions) HealthChecksstatic#

Use additional health checks other than EC2.

Specify types other than EC2, as EC2 is always enabled. It considers the instance unhealthy if it fails either the EC2 status checks or the additional health checks.

1 parameter

Parameters

• optionsoptionsoptionsoptionsOptions — Additional health checks options.