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

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

Overview

Note:

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

{
  healthy_threshold: 1,
  unhealthy_threshold: 1,
  timeout_seconds: 1,
  interval_seconds: 1,
  path: "string",
  success_codes: "string",
}

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)


1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1997

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)


1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1997

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)


1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1997

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.

Returns:

  • (String)


1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1997

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)


1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1997

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)


1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1997

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