Deregister Targets

elbv2_deregister_targets

R Documentation

Deregisters the specified targets from the specified target group¶

Description¶

Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.

The load balancer stops sending requests to targets that are deregistering, but uses connection draining to ensure that in-flight traffic completes on the existing connections. This deregistration delay is configured by default but can be updated for each target group.

For more information, see the following:

Deregistration delay in the Application Load Balancers User Guide
Deregistration delay in the Network Load Balancers User Guide
Deregistration delay in the Gateway Load Balancers User Guide

Note: If the specified target does not exist, the action returns successfully.

Usage¶

elbv2_deregister_targets(TargetGroupArn, Targets)

Arguments¶

TargetGroupArn: [required] The Amazon Resource Name (ARN) of the target group.
Targets: [required] The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it.

Value¶

An empty list.

Request syntax¶

svc$deregister_targets(
  TargetGroupArn = "string",
  Targets = list(
    list(
      Id = "string",
      Port = 123,
      AvailabilityZone = "string"
    )
  )
)

Examples¶

## Not run: 
# This example deregisters the specified instance from the specified
# target group.
svc$deregister_targets(
  TargetGroupArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:tar...",
  Targets = list(
    list(
      Id = "i-0f76fade"
    )
  )
)

## End(Not run)