HealthCheckState class

Input properties used for looking up and filtering HealthCheck resources.

Constructors

HealthCheckState({Input<String?>? arn, Input<int?>? childHealthThreshold, Input<List<String>?>? childHealthchecks, Input<String?>? cloudwatchAlarmName, Input<String?>? cloudwatchAlarmRegion, Input<bool?>? disabled, Input<bool?>? enableSni, Input<int?>? failureThreshold, Input<String?>? fqdn, Input<String?>? insufficientDataHealthStatus, Input<bool?>? invertHealthcheck, Input<String?>? ipAddress, Input<bool?>? measureLatency, Input<int?>? port, Input<String?>? referenceName, Input<List<String>?>? regions, Input<int?>? requestInterval, Input<String?>? resourcePath, Input<String?>? routingControlArn, Input<String?>? searchString, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<Map<String, String>?>? triggers, Input<String?>? type})
Creates a new HealthCheckState. arn ARN of the Health Check. childHealthThreshold The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive childHealthchecks For a specified parent health check, a list of HealthCheckId values for the associated child health checks. cloudwatchAlarmName The name of the CloudWatch alarm. cloudwatchAlarmRegion The region that the CloudWatch alarm was created in. disabled A boolean value that stops Route 53 from performing health checks. When set to true, Route 53 will do the following depending on the type of health check: enableSni A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS' defaults: when the type is "HTTPS" enableSni defaults to true, when type is anything else enableSni defaults to false. failureThreshold The number of consecutive health checks that an endpoint must pass or fail. fqdn The fully qualified domain name of the endpoint to be checked. If a value is set for ipAddress, the value set for fqdn will be passed in the Host header. insufficientDataHealthStatus The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus. invertHealthcheck A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy. ipAddress The IP address of the endpoint to be checked. measureLatency A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console. port The port of the endpoint to be checked. referenceName This is a reference name used in Caller Reference regions List of AWS Regions from which Amazon Route 53 health checkers check the specified endpoint. Valid values are us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, and sa-east-1. If not specified, all of the regions listed under Valid values are used by default. Once this argument is set, removing it has no effect. requestInterval The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request. resourcePath The path that you want Amazon Route 53 to request when performing health checks. routingControlArn ARN for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL searchString String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH. tags A map of tags to assign to the health check. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. triggers Map of arbitrary keys and values that, when changed, will trigger an in-place update of the CloudWatch alarm arguments. Use this argument to synchronize the health check when an alarm is changed. See example above. type The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC and RECOVERY_CONTROL.
const
HealthCheckState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of the Health Check.
final
childHealthchecks → Input<List<String>?>?
For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
final
childHealthThreshold → Input<int?>?
The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
final
cloudwatchAlarmName → Input<String?>?
The name of the CloudWatch alarm.
final
cloudwatchAlarmRegion → Input<String?>?
The region that the CloudWatch alarm was created in.
final
disabled → Input<bool?>?
A boolean value that stops Route 53 from performing health checks. When set to true, Route 53 will do the following depending on the type of health check:
final
enableSni → Input<bool?>?
A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS' defaults: when the type is "HTTPS" enableSni defaults to true, when type is anything else enableSni defaults to false.
final
failureThreshold → Input<int?>?
The number of consecutive health checks that an endpoint must pass or fail.
final
fqdn → Input<String?>?
The fully qualified domain name of the endpoint to be checked. If a value is set for ipAddress, the value set for fqdn will be passed in the Host header.
final
hashCode → int
The hash code for this object.
no setterinherited
insufficientDataHealthStatus → Input<String?>?
The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
final
invertHealthcheck → Input<bool?>?
A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
final
ipAddress → Input<String?>?
The IP address of the endpoint to be checked.
final
measureLatency → Input<bool?>?
A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
final
port → Input<int?>?
The port of the endpoint to be checked.
final
referenceName → Input<String?>?
This is a reference name used in Caller Reference (helpful for identifying single healthCheck set amongst others)
final
regions → Input<List<String>?>?
List of AWS Regions from which Amazon Route 53 health checkers check the specified endpoint. Valid values are us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, and sa-east-1. If not specified, all of the regions listed under Valid values are used by default. Once this argument is set, removing it has no effect.
final
requestInterval → Input<int?>?
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
final
resourcePath → Input<String?>?
The path that you want Amazon Route 53 to request when performing health checks.
final
routingControlArn → Input<String?>?
ARN for the Route 53 Application Recovery Controller routing control. This is used when health check type is RECOVERY_CONTROL
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchString → Input<String?>?
String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the health check. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
triggers → Input<Map<String, String>?>?
Map of arbitrary keys and values that, when changed, will trigger an in-place update of the CloudWatch alarm arguments. Use this argument to synchronize the health check when an alarm is changed. See example above.
final
type → Input<String?>?
The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC and RECOVERY_CONTROL.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited