Package software.amazon.awssdk.services.vpclattice.model

Interface HealthCheckConfig.Builder

    • Method Detail

      • enabled

        HealthCheckConfig.Builder enabled​(Boolean enabled)

        Indicates whether health checking is enabled.

        Parameters:
        enabled - Indicates whether health checking is enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • healthCheckIntervalSeconds

        HealthCheckConfig.Builder healthCheckIntervalSeconds​(Integer healthCheckIntervalSeconds)

        The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

        Parameters:
        healthCheckIntervalSeconds - The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • healthCheckTimeoutSeconds

        HealthCheckConfig.Builder healthCheckTimeoutSeconds​(Integer healthCheckTimeoutSeconds)

        The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

        Parameters:
        healthCheckTimeoutSeconds - The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • healthyThresholdCount

        HealthCheckConfig.Builder healthyThresholdCount​(Integer healthyThresholdCount)

        The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

        Parameters:
        healthyThresholdCount - The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • matcher

        HealthCheckConfig.Builder matcher​(Matcher matcher)

        The codes to use when checking for a successful response from a target. These are called Success codes in the console.

        Parameters:
        matcher - The codes to use when checking for a successful response from a target. These are called Success codes in the console.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • path

        HealthCheckConfig.Builder path​(String path)

        The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

        Parameters:
        path - The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • port

        HealthCheckConfig.Builder port​(Integer port)

        The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

        Parameters:
        port - The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • protocol

        HealthCheckConfig.Builder protocol​(String protocol)

        The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

        Parameters:
        protocol - The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TargetGroupProtocol, TargetGroupProtocol

      • protocol

        HealthCheckConfig.Builder protocol​(TargetGroupProtocol protocol)

        The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

        Parameters:
        protocol - The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TargetGroupProtocol, TargetGroupProtocol

      • protocolVersion

        HealthCheckConfig.Builder protocolVersion​(String protocolVersion)

        The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

        Parameters:
        protocolVersion - The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HealthCheckProtocolVersion, HealthCheckProtocolVersion

      • protocolVersion

        HealthCheckConfig.Builder protocolVersion​(HealthCheckProtocolVersion protocolVersion)

        The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

        Parameters:
        protocolVersion - The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HealthCheckProtocolVersion, HealthCheckProtocolVersion

      • unhealthyThresholdCount

        HealthCheckConfig.Builder unhealthyThresholdCount​(Integer unhealthyThresholdCount)

        The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

        Parameters:
        unhealthyThresholdCount - The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
        Returns:
        Returns a reference to this object so that method calls can be chained together.