Package com.pulumi.aws.route53

Class HealthCheckArgs

  • public final class HealthCheckArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HealthCheckArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static HealthCheckArgs.Builder builder()  
      static HealthCheckArgs.Builder builder​(HealthCheckArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> childHealthchecks()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> childHealthThreshold()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> cloudwatchAlarmName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> cloudwatchAlarmRegion()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> disabled()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableSni()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> failureThreshold()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> fqdn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> insufficientDataHealthStatus()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> invertHealthcheck()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> ipAddress()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> measureLatency()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> referenceName()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> regions()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> requestInterval()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> resourcePath()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> routingControlArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> searchString()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.lang.String> type()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • childHealthThreshold

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> childHealthThreshold()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> childHealthchecks()
        Returns:
        For a specified parent health check, a list of HealthCheckId values for the associated child health checks.

      • cloudwatchAlarmName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> cloudwatchAlarmName()
        Returns:
        The name of the CloudWatch alarm.

      • cloudwatchAlarmRegion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> cloudwatchAlarmRegion()
        Returns:
        The CloudWatchRegion that the CloudWatch alarm was created in.

      • disabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> disabled()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableSni()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> failureThreshold()
        Returns:
        The number of consecutive health checks that an endpoint must pass or fail.

      • fqdn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> fqdn()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> insufficientDataHealthStatus()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> invertHealthcheck()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> ipAddress()
        Returns:
        The IP address of the endpoint to be checked.

      • measureLatency

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> measureLatency()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()
        Returns:
        The port of the endpoint to be checked.

      • referenceName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> referenceName()
        Returns:
        This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)

      • regions

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> regions()
        Returns:
        A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.

      • requestInterval

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> requestInterval()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> resourcePath()
        Returns:
        The path that you want Amazon Route 53 to request when performing health checks.

      • routingControlArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> routingControlArn()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> searchString()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        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`.