Class: Aws::Lightsail::Types::ContainerServiceHealthCheckConfig

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

Overview

Describes the health check configuration of an Amazon Lightsail container service.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#healthy_thresholdInteger

The number of consecutive health checks successes required before moving the container to the ‘Healthy` state. The default value is `2`.

Returns:

  • (Integer)


2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
# File 'lib/aws-sdk-lightsail/types.rb', line 2504

class ContainerServiceHealthCheckConfig < Struct.new(
  :healthy_threshold,
  :unhealthy_threshold,
  :timeout_seconds,
  :interval_seconds,
  :path,
  :success_codes)
  SENSITIVE = []
  include Aws::Structure
end

#interval_secondsInteger

The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is ‘5`.

Returns:

  • (Integer)


2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
# File 'lib/aws-sdk-lightsail/types.rb', line 2504

class ContainerServiceHealthCheckConfig < Struct.new(
  :healthy_threshold,
  :unhealthy_threshold,
  :timeout_seconds,
  :interval_seconds,
  :path,
  :success_codes)
  SENSITIVE = []
  include Aws::Structure
end

#pathString

The path on the container on which to perform the health check. The default value is ‘/`.

Returns:

  • (String)


2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
# File 'lib/aws-sdk-lightsail/types.rb', line 2504

class ContainerServiceHealthCheckConfig < Struct.new(
  :healthy_threshold,
  :unhealthy_threshold,
  :timeout_seconds,
  :interval_seconds,
  :path,
  :success_codes)
  SENSITIVE = []
  include Aws::Structure
end

#success_codesString

The HTTP codes to use when checking for a successful response from a container. You can specify values between ‘200` and `499`. You can specify multiple values (for example, `200,202`) or a range of values (for example, `200-299`).

Returns:

  • (String)


2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
# File 'lib/aws-sdk-lightsail/types.rb', line 2504

class ContainerServiceHealthCheckConfig < Struct.new(
  :healthy_threshold,
  :unhealthy_threshold,
  :timeout_seconds,
  :interval_seconds,
  :path,
  :success_codes)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_secondsInteger

The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is ‘2`.

Returns:

  • (Integer)


2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
# File 'lib/aws-sdk-lightsail/types.rb', line 2504

class ContainerServiceHealthCheckConfig < Struct.new(
  :healthy_threshold,
  :unhealthy_threshold,
  :timeout_seconds,
  :interval_seconds,
  :path,
  :success_codes)
  SENSITIVE = []
  include Aws::Structure
end

#unhealthy_thresholdInteger

The number of consecutive health check failures required before moving the container to the ‘Unhealthy` state. The default value is `2`.

Returns:

  • (Integer)


2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
# File 'lib/aws-sdk-lightsail/types.rb', line 2504

class ContainerServiceHealthCheckConfig < Struct.new(
  :healthy_threshold,
  :unhealthy_threshold,
  :timeout_seconds,
  :interval_seconds,
  :path,
  :success_codes)
  SENSITIVE = []
  include Aws::Structure
end