Modify Target Group

elbv2_modify_target_group

R Documentation

Modifies the health checks used when evaluating the health state of the targets in the specified target group

Description

Modifies the health checks used when evaluating the health state of the targets in the specified target group.

Usage

elbv2_modify_target_group(TargetGroupArn, HealthCheckProtocol,
  HealthCheckPort, HealthCheckPath, HealthCheckEnabled,
  HealthCheckIntervalSeconds, HealthCheckTimeoutSeconds,
  HealthyThresholdCount, UnhealthyThresholdCount, Matcher)

Arguments

TargetGroupArn

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

HealthCheckProtocol

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.

HealthCheckPort

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

HealthCheckPath

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

HealthCheckEnabled

Indicates whether health checks are enabled.

HealthCheckIntervalSeconds

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

HealthCheckTimeoutSeconds

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

HealthyThresholdCount

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

UnhealthyThresholdCount

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

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.

Value

A list with the following syntax:

list(
  TargetGroups = list(
    list(
      TargetGroupArn = "string",
      TargetGroupName = "string",
      Protocol = "HTTP"|"HTTPS"|"TCP"|"TLS"|"UDP"|"TCP_UDP"|"GENEVE",
      Port = 123,
      VpcId = "string",
      HealthCheckProtocol = "HTTP"|"HTTPS"|"TCP"|"TLS"|"UDP"|"TCP_UDP"|"GENEVE",
      HealthCheckPort = "string",
      HealthCheckEnabled = TRUE|FALSE,
      HealthCheckIntervalSeconds = 123,
      HealthCheckTimeoutSeconds = 123,
      HealthyThresholdCount = 123,
      UnhealthyThresholdCount = 123,
      HealthCheckPath = "string",
      Matcher = list(
        HttpCode = "string",
        GrpcCode = "string"
      ),
      LoadBalancerArns = list(
        "string"
      ),
      TargetType = "instance"|"ip"|"lambda"|"alb",
      ProtocolVersion = "string",
      IpAddressType = "ipv4"|"ipv6"
    )
  )
)

Request syntax

svc$modify_target_group(
  TargetGroupArn = "string",
  HealthCheckProtocol = "HTTP"|"HTTPS"|"TCP"|"TLS"|"UDP"|"TCP_UDP"|"GENEVE",
  HealthCheckPort = "string",
  HealthCheckPath = "string",
  HealthCheckEnabled = TRUE|FALSE,
  HealthCheckIntervalSeconds = 123,
  HealthCheckTimeoutSeconds = 123,
  HealthyThresholdCount = 123,
  UnhealthyThresholdCount = 123,
  Matcher = list(
    HttpCode = "string",
    GrpcCode = "string"
  )
)

Examples

## Not run: 
# This example changes the configuration of the health checks used to
# evaluate the health of the targets for the specified target group.
svc$modify_target_group(
  HealthCheckPort = "443",
  HealthCheckProtocol = "HTTPS",
  TargetGroupArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:tar..."
)

## End(Not run)