HealthCheckConfig (AWS SDK for Java

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

All Implemented Interfaces:

Serializable
```
public class HealthCheckConfig
extends Object
implements Serializable
```
A complex type that contains the health check configuration.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

HealthCheckConfig()

Constructors
Constructor and Description
`HealthCheckConfig()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getFullyQualifiedDomainName()` Fully qualified domain name of the instance to be health checked.
`String`	`getIPAddress()` IP Address of the instance being checked.
`Integer`	`getPort()` Port on which connection will be opened to the instance to health check.
`String`	`getResourcePath()` Path to ping on the instance to check the health.
`String`	`getSearchString()` A string to search for in the body of a health check response.
`String`	`getType()` The type of health check to be performed.
`int`	`hashCode()`
`void`	`setFullyQualifiedDomainName(String fullyQualifiedDomainName)` Fully qualified domain name of the instance to be health checked.
`void`	`setIPAddress(String iPAddress)` IP Address of the instance being checked.
`void`	`setPort(Integer port)` Port on which connection will be opened to the instance to health check.
`void`	`setResourcePath(String resourcePath)` Path to ping on the instance to check the health.
`void`	`setSearchString(String searchString)` A string to search for in the body of a health check response.
`void`	`setType(HealthCheckType type)` The type of health check to be performed.
`void`	`setType(String type)` The type of health check to be performed.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`HealthCheckConfig`	`withFullyQualifiedDomainName(String fullyQualifiedDomainName)` Fully qualified domain name of the instance to be health checked.
`HealthCheckConfig`	`withIPAddress(String iPAddress)` IP Address of the instance being checked.
`HealthCheckConfig`	`withPort(Integer port)` Port on which connection will be opened to the instance to health check.
`HealthCheckConfig`	`withResourcePath(String resourcePath)` Path to ping on the instance to check the health.
`HealthCheckConfig`	`withSearchString(String searchString)` A string to search for in the body of a health check response.
`HealthCheckConfig`	`withType(HealthCheckType type)` The type of health check to be performed.
`HealthCheckConfig`	`withType(String type)` The type of health check to be performed.

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

- Constructor Detail
  - HealthCheckConfig
```
public HealthCheckConfig()
```
- Method Detail
  - getIPAddress
```
public String getIPAddress()
```
    IP Address of the instance being checked.
    Constraints:
    Length: 0 - 15
    Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
    
    Returns:
    IP Address of the instance being checked.
  - setIPAddress
```
public void setIPAddress(String iPAddress)
```
    IP Address of the instance being checked.
    Constraints:
    Length: 0 - 15
    Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
    
    Parameters:
    iPAddress - IP Address of the instance being checked.
  - withIPAddress
```
public HealthCheckConfig withIPAddress(String iPAddress)
```
    IP Address of the instance being checked.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 15
    Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
    
    Parameters:
    iPAddress - IP Address of the instance being checked.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPort
```
public Integer getPort()
```
    Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
    Constraints:
    Range: 1 - 65535
    
    Returns:
    Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
  - setPort
```
public void setPort(Integer port)
```
    Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
    Constraints:
    Range: 1 - 65535
    
    Parameters:
    port - Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
  - withPort
```
public HealthCheckConfig withPort(Integer port)
```
    Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 65535
    
    Parameters:
    port - Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getType
```
public String getType()
```
    The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
    Constraints:
    Allowed Values: HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP
    
    Returns:
    The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
    See Also:
    HealthCheckType
  - setType
```
public void setType(String type)
```
    The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
    Constraints:
    Allowed Values: HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP
    
    Parameters:
    type - The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
    See Also:
    HealthCheckType
  - withType
```
public HealthCheckConfig withType(String type)
```
    The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP
    
    Parameters:
    type - The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    HealthCheckType
  - setType
```
public void setType(HealthCheckType type)
```
    The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
    Constraints:
    Allowed Values: HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP
    
    Parameters:
    type - The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
    See Also:
    HealthCheckType
  - withType
```
public HealthCheckConfig withType(HealthCheckType type)
```
    The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP
    
    Parameters:
    type - The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    HealthCheckType
  - getResourcePath
```
public String getResourcePath()
```
    Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
    Constraints:
    Length: 0 - 255
    
    Returns:
    Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
  - setResourcePath
```
public void setResourcePath(String resourcePath)
```
    Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
    Constraints:
    Length: 0 - 255
    
    Parameters:
    resourcePath - Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
  - withResourcePath
```
public HealthCheckConfig withResourcePath(String resourcePath)
```
    Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 255
    
    Parameters:
    resourcePath - Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getFullyQualifiedDomainName
```
public String getFullyQualifiedDomainName()
```
    Fully qualified domain name of the instance to be health checked.
    Constraints:
    Length: 0 - 255
    
    Returns:
    Fully qualified domain name of the instance to be health checked.
  - setFullyQualifiedDomainName
```
public void setFullyQualifiedDomainName(String fullyQualifiedDomainName)
```
    Fully qualified domain name of the instance to be health checked.
    Constraints:
    Length: 0 - 255
    
    Parameters:
    fullyQualifiedDomainName - Fully qualified domain name of the instance to be health checked.
  - withFullyQualifiedDomainName
```
public HealthCheckConfig withFullyQualifiedDomainName(String fullyQualifiedDomainName)
```
    Fully qualified domain name of the instance to be health checked.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 255
    
    Parameters:
    fullyQualifiedDomainName - Fully qualified domain name of the instance to be health checked.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSearchString
```
public String getSearchString()
```
    A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
    Constraints:
    Length: 0 - 255
    
    Returns:
    A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
  - setSearchString
```
public void setSearchString(String searchString)
```
    A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
    Constraints:
    Length: 0 - 255
    
    Parameters:
    searchString - A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
  - withSearchString
```
public HealthCheckConfig withSearchString(String searchString)
```
    A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 255
    
    Parameters:
    searchString - A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class HealthCheckConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HealthCheckConfig

Method Detail

getIPAddress

setIPAddress

withIPAddress

getPort

setPort

withPort

getType

setType

withType

setType

withType

getResourcePath

setResourcePath

withResourcePath

getFullyQualifiedDomainName

setFullyQualifiedDomainName

withFullyQualifiedDomainName

getSearchString

setSearchString

withSearchString

toString

hashCode

equals