Class: Aws::AppRunner::Types::HealthCheckConfiguration

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

Overview

Describes the settings for the health check that App Runner performs to monitor the health of a service.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#healthy_threshold ⇒ Integer

The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

Default: ‘1`

Returns:

  • (Integer) 


1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-apprunner/types.rb', line 1462

class HealthCheckConfiguration < Struct.new(
  :protocol,
  :path,
  :interval,
  :timeout,
  :healthy_threshold,
  :unhealthy_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#interval ⇒ Integer

The time interval, in seconds, between health checks.

Default: ‘5`

Returns:

  • (Integer) 


1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-apprunner/types.rb', line 1462

class HealthCheckConfiguration < Struct.new(
  :protocol,
  :path,
  :interval,
  :timeout,
  :healthy_threshold,
  :unhealthy_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ String

The URL that health check requests are sent to.

‘Path` is only applicable when you set `Protocol` to `HTTP`.

Default: ‘“/”`

Returns:

  • (String) 


1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-apprunner/types.rb', line 1462

class HealthCheckConfiguration < Struct.new(
  :protocol,
  :path,
  :interval,
  :timeout,
  :healthy_threshold,
  :unhealthy_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

The IP protocol that App Runner uses to perform health checks for your service.

If you set ‘Protocol` to `HTTP`, App Runner sends health check requests to the HTTP path specified by `Path`.

Default: ‘TCP`

Returns:

  • (String) 


1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-apprunner/types.rb', line 1462

class HealthCheckConfiguration < Struct.new(
  :protocol,
  :path,
  :interval,
  :timeout,
  :healthy_threshold,
  :unhealthy_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#timeout ⇒ Integer

The time, in seconds, to wait for a health check response before deciding it failed.

Default: ‘2`

Returns:

  • (Integer) 


1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-apprunner/types.rb', line 1462

class HealthCheckConfiguration < Struct.new(
  :protocol,
  :path,
  :interval,
  :timeout,
  :healthy_threshold,
  :unhealthy_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#unhealthy_threshold ⇒ Integer

The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

Default: ‘5`

Returns:

  • (Integer) 


1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/aws-sdk-apprunner/types.rb', line 1462

class HealthCheckConfiguration < Struct.new(
  :protocol,
  :path,
  :interval,
  :timeout,
  :healthy_threshold,
  :unhealthy_threshold)
  SENSITIVE = []
  include Aws::Structure
end