pulumi-aws-kotlin/com.pulumi.aws.route53.kotlin/HealthCheckArgs

HealthCheckArgs

data class HealthCheckArgs(val childHealthThreshold: Output<Int>? = null, val childHealthchecks: Output<List<String>>? = null, val cloudwatchAlarmName: Output<String>? = null, val cloudwatchAlarmRegion: Output<String>? = null, val disabled: Output<Boolean>? = null, val enableSni: Output<Boolean>? = null, val failureThreshold: Output<Int>? = null, val fqdn: Output<String>? = null, val insufficientDataHealthStatus: Output<String>? = null, val invertHealthcheck: Output<Boolean>? = null, val ipAddress: Output<String>? = null, val measureLatency: Output<Boolean>? = null, val port: Output<Int>? = null, val referenceName: Output<String>? = null, val regions: Output<List<String>>? = null, val requestInterval: Output<Int>? = null, val resourcePath: Output<String>? = null, val routingControlArn: Output<String>? = null, val searchString: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val type: Output<String>? = null) : ConvertibleToJava<HealthCheckArgs>

Provides a Route53 health check.

Example Usage

Connectivity and HTTP Status Code 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()
            .failureThreshold("5")
            .fqdn("example.com")
            .port(80)
            .requestInterval("30")
            .resourcePath("/")
            .tags(Map.of("Name", "tf-test-health-check"))
            .type("HTTP")
            .build());
    }
}
Content copied to clipboard

Connectivity and String Matching 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()
            .failureThreshold("5")
            .fqdn("example.com")
            .port(443)
            .requestInterval("30")
            .resourcePath("/")
            .searchString("example")
            .type("HTTPS_STR_MATCH")
            .build());
    }
}
Content copied to clipboard

Aggregate 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(aws_route53_health_check.child().id())
            .tags(Map.of("Name", "tf-test-calculated-health-check"))
            .build());
    }
}
Content copied to clipboard

CloudWatch Alarm Check

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()
            .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());
    }
}
Content copied to clipboard

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
Content copied to clipboard

Constructors

Link copied to clipboard
fun HealthCheckArgs(childHealthThreshold: Output<Int>? = null, childHealthchecks: Output<List<String>>? = null, cloudwatchAlarmName: Output<String>? = null, cloudwatchAlarmRegion: Output<String>? = null, disabled: Output<Boolean>? = null, enableSni: Output<Boolean>? = null, failureThreshold: Output<Int>? = null, fqdn: Output<String>? = null, insufficientDataHealthStatus: Output<String>? = null, invertHealthcheck: Output<Boolean>? = null, ipAddress: Output<String>? = null, measureLatency: Output<Boolean>? = null, port: Output<Int>? = null, referenceName: Output<String>? = null, regions: Output<List<String>>? = null, requestInterval: Output<Int>? = null, resourcePath: Output<String>? = null, routingControlArn: Output<String>? = null, searchString: Output<String>? = null, tags: Output<Map<String, String>>? = null, type: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): HealthCheckArgs

Properties

Link copied to clipboard
val childHealthchecks: Output<List<String>>? = null

For a specified parent health check, a list of HealthCheckId values for the associated child health checks.

Link copied to clipboard
val childHealthThreshold: Output<Int>? = null

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

Link copied to clipboard
val cloudwatchAlarmName: Output<String>? = null

The name of the CloudWatch alarm.

Link copied to clipboard
val cloudwatchAlarmRegion: Output<String>? = null

The CloudWatchRegion that the CloudWatch alarm was created in.

Link copied to clipboard
val disabled: Output<Boolean>? = null

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:

Link copied to clipboard
val enableSni: Output<Boolean>? = null

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.

Link copied to clipboard
val failureThreshold: Output<Int>? = null

The number of consecutive health checks that an endpoint must pass or fail.

Link copied to clipboard
val fqdn: Output<String>? = null

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.

Link copied to clipboard
val insufficientDataHealthStatus: Output<String>? = null

The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.

Link copied to clipboard
val invertHealthcheck: Output<Boolean>? = null

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.

Link copied to clipboard
val ipAddress: Output<String>? = null

The IP address of the endpoint to be checked.

Link copied to clipboard
val measureLatency: Output<Boolean>? = null

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.

Link copied to clipboard
val port: Output<Int>? = null

The port of the endpoint to be checked.

Link copied to clipboard
val referenceName: Output<String>? = null

This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)

Link copied to clipboard
val regions: Output<List<String>>? = null

A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.

Link copied to clipboard
val requestInterval: Output<Int>? = null

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.

Link copied to clipboard
val resourcePath: Output<String>? = null

The path that you want Amazon Route 53 to request when performing health checks.

Link copied to clipboard
val routingControlArn: Output<String>? = null

The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL

Link copied to clipboard
val searchString: Output<String>? = null

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.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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.

Link copied to clipboard
val type: Output<String>? = null

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.