Package software.amazon.awssdk.services.elasticloadbalancingv2.model

Interface ModifyTargetGroupRequest.Builder

    • Method Detail

      • targetGroupArn

        ModifyTargetGroupRequest.Builder targetGroupArn​(String targetGroupArn)

        The Amazon Resource Name (ARN) of the target group.

        Parameters:
        targetGroupArn - The Amazon Resource Name (ARN) of the target group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • healthCheckProtocol

        ModifyTargetGroupRequest.Builder healthCheckProtocol​(String healthCheckProtocol)

        The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

        Parameters:
        healthCheckProtocol - The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProtocolEnum, ProtocolEnum

      • healthCheckProtocol

        ModifyTargetGroupRequest.Builder healthCheckProtocol​(ProtocolEnum healthCheckProtocol)

        The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

        Parameters:
        healthCheckProtocol - The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProtocolEnum, ProtocolEnum

      • healthCheckPort

        ModifyTargetGroupRequest.Builder healthCheckPort​(String healthCheckPort)

        The port the load balancer uses when performing health checks on targets.

        Parameters:
        healthCheckPort - The port the load balancer uses when performing health checks on targets.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • healthCheckPath

        ModifyTargetGroupRequest.Builder healthCheckPath​(String healthCheckPath)

        [HTTP/HTTPS health checks] The destination for health checks on the targets.

        [HTTP1 or HTTP2 protocol version] The ping path. The default is /.

        [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.

        Parameters:
        healthCheckPath - [HTTP/HTTPS health checks] The destination for health checks on the targets.

        [HTTP1 or HTTP2 protocol version] The ping path. The default is /.

        [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • healthCheckEnabled

        ModifyTargetGroupRequest.Builder healthCheckEnabled​(Boolean healthCheckEnabled)

        Indicates whether health checks are enabled.

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

      • healthCheckIntervalSeconds

        ModifyTargetGroupRequest.Builder healthCheckIntervalSeconds​(Integer healthCheckIntervalSeconds)

        The approximate amount of time, in seconds, between health checks of an individual target.

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

      • healthCheckTimeoutSeconds

        ModifyTargetGroupRequest.Builder healthCheckTimeoutSeconds​(Integer healthCheckTimeoutSeconds)

        [HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.

        Parameters:
        healthCheckTimeoutSeconds - [HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • healthyThresholdCount

        ModifyTargetGroupRequest.Builder healthyThresholdCount​(Integer healthyThresholdCount)

        The number of consecutive health checks successes required before considering an unhealthy target healthy.

        Parameters:
        healthyThresholdCount - The number of consecutive health checks successes required before considering an unhealthy target healthy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • unhealthyThresholdCount

        ModifyTargetGroupRequest.Builder unhealthyThresholdCount​(Integer unhealthyThresholdCount)

        The number of consecutive health check failures required before considering the target unhealthy.

        Parameters:
        unhealthyThresholdCount - The number of consecutive health check failures required before considering the target unhealthy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • matcher

        ModifyTargetGroupRequest.Builder matcher​(Matcher matcher)

        [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.

        Parameters:
        matcher - [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • matcher

        default ModifyTargetGroupRequest.Builder matcher​(Consumer<Matcher.Builder> matcher)

        [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.

        This is a convenience method that creates an instance of the Matcher.Builder avoiding the need to create one manually via Matcher.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to matcher(Matcher).

        Parameters:
        matcher - a consumer that will call methods on Matcher.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        matcher(Matcher)