AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ModifyTargetGroupInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  target_group_arn: "TargetGroupArn", # required
  health_check_protocol: "HTTP", # accepts HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, GENEVE
  health_check_port: "HealthCheckPort",
  health_check_path: "Path",
  health_check_enabled: false,
  health_check_interval_seconds: 1,
  health_check_timeout_seconds: 1,
  healthy_threshold_count: 1,
  unhealthy_threshold_count: 1,
  matcher: {
    http_code: "HttpCode",
    grpc_code: "GrpcCode",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#health_check_enabledBoolean

Indicates whether health checks are enabled.

Returns:

  • (Boolean)

    Indicates whether health checks are enabled.

#health_check_interval_secondsInteger

The approximate amount of time, in seconds, between health checks of an individual target. For TCP health checks, the supported values are 10 or 30 seconds.

With Network Load Balancers, you can\'t modify this setting.

Returns:

  • (Integer)

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

#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 /AWS.ALB/healthcheck.

Returns:

  • (String)

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

#health_check_portString

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

Returns:

  • (String)

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

#health_check_protocolString

The protocol the load balancer uses when performing health checks on targets. The TCP protocol 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.

With Network Load Balancers, you can\'t modify this setting.

Possible values:

  • HTTP
  • HTTPS
  • TCP
  • TLS
  • UDP
  • TCP_UDP
  • GENEVE

Returns:

  • (String)

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

#health_check_timeout_secondsInteger

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

With Network Load Balancers, you can\'t modify this setting.

Returns:

  • (Integer)

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

#healthy_threshold_countInteger

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

Returns:

  • (Integer)

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

#matcherTypes::Matcher

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

With Network Load Balancers, you can\'t modify this setting.

Returns:

  • (Types::Matcher)

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

#target_group_arnString

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

Returns:

  • (String)

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

#unhealthy_threshold_countInteger

The number of consecutive health check failures required before considering the target unhealthy. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count.

Returns:

  • (Integer)

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