AWS CDK Reference

Appearance

v2.273.0

HealthCheck Class ​

Health check settings.

Source
aws-autoscaling/lib/auto-scaling-group.ts
Type last changed
v2.182.0 · 5 Mar 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';
const healthCheck = autoscaling.HealthCheck.ec2(/* all optional props */ {
  grace: cdk.Duration.minutes(30),
});

Properties ​

gracePeriodDurationgrace_periodDurationgracePeriodDurationGracePeriodDurationGracePeriodDuration#
typestringtypestrtypeStringTypestringType*stringrequired#

Methods ​

ec2(options?: Ec2HealthCheckOptions): HealthCheck // chainable@staticmethod def ec2(options: typing.Optional[Ec2HealthCheckOptions] = None) -> HealthCheckpublic static HealthCheck ec2(Ec2HealthCheckOptions options)public static HealthCheck Ec2(Ec2HealthCheckOptions? options = null)func Ec2(Options Ec2HealthCheckOptions) HealthCheckstatic#
Use EC2 for health checks.
1 parameter

Parameters

  • optionsoptionsoptionsoptionsOptions — EC2 health check options.
elb(options: ElbHealthCheckOptions): HealthCheck // chainable@staticmethod def elb(options: ElbHealthCheckOptions) -> HealthCheckpublic static HealthCheck elb(ElbHealthCheckOptions options)public static HealthCheck Elb(ElbHealthCheckOptions options)func Elb(Options ElbHealthCheckOptions) HealthCheckstatic#
Use ELB for health checks.

It considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.

1 parameter

Parameters

  • optionsoptionsoptionsoptionsOptions — ELB health check options.