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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-route53/types.rb

Overview

Note:

When making an API call, you may pass CreateHealthCheckRequest data as a 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,
    disabled: 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, eu-west-3, ap-east-1, me-south-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, cn-northwest-1, cn-north-1, af-south-1, eu-south-1, us-gov-west-1, us-gov-east-1, us-iso-east-1, us-isob-east-1
      name: "AlarmName", # required
    },
    insufficient_data_health_status: "Healthy", # accepts Healthy, Unhealthy, LastKnownStatus
  },
}

A complex type that contains the health check request information.

Constant Summary collapse

SENSITIVE =
[]

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, 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, 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, Route 53 returns a `HealthCheckAlreadyExists` error.

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

Returns:

  • (String)

1138
1139
1140
1141
1142
1143
# File 'lib/aws-sdk-route53/types.rb', line 1138

class CreateHealthCheckRequest < Struct.new(
  :caller_reference,
  :health_check_config)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_configTypes::HealthCheckConfig

A complex type that contains settings for a new health check.


1138
1139
1140
1141
1142
1143
# File 'lib/aws-sdk-route53/types.rb', line 1138

class CreateHealthCheckRequest < Struct.new(
  :caller_reference,
  :health_check_config)
  SENSITIVE = []
  include Aws::Structure
end