Class HealthCheckSource

java.lang.Object
software.amazon.awssdk.services.route53.model.HealthCheckSource
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HealthCheckSource.Builder,HealthCheckSource>

@Generated("software.amazon.awssdk:codegen") public final class HealthCheckSource extends Object implements SdkPojo, Serializable, 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:
  • Method Details

    • healthCheckSourceId

      public final String 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

      public final HealthCheckSourceStatus 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 is CREATE_COMPLETED.

      • CREATE_IN_PROGRESS - Route 53 is creating the source. You can't use the source in a health check until its status is CREATE_COMPLETED.

      • CREATE_COMPLETED - The source is ready to use.

      • CREATE_FAILED - Route 53 couldn't create the source. StatusReasonCode and StatusReason explain 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: GetHealthCheckSource returns NoSuchHealthCheckSource.

      • DELETE_FAILED - Route 53 couldn't delete the source. StatusReasonCode and StatusReason explain why.

      If the status is CREATE_FAILED, fix the cause that StatusReasonCode indicates, and then either retry CreateHealthCheckSource with the same CallerReference and settings, or delete the source and create a new one. If the status is DELETE_FAILED, retry the DeleteHealthCheckSource request.

      If the service returns an enum value that is not available in the current SDK version, healthCheckSourceStatus will return HealthCheckSourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthCheckSourceStatusAsString().

      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 is CREATE_COMPLETED .

      • CREATE_IN_PROGRESS - Route 53 is creating the source. You can't use the source in a health check until its status is CREATE_COMPLETED.

      • CREATE_COMPLETED - The source is ready to use.

      • CREATE_FAILED - Route 53 couldn't create the source. StatusReasonCode and StatusReason explain 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: GetHealthCheckSource returns NoSuchHealthCheckSource.

      • DELETE_FAILED - Route 53 couldn't delete the source. StatusReasonCode and StatusReason explain why.

      If the status is CREATE_FAILED, fix the cause that StatusReasonCode indicates, and then either retry CreateHealthCheckSource with the same CallerReference and settings, or delete the source and create a new one. If the status is DELETE_FAILED, retry the DeleteHealthCheckSource request.

      See Also:
    • healthCheckSourceStatusAsString

      public final String 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 is CREATE_COMPLETED.

      • CREATE_IN_PROGRESS - Route 53 is creating the source. You can't use the source in a health check until its status is CREATE_COMPLETED.

      • CREATE_COMPLETED - The source is ready to use.

      • CREATE_FAILED - Route 53 couldn't create the source. StatusReasonCode and StatusReason explain 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: GetHealthCheckSource returns NoSuchHealthCheckSource.

      • DELETE_FAILED - Route 53 couldn't delete the source. StatusReasonCode and StatusReason explain why.

      If the status is CREATE_FAILED, fix the cause that StatusReasonCode indicates, and then either retry CreateHealthCheckSource with the same CallerReference and settings, or delete the source and create a new one. If the status is DELETE_FAILED, retry the DeleteHealthCheckSource request.

      If the service returns an enum value that is not available in the current SDK version, healthCheckSourceStatus will return HealthCheckSourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthCheckSourceStatusAsString().

      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 is CREATE_COMPLETED .

      • CREATE_IN_PROGRESS - Route 53 is creating the source. You can't use the source in a health check until its status is CREATE_COMPLETED.

      • CREATE_COMPLETED - The source is ready to use.

      • CREATE_FAILED - Route 53 couldn't create the source. StatusReasonCode and StatusReason explain 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: GetHealthCheckSource returns NoSuchHealthCheckSource.

      • DELETE_FAILED - Route 53 couldn't delete the source. StatusReasonCode and StatusReason explain why.

      If the status is CREATE_FAILED, fix the cause that StatusReasonCode indicates, and then either retry CreateHealthCheckSource with the same CallerReference and settings, or delete the source and create a new one. If the status is DELETE_FAILED, retry the DeleteHealthCheckSource request.

      See Also:
    • healthCheckSourceConfig

      public final HealthCheckSourceConfig 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

      public final HealthCheckSourceStatusReasonCode statusReasonCode()

      A code that indicates why the health check source has a status of CREATE_FAILED or DELETE_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 an AvailabilityZoneId doesn't match the Availability Zone of its subnet. Check that each subnet ID is correct, that the subnet exists, and that each AvailabilityZoneId matches 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 that VpcId is 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, statusReasonCode will return HealthCheckSourceStatusReasonCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusReasonCodeAsString().

      Returns:
      A code that indicates why the health check source has a status of CREATE_FAILED or DELETE_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 an AvailabilityZoneId doesn't match the Availability Zone of its subnet. Check that each subnet ID is correct, that the subnet exists, and that each AvailabilityZoneId matches 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 that VpcId is 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

      public final String statusReasonCodeAsString()

      A code that indicates why the health check source has a status of CREATE_FAILED or DELETE_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 an AvailabilityZoneId doesn't match the Availability Zone of its subnet. Check that each subnet ID is correct, that the subnet exists, and that each AvailabilityZoneId matches 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 that VpcId is 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, statusReasonCode will return HealthCheckSourceStatusReasonCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusReasonCodeAsString().

      Returns:
      A code that indicates why the health check source has a status of CREATE_FAILED or DELETE_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 an AvailabilityZoneId doesn't match the Availability Zone of its subnet. Check that each subnet ID is correct, that the subnet exists, and that each AvailabilityZoneId matches 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 that VpcId is 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

      public final String statusReason()

      A description of why the health check source has a status of CREATE_FAILED or DELETE_FAILED, and what you can do about it. The text corresponds to the value of StatusReasonCode. Route 53 returns this member only when StatusReasonCode is present.

      Returns:
      A description of why the health check source has a status of CREATE_FAILED or DELETE_FAILED, and what you can do about it. The text corresponds to the value of StatusReasonCode. Route 53 returns this member only when StatusReasonCode is present.
    • toBuilder

      public HealthCheckSource.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<HealthCheckSource.Builder,HealthCheckSource>
      Returns:
      a builder for type T
    • builder

      public static HealthCheckSource.Builder builder()
    • serializableBuilderClass

      public static Class<? extends HealthCheckSource.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.