AWS Tools for Windows PowerShell
Command Reference

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.

Synopsis

Calls the Amazon Route 53 UpdateHealthCheck API operation.

Syntax

Update-R53HealthCheck
-HealthCheckId <String>
-ChildHealthCheck <String[]>
-EnableSNI <Boolean>
-FailureThreshold <Int32>
-FullyQualifiedDomainName <String>
-HealthCheckVersion <Int64>
-HealthThreshold <Int32>
-InsufficientDataHealthStatus <InsufficientDataHealthStatus>
-Inverted <Boolean>
-IPAddress <String>
-AlarmIdentifier_Name <String>
-Port <Int32>
-AlarmIdentifier_Region <CloudWatchRegion>
-HealthCheckRegion <String[]>
-ResourcePath <String>
-SearchString <String>
-Force <SwitchParameter>

Description

This action updates an existing health check. To update a health check, send a POST request to the /Route 53 API version/healthcheck/health check ID resource. The request body must include a document with an UpdateHealthCheckRequest element. The response returns an UpdateHealthCheckResponse element, which contains metadata about the health check.

Parameters

-AlarmIdentifier_Name <String>
The name of the CloudWatch alarm.
Required?False
Position?Named
Accept pipeline input?False
-AlarmIdentifier_Region <CloudWatchRegion>
The CloudWatchRegion that the CloudWatch alarm was created in.
Required?False
Position?Named
Accept pipeline input?False
-ChildHealthCheck <String[]>
For a specified parent health check, a list of HealthCheckId values for the associated child health checks.Specify this value only if you want to change it.
Required?False
Position?Named
Accept pipeline input?False
-EnableSNI <Boolean>
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. If you don't specify a value for EnableSNI, Amazon Route 53 defaults to true when Type is HTTPS or HTTPS_STR_MATCH and defaults to false when Type is any other value.Specify this value only if you want to change it.
Required?False
Position?Named
Accept pipeline input?False
-FailureThreshold <Int32>
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.Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.Specify this value only if you want to change it.
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-FullyQualifiedDomainName <String>
Fully qualified domain name of the instance to be health checked.Specify this value only if you want to change it.
Required?False
Position?Named
Accept pipeline input?False
-HealthCheckId <String>
The ID of the health check to update.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-HealthCheckRegion <String[]>
A list of HealthCheckRegion values that specify the Amazon EC2 regions that you want Amazon Route 53 to use to perform health checks. You must specify at least three regions.When you remove a region from the list, Amazon Route 53 will briefly continue to check your endpoint from that region.Specify this value only if you want to change it.
Required?False
Position?Named
Accept pipeline input?False
-HealthCheckVersion <Int64>
Optional. When you specify a health check version, Amazon Route 53 compares this value with the current value in the health check, which prevents you from updating the health check when the versions don't match. Using HealthCheckVersion lets you prevent overwriting another change to the health check.
Required?False
Position?Named
Accept pipeline input?False
-HealthThreshold <Int32>
The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.Specify this value only if you want to change it.
Required?False
Position?Named
Accept pipeline input?False
-InsufficientDataHealthStatus <InsufficientDataHealthStatus>
Documentation for this parameter is not currently available; please refer to the service API documentation.
Required?False
Position?Named
Accept pipeline input?False
-Inverted <Boolean>
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 Amazon Route 53 considers the health check to be unhealthy.Specify this value only if you want to change it.
Required?False
Position?Named
Accept pipeline input?False
-IPAddress <String>
The IP address of the resource that you want to check.Specify this value only if you want to change it.
Required?False
Position?Named
Accept pipeline input?False
-Port <Int32>
The port on which you want Amazon Route 53 to open a connection to perform health checks.Specify this value only if you want to change it.
Required?False
Position?Named
Accept pipeline input?False
-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.Specify this value only if you want to change it.
Required?False
Position?Named
Accept pipeline input?False
-SearchString <String>
If the value of Type is 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, Amazon Route 53 considers the resource healthy. Amazon Route 53 considers case when searching for SearchString in the response body.Specify this value only if you want to change it.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

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
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

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

Inputs

You can pipe a String object to this cmdlet for the HealthCheckId parameter.

Outputs

This cmdlet returns a HealthCheck object. The service call response (type Amazon.Route53.Model.UpdateHealthCheckResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z