Class: Aws::ElasticLoadBalancingV2::Types::ModifyTargetGroupInput

Inherits:

Struct

• Object
• Struct
• Aws::ElasticLoadBalancingV2::Types::ModifyTargetGroupInput

Includes:

Structure

Defined in:

lib/aws-sdk-elasticloadbalancingv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #health_check_enabled ⇒ Boolean

  Indicates whether health checks are enabled.

• #health_check_interval_seconds ⇒ Integer

  The approximate amount of time, in seconds, between health checks of an individual target.

• #health_check_path ⇒ String

  [HTTP/HTTPS health checks] The destination for health checks on the targets.

• #health_check_port ⇒ String

  The port the load balancer uses when performing health checks on targets.

• #health_check_protocol ⇒ String

  The protocol the load balancer uses when performing health checks on targets.

• #health_check_timeout_seconds ⇒ Integer

  [HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.

• #healthy_threshold_count ⇒ Integer

  The number of consecutive health checks successes required before considering an unhealthy target healthy.

• #matcher ⇒ Types::Matcher

  [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.

• #target_group_arn ⇒ String

  The Amazon Resource Name (ARN) of the target group.

• #unhealthy_threshold_count ⇒ Integer

  The number of consecutive health check failures required before considering the target unhealthy.

Instance Attribute Details

#health_check_enabled ⇒ Boolean

Indicates whether health checks are enabled. If the target type is ‘lambda`, health checks are disabled by default but can be enabled. If the target type is `instance`, `ip`, or `alb`, health checks are always enabled and can’t be disabled.

Returns:

• (Boolean)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3241

class ModifyTargetGroupInput < Struct.new(
  :target_group_arn,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_interval_seconds ⇒ Integer

The approximate amount of time, in seconds, between health checks of an individual target.

Returns:

• (Integer)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3241

class ModifyTargetGroupInput < Struct.new(
  :target_group_arn,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_path ⇒ String

[HTTP/HTTPS health checks] The destination for health checks on the targets.

[HTTP1 or HTTP2 protocol version] The ping path. The default is /.

[GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3241

class ModifyTargetGroupInput < Struct.new(
  :target_group_arn,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_port ⇒ String

The port the load balancer uses when performing health checks on targets.

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3241

class ModifyTargetGroupInput < Struct.new(
  :target_group_arn,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_protocol ⇒ String

The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, TCP_UDP, QUIC, and TCP_QUIC protocols are not supported for health checks.

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3241

class ModifyTargetGroupInput < Struct.new(
  :target_group_arn,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_timeout_seconds ⇒ Integer

[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.

Returns:

• (Integer)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3241

class ModifyTargetGroupInput < Struct.new(
  :target_group_arn,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#healthy_threshold_count ⇒ Integer

The number of consecutive health checks successes required before considering an unhealthy target healthy.

Returns:

• (Integer)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3241

class ModifyTargetGroupInput < Struct.new(
  :target_group_arn,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#matcher ⇒ Types::Matcher

[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.

Returns:

• (Types::Matcher)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3241

class ModifyTargetGroupInput < Struct.new(
  :target_group_arn,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#target_group_arn ⇒ String

The Amazon Resource Name (ARN) of the target group.

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3241

class ModifyTargetGroupInput < Struct.new(
  :target_group_arn,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end

#unhealthy_threshold_count ⇒ Integer

The number of consecutive health check failures required before considering the target unhealthy.

Returns:

• (Integer)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3241

class ModifyTargetGroupInput < Struct.new(
  :target_group_arn,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  SENSITIVE = []
  include Aws::Structure
end