AssociateHealthCheck
Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Configuring health-based detection using health checks in the AWS WAF Developer Guide and Creating, updating, and deleting health checks in the Amazon Route 53 Developer Guide.
Request Syntax
{
"HealthCheckArn": "string",
"ProtectionId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- HealthCheckArn
-
The Amazon Resource Name (ARN) of the health check to associate with the protection.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws:route53:::healthcheck/\S{36}$Required: Yes
- ProtectionId
-
The unique identifier (ID) for the Protection object to add the health check association to.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9\\-]*Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
HTTP Status Code: 500
- InvalidParameterException
-
Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
HTTP Status Code: 400
- InvalidResourceException
-
Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.
HTTP Status Code: 400
- LimitsExceededException
-
Exception that indicates that the operation would exceed a limit.
HTTP Status Code: 400
- OptimisticLockException
-
Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
HTTP Status Code: 400
- ResourceNotFoundException
-
Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
