Package software.amazon.awscdk.services.route53

Class HealthCheckProps.Builder

java.lang.Object
software.amazon.awscdk.services.route53.HealthCheckProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<HealthCheckProps>
Enclosing interface:
HealthCheckProps
@Stability(Stable) public static final class HealthCheckProps.Builder extends Object implements software.amazon.jsii.Builder<HealthCheckProps>
A builder for HealthCheckProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • type

      @Stability(Stable) public HealthCheckProps.Builder type(HealthCheckType type)
      Sets the value of HealthCheckProps.getType()
      Parameters:
      type - The type of health check to be associated with the record. This parameter is required.
      Returns:
      this

    • alarmIdentifier

      @Stability(Stable) public HealthCheckProps.Builder alarmIdentifier(AlarmIdentifier alarmIdentifier)
      Sets the value of HealthCheckProps.getAlarmIdentifier()
      Parameters:
      alarmIdentifier - CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
      Returns:
      this

    • childHealthChecks

      @Stability(Stable) public HealthCheckProps.Builder childHealthChecks(List<? extends IHealthCheck> childHealthChecks)
      Sets the value of HealthCheckProps.getChildHealthChecks()
      Parameters:
      childHealthChecks - A list of health checks to monitor for this 'CALCULATED' health check.
      Returns:
      this

    • enableSni

      @Stability(Stable) public HealthCheckProps.Builder enableSni(Boolean enableSni)
      Sets the value of
      invalid @link 
      HealthCheckProps#getEnableSni
      Parameters:
      enableSni - Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.
      Returns:
      this

    • failureThreshold

      @Stability(Stable) public HealthCheckProps.Builder failureThreshold(Number failureThreshold)
      Sets the value of HealthCheckProps.getFailureThreshold()
      Parameters:
      failureThreshold - 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.
      Returns:
      this

    • fqdn

      @Stability(Stable) public HealthCheckProps.Builder fqdn(String fqdn)
      Sets the value of HealthCheckProps.getFqdn()
      Parameters:
      fqdn - Fully qualified domain name of the endpoint to be checked. Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

      If you specify a value for IPAddress:

      Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks. Note: If you specify a value for Port property other than 80 or 443, Route 53 will constract the value for Host header as FullyQualifiedDomainName:Port.

      If you don't specify a value for IPAddress:

      Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.

      Additionally, if the type of the health check is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify value for IPAddress. If the type is TCP, Route 53 doesn't pass a Host header.

      Returns:
      this

    • healthThreshold

      @Stability(Stable) public HealthCheckProps.Builder healthThreshold(Number healthThreshold)
      Sets the value of HealthCheckProps.getHealthThreshold()
      Parameters:
      healthThreshold - The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy.
      Returns:
      this

    • insufficientDataHealthStatus

      @Stability(Stable) public HealthCheckProps.Builder insufficientDataHealthStatus(InsufficientDataHealthStatusEnum insufficientDataHealthStatus)
      Sets the value of HealthCheckProps.getInsufficientDataHealthStatus()
      Parameters:
      insufficientDataHealthStatus - The status of the health check when CloudWatch has insufficient data about the state of associated alarm.
      Returns:
      this

    • inverted

      @Stability(Stable) public HealthCheckProps.Builder inverted(Boolean inverted)
      Sets the value of HealthCheckProps.getInverted()
      Parameters:
      inverted - Specify whether you want Amazon Route 53 to invert the status of a health check, so a health check that would normally be considered unhealthy is considered healthy, and vice versa.
      Returns:
      this

    • ipAddress

      @Stability(Stable) public HealthCheckProps.Builder ipAddress(String ipAddress)
      Sets the value of HealthCheckProps.getIpAddress()
      Parameters:
      ipAddress - The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.
      Returns:
      this

    • measureLatency

      @Stability(Stable) public HealthCheckProps.Builder measureLatency(Boolean measureLatency)
      Sets the value of HealthCheckProps.getMeasureLatency()
      Parameters:
      measureLatency - Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Route 53 console.
      Returns:
      this

    • port

      @Stability(Stable) public HealthCheckProps.Builder port(Number port)
      Sets the value of HealthCheckProps.getPort()
      Parameters:
      port - The port on the endpoint that you want Amazon Route 53 to perform health checks on.
      Returns:
      this

    • regions

      @Stability(Stable) public HealthCheckProps.Builder regions(List<String> regions)
      Sets the value of HealthCheckProps.getRegions()
      Parameters:
      regions - An array of region identifiers that you want Amazon Route 53 health checkers to check the health of the endpoint from. Please refer to the CloudFormation documentation for the most up-to-date list of regions.
      Returns:
      this

    • requestInterval

      @Stability(Stable) public HealthCheckProps.Builder requestInterval(Duration requestInterval)
      Sets the value of HealthCheckProps.getRequestInterval()
      Parameters:
      requestInterval - The duration between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Route 53 health checker makes requests at this interval.
      Returns:
      this

    • resourcePath

      @Stability(Stable) public HealthCheckProps.Builder resourcePath(String resourcePath)
      Sets the value of HealthCheckProps.getResourcePath()
      Parameters:
      resourcePath - 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. Route 53 automatically adds the DNS name for the service and a leading forward slash (/) character.
      Returns:
      this

    • routingControl

      @Stability(Stable) public HealthCheckProps.Builder routingControl(String routingControl)
      Sets the value of HealthCheckProps.getRoutingControl()
      Parameters:
      routingControl - The Amazon Resource Name (ARN) of the Route 53 Application Recovery Controller routing control that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
      Returns:
      this

    • searchString

      @Stability(Stable) public HealthCheckProps.Builder searchString(String searchString)
      Sets the value of HealthCheckProps.getSearchString()
      Parameters:
      searchString - 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, Route 53 considers the resource healthy.

      Route 53 considers case when searching for SearchString in the response body.

      Returns:
      this

    • build

      @Stability(Stable) public HealthCheckProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<HealthCheckProps>
      Returns:
      a new instance of HealthCheckProps
      Throws:
      NullPointerException - if any required attribute was not provided