HealthCheck

class aws_cdk.aws_route53.HealthCheck(scope, id, *, type, alarm_identifier=None, child_health_checks=None, enable_sni=None, failure_threshold=None, fqdn=None, health_threshold=None, insufficient_data_health_status=None, inverted=None, ip_address=None, measure_latency=None, port=None, regions=None, request_interval=None, resource_path=None, routing_control=None, search_string=None)

Bases: Resource

Amazon Route 53 health checks monitor the health and performance of your web applications, web servers, and other resources.

Each health check that you create can monitor one of the following:

  • The health of a resource, such as a web server,

  • The status of other health checks, and

  • The CloudWatch alarm that you specify,

  • The status of an Amazon Route 53 routing control.

ExampleMetadata:

infused

Example:

# my_zone: route53.HostedZone


health_check = route53.HealthCheck(self, "HealthCheck",
    type=route53.HealthCheckType.HTTP,
    fqdn="example.com",
    port=80,
    resource_path="/health",
    failure_threshold=3,
    request_interval=Duration.seconds(30)
)

route53.ARecord(self, "ARecord",
    zone=my_zone,
    target=route53.RecordTarget.from_ip_addresses("1.2.3.4"),
    health_check=health_check,
    weight=100
)
route53.ARecord(self, "ARecord2",
    zone=my_zone,
    target=route53.RecordTarget.from_ip_addresses("5.6.7.8"),
    weight=0
)

Creates a new health check.

Parameters:

  • scope (Construct) – The parent creating construct (usually this).

  • id (str) – The construct’s name.

  • type (HealthCheckType) – The type of health check to be associated with the record.

  • alarm_identifier (Union[AlarmIdentifier, Dict[str, Any], None]) – CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. Default: - if the type is CLOUDWATCH_METRIC, this property is required. Otherwise, it is not configured.

  • child_health_checks (Optional[Sequence[IHealthCheck]]) – A list of health checks to monitor for this ‘CALCULATED’ health check. Default: - if the type is CALCULATED, this property is required. Otherwise, it is not configured.

  • enable_sni (Optional[bool]) – Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate. Default: - if the type is HTTPS or HTTPS_STR_MATCH, this property default value is true. Otherwise, it is not configured.

  • failure_threshold (Union[int, float, None]) – The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. Default: - if the type is CALCULATED it’s not configured - if the type is CLOUDWATCH_METRIC it’s not configured - otherwise, the default value is 3.

  • fqdn (Optional[str]) – Fully qualified domain name of the endpoint to be checked. Amazon Route 53 behavior depends on whether you specify a value for IPAddress. If you specify a value for IPAddress: Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks. Note: If you specify a value for Port property other than 80 or 443, Route 53 will constract the value for Host header as FullyQualifiedDomainName:Port. If you don’t specify a value for IPAddress: Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint. Additionally, if the type of the health check is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify value for IPAddress. If the type is TCP, Route 53 doesn’t pass a Host header. Default: - not configured

  • health_threshold (Union[int, float, None]) – The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. Default: - if the type is CALCULATED, the default value is number of child health checks. Otherwise, it is not configured.

  • insufficient_data_health_status (Optional[InsufficientDataHealthStatusEnum]) – The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Default: - if the type is CLOUDWATCH_METRIC, the default value is InsufficientDataHealthStatus.LAST_KNOWN_STATUS. Otherwise, it is not configured.

  • inverted (Optional[bool]) – Specify whether you want Amazon Route 53 to invert the status of a health check, so a health check that would normally be considered unhealthy is considered healthy, and vice versa. Default: false

  • ip_address (Optional[str]) – The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don’t specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint. Default: - not configured

  • measure_latency (Optional[bool]) – Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Route 53 console. Default: - if the type is CALCULATED it’s not configured - if the type is CLOUDWATCH_METRIC it’s not configured - otherwise, the default value is false.

  • port (Union[int, float, None]) – The port on the endpoint that you want Amazon Route 53 to perform health checks on. Default: - if the type is HTTP or HTTP_STR_MATCH, the default value is 80. - if the type is HTTPS or HTTPS_STR_MATCH, the default value is 443. - otherwise, it is not configured.

  • regions (Optional[Sequence[str]]) – An array of region identifiers that you want Amazon Route 53 health checkers to check the health of the endpoint from. Please refer to the CloudFormation documentation for the most up-to-date list of regions. Default: - if the type is CALCULATED, CLOUDWATCH_METRIC, or RECOVERY_CONTROL, this property is not configured. - otherwise, the default value will be set by CloudFormation itself and will include all valid regions. Please refer to the CloudFormation documentation for the most up-to-date list of regions.

  • request_interval (Optional[Duration]) – The duration between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Route 53 health checker makes requests at this interval. Default: - if the type is CALCULATED it’s not configured - if the type is CLOUDWATCH_METRIC it’s not configured - otherwise, the default value is 30 seconds.

  • resource_path (Optional[str]) – The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service and a leading forward slash (/) character. Default: - if the type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, the default value is empty string. - otherwise, it is not configured.

  • routing_control (Optional[str]) – The Amazon Resource Name (ARN) of the Route 53 Application Recovery Controller routing control that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. Default: - if the type is RECOVERY_CONTROL, this property is required. Otherwise, it is not configured.

  • search_string (Optional[str]) – The string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. Route 53 considers case when searching for SearchString in the response body. Default: - if the type is HTTP_STR_MATCH or HTTPS_STR_MATCH, this property is required. Otherwise, it is not configured.

Returns:

a reference to the newly created health check.

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

health_check_id

The ID of the health check.

node

The tree node.

stack

The stack in which this resource is defined.

Static Methods

classmethod from_health_check_id(scope, id, health_check_id)

Import an existing health check into this CDK app.

Parameters:

  • scope (Construct) – The parent creating construct (usually this).

  • id (str) – The construct’s name.

  • health_check_id (str) – ID of the health check.

Return type:

IHealthCheck

Returns:

a reference to the existing health check.

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool