aws-cdk-lib.aws_route53.CfnHealthCheckProps

CfnHealthCheckProps Struct

Properties for defining a CfnHealthCheck.

Source

Generated code

Type last changed

v2.214.0 · 2 Sep 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_route53 as route53 } from 'aws-cdk-lib';
const cfnHealthCheckProps: route53.CfnHealthCheckProps = {
  healthCheckConfig: {
    type: 'type',

    // the properties below are optional
    alarmIdentifier: {
      name: 'name',
      region: 'region',
    },
    childHealthChecks: ['childHealthChecks'],
    enableSni: false,
    failureThreshold: 123,
    fullyQualifiedDomainName: 'fullyQualifiedDomainName',
    healthThreshold: 123,
    insufficientDataHealthStatus: 'insufficientDataHealthStatus',
    inverted: false,
    ipAddress: 'ipAddress',
    measureLatency: false,
    port: 123,
    regions: ['regions'],
    requestInterval: 123,
    resourcePath: 'resourcePath',
    routingControlArn: 'routingControlArn',
    searchString: 'searchString',
  },

  // the properties below are optional
  healthCheckTags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

healthCheckConfigIResolvable | CfnHealthCheck.HealthCheckConfigPropertyhealth_check_configtyping.Union[IResolvable, HealthCheckConfigProperty]healthCheckConfigIResolvableHealthCheckConfigIResolvableHealthCheckConfiginterface{}required#

A complex type that contains detailed information about one health check.

For the values to enter for HealthCheckConfig , see HealthCheckConfig

healthCheckTagsCfnHealthCheck.HealthCheckTagProperty[]health_check_tagstyping.List[HealthCheckTagProperty]healthCheckTagsList<HealthCheckTagProperty>HealthCheckTagsHealthCheckTagProperty[]HealthCheckTags*[]HealthCheckTagProperty#

The `HealthCheckTags` property describes key-value pairs that are associated with an `AWS::Route53::HealthCheck` resource.

Used as props by

• CfnHealthCheck