CreateHealthCheckSource
Creates a health check source, which defines the virtual private cloud (VPC), subnets, and security groups from which Route 53 sends private endpoint health check requests. To use this operation, you must have the route53:CreateHealthCheckSource permission. You must also have permission to create a service-linked role.
Specify a VPC, one subnet in each Availability Zone that Route 53 uses for private endpoint health checks in the AWS Region, and one or more security groups for each subnet. The security groups must allow outbound traffic to the endpoints that you want to check.
Route 53 creates a health check source asynchronously, and the initial HealthCheckSourceStatus is CREATE_PENDING. Call GetHealthCheckSource until the status is CREATE_COMPLETED before you create health checks that use the source. You can't change the configuration of a health check source after you create it.
If AWS Identity and Access Management (IAM) is still deleting the Route 53 service-linked role for your account, the request fails with InvalidInput. Retry after the deletion completes.
Request Syntax
POST /2013-04-01/healthchecksource HTTP/1.1
<?xml version="1.0" encoding="UTF-8"?>
<CreateHealthCheckSourceRequest xmlns="https://route53.amazonaws.com/doc/2013-04-01/">
<CallerReference>string</CallerReference>
<HealthCheckSourceConfig>
<SubnetConfigurationList>
<SubnetConfiguration>
<AvailabilityZoneId>string</AvailabilityZoneId>
<SecurityGroupIdList>
<SecurityGroupId>string</SecurityGroupId>
</SecurityGroupIdList>
<SubnetId>string</SubnetId>
</SubnetConfiguration>
</SubnetConfigurationList>
<VpcId>string</VpcId>
</HealthCheckSourceConfig>
<Tags>
<Tag>
<Key>string</Key>
<Value>string</Value>
</Tag>
</Tags>
</CreateHealthCheckSourceRequest>
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in XML format.
- CreateHealthCheckSourceRequest
-
Root level tag for the CreateHealthCheckSourceRequest parameters.
Required: Yes
- CallerReference
-
A unique, case-sensitive identifier that ensures that the operation completes no more than one time. If you retry a
CreateHealthCheckSourcerequest with the sameCallerReferenceand the same settings as a previous request, Route 53 returns the existing health check source without creating a duplicate. If that health check source has a status ofCREATE_FAILED, Route 53 tries to create it again. To create a new health check source after a failure, specify a new value forCallerReference. If a health check source with the sameCallerReferencealready exists and the settings differ, Route 53 returns aHealthCheckSourceAlreadyExistserror.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
- HealthCheckSourceConfig
-
A complex type that contains the virtual private cloud (VPC), subnets, and security groups for the health check source.
Type: HealthCheckSourceConfig object
Required: Yes
- Tags
-
A complex type that contains a list of the tags that you want to apply to the health check source when you create it.
Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
Response Syntax
HTTP/1.1 201
Location: Location
<?xml version="1.0" encoding="UTF-8"?>
<CreateHealthCheckSourceResponse>
<HealthCheckSourceId>string</HealthCheckSourceId>
<HealthCheckSourceStatus>string</HealthCheckSourceStatus>
</CreateHealthCheckSourceResponse>
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The response returns the following HTTP headers.
- Location
-
The unique URL representing the new health check source.
Length Constraints: Maximum length of 1024.
The following data is returned in XML format by the service.
- CreateHealthCheckSourceResponse
-
Root level tag for the CreateHealthCheckSourceResponse parameters.
Required: Yes
- HealthCheckSourceId
-
The ID of the new health check source. Route 53 assigns this ID when it creates the source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- HealthCheckSourceStatus
-
The current status of the health check source. Immediately after you create a health check source, the status is
CREATE_PENDING. If the request is a retry with the sameCallerReference, the status is the current status of the existing health check source.Type: String
Valid Values:
CREATE_PENDING | CREATE_IN_PROGRESS | CREATE_COMPLETED | CREATE_FAILED | DELETE_PENDING | DELETE_IN_PROGRESS | DELETE_COMPLETED | DELETE_FAILED
Errors
For information about the errors that are common to all actions, see Common Error Types.
- HealthCheckSourceAlreadyExists
-
The health check source that you're attempting to create already exists. Route 53 returns this error when you submit a request that has the same value for
CallerReferenceas an existing health check source and one or more values that differ from the existing health check source. To create another health check source, specify a new value forCallerReference. To find the existing health check source, callListHealthCheckSources.HTTP Status Code: 409
- InvalidInput
-
The input is not valid.
- message
HTTP Status Code: 400
- InvalidVPCId
-
The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.
- message
HTTP Status Code: 400
- TooManyHealthCheckSources
-
You can't create this health check source because the current account has reached its maximum number of health check sources. The maximum includes every health check source that hasn't reached
DELETE_COMPLETEDstatus, including a health check source with a status ofCREATE_FAILED.For information about default limits, see Limits in the Amazon Route 53 Developer Guide.
For information about how to get the current limit for an account, see GetAccountLimit. To request a higher limit, create a case
with the AWS Support Center. HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: