Package 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("software.amazon.awssdk:codegen") public final class ModifyTargetGroupRequest extends ElasticLoadBalancingV2Request implements ToCopyableBuilder<ModifyTargetGroupRequest.Builder,ModifyTargetGroupRequest>

  • Method Details

    • 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. 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.

      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. 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.
      See Also:

    • healthCheckProtocolAsString

      public final String healthCheckProtocolAsString()

      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.

      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. 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.
      See Also:

    • 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 /Amazon Web Services.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 /Amazon Web Services.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.

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

    • healthCheckTimeoutSeconds

      public final Integer healthCheckTimeoutSeconds()

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

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

    • 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.

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

    • 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. 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:
      [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.

    • toBuilder

      public ModifyTargetGroupRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ModifyTargetGroupRequest.Builder,ModifyTargetGroupRequest>
      Specified by:
      toBuilder in class ElasticLoadBalancingV2Request
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.