UpdateHealthCheckRequest class
A complex type that contains information about a request to update a health check.
Constructors
-
UpdateHealthCheckRequest({required String healthCheckId, AlarmIdentifier? alarmIdentifier, List<
String> ? childHealthChecks, bool? disabled, bool? enableSNI, int? failureThreshold, String? fullyQualifiedDomainName, int? healthCheckVersion, int? healthThreshold, String? iPAddress, InsufficientDataHealthStatus? insufficientDataHealthStatus, bool? inverted, int? port, List<HealthCheckRegion> ? regions, List<ResettableElementName> ? resetElements, String? resourcePath, String? searchString})
Properties
- alarmIdentifier → AlarmIdentifier?
-
A complex type that identifies the CloudWatch alarm that you want Amazon
Route 53 health checkers to use to determine whether the specified health
check is healthy.
final
-
childHealthChecks
→ List<
String> ? -
A complex type that contains one
ChildHealthCheck
element for each health check that you want to associate with aCALCULATED
health check.final - disabled → bool?
-
Stops Route 53 from performing health checks. When you disable a health
check, here's what happens:
final
- enableSNI → bool?
-
Specify whether you want Amazon Route 53 to send the value of
FullyQualifiedDomainName
to the endpoint in theclient_hello
message duringTLS
negotiation. This allows the endpoint to respond toHTTPS
health check requests with the applicable SSL/TLS certificate.final - failureThreshold → int?
-
The number of consecutive health checks that an endpoint must pass or fail
for Amazon Route 53 to change the current status of the endpoint from
unhealthy to healthy or vice versa. For more information, see How
Amazon Route 53 Determines Whether an Endpoint Is Healthy in the
Amazon Route 53 Developer Guide.
final
- fullyQualifiedDomainName → String?
-
Amazon Route 53 behavior depends on whether you specify a value for
IPAddress
. If you specify a value forIPAddress
:final - hashCode → int
-
The hash code for this object.
no setterinherited
- healthCheckId → String
-
The ID for the health check for which you want detailed information. When
you created the health check,
CreateHealthCheck
returned the ID in the response, in theHealthCheckId
element.final - healthCheckVersion → int?
-
A sequential counter that Amazon Route 53 sets to
1
when you create a health check and increments by 1 each time you update settings for the health check.final - healthThreshold → int?
-
The number of child health checks that are associated with a
CALCULATED
health that Amazon Route 53 must consider healthy for theCALCULATED
health check to be considered healthy. To specify the child health checks that you want to associate with aCALCULATED
health check, use theChildHealthChecks
andChildHealthCheck
elements.final - insufficientDataHealthStatus → InsufficientDataHealthStatus?
-
When CloudWatch has insufficient data about the metric to determine the
alarm state, the status that you want Amazon Route 53 to assign to the
health check:
final
- inverted → bool?
-
Specify whether you want Amazon Route 53 to invert the status of a health
check, for example, to consider a health check unhealthy when it otherwise
would be considered healthy.
final
- iPAddress → String?
-
The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53
to perform health checks on. If you don't specify a value for
IPAddress
, Route 53 sends a DNS request to resolve the domain name that you specify inFullyQualifiedDomainName
at the interval that you specify inRequestInterval
. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.final - port → int?
-
The port on the endpoint that you want Amazon Route 53 to perform health
checks on.
final
-
regions
→ List<
HealthCheckRegion> ? -
A complex type that contains one
Region
element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.final -
resetElements
→ List<
ResettableElementName> ? -
A complex type that contains one
ResettableElementName
element for each element that you want to reset to the default value. Valid values forResettableElementName
include the following:final - resourcePath → String?
-
The path that you want Amazon Route 53 to request when performing health
checks. The path can be any value for which your endpoint will return an
HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the
file /docs/route53-health-check.html. You can also include query string
parameters, for example,
/welcome.html?language=jp&login=y
.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- searchString → String?
-
If the value of
Type
isHTTP_STR_MATCH
orHTTPS_STR_MATCH
, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value ofType
when you update a health check.)final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
toXml(
String elemName, {List< XmlAttribute> ? attributes}) → XmlElement
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited