Interface ModifyTargetGroupRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ModifyTargetGroupRequest.Builder,
,ModifyTargetGroupRequest> ElasticLoadBalancingV2Request.Builder
,SdkBuilder<ModifyTargetGroupRequest.Builder,
,ModifyTargetGroupRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ModifyTargetGroupRequest
-
Method Summary
Modifier and TypeMethodDescriptionhealthCheckEnabled
(Boolean healthCheckEnabled) Indicates whether health checks are enabled.healthCheckIntervalSeconds
(Integer healthCheckIntervalSeconds) The approximate amount of time, in seconds, between health checks of an individual target.healthCheckPath
(String healthCheckPath) [HTTP/HTTPS health checks] The destination for health checks on the targets.healthCheckPort
(String healthCheckPort) The port the load balancer uses when performing health checks on targets.healthCheckProtocol
(String healthCheckProtocol) The protocol the load balancer uses when performing health checks on targets.healthCheckProtocol
(ProtocolEnum healthCheckProtocol) The protocol the load balancer uses when performing health checks on targets.healthCheckTimeoutSeconds
(Integer healthCheckTimeoutSeconds) [HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.healthyThresholdCount
(Integer healthyThresholdCount) The number of consecutive health checks successes required before considering an unhealthy target healthy.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.[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.targetGroupArn
(String targetGroupArn) The Amazon Resource Name (ARN) of the target group.unhealthyThresholdCount
(Integer unhealthyThresholdCount) The number of consecutive health check failures required before considering the target unhealthy.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.elasticloadbalancingv2.model.ElasticLoadBalancingV2Request.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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:
-
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:
-
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
[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
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
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
[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
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
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
[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
[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 theMatcher.Builder
avoiding the need to create one manually viaMatcher.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomatcher(Matcher)
.- Parameters:
matcher
- a consumer that will call methods onMatcher.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ModifyTargetGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ModifyTargetGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-