software.amazon.awssdk.services.elasticloadbalancingv2.model

Class ModifyTargetGroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticloadbalancingv2.model.ElasticLoadBalancingV2Request

software.amazon.awssdk.services.elasticloadbalancingv2.model.ModifyTargetGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyTargetGroupRequest.Builder,ModifyTargetGroupRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ModifyTargetGroupRequest
extends ElasticLoadBalancingV2Request
implements ToCopyableBuilder<ModifyTargetGroupRequest.Builder,ModifyTargetGroupRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModifyTargetGroupRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ModifyTargetGroupRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	healthCheckEnabled() Indicates whether health checks are enabled.
Integer	healthCheckIntervalSeconds() The approximate amount of time, in seconds, between health checks of an individual target.
String	healthCheckPath() [HTTP/HTTPS health checks] The destination for health checks on the targets.
String	healthCheckPort() The port the load balancer uses when performing health checks on targets.
ProtocolEnum	healthCheckProtocol() The protocol the load balancer uses when performing health checks on targets.
String	healthCheckProtocolAsString() The protocol the load balancer uses when performing health checks on targets.
Integer	healthCheckTimeoutSeconds() [HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.
Integer	healthyThresholdCount() The number of consecutive health checks successes required before considering an unhealthy target healthy.
Matcher	matcher() [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyTargetGroupRequest.Builder>	serializableBuilderClass()
String	targetGroupArn() The Amazon Resource Name (ARN) of the target group.
ModifyTargetGroupRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	unhealthyThresholdCount() The number of consecutive health check failures required before considering the target unhealthy.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

targetGroupArn

public final String targetGroupArn()

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

Returns:

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

healthCheckProtocol

public final ProtocolEnum healthCheckProtocol()

The protocol the load balancer uses when performing health checks on targets. The TCP protocol 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.

With Network Load Balancers, you can't modify this setting.

If the service returns an enum value that is not available in the current SDK version, healthCheckProtocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthCheckProtocolAsString().

Returns:

The protocol the load balancer uses when performing health checks on targets. The TCP protocol 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.

With Network Load Balancers, you can't modify this setting.

See Also:

ProtocolEnum

healthCheckProtocolAsString

public final String healthCheckProtocolAsString()

The protocol the load balancer uses when performing health checks on targets. The TCP protocol 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.

With Network Load Balancers, you can't modify this setting.

If the service returns an enum value that is not available in the current SDK version, healthCheckProtocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthCheckProtocolAsString().

Returns:

The protocol the load balancer uses when performing health checks on targets. The TCP protocol 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.

With Network Load Balancers, you can't modify this setting.

See Also:

ProtocolEnum

healthCheckPort

public final String healthCheckPort()

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

Returns:

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

healthCheckPath

public final 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 /AWS.ALB/healthcheck.

Returns:

[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 /AWS.ALB/healthcheck.

healthCheckEnabled

public final Boolean healthCheckEnabled()

Indicates whether health checks are enabled.

Returns:

Indicates whether health checks are enabled.

healthCheckIntervalSeconds

public final Integer healthCheckIntervalSeconds()

The approximate amount of time, in seconds, between health checks of an individual target. For TCP health checks, the supported values are 10 or 30 seconds.

With Network Load Balancers, you can't modify this setting.

Returns:

The approximate amount of time, in seconds, between health checks of an individual target. For TCP health checks, the supported values are 10 or 30 seconds.

With Network Load Balancers, you can't modify this setting.

healthCheckTimeoutSeconds

public final Integer healthCheckTimeoutSeconds()

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

With Network Load Balancers, you can't modify this setting.

Returns:

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

With Network Load Balancers, you can't modify this setting.

healthyThresholdCount

public final Integer healthyThresholdCount()

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

Returns:

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

unhealthyThresholdCount

public final Integer unhealthyThresholdCount()

The number of consecutive health check failures required before considering the target unhealthy. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count.

Returns:

The number of consecutive health check failures required before considering the target unhealthy. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count.

matcher

public final Matcher matcher()

[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.

With Network Load Balancers, you can't modify this setting.

Returns:

[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.

With Network Load Balancers, you can't modify this setting.

toBuilder

public ModifyTargetGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyTargetGroupRequest.Builder,ModifyTargetGroupRequest>

Specified by:

toBuilder in class ElasticLoadBalancingV2Request

builder

public static ModifyTargetGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ModifyTargetGroupRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo