Expand description
A complex type that contains information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:
-
You can't use a health check that's defined by
HealthCheckConfig
because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.) -
You want to use a third-party health checker regardless of where your resources are located.
If you specify a health check configuration, you can specify either HealthCheckCustomConfig
or HealthCheckConfig
but not both.
To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus
request. Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent UpdateInstanceCustomHealthStatus
request.
Here's how custom health checks work:
-
You create a service.
-
You register an instance.
-
You configure a third-party health checker to monitor the resource that's associated with the new instance.
Cloud Map doesn't check the health of the resource directly.
-
The third-party health-checker determines that the resource is unhealthy and notifies your application.
-
Your application submits an
UpdateInstanceCustomHealthStatus
request. -
Cloud Map waits for 30 seconds.
-
If another
UpdateInstanceCustomHealthStatus
request doesn't arrive during that time to change the status back to healthy, Cloud Map stops routing traffic to the resource.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.failure_threshold: Option<i32>
This parameter is no longer supported and is always set to 1. Cloud Map waits for approximately 30 seconds after receiving an UpdateInstanceCustomHealthStatus
request before changing the status of the service instance.
The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus
request before it changes the health status of a service instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus
request with the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits 30
seconds after the first request to make the change.
Implementations
sourceimpl HealthCheckCustomConfig
impl HealthCheckCustomConfig
sourcepub fn failure_threshold(&self) -> Option<i32>
pub fn failure_threshold(&self) -> Option<i32>
This parameter is no longer supported and is always set to 1. Cloud Map waits for approximately 30 seconds after receiving an UpdateInstanceCustomHealthStatus
request before changing the status of the service instance.
The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus
request before it changes the health status of a service instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus
request with the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits 30
seconds after the first request to make the change.
sourceimpl HealthCheckCustomConfig
impl HealthCheckCustomConfig
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture HealthCheckCustomConfig
Trait Implementations
sourceimpl Clone for HealthCheckCustomConfig
impl Clone for HealthCheckCustomConfig
sourcefn clone(&self) -> HealthCheckCustomConfig
fn clone(&self) -> HealthCheckCustomConfig
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 HealthCheckCustomConfig
impl Debug for HealthCheckCustomConfig
sourceimpl PartialEq<HealthCheckCustomConfig> for HealthCheckCustomConfig
impl PartialEq<HealthCheckCustomConfig> for HealthCheckCustomConfig
sourcefn eq(&self, other: &HealthCheckCustomConfig) -> bool
fn eq(&self, other: &HealthCheckCustomConfig) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &HealthCheckCustomConfig) -> bool
fn ne(&self, other: &HealthCheckCustomConfig) -> bool
This method tests for !=
.
impl StructuralPartialEq for HealthCheckCustomConfig
Auto Trait Implementations
impl RefUnwindSafe for HealthCheckCustomConfig
impl Send for HealthCheckCustomConfig
impl Sync for HealthCheckCustomConfig
impl Unpin for HealthCheckCustomConfig
impl UnwindSafe for HealthCheckCustomConfig
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