You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Route53::Types::CreateHealthCheckRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateHealthCheckRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  caller_reference: "HealthCheckNonce", # required
  health_check_config: { # required
    ip_address: "IPAddress",
    port: 1,
    type: "HTTP", # required, accepts HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC
    resource_path: "ResourcePath",
    fully_qualified_domain_name: "FullyQualifiedDomainName",
    search_string: "SearchString",
    request_interval: 1,
    failure_threshold: 1,
    measure_latency: false,
    inverted: false,
    health_threshold: 1,
    child_health_checks: ["HealthCheckId"],
    enable_sni: false,
    regions: ["us-east-1"], # accepts us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1
    alarm_identifier: {
      region: "us-east-1", # required, accepts us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-central-1, eu-west-1, eu-west-2, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, sa-east-1
      name: "AlarmName", # required
    },
    insufficient_data_health_status: "Healthy", # accepts Healthy, Unhealthy, LastKnownStatus
  },
}

A complex type that contains the health check request information.

Instance Attribute Summary collapse

Instance Attribute Details

#caller_referenceString

A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks:

  • If you send a CreateHealthCheck request with the same CallerReference and settings as a previous request, and if the health check doesn\'t exist, Amazon Route 53 creates the health check. If the health check does exist, Amazon Route 53 returns the settings for the existing health check.

  • If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, regardless of the settings, Amazon Route 53 returns a HealthCheckAlreadyExists error.

  • If you send a CreateHealthCheck request with the same CallerReference as an existing health check but with different settings, Amazon Route 53 returns a HealthCheckAlreadyExists error.

  • If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Amazon Route 53 creates the health check.

Returns:

  • (String)

    A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks:.

#health_check_configTypes::HealthCheckConfig

A complex type that contains the response to a CreateHealthCheck request.

Returns: