HealthCheckConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apprunner.model.HealthCheckConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HealthCheckConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the settings for the health check that App Runner performs to monitor the health of a service.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

HealthCheckConfiguration()

Constructors
Constructor and Description
`HealthCheckConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HealthCheckConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getHealthyThreshold()` The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
`Integer`	`getInterval()` The time interval, in seconds, between health checks.
`String`	`getPath()` The URL that health check requests are sent to.
`String`	`getProtocol()` The IP protocol that App Runner uses to perform health checks for your service.
`Integer`	`getTimeout()` The time, in seconds, to wait for a health check response before deciding it failed.
`Integer`	`getUnhealthyThreshold()` The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setHealthyThreshold(Integer healthyThreshold)` The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
`void`	`setInterval(Integer interval)` The time interval, in seconds, between health checks.
`void`	`setPath(String path)` The URL that health check requests are sent to.
`void`	`setProtocol(String protocol)` The IP protocol that App Runner uses to perform health checks for your service.
`void`	`setTimeout(Integer timeout)` The time, in seconds, to wait for a health check response before deciding it failed.
`void`	`setUnhealthyThreshold(Integer unhealthyThreshold)` The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
`String`	`toString()` Returns a string representation of this object.
`HealthCheckConfiguration`	`withHealthyThreshold(Integer healthyThreshold)` The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
`HealthCheckConfiguration`	`withInterval(Integer interval)` The time interval, in seconds, between health checks.
`HealthCheckConfiguration`	`withPath(String path)` The URL that health check requests are sent to.
`HealthCheckConfiguration`	`withProtocol(HealthCheckProtocol protocol)` The IP protocol that App Runner uses to perform health checks for your service.
`HealthCheckConfiguration`	`withProtocol(String protocol)` The IP protocol that App Runner uses to perform health checks for your service.
`HealthCheckConfiguration`	`withTimeout(Integer timeout)` The time, in seconds, to wait for a health check response before deciding it failed.
`HealthCheckConfiguration`	`withUnhealthyThreshold(Integer unhealthyThreshold)` The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

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

- Constructor Detail
  - HealthCheckConfiguration
```
public HealthCheckConfiguration()
```
- Method Detail
  - setProtocol
```
public void setProtocol(String protocol)
```
    The IP protocol that App Runner uses to perform health checks for your service.
    
    If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.
    
    Default: TCP
    
    Parameters:
    
    protocol - The IP protocol that App Runner uses to perform health checks for your service.
    
    If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.
    
    Default: TCP
    
    See Also:
    
    HealthCheckProtocol
  - getProtocol
```
public String getProtocol()
```
    The IP protocol that App Runner uses to perform health checks for your service.
    
    If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.
    
    Default: TCP
    
    Returns:
    
    The IP protocol that App Runner uses to perform health checks for your service.
    
    If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.
    
    Default: TCP
    
    See Also:
    
    HealthCheckProtocol
  - withProtocol
```
public HealthCheckConfiguration withProtocol(String protocol)
```
    The IP protocol that App Runner uses to perform health checks for your service.
    
    If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.
    
    Default: TCP
    
    Parameters:
    
    protocol - The IP protocol that App Runner uses to perform health checks for your service.
    
    If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.
    
    Default: TCP
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HealthCheckProtocol
  - withProtocol
```
public HealthCheckConfiguration withProtocol(HealthCheckProtocol protocol)
```
    The IP protocol that App Runner uses to perform health checks for your service.
    
    If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.
    
    Default: TCP
    
    Parameters:
    
    protocol - The IP protocol that App Runner uses to perform health checks for your service.
    
    If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.
    
    Default: TCP
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HealthCheckProtocol
  - setPath
```
public void setPath(String path)
```
    The URL that health check requests are sent to.
    
    Path is only applicable when you set Protocol to HTTP.
    
    Default: "/"
    
    Parameters:
    
    path - The URL that health check requests are sent to.
    
    Path is only applicable when you set Protocol to HTTP.
    
    Default: "/"
  - getPath
```
public String getPath()
```
    The URL that health check requests are sent to.
    
    Path is only applicable when you set Protocol to HTTP.
    
    Default: "/"
    
    Returns:
    
    The URL that health check requests are sent to.
    
    Path is only applicable when you set Protocol to HTTP.
    
    Default: "/"
  - withPath
```
public HealthCheckConfiguration withPath(String path)
```
    The URL that health check requests are sent to.
    
    Path is only applicable when you set Protocol to HTTP.
    
    Default: "/"
    
    Parameters:
    
    path - The URL that health check requests are sent to.
    
    Path is only applicable when you set Protocol to HTTP.
    
    Default: "/"
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInterval
```
public void setInterval(Integer interval)
```
    The time interval, in seconds, between health checks.
    
    Default: 5
    
    Parameters:
    
    interval - The time interval, in seconds, between health checks.
    
    Default: 5
  - getInterval
```
public Integer getInterval()
```
    The time interval, in seconds, between health checks.
    
    Default: 5
    
    Returns:
    
    The time interval, in seconds, between health checks.
    
    Default: 5
  - withInterval
```
public HealthCheckConfiguration withInterval(Integer interval)
```
    The time interval, in seconds, between health checks.
    
    Default: 5
    
    Parameters:
    
    interval - The time interval, in seconds, between health checks.
    
    Default: 5
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeout
```
public void setTimeout(Integer timeout)
```
    The time, in seconds, to wait for a health check response before deciding it failed.
    
    Default: 2
    
    Parameters:
    
    timeout - The time, in seconds, to wait for a health check response before deciding it failed.
    
    Default: 2
  - getTimeout
```
public Integer getTimeout()
```
    The time, in seconds, to wait for a health check response before deciding it failed.
    
    Default: 2
    
    Returns:
    
    The time, in seconds, to wait for a health check response before deciding it failed.
    
    Default: 2
  - withTimeout
```
public HealthCheckConfiguration withTimeout(Integer timeout)
```
    The time, in seconds, to wait for a health check response before deciding it failed.
    
    Default: 2
    
    Parameters:
    
    timeout - The time, in seconds, to wait for a health check response before deciding it failed.
    
    Default: 2
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHealthyThreshold
```
public void setHealthyThreshold(Integer healthyThreshold)
```
    The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
    
    Default: 1
    
    Parameters:
    
    healthyThreshold - The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
    
    Default: 1
  - getHealthyThreshold
```
public Integer getHealthyThreshold()
```
    The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
    
    Default: 1
    
    Returns:
    
    The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
    
    Default: 1
  - withHealthyThreshold
```
public HealthCheckConfiguration withHealthyThreshold(Integer healthyThreshold)
```
    The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
    
    Default: 1
    
    Parameters:
    
    healthyThreshold - The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
    
    Default: 1
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUnhealthyThreshold
```
public void setUnhealthyThreshold(Integer unhealthyThreshold)
```
    The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
    
    Default: 5
    
    Parameters:
    
    unhealthyThreshold - The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
    
    Default: 5
  - getUnhealthyThreshold
```
public Integer getUnhealthyThreshold()
```
    The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
    
    Default: 5
    
    Returns:
    
    The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
    
    Default: 5
  - withUnhealthyThreshold
```
public HealthCheckConfiguration withUnhealthyThreshold(Integer unhealthyThreshold)
```
    The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
    
    Default: 5
    
    Parameters:
    
    unhealthyThreshold - The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
    
    Default: 5
    
    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 HealthCheckConfiguration 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.793

Class HealthCheckConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HealthCheckConfiguration

Method Detail

setProtocol

getProtocol

withProtocol

withProtocol

setPath

getPath

withPath

setInterval

getInterval

withInterval

setTimeout

getTimeout

withTimeout

setHealthyThreshold

getHealthyThreshold

withHealthyThreshold

setUnhealthyThreshold

getUnhealthyThreshold

withUnhealthyThreshold

toString

equals

hashCode

clone

marshall