Skip to content

Commit b773c5c

Browse files
author
awstools
committed
docs(client-elastic-load-balancing-v2): Gateway Load Balancer adds a new feature (target_failover) for customers to rebalance existing flows to a healthy target after marked unhealthy or deregistered. This allows graceful patching/upgrades of target appliances during maintenance windows, and helps reduce unhealthy target failover time.
1 parent 0d16b1a commit b773c5c

File tree

4 files changed

+422
-332
lines changed

4 files changed

+422
-332
lines changed

clients/client-elastic-load-balancing-v2/src/ElasticLoadBalancingV2.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1345,8 +1345,7 @@ export class ElasticLoadBalancingV2 extends ElasticLoadBalancingV2Client {
13451345
}
13461346

13471347
/**
1348-
* <p>Sets the type of IP addresses used by the subnets of the specified Application Load
1349-
* Balancer or Network Load Balancer.</p>
1348+
* <p>Sets the type of IP addresses used by the subnets of the specified load balancer.</p>
13501349
*/
13511350
public setIpAddressType(
13521351
args: SetIpAddressTypeCommandInput,

clients/client-elastic-load-balancing-v2/src/commands/SetIpAddressTypeCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@ export interface SetIpAddressTypeCommandInput extends SetIpAddressTypeInput {}
3232
export interface SetIpAddressTypeCommandOutput extends SetIpAddressTypeOutput, __MetadataBearer {}
3333

3434
/**
35-
* <p>Sets the type of IP addresses used by the subnets of the specified Application Load
36-
* Balancer or Network Load Balancer.</p>
35+
* <p>Sets the type of IP addresses used by the subnets of the specified load balancer.</p>
3736
* @example
3837
* Use a bare-bones client and the command you need to make an API call.
3938
* ```javascript

clients/client-elastic-load-balancing-v2/src/models/models_0.ts

Lines changed: 37 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -744,7 +744,15 @@ export interface Cipher {
744744
Priority?: number;
745745
}
746746

747-
export type ProtocolEnum = "GENEVE" | "HTTP" | "HTTPS" | "TCP" | "TCP_UDP" | "TLS" | "UDP";
747+
export enum ProtocolEnum {
748+
GENEVE = "GENEVE",
749+
HTTP = "HTTP",
750+
HTTPS = "HTTPS",
751+
TCP = "TCP",
752+
TCP_UDP = "TCP_UDP",
753+
TLS = "TLS",
754+
UDP = "UDP",
755+
}
748756

749757
export interface CreateListenerInput {
750758
/**
@@ -2912,16 +2920,16 @@ export interface TargetGroupAttribute {
29122920
* <ul>
29132921
* <li>
29142922
* <p>
2915-
* <code>lb_cookie</code> and <code>app_cookie</code> for Application Load Balancers</p>
2923+
* <code>lb_cookie</code> and <code>app_cookie</code> for Application Load Balancers.</p>
29162924
* </li>
29172925
* <li>
29182926
* <p>
2919-
* <code>source_ip</code> for Network Load Balancers</p>
2927+
* <code>source_ip</code> for Network Load Balancers.</p>
29202928
* </li>
29212929
* <li>
29222930
* <p>
29232931
* <code>source_ip_dest_ip</code> and <code>source_ip_dest_ip_proto</code> for Gateway Load
2924-
* Balancers</p>
2932+
* Balancers.</p>
29252933
* </li>
29262934
* </ul>
29272935
* </li>
@@ -2963,7 +2971,7 @@ export interface TargetGroupAttribute {
29632971
* <code>stickiness.lb_cookie.duration_seconds</code> - The time period, in seconds,
29642972
* during which requests from a client should be routed to the same target. After this time
29652973
* period expires, the load balancer-generated cookie is considered stale. The range is 1
2966-
* second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).</p>
2974+
* second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). </p>
29672975
* </li>
29682976
* </ul>
29692977
*
@@ -3002,7 +3010,30 @@ export interface TargetGroupAttribute {
30023010
* <p>
30033011
* <code>proxy_protocol_v2.enabled</code> - Indicates whether Proxy Protocol version 2 is
30043012
* enabled. The value is <code>true</code> or <code>false</code>. The default is
3005-
* <code>false</code>.</p>
3013+
* <code>false</code>. </p>
3014+
* </li>
3015+
* </ul>
3016+
* <p>The following attributes are supported only by Gateway Load Balancers:</p>
3017+
* <ul>
3018+
* <li>
3019+
* <p>
3020+
* <code>target_failover.on_deregistration</code> - Indicates how the Gateway Load
3021+
* Balancer handles existing flows when a target is deregistered. The possible values are
3022+
* <code>rebalance</code> and <code>no_rebalance</code>. The default is
3023+
* <code>no_rebalance</code>. The two attributes
3024+
* (<code>target_failover.on_deregistration</code> and
3025+
* <code>target_failover.on_unhealthy</code>) can't be set independently. The value you set
3026+
* for both attributes must be the same. </p>
3027+
* </li>
3028+
* <li>
3029+
* <p>
3030+
* <code>target_failover.on_unhealthy</code> - Indicates how the Gateway Load Balancer
3031+
* handles existing flows when a target is unhealthy. The possible values are
3032+
* <code>rebalance</code> and <code>no_rebalance</code>. The default is
3033+
* <code>no_rebalance</code>. The two attributes
3034+
* (<code>target_failover.on_deregistration</code> and
3035+
* <code>target_failover.on_unhealthy</code>) cannot be set independently. The value you
3036+
* set for both attributes must be the same. </p>
30063037
* </li>
30073038
* </ul>
30083039
*/

0 commit comments

Comments
 (0)