Package software.amazon.awscdk.services.route53

Class CfnHealthCheck

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.route53.CfnHealthCheck
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IHealthCheckRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:44.172Z") @Stability(Stable) public class CfnHealthCheck extends CfnResource implements IInspectable, IHealthCheckRef, ITaggableV2
The AWS::Route53::HealthCheck resource is a Route 53 resource type that contains settings for a Route 53 health check.

For information about associating health checks with records, see HealthCheckId in ChangeResourceRecordSets .

You can't create a health check with simple routing.

ELB Load Balancers

If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check.

Private Hosted Zones

You can associate health checks with failover records in a private hosted zone. Note the following:

  • Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.
  • You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.
  • You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.route53.*;
 CfnHealthCheck cfnHealthCheck = CfnHealthCheck.Builder.create(this, "MyCfnHealthCheck")
         .healthCheckConfig(HealthCheckConfigProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .alarmIdentifier(AlarmIdentifierProperty.builder()
                         .name("name")
                         .region("region")
                         .build())
                 .childHealthChecks(List.of("childHealthChecks"))
                 .enableSni(false)
                 .failureThreshold(123)
                 .fullyQualifiedDomainName("fullyQualifiedDomainName")
                 .healthThreshold(123)
                 .insufficientDataHealthStatus("insufficientDataHealthStatus")
                 .inverted(false)
                 .ipAddress("ipAddress")
                 .measureLatency(false)
                 .port(123)
                 .regions(List.of("regions"))
                 .requestInterval(123)
                 .resourcePath("resourcePath")
                 .routingControlArn("routingControlArn")
                 .searchString("searchString")
                 .build())
         // the properties below are optional
         .healthCheckTags(List.of(HealthCheckTagProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnHealthCheck

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

    • CfnHealthCheck

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

    • CfnHealthCheck

      @Stability(Stable) public CfnHealthCheck(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnHealthCheckProps props)
      Create a new AWS::Route53::HealthCheck.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForHealthCheck

      @Stability(Stable) @NotNull public static String arnForHealthCheck(@NotNull IHealthCheckRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnHealthCheck

      @Stability(Stable) @NotNull public static Boolean isCfnHealthCheck(@NotNull Object x)
      Checks whether the given object is a CfnHealthCheck.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrHealthCheckId

      @Stability(Stable) @NotNull public String getAttrHealthCheckId()
      The identifier that Amazon Route 53 assigned to the health check when you created it.

      When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getHealthCheckRef

      @Stability(Stable) @NotNull public HealthCheckReference getHealthCheckRef()
      A reference to a HealthCheck resource.
      Specified by:
      getHealthCheckRef in interface IHealthCheckRef

    • getHealthCheckConfig

      @Stability(Stable) @NotNull public Object getHealthCheckConfig()
      A complex type that contains detailed information about one health check.

      Returns union: either IResolvable or CfnHealthCheck.HealthCheckConfigProperty

    • setHealthCheckConfig

      @Stability(Stable) public void setHealthCheckConfig(@NotNull IResolvable value)
      A complex type that contains detailed information about one health check.

    • setHealthCheckConfig

      @Stability(Stable) public void setHealthCheckConfig(@NotNull CfnHealthCheck.HealthCheckConfigProperty value)
      A complex type that contains detailed information about one health check.

    • getHealthCheckTags

      @Stability(Stable) @Nullable public List<CfnHealthCheck.HealthCheckTagProperty> getHealthCheckTags()
      The HealthCheckTags property describes key-value pairs that are associated with an AWS::Route53::HealthCheck resource.

    • setHealthCheckTags

      @Stability(Stable) public void setHealthCheckTags(@Nullable List<CfnHealthCheck.HealthCheckTagProperty> value)
      The HealthCheckTags property describes key-value pairs that are associated with an AWS::Route53::HealthCheck resource.