Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. route53
  5. HealthCheck

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.route53.HealthCheck

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a Route53 health check.

    Example Usage

    Connectivity and HTTP Status Code Check

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.route53.HealthCheck("example", {
    fqdn: "example.com",
    port: 80,
    type: "HTTP",
    resourcePath: "/",
    failureThreshold: 5,
    requestInterval: 30,
    tags: {
        Name: "tf-test-health-check",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.route53.HealthCheck("example",
    fqdn="example.com",
    port=80,
    type="HTTP",
    resource_path="/",
    failure_threshold=5,
    request_interval=30,
    tags={
        "Name": "tf-test-health-check",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := route53.NewHealthCheck(ctx, "example", &route53.HealthCheckArgs{
			Fqdn:             pulumi.String("example.com"),
			Port:             pulumi.Int(80),
			Type:             pulumi.String("HTTP"),
			ResourcePath:     pulumi.String("/"),
			FailureThreshold: pulumi.Int(5),
			RequestInterval:  pulumi.Int(30),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("tf-test-health-check"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Route53.HealthCheck("example", new()
    {
        Fqdn = "example.com",
        Port = 80,
        Type = "HTTP",
        ResourcePath = "/",
        FailureThreshold = 5,
        RequestInterval = 30,
        Tags = 
        {
            { "Name", "tf-test-health-check" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53.HealthCheck;
import com.pulumi.aws.route53.HealthCheckArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new HealthCheck("example", HealthCheckArgs.builder()
            .fqdn("example.com")
            .port(80)
            .type("HTTP")
            .resourcePath("/")
            .failureThreshold("5")
            .requestInterval("30")
            .tags(Map.of("Name", "tf-test-health-check"))
            .build());

    }
}

    resources:
  example:
    type: aws:route53:HealthCheck
    properties:
      fqdn: example.com
      port: 80
      type: HTTP
      resourcePath: /
      failureThreshold: '5'
      requestInterval: '30'
      tags:
        Name: tf-test-health-check

    Connectivity and String Matching Check

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.route53.HealthCheck("example", {
    failureThreshold: 5,
    fqdn: "example.com",
    port: 443,
    requestInterval: 30,
    resourcePath: "/",
    searchString: "example",
    type: "HTTPS_STR_MATCH",
});

    import pulumi
import pulumi_aws as aws

example = aws.route53.HealthCheck("example",
    failure_threshold=5,
    fqdn="example.com",
    port=443,
    request_interval=30,
    resource_path="/",
    search_string="example",
    type="HTTPS_STR_MATCH")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := route53.NewHealthCheck(ctx, "example", &route53.HealthCheckArgs{
			FailureThreshold: pulumi.Int(5),
			Fqdn:             pulumi.String("example.com"),
			Port:             pulumi.Int(443),
			RequestInterval:  pulumi.Int(30),
			ResourcePath:     pulumi.String("/"),
			SearchString:     pulumi.String("example"),
			Type:             pulumi.String("HTTPS_STR_MATCH"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Route53.HealthCheck("example", new()
    {
        FailureThreshold = 5,
        Fqdn = "example.com",
        Port = 443,
        RequestInterval = 30,
        ResourcePath = "/",
        SearchString = "example",
        Type = "HTTPS_STR_MATCH",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53.HealthCheck;
import com.pulumi.aws.route53.HealthCheckArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new HealthCheck("example", HealthCheckArgs.builder()
            .failureThreshold("5")
            .fqdn("example.com")
            .port(443)
            .requestInterval("30")
            .resourcePath("/")
            .searchString("example")
            .type("HTTPS_STR_MATCH")
            .build());

    }
}

    resources:
  example:
    type: aws:route53:HealthCheck
    properties:
      failureThreshold: '5'
      fqdn: example.com
      port: 443
      requestInterval: '30'
      resourcePath: /
      searchString: example
      type: HTTPS_STR_MATCH

    Aggregate Check

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const parent = new aws.route53.HealthCheck("parent", {
    type: "CALCULATED",
    childHealthThreshold: 1,
    childHealthchecks: [child.id],
    tags: {
        Name: "tf-test-calculated-health-check",
    },
});

    import pulumi
import pulumi_aws as aws

parent = aws.route53.HealthCheck("parent",
    type="CALCULATED",
    child_health_threshold=1,
    child_healthchecks=[child["id"]],
    tags={
        "Name": "tf-test-calculated-health-check",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := route53.NewHealthCheck(ctx, "parent", &route53.HealthCheckArgs{
			Type:                 pulumi.String("CALCULATED"),
			ChildHealthThreshold: pulumi.Int(1),
			ChildHealthchecks: pulumi.StringArray{
				child.Id,
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("tf-test-calculated-health-check"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var parent = new Aws.Route53.HealthCheck("parent", new()
    {
        Type = "CALCULATED",
        ChildHealthThreshold = 1,
        ChildHealthchecks = new[]
        {
            child.Id,
        },
        Tags = 
        {
            { "Name", "tf-test-calculated-health-check" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53.HealthCheck;
import com.pulumi.aws.route53.HealthCheckArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var parent = new HealthCheck("parent", HealthCheckArgs.builder()
            .type("CALCULATED")
            .childHealthThreshold(1)
            .childHealthchecks(child.id())
            .tags(Map.of("Name", "tf-test-calculated-health-check"))
            .build());

    }
}

    resources:
  parent:
    type: aws:route53:HealthCheck
    properties:
      type: CALCULATED
      childHealthThreshold: 1
      childHealthchecks:
        - ${child.id}
      tags:
        Name: tf-test-calculated-health-check

    CloudWatch Alarm Check

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const foobar = new aws.cloudwatch.MetricAlarm("foobar", {
    name: "test-foobar5",
    comparisonOperator: "GreaterThanOrEqualToThreshold",
    evaluationPeriods: 2,
    metricName: "CPUUtilization",
    namespace: "AWS/EC2",
    period: 120,
    statistic: "Average",
    threshold: 80,
    alarmDescription: "This metric monitors ec2 cpu utilization",
});
const foo = new aws.route53.HealthCheck("foo", {
    type: "CLOUDWATCH_METRIC",
    cloudwatchAlarmName: foobar.name,
    cloudwatchAlarmRegion: "us-west-2",
    insufficientDataHealthStatus: "Healthy",
});

    import pulumi
import pulumi_aws as aws

foobar = aws.cloudwatch.MetricAlarm("foobar",
    name="test-foobar5",
    comparison_operator="GreaterThanOrEqualToThreshold",
    evaluation_periods=2,
    metric_name="CPUUtilization",
    namespace="AWS/EC2",
    period=120,
    statistic="Average",
    threshold=80,
    alarm_description="This metric monitors ec2 cpu utilization")
foo = aws.route53.HealthCheck("foo",
    type="CLOUDWATCH_METRIC",
    cloudwatch_alarm_name=foobar.name,
    cloudwatch_alarm_region="us-west-2",
    insufficient_data_health_status="Healthy")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		foobar, err := cloudwatch.NewMetricAlarm(ctx, "foobar", &cloudwatch.MetricAlarmArgs{
			Name:               pulumi.String("test-foobar5"),
			ComparisonOperator: pulumi.String("GreaterThanOrEqualToThreshold"),
			EvaluationPeriods:  pulumi.Int(2),
			MetricName:         pulumi.String("CPUUtilization"),
			Namespace:          pulumi.String("AWS/EC2"),
			Period:             pulumi.Int(120),
			Statistic:          pulumi.String("Average"),
			Threshold:          pulumi.Float64(80),
			AlarmDescription:   pulumi.String("This metric monitors ec2 cpu utilization"),
		})
		if err != nil {
			return err
		}
		_, err = route53.NewHealthCheck(ctx, "foo", &route53.HealthCheckArgs{
			Type:                         pulumi.String("CLOUDWATCH_METRIC"),
			CloudwatchAlarmName:          foobar.Name,
			CloudwatchAlarmRegion:        pulumi.String("us-west-2"),
			InsufficientDataHealthStatus: pulumi.String("Healthy"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var foobar = new Aws.CloudWatch.MetricAlarm("foobar", new()
    {
        Name = "test-foobar5",
        ComparisonOperator = "GreaterThanOrEqualToThreshold",
        EvaluationPeriods = 2,
        MetricName = "CPUUtilization",
        Namespace = "AWS/EC2",
        Period = 120,
        Statistic = "Average",
        Threshold = 80,
        AlarmDescription = "This metric monitors ec2 cpu utilization",
    });

    var foo = new Aws.Route53.HealthCheck("foo", new()
    {
        Type = "CLOUDWATCH_METRIC",
        CloudwatchAlarmName = foobar.Name,
        CloudwatchAlarmRegion = "us-west-2",
        InsufficientDataHealthStatus = "Healthy",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.MetricAlarm;
import com.pulumi.aws.cloudwatch.MetricAlarmArgs;
import com.pulumi.aws.route53.HealthCheck;
import com.pulumi.aws.route53.HealthCheckArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var foobar = new MetricAlarm("foobar", MetricAlarmArgs.builder()
            .name("test-foobar5")
            .comparisonOperator("GreaterThanOrEqualToThreshold")
            .evaluationPeriods("2")
            .metricName("CPUUtilization")
            .namespace("AWS/EC2")
            .period("120")
            .statistic("Average")
            .threshold("80")
            .alarmDescription("This metric monitors ec2 cpu utilization")
            .build());

        var foo = new HealthCheck("foo", HealthCheckArgs.builder()
            .type("CLOUDWATCH_METRIC")
            .cloudwatchAlarmName(foobar.name())
            .cloudwatchAlarmRegion("us-west-2")
            .insufficientDataHealthStatus("Healthy")
            .build());

    }
}

    resources:
  foobar:
    type: aws:cloudwatch:MetricAlarm
    properties:
      name: test-foobar5
      comparisonOperator: GreaterThanOrEqualToThreshold
      evaluationPeriods: '2'
      metricName: CPUUtilization
      namespace: AWS/EC2
      period: '120'
      statistic: Average
      threshold: '80'
      alarmDescription: This metric monitors ec2 cpu utilization
  foo:
    type: aws:route53:HealthCheck
    properties:
      type: CLOUDWATCH_METRIC
      cloudwatchAlarmName: ${foobar.name}
      cloudwatchAlarmRegion: us-west-2
      insufficientDataHealthStatus: Healthy

    Create HealthCheck Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new HealthCheck(name: string, args: HealthCheckArgs, opts?: CustomResourceOptions);
    @overload
def HealthCheck(resource_name: str,
                args: HealthCheckArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def HealthCheck(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                type: Optional[str] = None,
                ip_address: Optional[str] = None,
                search_string: Optional[str] = None,
                cloudwatch_alarm_region: Optional[str] = None,
                disabled: Optional[bool] = None,
                enable_sni: Optional[bool] = None,
                failure_threshold: Optional[int] = None,
                fqdn: Optional[str] = None,
                measure_latency: Optional[bool] = None,
                child_healthchecks: Optional[Sequence[str]] = None,
                cloudwatch_alarm_name: Optional[str] = None,
                insufficient_data_health_status: Optional[str] = None,
                port: Optional[int] = None,
                reference_name: Optional[str] = None,
                regions: Optional[Sequence[str]] = None,
                request_interval: Optional[int] = None,
                resource_path: Optional[str] = None,
                routing_control_arn: Optional[str] = None,
                child_health_threshold: Optional[int] = None,
                tags: Optional[Mapping[str, str]] = None,
                invert_healthcheck: Optional[bool] = None)
    func NewHealthCheck(ctx *Context, name string, args HealthCheckArgs, opts ...ResourceOption) (*HealthCheck, error)
    public HealthCheck(string name, HealthCheckArgs args, CustomResourceOptions? opts = null)
    public HealthCheck(String name, HealthCheckArgs args)
public HealthCheck(String name, HealthCheckArgs args, CustomResourceOptions options)

    type: aws:route53:HealthCheck
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args HealthCheckArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args HealthCheckArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args HealthCheckArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HealthCheckArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HealthCheckArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var healthCheckResource = new Aws.Route53.HealthCheck("healthCheckResource", new()
{
    Type = "string",
    IpAddress = "string",
    SearchString = "string",
    CloudwatchAlarmRegion = "string",
    Disabled = false,
    EnableSni = false,
    FailureThreshold = 0,
    Fqdn = "string",
    MeasureLatency = false,
    ChildHealthchecks = new[]
    {
        "string",
    },
    CloudwatchAlarmName = "string",
    InsufficientDataHealthStatus = "string",
    Port = 0,
    ReferenceName = "string",
    Regions = new[]
    {
        "string",
    },
    RequestInterval = 0,
    ResourcePath = "string",
    RoutingControlArn = "string",
    ChildHealthThreshold = 0,
    Tags = 
    {
        { "string", "string" },
    },
    InvertHealthcheck = false,
});

    example, err := route53.NewHealthCheck(ctx, "healthCheckResource", &route53.HealthCheckArgs{
	Type:                  pulumi.String("string"),
	IpAddress:             pulumi.String("string"),
	SearchString:          pulumi.String("string"),
	CloudwatchAlarmRegion: pulumi.String("string"),
	Disabled:              pulumi.Bool(false),
	EnableSni:             pulumi.Bool(false),
	FailureThreshold:      pulumi.Int(0),
	Fqdn:                  pulumi.String("string"),
	MeasureLatency:        pulumi.Bool(false),
	ChildHealthchecks: pulumi.StringArray{
		pulumi.String("string"),
	},
	CloudwatchAlarmName:          pulumi.String("string"),
	InsufficientDataHealthStatus: pulumi.String("string"),
	Port:                         pulumi.Int(0),
	ReferenceName:                pulumi.String("string"),
	Regions: pulumi.StringArray{
		pulumi.String("string"),
	},
	RequestInterval:      pulumi.Int(0),
	ResourcePath:         pulumi.String("string"),
	RoutingControlArn:    pulumi.String("string"),
	ChildHealthThreshold: pulumi.Int(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	InvertHealthcheck: pulumi.Bool(false),
})

    var healthCheckResource = new HealthCheck("healthCheckResource", HealthCheckArgs.builder()
    .type("string")
    .ipAddress("string")
    .searchString("string")
    .cloudwatchAlarmRegion("string")
    .disabled(false)
    .enableSni(false)
    .failureThreshold(0)
    .fqdn("string")
    .measureLatency(false)
    .childHealthchecks("string")
    .cloudwatchAlarmName("string")
    .insufficientDataHealthStatus("string")
    .port(0)
    .referenceName("string")
    .regions("string")
    .requestInterval(0)
    .resourcePath("string")
    .routingControlArn("string")
    .childHealthThreshold(0)
    .tags(Map.of("string", "string"))
    .invertHealthcheck(false)
    .build());

    health_check_resource = aws.route53.HealthCheck("healthCheckResource",
    type="string",
    ip_address="string",
    search_string="string",
    cloudwatch_alarm_region="string",
    disabled=False,
    enable_sni=False,
    failure_threshold=0,
    fqdn="string",
    measure_latency=False,
    child_healthchecks=["string"],
    cloudwatch_alarm_name="string",
    insufficient_data_health_status="string",
    port=0,
    reference_name="string",
    regions=["string"],
    request_interval=0,
    resource_path="string",
    routing_control_arn="string",
    child_health_threshold=0,
    tags={
        "string": "string",
    },
    invert_healthcheck=False)

    const healthCheckResource = new aws.route53.HealthCheck("healthCheckResource", {
    type: "string",
    ipAddress: "string",
    searchString: "string",
    cloudwatchAlarmRegion: "string",
    disabled: false,
    enableSni: false,
    failureThreshold: 0,
    fqdn: "string",
    measureLatency: false,
    childHealthchecks: ["string"],
    cloudwatchAlarmName: "string",
    insufficientDataHealthStatus: "string",
    port: 0,
    referenceName: "string",
    regions: ["string"],
    requestInterval: 0,
    resourcePath: "string",
    routingControlArn: "string",
    childHealthThreshold: 0,
    tags: {
        string: "string",
    },
    invertHealthcheck: false,
});

    type: aws:route53:HealthCheck
properties:
    childHealthThreshold: 0
    childHealthchecks:
        - string
    cloudwatchAlarmName: string
    cloudwatchAlarmRegion: string
    disabled: false
    enableSni: false
    failureThreshold: 0
    fqdn: string
    insufficientDataHealthStatus: string
    invertHealthcheck: false
    ipAddress: string
    measureLatency: false
    port: 0
    referenceName: string
    regions:
        - string
    requestInterval: 0
    resourcePath: string
    routingControlArn: string
    searchString: string
    tags:
        string: string
    type: string

    HealthCheck Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The HealthCheck resource accepts the following input properties:

    Type string
    The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC and RECOVERY_CONTROL.
    ChildHealthThreshold int
    The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
    ChildHealthchecks List<string>
    For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
    CloudwatchAlarmName string
    The name of the CloudWatch alarm.
    CloudwatchAlarmRegion string
    The CloudWatchRegion that the CloudWatch alarm was created in.
    Disabled bool

    A boolean value that stops Route 53 from performing health checks. When set to true, Route 53 will do the following depending on the type of health check:

    • For health checks that check the health of endpoints, Route5 53 stops submitting requests to your application, server, or other resource.
    • For calculated health checks, Route 53 stops aggregating the status of the referenced health checks.
    • For health checks that monitor CloudWatch alarms, Route 53 stops monitoring the corresponding CloudWatch metrics.

    Note: After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of invert_healthcheck.

    EnableSni bool
    A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS' defaults: when the type is "HTTPS" enable_sni defaults to true, when type is anything else enable_sni defaults to false.
    FailureThreshold int
    The number of consecutive health checks that an endpoint must pass or fail.
    Fqdn string
    The fully qualified domain name of the endpoint to be checked. If a value is set for ip_address, the value set for fqdn will be passed in the Host header.
    InsufficientDataHealthStatus string
    The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
    InvertHealthcheck bool
    A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
    IpAddress string
    The IP address of the endpoint to be checked.
    MeasureLatency bool
    A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
    Port int
    The port of the endpoint to be checked.
    ReferenceName string
    This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
    Regions List<string>
    A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
    RequestInterval int
    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
    ResourcePath string
    The path that you want Amazon Route 53 to request when performing health checks.
    RoutingControlArn string
    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL
    SearchString string
    String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
    Tags Dictionary<string, string>
    A map of tags to assign to the health check. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Type string
    The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC and RECOVERY_CONTROL.
    ChildHealthThreshold int
    The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
    ChildHealthchecks []string
    For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
    CloudwatchAlarmName string
    The name of the CloudWatch alarm.
    CloudwatchAlarmRegion string
    The CloudWatchRegion that the CloudWatch alarm was created in.
    Disabled bool

    A boolean value that stops Route 53 from performing health checks. When set to true, Route 53 will do the following depending on the type of health check:

    • For health checks that check the health of endpoints, Route5 53 stops submitting requests to your application, server, or other resource.
    • For calculated health checks, Route 53 stops aggregating the status of the referenced health checks.
    • For health checks that monitor CloudWatch alarms, Route 53 stops monitoring the corresponding CloudWatch metrics.

    Note: After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of invert_healthcheck.

    EnableSni bool
    A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS' defaults: when the type is "HTTPS" enable_sni defaults to true, when type is anything else enable_sni defaults to false.
    FailureThreshold int
    The number of consecutive health checks that an endpoint must pass or fail.
    Fqdn string
    The fully qualified domain name of the endpoint to be checked. If a value is set for ip_address, the value set for fqdn will be passed in the Host header.
    InsufficientDataHealthStatus string
    The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
    InvertHealthcheck bool
    A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
    IpAddress string
    The IP address of the endpoint to be checked.
    MeasureLatency bool
    A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
    Port int
    The port of the endpoint to be checked.
    ReferenceName string
    This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
    Regions []string
    A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
    RequestInterval int
    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
    ResourcePath string
    The path that you want Amazon Route 53 to request when performing health checks.
    RoutingControlArn string
    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL
    SearchString string
    String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
    Tags map[string]string
    A map of tags to assign to the health check. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type String
    The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC and RECOVERY_CONTROL.
    childHealthThreshold Integer
    The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
    childHealthchecks List<String>
    For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
    cloudwatchAlarmName String
    The name of the CloudWatch alarm.
    cloudwatchAlarmRegion String
    The CloudWatchRegion that the CloudWatch alarm was created in.
    disabled Boolean

    A boolean value that stops Route 53 from performing health checks. When set to true, Route 53 will do the following depending on the type of health check:

    • For health checks that check the health of endpoints, Route5 53 stops submitting requests to your application, server, or other resource.
    • For calculated health checks, Route 53 stops aggregating the status of the referenced health checks.
    • For health checks that monitor CloudWatch alarms, Route 53 stops monitoring the corresponding CloudWatch metrics.

    Note: After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of invert_healthcheck.

    enableSni Boolean
    A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS' defaults: when the type is "HTTPS" enable_sni defaults to true, when type is anything else enable_sni defaults to false.
    failureThreshold Integer
    The number of consecutive health checks that an endpoint must pass or fail.
    fqdn String
    The fully qualified domain name of the endpoint to be checked. If a value is set for ip_address, the value set for fqdn will be passed in the Host header.
    insufficientDataHealthStatus String
    The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
    invertHealthcheck Boolean
    A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
    ipAddress String
    The IP address of the endpoint to be checked.
    measureLatency Boolean
    A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
    port Integer
    The port of the endpoint to be checked.
    referenceName String
    This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
    regions List<String>
    A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
    requestInterval Integer
    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
    resourcePath String
    The path that you want Amazon Route 53 to request when performing health checks.
    routingControlArn String
    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL
    searchString String
    String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
    tags Map<String,String>
    A map of tags to assign to the health check. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type string
    The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC and RECOVERY_CONTROL.
    childHealthThreshold number
    The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
    childHealthchecks string[]
    For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
    cloudwatchAlarmName string
    The name of the CloudWatch alarm.
    cloudwatchAlarmRegion string
    The CloudWatchRegion that the CloudWatch alarm was created in.
    disabled boolean

    A boolean value that stops Route 53 from performing health checks. When set to true, Route 53 will do the following depending on the type of health check:

    • For health checks that check the health of endpoints, Route5 53 stops submitting requests to your application, server, or other resource.
    • For calculated health checks, Route 53 stops aggregating the status of the referenced health checks.
    • For health checks that monitor CloudWatch alarms, Route 53 stops monitoring the corresponding CloudWatch metrics.

    Note: After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of invert_healthcheck.

    enableSni boolean
    A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS' defaults: when the type is "HTTPS" enable_sni defaults to true, when type is anything else enable_sni defaults to false.
    failureThreshold number
    The number of consecutive health checks that an endpoint must pass or fail.
    fqdn string
    The fully qualified domain name of the endpoint to be checked. If a value is set for ip_address, the value set for fqdn will be passed in the Host header.
    insufficientDataHealthStatus string
    The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
    invertHealthcheck boolean
    A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
    ipAddress string
    The IP address of the endpoint to be checked.
    measureLatency boolean
    A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
    port number
    The port of the endpoint to be checked.
    referenceName string
    This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
    regions string[]
    A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
    requestInterval number
    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
    resourcePath string
    The path that you want Amazon Route 53 to request when performing health checks.
    routingControlArn string
    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL
    searchString string
    String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
    tags {[key: string]: string}
    A map of tags to assign to the health check. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type str
    The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC and RECOVERY_CONTROL.
    child_health_threshold int
    The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
    child_healthchecks Sequence[str]
    For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
    cloudwatch_alarm_name str
    The name of the CloudWatch alarm.
    cloudwatch_alarm_region str
    The CloudWatchRegion that the CloudWatch alarm was created in.
    disabled bool

    A boolean value that stops Route 53 from performing health checks. When set to true, Route 53 will do the following depending on the type of health check:

    • For health checks that check the health of endpoints, Route5 53 stops submitting requests to your application, server, or other resource.
    • For calculated health checks, Route 53 stops aggregating the status of the referenced health checks.
    • For health checks that monitor CloudWatch alarms, Route 53 stops monitoring the corresponding CloudWatch metrics.

    Note: After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of invert_healthcheck.

    enable_sni bool
    A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS' defaults: when the type is "HTTPS" enable_sni defaults to true, when type is anything else enable_sni defaults to false.
    failure_threshold int
    The number of consecutive health checks that an endpoint must pass or fail.
    fqdn str
    The fully qualified domain name of the endpoint to be checked. If a value is set for ip_address, the value set for fqdn will be passed in the Host header.
    insufficient_data_health_status str
    The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
    invert_healthcheck bool
    A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
    ip_address str
    The IP address of the endpoint to be checked.
    measure_latency bool
    A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
    port int
    The port of the endpoint to be checked.
    reference_name str
    This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
    regions Sequence[str]
    A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
    request_interval int
    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
    resource_path str
    The path that you want Amazon Route 53 to request when performing health checks.
    routing_control_arn str
    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL
    search_string str
    String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
    tags Mapping[str, str]
    A map of tags to assign to the health check. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type String
    The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC and RECOVERY_CONTROL.
    childHealthThreshold Number
    The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
    childHealthchecks List<String>
    For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
    cloudwatchAlarmName String
    The name of the CloudWatch alarm.
    cloudwatchAlarmRegion String
    The CloudWatchRegion that the CloudWatch alarm was created in.
    disabled Boolean

    A boolean value that stops Route 53 from performing health checks. When set to true, Route 53 will do the following depending on the type of health check:

    • For health checks that check the health of endpoints, Route5 53 stops submitting requests to your application, server, or other resource.
    • For calculated health checks, Route 53 stops aggregating the status of the referenced health checks.
    • For health checks that monitor CloudWatch alarms, Route 53 stops monitoring the corresponding CloudWatch metrics.

    Note: After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of invert_healthcheck.

    enableSni Boolean
    A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS' defaults: when the type is "HTTPS" enable_sni defaults to true, when type is anything else enable_sni defaults to false.
    failureThreshold Number
    The number of consecutive health checks that an endpoint must pass or fail.
    fqdn String
    The fully qualified domain name of the endpoint to be checked. If a value is set for ip_address, the value set for fqdn will be passed in the Host header.
    insufficientDataHealthStatus String
    The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
    invertHealthcheck Boolean
    A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
    ipAddress String
    The IP address of the endpoint to be checked.
    measureLatency Boolean
    A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
    port Number
    The port of the endpoint to be checked.
    referenceName String
    This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
    regions List<String>
    A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
    requestInterval Number
    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
    resourcePath String
    The path that you want Amazon Route 53 to request when performing health checks.
    routingControlArn String
    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL
    searchString String
    String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
    tags Map<String>
    A map of tags to assign to the health check. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the HealthCheck resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the Health Check.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) of the Health Check.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the Health Check.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) of the Health Check.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) of the Health Check.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the Health Check.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing HealthCheck Resource

    Get an existing HealthCheck resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: HealthCheckState, opts?: CustomResourceOptions): HealthCheck
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        child_health_threshold: Optional[int] = None,
        child_healthchecks: Optional[Sequence[str]] = None,
        cloudwatch_alarm_name: Optional[str] = None,
        cloudwatch_alarm_region: Optional[str] = None,
        disabled: Optional[bool] = None,
        enable_sni: Optional[bool] = None,
        failure_threshold: Optional[int] = None,
        fqdn: Optional[str] = None,
        insufficient_data_health_status: Optional[str] = None,
        invert_healthcheck: Optional[bool] = None,
        ip_address: Optional[str] = None,
        measure_latency: Optional[bool] = None,
        port: Optional[int] = None,
        reference_name: Optional[str] = None,
        regions: Optional[Sequence[str]] = None,
        request_interval: Optional[int] = None,
        resource_path: Optional[str] = None,
        routing_control_arn: Optional[str] = None,
        search_string: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None) -> HealthCheck
    func GetHealthCheck(ctx *Context, name string, id IDInput, state *HealthCheckState, opts ...ResourceOption) (*HealthCheck, error)
    public static HealthCheck Get(string name, Input<string> id, HealthCheckState? state, CustomResourceOptions? opts = null)
    public static HealthCheck get(String name, Output<String> id, HealthCheckState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name (ARN) of the Health Check.
    ChildHealthThreshold int
    The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
    ChildHealthchecks List<string>
    For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
    CloudwatchAlarmName string
    The name of the CloudWatch alarm.
    CloudwatchAlarmRegion string
    The CloudWatchRegion that the CloudWatch alarm was created in.
    Disabled bool

    A boolean value that stops Route 53 from performing health checks. When set to true, Route 53 will do the following depending on the type of health check:

    • For health checks that check the health of endpoints, Route5 53 stops submitting requests to your application, server, or other resource.
    • For calculated health checks, Route 53 stops aggregating the status of the referenced health checks.
    • For health checks that monitor CloudWatch alarms, Route 53 stops monitoring the corresponding CloudWatch metrics.

    Note: After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of invert_healthcheck.

    EnableSni bool
    A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS' defaults: when the type is "HTTPS" enable_sni defaults to true, when type is anything else enable_sni defaults to false.
    FailureThreshold int
    The number of consecutive health checks that an endpoint must pass or fail.
    Fqdn string
    The fully qualified domain name of the endpoint to be checked. If a value is set for ip_address, the value set for fqdn will be passed in the Host header.
    InsufficientDataHealthStatus string
    The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
    InvertHealthcheck bool
    A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
    IpAddress string
    The IP address of the endpoint to be checked.
    MeasureLatency bool
    A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
    Port int
    The port of the endpoint to be checked.
    ReferenceName string
    This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
    Regions List<string>
    A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
    RequestInterval int
    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
    ResourcePath string
    The path that you want Amazon Route 53 to request when performing health checks.
    RoutingControlArn string
    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL
    SearchString string
    String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
    Tags Dictionary<string, string>
    A map of tags to assign to the health check. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Type string
    The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC and RECOVERY_CONTROL.
    Arn string
    The Amazon Resource Name (ARN) of the Health Check.
    ChildHealthThreshold int
    The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
    ChildHealthchecks []string
    For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
    CloudwatchAlarmName string
    The name of the CloudWatch alarm.
    CloudwatchAlarmRegion string
    The CloudWatchRegion that the CloudWatch alarm was created in.
    Disabled bool

    A boolean value that stops Route 53 from performing health checks. When set to true, Route 53 will do the following depending on the type of health check:

    • For health checks that check the health of endpoints, Route5 53 stops submitting requests to your application, server, or other resource.
    • For calculated health checks, Route 53 stops aggregating the status of the referenced health checks.
    • For health checks that monitor CloudWatch alarms, Route 53 stops monitoring the corresponding CloudWatch metrics.

    Note: After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of invert_healthcheck.

    EnableSni bool
    A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS' defaults: when the type is "HTTPS" enable_sni defaults to true, when type is anything else enable_sni defaults to false.
    FailureThreshold int
    The number of consecutive health checks that an endpoint must pass or fail.
    Fqdn string
    The fully qualified domain name of the endpoint to be checked. If a value is set for ip_address, the value set for fqdn will be passed in the Host header.
    InsufficientDataHealthStatus string
    The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
    InvertHealthcheck bool
    A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
    IpAddress string
    The IP address of the endpoint to be checked.
    MeasureLatency bool
    A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
    Port int
    The port of the endpoint to be checked.
    ReferenceName string
    This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
    Regions []string
    A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
    RequestInterval int
    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
    ResourcePath string
    The path that you want Amazon Route 53 to request when performing health checks.
    RoutingControlArn string
    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL
    SearchString string
    String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
    Tags map[string]string
    A map of tags to assign to the health check. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Type string
    The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC and RECOVERY_CONTROL.
    arn String
    The Amazon Resource Name (ARN) of the Health Check.
    childHealthThreshold Integer
    The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
    childHealthchecks List<String>
    For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
    cloudwatchAlarmName String
    The name of the CloudWatch alarm.
    cloudwatchAlarmRegion String
    The CloudWatchRegion that the CloudWatch alarm was created in.
    disabled Boolean

    A boolean value that stops Route 53 from performing health checks. When set to true, Route 53 will do the following depending on the type of health check:

    • For health checks that check the health of endpoints, Route5 53 stops submitting requests to your application, server, or other resource.
    • For calculated health checks, Route 53 stops aggregating the status of the referenced health checks.
    • For health checks that monitor CloudWatch alarms, Route 53 stops monitoring the corresponding CloudWatch metrics.

    Note: After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of invert_healthcheck.

    enableSni Boolean
    A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS' defaults: when the type is "HTTPS" enable_sni defaults to true, when type is anything else enable_sni defaults to false.
    failureThreshold Integer
    The number of consecutive health checks that an endpoint must pass or fail.
    fqdn String
    The fully qualified domain name of the endpoint to be checked. If a value is set for ip_address, the value set for fqdn will be passed in the Host header.
    insufficientDataHealthStatus String
    The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
    invertHealthcheck Boolean
    A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
    ipAddress String
    The IP address of the endpoint to be checked.
    measureLatency Boolean
    A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
    port Integer
    The port of the endpoint to be checked.
    referenceName String
    This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
    regions List<String>
    A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
    requestInterval Integer
    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
    resourcePath String
    The path that you want Amazon Route 53 to request when performing health checks.
    routingControlArn String
    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL
    searchString String
    String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
    tags Map<String,String>
    A map of tags to assign to the health check. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type String
    The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC and RECOVERY_CONTROL.
    arn string
    The Amazon Resource Name (ARN) of the Health Check.
    childHealthThreshold number
    The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
    childHealthchecks string[]
    For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
    cloudwatchAlarmName string
    The name of the CloudWatch alarm.
    cloudwatchAlarmRegion string
    The CloudWatchRegion that the CloudWatch alarm was created in.
    disabled boolean

    A boolean value that stops Route 53 from performing health checks. When set to true, Route 53 will do the following depending on the type of health check:

    • For health checks that check the health of endpoints, Route5 53 stops submitting requests to your application, server, or other resource.
    • For calculated health checks, Route 53 stops aggregating the status of the referenced health checks.
    • For health checks that monitor CloudWatch alarms, Route 53 stops monitoring the corresponding CloudWatch metrics.

    Note: After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of invert_healthcheck.

    enableSni boolean
    A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS' defaults: when the type is "HTTPS" enable_sni defaults to true, when type is anything else enable_sni defaults to false.
    failureThreshold number
    The number of consecutive health checks that an endpoint must pass or fail.
    fqdn string
    The fully qualified domain name of the endpoint to be checked. If a value is set for ip_address, the value set for fqdn will be passed in the Host header.
    insufficientDataHealthStatus string
    The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
    invertHealthcheck boolean
    A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
    ipAddress string
    The IP address of the endpoint to be checked.
    measureLatency boolean
    A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
    port number
    The port of the endpoint to be checked.
    referenceName string
    This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
    regions string[]
    A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
    requestInterval number
    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
    resourcePath string
    The path that you want Amazon Route 53 to request when performing health checks.
    routingControlArn string
    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL
    searchString string
    String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
    tags {[key: string]: string}
    A map of tags to assign to the health check. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type string
    The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC and RECOVERY_CONTROL.
    arn str
    The Amazon Resource Name (ARN) of the Health Check.
    child_health_threshold int
    The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
    child_healthchecks Sequence[str]
    For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
    cloudwatch_alarm_name str
    The name of the CloudWatch alarm.
    cloudwatch_alarm_region str
    The CloudWatchRegion that the CloudWatch alarm was created in.
    disabled bool

    A boolean value that stops Route 53 from performing health checks. When set to true, Route 53 will do the following depending on the type of health check:

    • For health checks that check the health of endpoints, Route5 53 stops submitting requests to your application, server, or other resource.
    • For calculated health checks, Route 53 stops aggregating the status of the referenced health checks.
    • For health checks that monitor CloudWatch alarms, Route 53 stops monitoring the corresponding CloudWatch metrics.

    Note: After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of invert_healthcheck.

    enable_sni bool
    A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS' defaults: when the type is "HTTPS" enable_sni defaults to true, when type is anything else enable_sni defaults to false.
    failure_threshold int
    The number of consecutive health checks that an endpoint must pass or fail.
    fqdn str
    The fully qualified domain name of the endpoint to be checked. If a value is set for ip_address, the value set for fqdn will be passed in the Host header.
    insufficient_data_health_status str
    The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
    invert_healthcheck bool
    A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
    ip_address str
    The IP address of the endpoint to be checked.
    measure_latency bool
    A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
    port int
    The port of the endpoint to be checked.
    reference_name str
    This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
    regions Sequence[str]
    A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
    request_interval int
    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
    resource_path str
    The path that you want Amazon Route 53 to request when performing health checks.
    routing_control_arn str
    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL
    search_string str
    String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
    tags Mapping[str, str]
    A map of tags to assign to the health check. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type str
    The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC and RECOVERY_CONTROL.
    arn String
    The Amazon Resource Name (ARN) of the Health Check.
    childHealthThreshold Number
    The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
    childHealthchecks List<String>
    For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
    cloudwatchAlarmName String
    The name of the CloudWatch alarm.
    cloudwatchAlarmRegion String
    The CloudWatchRegion that the CloudWatch alarm was created in.
    disabled Boolean

    A boolean value that stops Route 53 from performing health checks. When set to true, Route 53 will do the following depending on the type of health check:

    • For health checks that check the health of endpoints, Route5 53 stops submitting requests to your application, server, or other resource.
    • For calculated health checks, Route 53 stops aggregating the status of the referenced health checks.
    • For health checks that monitor CloudWatch alarms, Route 53 stops monitoring the corresponding CloudWatch metrics.

    Note: After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of invert_healthcheck.

    enableSni Boolean
    A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS' defaults: when the type is "HTTPS" enable_sni defaults to true, when type is anything else enable_sni defaults to false.
    failureThreshold Number
    The number of consecutive health checks that an endpoint must pass or fail.
    fqdn String
    The fully qualified domain name of the endpoint to be checked. If a value is set for ip_address, the value set for fqdn will be passed in the Host header.
    insufficientDataHealthStatus String
    The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
    invertHealthcheck Boolean
    A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
    ipAddress String
    The IP address of the endpoint to be checked.
    measureLatency Boolean
    A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
    port Number
    The port of the endpoint to be checked.
    referenceName String
    This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
    regions List<String>
    A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
    requestInterval Number
    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
    resourcePath String
    The path that you want Amazon Route 53 to request when performing health checks.
    routingControlArn String
    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL
    searchString String
    String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
    tags Map<String>
    A map of tags to assign to the health check. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type String
    The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC and RECOVERY_CONTROL.

    Import

    Using pulumi import, import Route53 Health Checks using the health check id. For example:

    $ pulumi import aws:route53/healthCheck:HealthCheck http_check abcdef11-2222-3333-4444-555555fedcba

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws