AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
New-R53HealthCheck-CallerReference <String>-HealthCheckConfig_ChildHealthCheck <String[]>-HealthCheckConfig_Disabled <Boolean>-HealthCheckConfig_EnableSNI <Boolean>-HealthCheckConfig_FailureThreshold <Int32>-HealthCheckConfig_FullyQualifiedDomainName <String>-HealthCheckConfig_HealthThreshold <Int32>-HealthCheckConfig_InsufficientDataHealthStatus <InsufficientDataHealthStatus>-HealthCheckConfig_Inverted <Boolean>-HealthCheckConfig_IPAddress <String>-HealthCheckConfig_MeasureLatency <Boolean>-AlarmIdentifier_Name <String>-HealthCheckConfig_Port <Int32>-AlarmIdentifier_Region <CloudWatchRegion>-HealthCheckConfig_Region <String[]>-HealthCheckConfig_RequestInterval <Int32>-HealthCheckConfig_ResourcePath <String>-HealthCheckConfig_SearchString <String>-HealthCheckConfig_Type <HealthCheckType>
StatusCheckFailed
metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide. Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
CreateHealthCheck
request without the risk of creating two identical health checks:CreateHealthCheck
request with the same CallerReference
and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Route 53 returns the settings for the existing health check.CreateHealthCheck
request with the same CallerReference
as a deleted health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists
error.CreateHealthCheck
request with the same CallerReference
as an existing health check but with different settings, Route 53 returns a HealthCheckAlreadyExists
error.CreateHealthCheck
request with a unique CallerReference
but settings identical to an existing health check, Route 53 creates the health check.Required? | False |
Position? | 1 |
Accept pipeline input? | True (ByValue, ) |
ChildHealthCheck
element for each health check that you want to associate with a CALCULATED
health check. Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
FullyQualifiedDomainName
to the endpoint in the client_hello
message during TLS negotiation. This allows the endpoint to respond to HTTPS
health check requests with the applicable SSL/TLS certificate.Some endpoints require that HTTPS
requests include the host name in the client_hello
message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure
. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.The SSL/TLS certificate on your endpoint includes a domain name in the Common Name
field and possibly several more in the Subject Alternative Names
field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName
. If the endpoint responds to the client_hello
message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName
, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName
from the client_hello
message. Required? | False |
Position? | Named |
Accept pipeline input? | False |
FailureThreshold
, the default value is three health checks. Required? | False |
Position? | Named |
Accept pipeline input? | False |
IPAddress
.If you specify a value forIPAddress
:Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName
in the Host
header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.When Route 53 checks the health of an endpoint, here is how it constructs the Host
header:80
for Port
and HTTP
or HTTP_STR_MATCH
for Type
, Route 53 passes the value of FullyQualifiedDomainName
to the endpoint in the Host header. 443
for Port
and HTTPS
or HTTPS_STR_MATCH
for Type
, Route 53 passes the value of FullyQualifiedDomainName
to the endpoint in the Host
header.Port
and any value except TCP
for Type
, Route 53 passes FullyQualifiedDomainName:Port
to the endpoint in the Host
header.FullyQualifiedDomainName
, Route 53 substitutes the value of IPAddress
in the Host
header in each of the preceding cases.If you don't specify a value for IPAddress
:Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName
at the interval that you specify for RequestInterval
. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.If you don't specify a value for IPAddress
, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName
, the health check fails with a "DNS resolution failed" error.If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName
, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName
, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).FullyQualifiedDomainName
matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.Type
is HTTP
, HTTPS
, HTTP_STR_MATCH
, or HTTPS_STR_MATCH
, Route 53 passes the value of FullyQualifiedDomainName
in the Host
header, as it does when you specify a value for IPAddress
. If the value of Type
is TCP
, Route 53 doesn't pass a Host
header. Required? | False |
Position? | Named |
Accept pipeline input? | False |
CALCULATED
health that Amazon Route 53 must consider healthy for the CALCULATED
health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED
health check, use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.Note the following:0
, Route 53 always considers this health check to be healthy.Required? | False |
Position? | Named |
Accept pipeline input? | False |
Healthy
: Route 53 considers the health check to be healthy.Unhealthy
: Route 53 considers the health check to be unhealthy.LastKnownStatus
: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
IPAddress
, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName
at the interval that you specify in RequestInterval
. Using an IP address returned by DNS, Route 53 then checks the health of the endpoint.Use one of the following formats for the value of IPAddress
: 192.0.2.44
.2001:0db8:85a3:0000:0000:abcd:0001:2345
. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345
.IPAddress
. This ensures that the IP address of your instance will never change.For more information, see HealthCheckConfig$FullyQualifiedDomainName.Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:Type
is CALCULATED
or CLOUDWATCH_METRIC
, omit IPAddress
. Required? | False |
Position? | Named |
Accept pipeline input? | False |
MeasureLatency
after you create a health check.Required? | False |
Position? | Named |
Accept pipeline input? | False |
Port
only when you specify a value for IPAddress
. Required? | False |
Position? | Named |
Accept pipeline input? | False |
Region
element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.If you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions). Required? | False |
Position? | Named |
Accept pipeline input? | False |
RequestInterval
after you create a health check.RequestInterval
, the default value is 30
seconds. Required? | False |
Position? | Named |
Accept pipeline input? | False |
/welcome.html?language=jp&login=y
. Required? | False |
Position? | Named |
Accept pipeline input? | False |
HTTP_STR_MATCH
or HTTP_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.Route 53 considers case when searching for SearchString
in the response body. Required? | False |
Position? | Named |
Accept pipeline input? | False |
Type
after you create a health check.HTTPS
for the value of Type
, the endpoint must support TLS v1.0 or later.SearchString
.HTTPS
request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString
.OK
, the health check is considered healthy. If the state is ALARM
, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK
or ALARM
, the health check status depends on the setting for InsufficientDataHealthStatus
: Healthy
, Unhealthy
, or LastKnownStatus
. HealthThreshold
.Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required? | False |
Position? | Named |
Accept pipeline input? | False |
AWS Tools for PowerShell: 2.x.y.z