pub struct HealthCheckConfig {
pub failure_threshold: Option<i64>,
pub resource_path: Option<String>,
pub type_: String,
}
Expand description
Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig
.
If you specify a health check configuration, you can specify either HealthCheckCustomConfig
or HealthCheckConfig
but not both.
Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.
Note the following about configuring health checks.
- A and AAAA records
-
If
DnsConfig
includes configurations for bothA
andAAAA
records, AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint tthat's specified by the IPv4 address is unhealthy, Route 53 considers both theA
andAAAA
records to be unhealthy. - CNAME records
-
You can't specify settings for
HealthCheckConfig
when theDNSConfig
includesCNAME
for the value ofType
. If you do, theCreateService
request will fail with anInvalidInput
error. - Request interval
-
A Route 53 health checker in each health-checking AWS Region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another. Therefore, you might sometimes see several requests in one second that's followed by a few seconds with no health checks at all.
- Health checking regions
-
Health checkers perform checks from all Route 53 health-checking Regions. For a list of the current Regions, see Regions.
- Alias records
-
When you register an instance, if you include the
AWSALIASDNSNAME
attribute, AWS Cloud Map creates a Route 53 alias record. Note the following:-
Route 53 automatically sets
EvaluateTargetHealth
to true for alias records. WhenEvaluateTargetHealth
is true, the alias record inherits the health of the referenced AWS resource. such as an ELB load balancer. For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/APIAliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth">EvaluateTargetHealth. -
If you include
HealthCheckConfig
and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.
-
- Charges for health checks
-
Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.
Fields
failure_threshold: Option<i64>
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or the other way around. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
resource_path: Option<String>
The path that you want Route 53 to request when performing health checks. The path can be any value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is /docs/route53-health-check.html
. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath
, the default value is /
.
If you specify TCP
for Type
, you must not specify a value for ResourcePath
.
type_: String
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.
You can't change the value of Type
after you create a health check.
You can create the following types of health checks:
-
HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
-
HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of
Type
, the endpoint must support TLS v1.0 or later. -
TCP: Route 53 tries to establish a TCP connection.
If you specify
TCP
forType
, don't specify a value forResourcePath
.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
Trait Implementations
sourceimpl Clone for HealthCheckConfig
impl Clone for HealthCheckConfig
sourcefn clone(&self) -> HealthCheckConfig
fn clone(&self) -> HealthCheckConfig
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for HealthCheckConfig
impl Debug for HealthCheckConfig
sourceimpl Default for HealthCheckConfig
impl Default for HealthCheckConfig
sourcefn default() -> HealthCheckConfig
fn default() -> HealthCheckConfig
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for HealthCheckConfig
impl<'de> Deserialize<'de> for HealthCheckConfig
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<HealthCheckConfig> for HealthCheckConfig
impl PartialEq<HealthCheckConfig> for HealthCheckConfig
sourcefn eq(&self, other: &HealthCheckConfig) -> bool
fn eq(&self, other: &HealthCheckConfig) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &HealthCheckConfig) -> bool
fn ne(&self, other: &HealthCheckConfig) -> bool
This method tests for !=
.
sourceimpl Serialize for HealthCheckConfig
impl Serialize for HealthCheckConfig
impl StructuralPartialEq for HealthCheckConfig
Auto Trait Implementations
impl RefUnwindSafe for HealthCheckConfig
impl Send for HealthCheckConfig
impl Sync for HealthCheckConfig
impl Unpin for HealthCheckConfig
impl UnwindSafe for HealthCheckConfig
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more