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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

Indicates whether health checking is enabled.

Returns:

  • (Boolean)


1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 1967

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

#health_check_interval_secondsInteger

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)


1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 1967

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

#health_check_timeout_secondsInteger

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)


1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 1967

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

#healthy_threshold_countInteger

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)


1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 1967

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

#matcherTypes::Matcher

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

Returns:



1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 1967

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

#pathString

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)


1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 1967

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

#portInteger

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

Returns:

  • (Integer)


1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 1967

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

#protocolString

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

Returns:

  • (String)


1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 1967

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

#protocol_versionString

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

Returns:

  • (String)


1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 1967

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

#unhealthy_threshold_countInteger

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

Returns:

  • (Integer)


1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 1967

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