Deregister Instances from Load Balancer

elb_deregister_instances_from_load_balancer

R Documentation

Deregisters the specified instances from the specified load balancer¶

Description¶

Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.

You can use describe_load_balancers to verify that the instance is deregistered from the load balancer.

For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.

Usage¶

elb_deregister_instances_from_load_balancer(LoadBalancerName, Instances)

Arguments¶

LoadBalancerName: [required] The name of the load balancer.
Instances: [required] The IDs of the instances.

Value¶

A list with the following syntax:

list(
  Instances = list(
    list(
      InstanceId = "string"
    )
  )
)

Request syntax¶

svc$deregister_instances_from_load_balancer(
  LoadBalancerName = "string",
  Instances = list(
    list(
      InstanceId = "string"
    )
  )
)

Examples¶

## Not run: 
# This example deregisters the specified instance from the specified load
# balancer.
svc$deregister_instances_from_load_balancer(
  Instances = list(
    list(
      InstanceId = "i-d6f6fae3"
    )
  ),
  LoadBalancerName = "my-load-balancer"
)

## End(Not run)