@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.
Constructor and Description |
---|
HealthCheckConfiguration() |
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.
|
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
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
HealthCheckProtocol
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
If you set Protocol
to HTTP
, App Runner sends health check requests to the HTTP
path specified by Path
.
Default: TCP
HealthCheckProtocol
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
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
HealthCheckProtocol
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
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
HealthCheckProtocol
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: "/"
path
- The URL that health check requests are sent to.
Path
is only applicable when you set Protocol
to HTTP
.
Default: "/"
public String getPath()
The URL that health check requests are sent to.
Path
is only applicable when you set Protocol
to HTTP
.
Default: "/"
Path
is only applicable when you set Protocol
to HTTP
.
Default: "/"
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: "/"
path
- The URL that health check requests are sent to.
Path
is only applicable when you set Protocol
to HTTP
.
Default: "/"
public void setInterval(Integer interval)
The time interval, in seconds, between health checks.
Default: 5
interval
- The time interval, in seconds, between health checks.
Default: 5
public Integer getInterval()
The time interval, in seconds, between health checks.
Default: 5
Default: 5
public HealthCheckConfiguration withInterval(Integer interval)
The time interval, in seconds, between health checks.
Default: 5
interval
- The time interval, in seconds, between health checks.
Default: 5
public void setTimeout(Integer timeout)
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
timeout
- The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
public Integer getTimeout()
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
Default: 2
public HealthCheckConfiguration withTimeout(Integer timeout)
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
timeout
- The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
public void setHealthyThreshold(Integer healthyThreshold)
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
healthyThreshold
- The number of consecutive checks that must succeed before App Runner decides that the service is
healthy.
Default: 1
public Integer getHealthyThreshold()
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
Default: 1
public HealthCheckConfiguration withHealthyThreshold(Integer healthyThreshold)
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
healthyThreshold
- The number of consecutive checks that must succeed before App Runner decides that the service is
healthy.
Default: 1
public void setUnhealthyThreshold(Integer unhealthyThreshold)
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 5
unhealthyThreshold
- The number of consecutive checks that must fail before App Runner decides that the service is
unhealthy.
Default: 5
public Integer getUnhealthyThreshold()
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 5
Default: 5
public HealthCheckConfiguration withUnhealthyThreshold(Integer unhealthyThreshold)
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 5
unhealthyThreshold
- The number of consecutive checks that must fail before App Runner decides that the service is
unhealthy.
Default: 5
public String toString()
toString
in class Object
Object.toString()
public HealthCheckConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.