You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

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

{
  target_group_arn: "TargetGroupArn", # required
  health_check_protocol: "HTTP", # accepts HTTP, HTTPS, TCP
  health_check_port: "HealthCheckPort",
  health_check_path: "Path",
  health_check_interval_seconds: 1,
  health_check_timeout_seconds: 1,
  healthy_threshold_count: 1,
  unhealthy_threshold_count: 1,
  matcher: {
    http_code: "HttpCode", # required
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#health_check_interval_secondsInteger

The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds.

Returns:

  • (Integer)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1762

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

#health_check_pathString

[HTTP/HTTPS health checks] The ping path that is the destination for the health check request.

Returns:

  • (String)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1762

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

#health_check_portString

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

Returns:

  • (String)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1762

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

#health_check_protocolString

The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP.

Returns:

  • (String)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1762

class ModifyTargetGroupInput < Struct.new(
  :target_group_arn,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  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)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1762

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

#healthy_threshold_countInteger

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

Returns:

  • (Integer)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1762

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

#matcherTypes::Matcher

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

Returns:



1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1762

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

#target_group_arnString

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

Returns:

  • (String)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1762

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

#unhealthy_threshold_countInteger

The number of consecutive health check failures required before considering the target unhealthy. For Network Load Balancers, this value must be the same as the healthy threshold count.

Returns:

  • (Integer)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1762

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