HealthCheckConfig (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.vpclattice.model.HealthCheckConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HealthCheckConfig
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the health check configuration of a target group. Health check configurations aren't used for target groups of type LAMBDA or ALB.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

HealthCheckConfig()

Constructors
Constructor and Description
`HealthCheckConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HealthCheckConfig`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getEnabled()` Indicates whether health checking is enabled.
`Integer`	`getHealthCheckIntervalSeconds()` The approximate amount of time, in seconds, between health checks of an individual target.
`Integer`	`getHealthCheckTimeoutSeconds()` The amount of time, in seconds, to wait before reporting a target as unhealthy.
`Integer`	`getHealthyThresholdCount()` The number of consecutive successful health checks required before considering an unhealthy target healthy.
`Matcher`	`getMatcher()` The codes to use when checking for a successful response from a target.
`String`	`getPath()` The destination for health checks on the targets.
`Integer`	`getPort()` The port used when performing health checks on targets.
`String`	`getProtocol()` The protocol used when performing health checks on targets.
`String`	`getProtocolVersion()` The protocol version used when performing health checks on targets.
`Integer`	`getUnhealthyThresholdCount()` The number of consecutive failed health checks required before considering a target unhealthy.
`int`	`hashCode()`
`Boolean`	`isEnabled()` Indicates whether health checking is enabled.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEnabled(Boolean enabled)` Indicates whether health checking is enabled.
`void`	`setHealthCheckIntervalSeconds(Integer healthCheckIntervalSeconds)` The approximate amount of time, in seconds, between health checks of an individual target.
`void`	`setHealthCheckTimeoutSeconds(Integer healthCheckTimeoutSeconds)` The amount of time, in seconds, to wait before reporting a target as unhealthy.
`void`	`setHealthyThresholdCount(Integer healthyThresholdCount)` The number of consecutive successful health checks required before considering an unhealthy target healthy.
`void`	`setMatcher(Matcher matcher)` The codes to use when checking for a successful response from a target.
`void`	`setPath(String path)` The destination for health checks on the targets.
`void`	`setPort(Integer port)` The port used when performing health checks on targets.
`void`	`setProtocol(String protocol)` The protocol used when performing health checks on targets.
`void`	`setProtocolVersion(String protocolVersion)` The protocol version used when performing health checks on targets.
`void`	`setUnhealthyThresholdCount(Integer unhealthyThresholdCount)` The number of consecutive failed health checks required before considering a target unhealthy.
`String`	`toString()` Returns a string representation of this object.
`HealthCheckConfig`	`withEnabled(Boolean enabled)` Indicates whether health checking is enabled.
`HealthCheckConfig`	`withHealthCheckIntervalSeconds(Integer healthCheckIntervalSeconds)` The approximate amount of time, in seconds, between health checks of an individual target.
`HealthCheckConfig`	`withHealthCheckTimeoutSeconds(Integer healthCheckTimeoutSeconds)` The amount of time, in seconds, to wait before reporting a target as unhealthy.
`HealthCheckConfig`	`withHealthyThresholdCount(Integer healthyThresholdCount)` The number of consecutive successful health checks required before considering an unhealthy target healthy.
`HealthCheckConfig`	`withMatcher(Matcher matcher)` The codes to use when checking for a successful response from a target.
`HealthCheckConfig`	`withPath(String path)` The destination for health checks on the targets.
`HealthCheckConfig`	`withPort(Integer port)` The port used when performing health checks on targets.
`HealthCheckConfig`	`withProtocol(String protocol)` The protocol used when performing health checks on targets.
`HealthCheckConfig`	`withProtocol(TargetGroupProtocol protocol)` The protocol used when performing health checks on targets.
`HealthCheckConfig`	`withProtocolVersion(HealthCheckProtocolVersion protocolVersion)` The protocol version used when performing health checks on targets.
`HealthCheckConfig`	`withProtocolVersion(String protocolVersion)` The protocol version used when performing health checks on targets.
`HealthCheckConfig`	`withUnhealthyThresholdCount(Integer unhealthyThresholdCount)` The number of consecutive failed health checks required before considering a target unhealthy.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HealthCheckConfig
```
public HealthCheckConfig()
```
- Method Detail
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    Indicates whether health checking is enabled.
    
    Parameters:
    
    enabled - Indicates whether health checking is enabled.
  - getEnabled
```
public Boolean getEnabled()
```
    Indicates whether health checking is enabled.
    
    Returns:
    
    Indicates whether health checking is enabled.
  - withEnabled
```
public HealthCheckConfig withEnabled(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.
  - isEnabled
```
public Boolean isEnabled()
```
    Indicates whether health checking is enabled.
    
    Returns:
    
    Indicates whether health checking is enabled.
  - setHealthCheckIntervalSeconds
```
public void setHealthCheckIntervalSeconds(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.
  - getHealthCheckIntervalSeconds
```
public Integer getHealthCheckIntervalSeconds()
```
    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:
    
    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.
  - withHealthCheckIntervalSeconds
```
public HealthCheckConfig withHealthCheckIntervalSeconds(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.
  - setHealthCheckTimeoutSeconds
```
public void setHealthCheckTimeoutSeconds(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.
  - getHealthCheckTimeoutSeconds
```
public Integer getHealthCheckTimeoutSeconds()
```
    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:
    
    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.
  - withHealthCheckTimeoutSeconds
```
public HealthCheckConfig withHealthCheckTimeoutSeconds(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.
  - setHealthyThresholdCount
```
public void setHealthyThresholdCount(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.
  - getHealthyThresholdCount
```
public Integer getHealthyThresholdCount()
```
    The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
    
    Returns:
    
    The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
  - withHealthyThresholdCount
```
public HealthCheckConfig withHealthyThresholdCount(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.
  - setMatcher
```
public void setMatcher(Matcher matcher)
```
    The codes to use when checking for a successful response from a target.
    
    Parameters:
    
    matcher - The codes to use when checking for a successful response from a target.
  - getMatcher
```
public Matcher getMatcher()
```
    The codes to use when checking for a successful response from a target.
    
    Returns:
    
    The codes to use when checking for a successful response from a target.
  - withMatcher
```
public HealthCheckConfig withMatcher(Matcher matcher)
```
    The codes to use when checking for a successful response from a target.
    
    Parameters:
    
    matcher - The codes to use when checking for a successful response from a target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPath
```
public void setPath(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.
  - getPath
```
public String getPath()
```
    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:
    
    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.
  - withPath
```
public HealthCheckConfig withPath(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.
  - setPort
```
public void setPort(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.
  - getPort
```
public Integer getPort()
```
    The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
    
    Returns:
    
    The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
  - withPort
```
public HealthCheckConfig withPort(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.
  - setProtocol
```
public void setProtocol(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.
    
    See Also:
    
    TargetGroupProtocol
  - getProtocol
```
public String getProtocol()
```
    The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.
    
    Returns:
    
    The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.
    
    See Also:
    
    TargetGroupProtocol
  - withProtocol
```
public HealthCheckConfig withProtocol(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
  - withProtocol
```
public HealthCheckConfig withProtocol(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
  - setProtocolVersion
```
public void setProtocolVersion(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.
    
    See Also:
    
    HealthCheckProtocolVersion
  - getProtocolVersion
```
public String getProtocolVersion()
```
    The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.
    
    Returns:
    
    The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.
    
    See Also:
    
    HealthCheckProtocolVersion
  - withProtocolVersion
```
public HealthCheckConfig withProtocolVersion(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
  - withProtocolVersion
```
public HealthCheckConfig withProtocolVersion(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
  - setUnhealthyThresholdCount
```
public void setUnhealthyThresholdCount(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.
  - getUnhealthyThresholdCount
```
public Integer getUnhealthyThresholdCount()
```
    The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
    
    Returns:
    
    The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
  - withUnhealthyThresholdCount
```
public HealthCheckConfig withUnhealthyThresholdCount(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public HealthCheckConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class HealthCheckConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HealthCheckConfig

Method Detail

setEnabled

getEnabled

withEnabled

isEnabled

setHealthCheckIntervalSeconds

getHealthCheckIntervalSeconds

withHealthCheckIntervalSeconds

setHealthCheckTimeoutSeconds

getHealthCheckTimeoutSeconds

withHealthCheckTimeoutSeconds

setHealthyThresholdCount

getHealthyThresholdCount

withHealthyThresholdCount

setMatcher

getMatcher

withMatcher

setPath

getPath

withPath

setPort

getPort

withPort

setProtocol

getProtocol

withProtocol

withProtocol

setProtocolVersion

getProtocolVersion

withProtocolVersion

withProtocolVersion

setUnhealthyThresholdCount

getUnhealthyThresholdCount

withUnhealthyThresholdCount

toString

equals

hashCode

clone

marshall