Class: Aws::VPCLattice::Types::HealthCheckConfig

Inherits:

Struct

• Object
• Struct
• Aws::VPCLattice::Types::HealthCheckConfig

Defined in:

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

Overview

Describes the health check configuration of a target group. Health check configurations aren't used for target groups of type LAMBDA or ALB.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #enabled ⇒ Boolean

  Indicates whether health checking is enabled.

• #health_check_interval_seconds ⇒ Integer

  The approximate amount of time, in seconds, between health checks of an individual target.

• #health_check_timeout_seconds ⇒ Integer

  The amount of time, in seconds, to wait before reporting a target as unhealthy.

• #healthy_threshold_count ⇒ Integer

  The number of consecutive successful health checks required before considering an unhealthy target healthy.

• #matcher ⇒ Types::Matcher

  The codes to use when checking for a successful response from a target.

• #path ⇒ String

  The destination for health checks on the targets.

• #port ⇒ Integer

  The port used when performing health checks on targets.

• #protocol ⇒ String

  The protocol used when performing health checks on targets.

• #protocol_version ⇒ String

  The protocol version used when performing health checks on targets.

• #unhealthy_threshold_count ⇒ Integer

  The number of consecutive failed health checks required before considering a target unhealthy.

Instance Attribute Details

#enabled ⇒ Boolean

Indicates whether health checking is enabled.

Returns:

• (Boolean)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 3144

class HealthCheckConfig < Struct.new(
  :enabled,
  :protocol,
  :protocol_version,
  :port,
  :path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_interval_seconds ⇒ Integer

The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

Returns:

• (Integer)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 3144

class HealthCheckConfig < Struct.new(
  :enabled,
  :protocol,
  :protocol_version,
  :port,
  :path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_timeout_seconds ⇒ Integer

The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

Returns:

• (Integer)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 3144

class HealthCheckConfig < Struct.new(
  :enabled,
  :protocol,
  :protocol_version,
  :port,
  :path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#healthy_threshold_count ⇒ Integer

The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

Returns:

• (Integer)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 3144

class HealthCheckConfig < Struct.new(
  :enabled,
  :protocol,
  :protocol_version,
  :port,
  :path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#matcher ⇒ Types::Matcher

The codes to use when checking for a successful response from a target.

Returns:

• (Types::Matcher)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 3144

class HealthCheckConfig < Struct.new(
  :enabled,
  :protocol,
  :protocol_version,
  :port,
  :path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ String

The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

Returns:

• (String)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 3144

class HealthCheckConfig < Struct.new(
  :enabled,
  :protocol,
  :protocol_version,
  :port,
  :path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

Returns:

• (Integer)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 3144

class HealthCheckConfig < Struct.new(
  :enabled,
  :protocol,
  :protocol_version,
  :port,
  :path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

Returns:

• (String)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 3144

class HealthCheckConfig < Struct.new(
  :enabled,
  :protocol,
  :protocol_version,
  :port,
  :path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#protocol_version ⇒ String

The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

Returns:

• (String)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 3144

class HealthCheckConfig < Struct.new(
  :enabled,
  :protocol,
  :protocol_version,
  :port,
  :path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#unhealthy_threshold_count ⇒ Integer

The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

Returns:

• (Integer)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 3144

class HealthCheckConfig < Struct.new(
  :enabled,
  :protocol,
  :protocol_version,
  :port,
  :path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end