ILoadBalancingManager Interface

Summary

Used to access Amazon Elastic Load Balancers.
graph BT Type["ILoadBalancingManager"] class Type type-node Implementing0["LoadBalancingManager"]-.->Type click Implementing0 "/api/Cake.AWS.ElasticLoadBalancing/LoadBalancingManager"

Syntax

public interface ILoadBalancingManager

Methods

Name Value Summary
DeregisterInstances(string, IList<string>, LoadBalancingSettings, CancellationToken) Task<bool>
Removes instances from the load balancer. Once the instance is deregistered, it will stop receiving traffic from the load balancer.
DisableAvailabilityZones(string, IList<string>, LoadBalancingSettings, CancellationToken) Task<bool>
Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer. There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones.
EnableAvailabilityZones(string, IList<string>, LoadBalancingSettings, CancellationToken) Task<bool>
Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer. The load balancer evenly distributes requests across all its registered Availability Zones that contain instances.
RegisterInstances(string, IList<string>, LoadBalancingSettings, CancellationToken) Task<bool>
Adds new instances to the load balancer. Once the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in any of the Availability Zones registered for the load balancer will be moved to the OutOfService state. It will move to the InService state when the Availability Zone is added to the load balancer.

Extension Methods

Name Value Summary
Dump<ILoadBalancingManager>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ILoadBalancingManager>(ILoadBalancingManager[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ILoadBalancingManager>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ILoadBalancingManager>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ILoadBalancingManager>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ILoadBalancingManager>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin