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

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

Overview

Note:

When making an API call, you may pass HealthCheckConfiguration data as a hash:

{
  protocol: "TCP", # accepts TCP, HTTP
  path: "HealthCheckPath",
  interval: 1,
  timeout: 1,
  healthy_threshold: 1,
  unhealthy_threshold: 1,
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#healthy_thresholdInteger

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

Default: 1

Returns:

  • (Integer)


1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1560

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

#intervalInteger

The time interval, in seconds, between health checks.

Default: 5

Returns:

  • (Integer)


1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1560

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

#pathString

The URL that health check requests are sent to.

Path is only applicable when you set Protocol to HTTP.

Default: "/"

Returns:

  • (String)


1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1560

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

#protocolString

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)


1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1560

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

#timeoutInteger

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

Default: 2

Returns:

  • (Integer)


1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1560

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

#unhealthy_thresholdInteger

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

Default: 5

Returns:

  • (Integer)


1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1560

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