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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#health_check_enabledBoolean

Indicates whether health checks are enabled.

Returns:

  • (Boolean)


2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2824

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_secondsInteger

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

Returns:

  • (Integer)


2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2824

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_pathString

[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)


2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2824

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_portString

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

Returns:

  • (String)


2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2824

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_protocolString

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, and TCP_UDP protocols are not supported for health checks.

Returns:

  • (String)


2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2824

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_secondsInteger

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

Returns:

  • (Integer)


2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2824

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_countInteger

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

Returns:

  • (Integer)


2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2824

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

#matcherTypes::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:



2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2824

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_arnString

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

Returns:

  • (String)


2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2824

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_countInteger

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

Returns:

  • (Integer)


2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2824

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