Class HealthCheckSource
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<HealthCheckSource.Builder,HealthCheckSource>
A complex type that contains information about a health check source: its ID, its status, and the virtual private cloud (VPC), subnets, and security groups from which Route 53 sends health check requests to private endpoints.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic HealthCheckSource.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final HealthCheckSourceConfigThe virtual private cloud (VPC), subnets, and security groups for the health check source.final StringThe ID of the health check source.final HealthCheckSourceStatusThe current status of the health check source.final StringThe current status of the health check source.static Class<? extends HealthCheckSource.Builder> final StringA description of why the health check source has a status ofCREATE_FAILEDorDELETE_FAILED, and what you can do about it.A code that indicates why the health check source has a status ofCREATE_FAILEDorDELETE_FAILED.final StringA code that indicates why the health check source has a status ofCREATE_FAILEDorDELETE_FAILED.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
healthCheckSourceId
The ID of the health check source. Route 53 assigns this ID when it creates the source.
- Returns:
- The ID of the health check source. Route 53 assigns this ID when it creates the source.
-
healthCheckSourceStatus
The current status of the health check source. The health check source status can have one of the following values:
-
CREATE_PENDING- Route 53 accepted the request to create the source and hasn't started creating it. You can't use the source in a health check until its status isCREATE_COMPLETED. -
CREATE_IN_PROGRESS- Route 53 is creating the source. You can't use the source in a health check until its status isCREATE_COMPLETED. -
CREATE_COMPLETED- The source is ready to use. -
CREATE_FAILED- Route 53 couldn't create the source.StatusReasonCodeandStatusReasonexplain why. -
DELETE_PENDING- Route 53 accepted the request to delete the source and hasn't started deleting it. -
DELETE_IN_PROGRESS- Route 53 is deleting the source. -
DELETE_COMPLETED- Route 53 has deleted the source. You can't retrieve a health check source in this status:GetHealthCheckSourcereturnsNoSuchHealthCheckSource. -
DELETE_FAILED- Route 53 couldn't delete the source.StatusReasonCodeandStatusReasonexplain why.
If the status is
CREATE_FAILED, fix the cause thatStatusReasonCodeindicates, and then either retryCreateHealthCheckSourcewith the sameCallerReferenceand settings, or delete the source and create a new one. If the status isDELETE_FAILED, retry theDeleteHealthCheckSourcerequest.If the service returns an enum value that is not available in the current SDK version,
healthCheckSourceStatuswill returnHealthCheckSourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromhealthCheckSourceStatusAsString().- Returns:
- The current status of the health check source. The health check source status can have one of the
following values:
-
CREATE_PENDING- Route 53 accepted the request to create the source and hasn't started creating it. You can't use the source in a health check until its status isCREATE_COMPLETED. -
CREATE_IN_PROGRESS- Route 53 is creating the source. You can't use the source in a health check until its status isCREATE_COMPLETED. -
CREATE_COMPLETED- The source is ready to use. -
CREATE_FAILED- Route 53 couldn't create the source.StatusReasonCodeandStatusReasonexplain why. -
DELETE_PENDING- Route 53 accepted the request to delete the source and hasn't started deleting it. -
DELETE_IN_PROGRESS- Route 53 is deleting the source. -
DELETE_COMPLETED- Route 53 has deleted the source. You can't retrieve a health check source in this status:GetHealthCheckSourcereturnsNoSuchHealthCheckSource. -
DELETE_FAILED- Route 53 couldn't delete the source.StatusReasonCodeandStatusReasonexplain why.
If the status is
CREATE_FAILED, fix the cause thatStatusReasonCodeindicates, and then either retryCreateHealthCheckSourcewith the sameCallerReferenceand settings, or delete the source and create a new one. If the status isDELETE_FAILED, retry theDeleteHealthCheckSourcerequest. -
- See Also:
-
-
healthCheckSourceStatusAsString
The current status of the health check source. The health check source status can have one of the following values:
-
CREATE_PENDING- Route 53 accepted the request to create the source and hasn't started creating it. You can't use the source in a health check until its status isCREATE_COMPLETED. -
CREATE_IN_PROGRESS- Route 53 is creating the source. You can't use the source in a health check until its status isCREATE_COMPLETED. -
CREATE_COMPLETED- The source is ready to use. -
CREATE_FAILED- Route 53 couldn't create the source.StatusReasonCodeandStatusReasonexplain why. -
DELETE_PENDING- Route 53 accepted the request to delete the source and hasn't started deleting it. -
DELETE_IN_PROGRESS- Route 53 is deleting the source. -
DELETE_COMPLETED- Route 53 has deleted the source. You can't retrieve a health check source in this status:GetHealthCheckSourcereturnsNoSuchHealthCheckSource. -
DELETE_FAILED- Route 53 couldn't delete the source.StatusReasonCodeandStatusReasonexplain why.
If the status is
CREATE_FAILED, fix the cause thatStatusReasonCodeindicates, and then either retryCreateHealthCheckSourcewith the sameCallerReferenceand settings, or delete the source and create a new one. If the status isDELETE_FAILED, retry theDeleteHealthCheckSourcerequest.If the service returns an enum value that is not available in the current SDK version,
healthCheckSourceStatuswill returnHealthCheckSourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromhealthCheckSourceStatusAsString().- Returns:
- The current status of the health check source. The health check source status can have one of the
following values:
-
CREATE_PENDING- Route 53 accepted the request to create the source and hasn't started creating it. You can't use the source in a health check until its status isCREATE_COMPLETED. -
CREATE_IN_PROGRESS- Route 53 is creating the source. You can't use the source in a health check until its status isCREATE_COMPLETED. -
CREATE_COMPLETED- The source is ready to use. -
CREATE_FAILED- Route 53 couldn't create the source.StatusReasonCodeandStatusReasonexplain why. -
DELETE_PENDING- Route 53 accepted the request to delete the source and hasn't started deleting it. -
DELETE_IN_PROGRESS- Route 53 is deleting the source. -
DELETE_COMPLETED- Route 53 has deleted the source. You can't retrieve a health check source in this status:GetHealthCheckSourcereturnsNoSuchHealthCheckSource. -
DELETE_FAILED- Route 53 couldn't delete the source.StatusReasonCodeandStatusReasonexplain why.
If the status is
CREATE_FAILED, fix the cause thatStatusReasonCodeindicates, and then either retryCreateHealthCheckSourcewith the sameCallerReferenceand settings, or delete the source and create a new one. If the status isDELETE_FAILED, retry theDeleteHealthCheckSourcerequest. -
- See Also:
-
-
healthCheckSourceConfig
The virtual private cloud (VPC), subnets, and security groups for the health check source.
- Returns:
- The virtual private cloud (VPC), subnets, and security groups for the health check source.
-
statusReasonCode
A code that indicates why the health check source has a status of
CREATE_FAILEDorDELETE_FAILED. Route 53 returns this member only when the status is one of those values. The code can have one of the following values:-
INSUFFICIENT_SUBNET_IPS- One of the specified subnets doesn't have enough free private IP addresses. Check the available IP addresses in each subnet, and delete network interfaces that you don't need. -
EC2_LIMIT_EXCEEDED- Your account reached an Amazon virtual private cloud (VPC) quota for network interfaces or security groups. Delete network interfaces that you don't need, specify fewer security groups, or request a quota increase. -
INVALID_SUBNET- One of the specified subnets doesn't exist or isn't valid, or anAvailabilityZoneIddoesn't match the Availability Zone of its subnet. Check that each subnet ID is correct, that the subnet exists, and that eachAvailabilityZoneIdmatches its subnet. -
INVALID_SECURITY_GROUP- One of the specified security groups doesn't exist or isn't valid. Check that each security group ID is correct and that the security group exists. -
INVALID_CONFIGURATION- The combination of VPC, subnets, and security groups isn't valid. Check thatVpcIdis correct and exists, that each subnet is in that VPC, and that the security groups for each subnet are in the same VPC as that subnet. -
SLR_MISSING_OR_NOT_ASSUMABLE- Route 53 couldn't assume its service-linked role in your account. In IAM, check that the service-linked role for Route 53 private endpoint health checks exists and that no deletion task for it is in progress. -
INTERNAL_ERROR- Route 53 encountered an internal error. Contact Amazon Web Services Support and provide the health check source ID.
If the service returns an enum value that is not available in the current SDK version,
statusReasonCodewill returnHealthCheckSourceStatusReasonCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusReasonCodeAsString().- Returns:
- A code that indicates why the health check source has a status of
CREATE_FAILEDorDELETE_FAILED. Route 53 returns this member only when the status is one of those values. The code can have one of the following values:-
INSUFFICIENT_SUBNET_IPS- One of the specified subnets doesn't have enough free private IP addresses. Check the available IP addresses in each subnet, and delete network interfaces that you don't need. -
EC2_LIMIT_EXCEEDED- Your account reached an Amazon virtual private cloud (VPC) quota for network interfaces or security groups. Delete network interfaces that you don't need, specify fewer security groups, or request a quota increase. -
INVALID_SUBNET- One of the specified subnets doesn't exist or isn't valid, or anAvailabilityZoneIddoesn't match the Availability Zone of its subnet. Check that each subnet ID is correct, that the subnet exists, and that eachAvailabilityZoneIdmatches its subnet. -
INVALID_SECURITY_GROUP- One of the specified security groups doesn't exist or isn't valid. Check that each security group ID is correct and that the security group exists. -
INVALID_CONFIGURATION- The combination of VPC, subnets, and security groups isn't valid. Check thatVpcIdis correct and exists, that each subnet is in that VPC, and that the security groups for each subnet are in the same VPC as that subnet. -
SLR_MISSING_OR_NOT_ASSUMABLE- Route 53 couldn't assume its service-linked role in your account. In IAM, check that the service-linked role for Route 53 private endpoint health checks exists and that no deletion task for it is in progress. -
INTERNAL_ERROR- Route 53 encountered an internal error. Contact Amazon Web Services Support and provide the health check source ID.
-
- See Also:
-
-
statusReasonCodeAsString
A code that indicates why the health check source has a status of
CREATE_FAILEDorDELETE_FAILED. Route 53 returns this member only when the status is one of those values. The code can have one of the following values:-
INSUFFICIENT_SUBNET_IPS- One of the specified subnets doesn't have enough free private IP addresses. Check the available IP addresses in each subnet, and delete network interfaces that you don't need. -
EC2_LIMIT_EXCEEDED- Your account reached an Amazon virtual private cloud (VPC) quota for network interfaces or security groups. Delete network interfaces that you don't need, specify fewer security groups, or request a quota increase. -
INVALID_SUBNET- One of the specified subnets doesn't exist or isn't valid, or anAvailabilityZoneIddoesn't match the Availability Zone of its subnet. Check that each subnet ID is correct, that the subnet exists, and that eachAvailabilityZoneIdmatches its subnet. -
INVALID_SECURITY_GROUP- One of the specified security groups doesn't exist or isn't valid. Check that each security group ID is correct and that the security group exists. -
INVALID_CONFIGURATION- The combination of VPC, subnets, and security groups isn't valid. Check thatVpcIdis correct and exists, that each subnet is in that VPC, and that the security groups for each subnet are in the same VPC as that subnet. -
SLR_MISSING_OR_NOT_ASSUMABLE- Route 53 couldn't assume its service-linked role in your account. In IAM, check that the service-linked role for Route 53 private endpoint health checks exists and that no deletion task for it is in progress. -
INTERNAL_ERROR- Route 53 encountered an internal error. Contact Amazon Web Services Support and provide the health check source ID.
If the service returns an enum value that is not available in the current SDK version,
statusReasonCodewill returnHealthCheckSourceStatusReasonCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusReasonCodeAsString().- Returns:
- A code that indicates why the health check source has a status of
CREATE_FAILEDorDELETE_FAILED. Route 53 returns this member only when the status is one of those values. The code can have one of the following values:-
INSUFFICIENT_SUBNET_IPS- One of the specified subnets doesn't have enough free private IP addresses. Check the available IP addresses in each subnet, and delete network interfaces that you don't need. -
EC2_LIMIT_EXCEEDED- Your account reached an Amazon virtual private cloud (VPC) quota for network interfaces or security groups. Delete network interfaces that you don't need, specify fewer security groups, or request a quota increase. -
INVALID_SUBNET- One of the specified subnets doesn't exist or isn't valid, or anAvailabilityZoneIddoesn't match the Availability Zone of its subnet. Check that each subnet ID is correct, that the subnet exists, and that eachAvailabilityZoneIdmatches its subnet. -
INVALID_SECURITY_GROUP- One of the specified security groups doesn't exist or isn't valid. Check that each security group ID is correct and that the security group exists. -
INVALID_CONFIGURATION- The combination of VPC, subnets, and security groups isn't valid. Check thatVpcIdis correct and exists, that each subnet is in that VPC, and that the security groups for each subnet are in the same VPC as that subnet. -
SLR_MISSING_OR_NOT_ASSUMABLE- Route 53 couldn't assume its service-linked role in your account. In IAM, check that the service-linked role for Route 53 private endpoint health checks exists and that no deletion task for it is in progress. -
INTERNAL_ERROR- Route 53 encountered an internal error. Contact Amazon Web Services Support and provide the health check source ID.
-
- See Also:
-
-
statusReason
A description of why the health check source has a status of
CREATE_FAILEDorDELETE_FAILED, and what you can do about it. The text corresponds to the value ofStatusReasonCode. Route 53 returns this member only whenStatusReasonCodeis present.- Returns:
- A description of why the health check source has a status of
CREATE_FAILEDorDELETE_FAILED, and what you can do about it. The text corresponds to the value ofStatusReasonCode. Route 53 returns this member only whenStatusReasonCodeis present.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<HealthCheckSource.Builder,HealthCheckSource> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-