Class: Aws::RTBFabric::Types::HealthCheckConfig

Inherits:

Struct

• Object
• Struct
• Aws::RTBFabric::Types::HealthCheckConfig

Defined in:

gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb

Overview

The health check configuration for a managed endpoint. Defines how the service probes instances in the Auto Scaling group to determine their health status.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #healthy_threshold_count ⇒ Integer

  The number of consecutive successful health checks required before an instance is considered healthy.

• #interval_seconds ⇒ Integer

  The interval between health check probes, in seconds.

• #path ⇒ String

  The destination path for the health check request.

• #port ⇒ Integer

  The port to use for health check probes.

• #protocol ⇒ String

  The protocol to use for health check probes.

• #status_code_matcher ⇒ String

  The expected HTTP status code or status code pattern from healthy instances.

• #timeout_ms ⇒ Integer

  The timeout for each health check probe, in milliseconds.

• #unhealthy_threshold_count ⇒ Integer

  The number of consecutive failed health checks required before an instance is considered unhealthy.

Instance Attribute Details

#healthy_threshold_count ⇒ Integer

The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.

Returns:

• (Integer)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 1370

class HealthCheckConfig < Struct.new(
  :port,
  :path,
  :protocol,
  :timeout_ms,
  :interval_seconds,
  :status_code_matcher,
  :healthy_threshold_count,
  :unhealthy_threshold_count)
  SENSITIVE = []
  include Aws::Structure
end

#interval_seconds ⇒ Integer

The interval between health check probes, in seconds. Valid range is 5 to 60.

Returns:

• (Integer)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 1370

class HealthCheckConfig < Struct.new(
  :port,
  :path,
  :protocol,
  :timeout_ms,
  :interval_seconds,
  :status_code_matcher,
  :healthy_threshold_count,
  :unhealthy_threshold_count)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ String

The destination path for the health check request. Must start with /.

Returns:

• (String)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 1370

class HealthCheckConfig < Struct.new(
  :port,
  :path,
  :protocol,
  :timeout_ms,
  :interval_seconds,
  :status_code_matcher,
  :healthy_threshold_count,
  :unhealthy_threshold_count)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

The port to use for health check probes. Valid range is 80 to 65535.

Returns:

• (Integer)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 1370

class HealthCheckConfig < Struct.new(
  :port,
  :path,
  :protocol,
  :timeout_ms,
  :interval_seconds,
  :status_code_matcher,
  :healthy_threshold_count,
  :unhealthy_threshold_count)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

The protocol to use for health check probes.

Returns:

• (String)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 1370

class HealthCheckConfig < Struct.new(
  :port,
  :path,
  :protocol,
  :timeout_ms,
  :interval_seconds,
  :status_code_matcher,
  :healthy_threshold_count,
  :unhealthy_threshold_count)
  SENSITIVE = []
  include Aws::Structure
end

#status_code_matcher ⇒ String

The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, 200), a range (for example, 200-299), or a comma-separated list (for example, 200,204).

Returns:

• (String)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 1370

class HealthCheckConfig < Struct.new(
  :port,
  :path,
  :protocol,
  :timeout_ms,
  :interval_seconds,
  :status_code_matcher,
  :healthy_threshold_count,
  :unhealthy_threshold_count)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_ms ⇒ Integer

The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.

Returns:

• (Integer)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 1370

class HealthCheckConfig < Struct.new(
  :port,
  :path,
  :protocol,
  :timeout_ms,
  :interval_seconds,
  :status_code_matcher,
  :healthy_threshold_count,
  :unhealthy_threshold_count)
  SENSITIVE = []
  include Aws::Structure
end

#unhealthy_threshold_count ⇒ Integer

The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.

Returns:

• (Integer)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 1370

class HealthCheckConfig < Struct.new(
  :port,
  :path,
  :protocol,
  :timeout_ms,
  :interval_seconds,
  :status_code_matcher,
  :healthy_threshold_count,
  :unhealthy_threshold_count)
  SENSITIVE = []
  include Aws::Structure
end