-
Notifications
You must be signed in to change notification settings - Fork 20
Expand file tree
/
Copy pathload_balancers.py
More file actions
2305 lines (1952 loc) · 102 KB
/
load_balancers.py
File metadata and controls
2305 lines (1952 loc) · 102 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing import Iterable
from typing_extensions import Literal, overload
import httpx
from .droplets import (
DropletsResource,
AsyncDropletsResource,
DropletsResourceWithRawResponse,
AsyncDropletsResourceWithRawResponse,
DropletsResourceWithStreamingResponse,
AsyncDropletsResourceWithStreamingResponse,
)
from ...._types import Body, Omit, Query, Headers, NoneType, NotGiven, SequenceNotStr, omit, not_given
from ...._utils import required_args, maybe_transform, async_maybe_transform
from ...._compat import cached_property
from ...._resource import SyncAPIResource, AsyncAPIResource
from ...._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from ...._base_client import make_request_options
from .forwarding_rules import (
ForwardingRulesResource,
AsyncForwardingRulesResource,
ForwardingRulesResourceWithRawResponse,
AsyncForwardingRulesResourceWithRawResponse,
ForwardingRulesResourceWithStreamingResponse,
AsyncForwardingRulesResourceWithStreamingResponse,
)
from ....types.gpu_droplets import (
load_balancer_list_params,
load_balancer_create_params,
load_balancer_update_params,
)
from ....types.gpu_droplets.domains_param import DomainsParam
from ....types.gpu_droplets.lb_firewall_param import LbFirewallParam
from ....types.gpu_droplets.glb_settings_param import GlbSettingsParam
from ....types.gpu_droplets.health_check_param import HealthCheckParam
from ....types.gpu_droplets.forwarding_rule_param import ForwardingRuleParam
from ....types.gpu_droplets.sticky_sessions_param import StickySessionsParam
from ....types.gpu_droplets.load_balancer_list_response import LoadBalancerListResponse
from ....types.gpu_droplets.load_balancer_create_response import LoadBalancerCreateResponse
from ....types.gpu_droplets.load_balancer_update_response import LoadBalancerUpdateResponse
from ....types.gpu_droplets.load_balancer_retrieve_response import LoadBalancerRetrieveResponse
__all__ = ["LoadBalancersResource", "AsyncLoadBalancersResource"]
class LoadBalancersResource(SyncAPIResource):
"""
[DigitalOcean Load Balancers](https://docs.digitalocean.com/products/networking/load-balancers/)
provide a way to distribute traffic across multiple Droplets. By sending
requests to the `/v2/load_balancers` endpoint, you can list, create, or
delete load balancers as well as add or remove Droplets, forwarding rules,
and other configuration details.
"""
@cached_property
def droplets(self) -> DropletsResource:
"""
[DigitalOcean Load Balancers](https://docs.digitalocean.com/products/networking/load-balancers/)
provide a way to distribute traffic across multiple Droplets. By sending
requests to the `/v2/load_balancers` endpoint, you can list, create, or
delete load balancers as well as add or remove Droplets, forwarding rules,
and other configuration details.
"""
return DropletsResource(self._client)
@cached_property
def forwarding_rules(self) -> ForwardingRulesResource:
"""
[DigitalOcean Load Balancers](https://docs.digitalocean.com/products/networking/load-balancers/)
provide a way to distribute traffic across multiple Droplets. By sending
requests to the `/v2/load_balancers` endpoint, you can list, create, or
delete load balancers as well as add or remove Droplets, forwarding rules,
and other configuration details.
"""
return ForwardingRulesResource(self._client)
@cached_property
def with_raw_response(self) -> LoadBalancersResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/digitalocean/gradient-python#accessing-raw-response-data-eg-headers
"""
return LoadBalancersResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> LoadBalancersResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/digitalocean/gradient-python#with_streaming_response
"""
return LoadBalancersResourceWithStreamingResponse(self)
@overload
def create(
self,
*,
forwarding_rules: Iterable[ForwardingRuleParam],
algorithm: Literal["round_robin", "least_connections"] | Omit = omit,
disable_lets_encrypt_dns_records: bool | Omit = omit,
domains: Iterable[DomainsParam] | Omit = omit,
droplet_ids: Iterable[int] | Omit = omit,
enable_backend_keepalive: bool | Omit = omit,
enable_proxy_protocol: bool | Omit = omit,
firewall: LbFirewallParam | Omit = omit,
glb_settings: GlbSettingsParam | Omit = omit,
health_check: HealthCheckParam | Omit = omit,
http_idle_timeout_seconds: int | Omit = omit,
name: str | Omit = omit,
network: Literal["EXTERNAL", "INTERNAL"] | Omit = omit,
network_stack: Literal["IPV4", "DUALSTACK"] | Omit = omit,
project_id: str | Omit = omit,
redirect_http_to_https: bool | Omit = omit,
region: Literal[
"ams1",
"ams2",
"ams3",
"blr1",
"fra1",
"lon1",
"nyc1",
"nyc2",
"nyc3",
"sfo1",
"sfo2",
"sfo3",
"sgp1",
"tor1",
"syd1",
]
| Omit = omit,
size: Literal["lb-small", "lb-medium", "lb-large"] | Omit = omit,
size_unit: int | Omit = omit,
sticky_sessions: StickySessionsParam | Omit = omit,
target_load_balancer_ids: SequenceNotStr[str] | Omit = omit,
tls_cipher_policy: Literal["DEFAULT", "STRONG"] | Omit = omit,
type: Literal["REGIONAL", "REGIONAL_NETWORK", "GLOBAL"] | Omit = omit,
vpc_uuid: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> LoadBalancerCreateResponse:
"""
To create a new load balancer instance, send a POST request to
`/v2/load_balancers`.
You can specify the Droplets that will sit behind the load balancer using one of
two methods:
- Set `droplet_ids` to a list of specific Droplet IDs.
- Set `tag` to the name of a tag. All Droplets with this tag applied will be
assigned to the load balancer. Additional Droplets will be automatically
assigned as they are tagged.
These methods are mutually exclusive.
Args:
forwarding_rules: An array of objects specifying the forwarding rules for a load balancer.
algorithm: This field has been deprecated. You can no longer specify an algorithm for load
balancers.
disable_lets_encrypt_dns_records: A boolean value indicating whether to disable automatic DNS record creation for
Let's Encrypt certificates that are added to the load balancer.
domains: An array of objects specifying the domain configurations for a Global load
balancer.
droplet_ids: An array containing the IDs of the Droplets assigned to the load balancer.
enable_backend_keepalive: A boolean value indicating whether HTTP keepalive connections are maintained to
target Droplets.
enable_proxy_protocol: A boolean value indicating whether PROXY Protocol is in use.
firewall: An object specifying allow and deny rules to control traffic to the load
balancer.
glb_settings: An object specifying forwarding configurations for a Global load balancer.
health_check: An object specifying health check settings for the load balancer.
http_idle_timeout_seconds: An integer value which configures the idle timeout for HTTP requests to the
target droplets.
name: A human-readable name for a load balancer instance.
network: A string indicating whether the load balancer should be external or internal.
Internal load balancers have no public IPs and are only accessible to resources
on the same VPC network. This property cannot be updated after creating the load
balancer.
network_stack: A string indicating whether the load balancer will support IPv4 or both IPv4 and
IPv6 networking. This property cannot be updated after creating the load
balancer.
project_id: The ID of the project that the load balancer is associated with. If no ID is
provided at creation, the load balancer associates with the user's default
project. If an invalid project ID is provided, the load balancer will not be
created.
redirect_http_to_https: A boolean value indicating whether HTTP requests to the load balancer on port 80
will be redirected to HTTPS on port 443.
region: The slug identifier for the region where the resource will initially be
available.
size: This field has been replaced by the `size_unit` field for all regions except in
AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load
balancer having a set number of nodes.
- `lb-small` = 1 node
- `lb-medium` = 3 nodes
- `lb-large` = 6 nodes
You can resize load balancers after creation up to once per hour. You cannot
resize a load balancer within the first hour of its creation.
size_unit: How many nodes the load balancer contains. Each additional node increases the
load balancer's ability to manage more connections. Load balancers can be scaled
up or down, and you can change the number of nodes after creation up to once per
hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions.
Use the `size` field to scale load balancers that reside in these regions.
sticky_sessions: An object specifying sticky sessions settings for the load balancer.
target_load_balancer_ids: An array containing the UUIDs of the Regional load balancers to be used as
target backends for a Global load balancer.
tls_cipher_policy: A string indicating the policy for the TLS cipher suites used by the load
balancer. The possible values are `DEFAULT` or `STRONG`. The default value is
`DEFAULT`.
type: A string indicating whether the load balancer should be a standard regional HTTP
load balancer, a regional network load balancer that routes traffic at the
TCP/UDP transport layer, or a global load balancer.
vpc_uuid: A string specifying the UUID of the VPC to which the load balancer is assigned.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
...
@overload
def create(
self,
*,
forwarding_rules: Iterable[ForwardingRuleParam],
algorithm: Literal["round_robin", "least_connections"] | Omit = omit,
disable_lets_encrypt_dns_records: bool | Omit = omit,
domains: Iterable[DomainsParam] | Omit = omit,
enable_backend_keepalive: bool | Omit = omit,
enable_proxy_protocol: bool | Omit = omit,
firewall: LbFirewallParam | Omit = omit,
glb_settings: GlbSettingsParam | Omit = omit,
health_check: HealthCheckParam | Omit = omit,
http_idle_timeout_seconds: int | Omit = omit,
name: str | Omit = omit,
network: Literal["EXTERNAL", "INTERNAL"] | Omit = omit,
network_stack: Literal["IPV4", "DUALSTACK"] | Omit = omit,
project_id: str | Omit = omit,
redirect_http_to_https: bool | Omit = omit,
region: Literal[
"ams1",
"ams2",
"ams3",
"blr1",
"fra1",
"lon1",
"nyc1",
"nyc2",
"nyc3",
"sfo1",
"sfo2",
"sfo3",
"sgp1",
"tor1",
"syd1",
]
| Omit = omit,
size: Literal["lb-small", "lb-medium", "lb-large"] | Omit = omit,
size_unit: int | Omit = omit,
sticky_sessions: StickySessionsParam | Omit = omit,
tag: str | Omit = omit,
target_load_balancer_ids: SequenceNotStr[str] | Omit = omit,
tls_cipher_policy: Literal["DEFAULT", "STRONG"] | Omit = omit,
type: Literal["REGIONAL", "REGIONAL_NETWORK", "GLOBAL"] | Omit = omit,
vpc_uuid: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> LoadBalancerCreateResponse:
"""
To create a new load balancer instance, send a POST request to
`/v2/load_balancers`.
You can specify the Droplets that will sit behind the load balancer using one of
two methods:
- Set `droplet_ids` to a list of specific Droplet IDs.
- Set `tag` to the name of a tag. All Droplets with this tag applied will be
assigned to the load balancer. Additional Droplets will be automatically
assigned as they are tagged.
These methods are mutually exclusive.
Args:
forwarding_rules: An array of objects specifying the forwarding rules for a load balancer.
algorithm: This field has been deprecated. You can no longer specify an algorithm for load
balancers.
disable_lets_encrypt_dns_records: A boolean value indicating whether to disable automatic DNS record creation for
Let's Encrypt certificates that are added to the load balancer.
domains: An array of objects specifying the domain configurations for a Global load
balancer.
enable_backend_keepalive: A boolean value indicating whether HTTP keepalive connections are maintained to
target Droplets.
enable_proxy_protocol: A boolean value indicating whether PROXY Protocol is in use.
firewall: An object specifying allow and deny rules to control traffic to the load
balancer.
glb_settings: An object specifying forwarding configurations for a Global load balancer.
health_check: An object specifying health check settings for the load balancer.
http_idle_timeout_seconds: An integer value which configures the idle timeout for HTTP requests to the
target droplets.
name: A human-readable name for a load balancer instance.
network: A string indicating whether the load balancer should be external or internal.
Internal load balancers have no public IPs and are only accessible to resources
on the same VPC network. This property cannot be updated after creating the load
balancer.
network_stack: A string indicating whether the load balancer will support IPv4 or both IPv4 and
IPv6 networking. This property cannot be updated after creating the load
balancer.
project_id: The ID of the project that the load balancer is associated with. If no ID is
provided at creation, the load balancer associates with the user's default
project. If an invalid project ID is provided, the load balancer will not be
created.
redirect_http_to_https: A boolean value indicating whether HTTP requests to the load balancer on port 80
will be redirected to HTTPS on port 443.
region: The slug identifier for the region where the resource will initially be
available.
size: This field has been replaced by the `size_unit` field for all regions except in
AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load
balancer having a set number of nodes.
- `lb-small` = 1 node
- `lb-medium` = 3 nodes
- `lb-large` = 6 nodes
You can resize load balancers after creation up to once per hour. You cannot
resize a load balancer within the first hour of its creation.
size_unit: How many nodes the load balancer contains. Each additional node increases the
load balancer's ability to manage more connections. Load balancers can be scaled
up or down, and you can change the number of nodes after creation up to once per
hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions.
Use the `size` field to scale load balancers that reside in these regions.
sticky_sessions: An object specifying sticky sessions settings for the load balancer.
tag: The name of a Droplet tag corresponding to Droplets assigned to the load
balancer.
target_load_balancer_ids: An array containing the UUIDs of the Regional load balancers to be used as
target backends for a Global load balancer.
tls_cipher_policy: A string indicating the policy for the TLS cipher suites used by the load
balancer. The possible values are `DEFAULT` or `STRONG`. The default value is
`DEFAULT`.
type: A string indicating whether the load balancer should be a standard regional HTTP
load balancer, a regional network load balancer that routes traffic at the
TCP/UDP transport layer, or a global load balancer.
vpc_uuid: A string specifying the UUID of the VPC to which the load balancer is assigned.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
...
@required_args(["forwarding_rules"])
def create(
self,
*,
forwarding_rules: Iterable[ForwardingRuleParam],
algorithm: Literal["round_robin", "least_connections"] | Omit = omit,
disable_lets_encrypt_dns_records: bool | Omit = omit,
domains: Iterable[DomainsParam] | Omit = omit,
droplet_ids: Iterable[int] | Omit = omit,
enable_backend_keepalive: bool | Omit = omit,
enable_proxy_protocol: bool | Omit = omit,
firewall: LbFirewallParam | Omit = omit,
glb_settings: GlbSettingsParam | Omit = omit,
health_check: HealthCheckParam | Omit = omit,
http_idle_timeout_seconds: int | Omit = omit,
name: str | Omit = omit,
network: Literal["EXTERNAL", "INTERNAL"] | Omit = omit,
network_stack: Literal["IPV4", "DUALSTACK"] | Omit = omit,
project_id: str | Omit = omit,
redirect_http_to_https: bool | Omit = omit,
region: Literal[
"ams1",
"ams2",
"ams3",
"blr1",
"fra1",
"lon1",
"nyc1",
"nyc2",
"nyc3",
"sfo1",
"sfo2",
"sfo3",
"sgp1",
"tor1",
"syd1",
]
| Omit = omit,
size: Literal["lb-small", "lb-medium", "lb-large"] | Omit = omit,
size_unit: int | Omit = omit,
sticky_sessions: StickySessionsParam | Omit = omit,
target_load_balancer_ids: SequenceNotStr[str] | Omit = omit,
tls_cipher_policy: Literal["DEFAULT", "STRONG"] | Omit = omit,
type: Literal["REGIONAL", "REGIONAL_NETWORK", "GLOBAL"] | Omit = omit,
vpc_uuid: str | Omit = omit,
tag: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> LoadBalancerCreateResponse:
return self._post(
"/v2/load_balancers"
if self._client._base_url_overridden
else "https://api.digitalocean.com/v2/load_balancers",
body=maybe_transform(
{
"forwarding_rules": forwarding_rules,
"algorithm": algorithm,
"disable_lets_encrypt_dns_records": disable_lets_encrypt_dns_records,
"domains": domains,
"droplet_ids": droplet_ids,
"enable_backend_keepalive": enable_backend_keepalive,
"enable_proxy_protocol": enable_proxy_protocol,
"firewall": firewall,
"glb_settings": glb_settings,
"health_check": health_check,
"http_idle_timeout_seconds": http_idle_timeout_seconds,
"name": name,
"network": network,
"network_stack": network_stack,
"project_id": project_id,
"redirect_http_to_https": redirect_http_to_https,
"region": region,
"size": size,
"size_unit": size_unit,
"sticky_sessions": sticky_sessions,
"target_load_balancer_ids": target_load_balancer_ids,
"tls_cipher_policy": tls_cipher_policy,
"type": type,
"vpc_uuid": vpc_uuid,
"tag": tag,
},
load_balancer_create_params.LoadBalancerCreateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=LoadBalancerCreateResponse,
)
def retrieve(
self,
lb_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> LoadBalancerRetrieveResponse:
"""
To show information about a load balancer instance, send a GET request to
`/v2/load_balancers/$LOAD_BALANCER_ID`.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not lb_id:
raise ValueError(f"Expected a non-empty value for `lb_id` but received {lb_id!r}")
return self._get(
f"/v2/load_balancers/{lb_id}"
if self._client._base_url_overridden
else f"https://api.digitalocean.com/v2/load_balancers/{lb_id}",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=LoadBalancerRetrieveResponse,
)
@overload
def update(
self,
lb_id: str,
*,
forwarding_rules: Iterable[ForwardingRuleParam],
algorithm: Literal["round_robin", "least_connections"] | Omit = omit,
disable_lets_encrypt_dns_records: bool | Omit = omit,
domains: Iterable[DomainsParam] | Omit = omit,
droplet_ids: Iterable[int] | Omit = omit,
enable_backend_keepalive: bool | Omit = omit,
enable_proxy_protocol: bool | Omit = omit,
firewall: LbFirewallParam | Omit = omit,
glb_settings: GlbSettingsParam | Omit = omit,
health_check: HealthCheckParam | Omit = omit,
http_idle_timeout_seconds: int | Omit = omit,
name: str | Omit = omit,
network: Literal["EXTERNAL", "INTERNAL"] | Omit = omit,
network_stack: Literal["IPV4", "DUALSTACK"] | Omit = omit,
project_id: str | Omit = omit,
redirect_http_to_https: bool | Omit = omit,
region: Literal[
"ams1",
"ams2",
"ams3",
"blr1",
"fra1",
"lon1",
"nyc1",
"nyc2",
"nyc3",
"sfo1",
"sfo2",
"sfo3",
"sgp1",
"tor1",
"syd1",
]
| Omit = omit,
size: Literal["lb-small", "lb-medium", "lb-large"] | Omit = omit,
size_unit: int | Omit = omit,
sticky_sessions: StickySessionsParam | Omit = omit,
target_load_balancer_ids: SequenceNotStr[str] | Omit = omit,
tls_cipher_policy: Literal["DEFAULT", "STRONG"] | Omit = omit,
type: Literal["REGIONAL", "REGIONAL_NETWORK", "GLOBAL"] | Omit = omit,
vpc_uuid: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> LoadBalancerUpdateResponse:
"""
To update a load balancer's settings, send a PUT request to
`/v2/load_balancers/$LOAD_BALANCER_ID`. The request should contain a full
representation of the load balancer including existing attributes. It may
contain _one of_ the `droplets_ids` or `tag` attributes as they are mutually
exclusive. **Note that any attribute that is not provided will be reset to its
default value.**
Args:
forwarding_rules: An array of objects specifying the forwarding rules for a load balancer.
algorithm: This field has been deprecated. You can no longer specify an algorithm for load
balancers.
disable_lets_encrypt_dns_records: A boolean value indicating whether to disable automatic DNS record creation for
Let's Encrypt certificates that are added to the load balancer.
domains: An array of objects specifying the domain configurations for a Global load
balancer.
droplet_ids: An array containing the IDs of the Droplets assigned to the load balancer.
enable_backend_keepalive: A boolean value indicating whether HTTP keepalive connections are maintained to
target Droplets.
enable_proxy_protocol: A boolean value indicating whether PROXY Protocol is in use.
firewall: An object specifying allow and deny rules to control traffic to the load
balancer.
glb_settings: An object specifying forwarding configurations for a Global load balancer.
health_check: An object specifying health check settings for the load balancer.
http_idle_timeout_seconds: An integer value which configures the idle timeout for HTTP requests to the
target droplets.
name: A human-readable name for a load balancer instance.
network: A string indicating whether the load balancer should be external or internal.
Internal load balancers have no public IPs and are only accessible to resources
on the same VPC network. This property cannot be updated after creating the load
balancer.
network_stack: A string indicating whether the load balancer will support IPv4 or both IPv4 and
IPv6 networking. This property cannot be updated after creating the load
balancer.
project_id: The ID of the project that the load balancer is associated with. If no ID is
provided at creation, the load balancer associates with the user's default
project. If an invalid project ID is provided, the load balancer will not be
created.
redirect_http_to_https: A boolean value indicating whether HTTP requests to the load balancer on port 80
will be redirected to HTTPS on port 443.
region: The slug identifier for the region where the resource will initially be
available.
size: This field has been replaced by the `size_unit` field for all regions except in
AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load
balancer having a set number of nodes.
- `lb-small` = 1 node
- `lb-medium` = 3 nodes
- `lb-large` = 6 nodes
You can resize load balancers after creation up to once per hour. You cannot
resize a load balancer within the first hour of its creation.
size_unit: How many nodes the load balancer contains. Each additional node increases the
load balancer's ability to manage more connections. Load balancers can be scaled
up or down, and you can change the number of nodes after creation up to once per
hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions.
Use the `size` field to scale load balancers that reside in these regions.
sticky_sessions: An object specifying sticky sessions settings for the load balancer.
target_load_balancer_ids: An array containing the UUIDs of the Regional load balancers to be used as
target backends for a Global load balancer.
tls_cipher_policy: A string indicating the policy for the TLS cipher suites used by the load
balancer. The possible values are `DEFAULT` or `STRONG`. The default value is
`DEFAULT`.
type: A string indicating whether the load balancer should be a standard regional HTTP
load balancer, a regional network load balancer that routes traffic at the
TCP/UDP transport layer, or a global load balancer.
vpc_uuid: A string specifying the UUID of the VPC to which the load balancer is assigned.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
...
@overload
def update(
self,
lb_id: str,
*,
forwarding_rules: Iterable[ForwardingRuleParam],
algorithm: Literal["round_robin", "least_connections"] | Omit = omit,
disable_lets_encrypt_dns_records: bool | Omit = omit,
domains: Iterable[DomainsParam] | Omit = omit,
enable_backend_keepalive: bool | Omit = omit,
enable_proxy_protocol: bool | Omit = omit,
firewall: LbFirewallParam | Omit = omit,
glb_settings: GlbSettingsParam | Omit = omit,
health_check: HealthCheckParam | Omit = omit,
http_idle_timeout_seconds: int | Omit = omit,
name: str | Omit = omit,
network: Literal["EXTERNAL", "INTERNAL"] | Omit = omit,
network_stack: Literal["IPV4", "DUALSTACK"] | Omit = omit,
project_id: str | Omit = omit,
redirect_http_to_https: bool | Omit = omit,
region: Literal[
"ams1",
"ams2",
"ams3",
"blr1",
"fra1",
"lon1",
"nyc1",
"nyc2",
"nyc3",
"sfo1",
"sfo2",
"sfo3",
"sgp1",
"tor1",
"syd1",
]
| Omit = omit,
size: Literal["lb-small", "lb-medium", "lb-large"] | Omit = omit,
size_unit: int | Omit = omit,
sticky_sessions: StickySessionsParam | Omit = omit,
tag: str | Omit = omit,
target_load_balancer_ids: SequenceNotStr[str] | Omit = omit,
tls_cipher_policy: Literal["DEFAULT", "STRONG"] | Omit = omit,
type: Literal["REGIONAL", "REGIONAL_NETWORK", "GLOBAL"] | Omit = omit,
vpc_uuid: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> LoadBalancerUpdateResponse:
"""
To update a load balancer's settings, send a PUT request to
`/v2/load_balancers/$LOAD_BALANCER_ID`. The request should contain a full
representation of the load balancer including existing attributes. It may
contain _one of_ the `droplets_ids` or `tag` attributes as they are mutually
exclusive. **Note that any attribute that is not provided will be reset to its
default value.**
Args:
forwarding_rules: An array of objects specifying the forwarding rules for a load balancer.
algorithm: This field has been deprecated. You can no longer specify an algorithm for load
balancers.
disable_lets_encrypt_dns_records: A boolean value indicating whether to disable automatic DNS record creation for
Let's Encrypt certificates that are added to the load balancer.
domains: An array of objects specifying the domain configurations for a Global load
balancer.
enable_backend_keepalive: A boolean value indicating whether HTTP keepalive connections are maintained to
target Droplets.
enable_proxy_protocol: A boolean value indicating whether PROXY Protocol is in use.
firewall: An object specifying allow and deny rules to control traffic to the load
balancer.
glb_settings: An object specifying forwarding configurations for a Global load balancer.
health_check: An object specifying health check settings for the load balancer.
http_idle_timeout_seconds: An integer value which configures the idle timeout for HTTP requests to the
target droplets.
name: A human-readable name for a load balancer instance.
network: A string indicating whether the load balancer should be external or internal.
Internal load balancers have no public IPs and are only accessible to resources
on the same VPC network. This property cannot be updated after creating the load
balancer.
network_stack: A string indicating whether the load balancer will support IPv4 or both IPv4 and
IPv6 networking. This property cannot be updated after creating the load
balancer.
project_id: The ID of the project that the load balancer is associated with. If no ID is
provided at creation, the load balancer associates with the user's default
project. If an invalid project ID is provided, the load balancer will not be
created.
redirect_http_to_https: A boolean value indicating whether HTTP requests to the load balancer on port 80
will be redirected to HTTPS on port 443.
region: The slug identifier for the region where the resource will initially be
available.
size: This field has been replaced by the `size_unit` field for all regions except in
AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load
balancer having a set number of nodes.
- `lb-small` = 1 node
- `lb-medium` = 3 nodes
- `lb-large` = 6 nodes
You can resize load balancers after creation up to once per hour. You cannot
resize a load balancer within the first hour of its creation.
size_unit: How many nodes the load balancer contains. Each additional node increases the
load balancer's ability to manage more connections. Load balancers can be scaled
up or down, and you can change the number of nodes after creation up to once per
hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions.
Use the `size` field to scale load balancers that reside in these regions.
sticky_sessions: An object specifying sticky sessions settings for the load balancer.
tag: The name of a Droplet tag corresponding to Droplets assigned to the load
balancer.
target_load_balancer_ids: An array containing the UUIDs of the Regional load balancers to be used as
target backends for a Global load balancer.
tls_cipher_policy: A string indicating the policy for the TLS cipher suites used by the load
balancer. The possible values are `DEFAULT` or `STRONG`. The default value is
`DEFAULT`.
type: A string indicating whether the load balancer should be a standard regional HTTP
load balancer, a regional network load balancer that routes traffic at the
TCP/UDP transport layer, or a global load balancer.
vpc_uuid: A string specifying the UUID of the VPC to which the load balancer is assigned.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
...
@required_args(["forwarding_rules"])
def update(
self,
lb_id: str,
*,
forwarding_rules: Iterable[ForwardingRuleParam],
algorithm: Literal["round_robin", "least_connections"] | Omit = omit,
disable_lets_encrypt_dns_records: bool | Omit = omit,
domains: Iterable[DomainsParam] | Omit = omit,
droplet_ids: Iterable[int] | Omit = omit,
enable_backend_keepalive: bool | Omit = omit,
enable_proxy_protocol: bool | Omit = omit,
firewall: LbFirewallParam | Omit = omit,
glb_settings: GlbSettingsParam | Omit = omit,
health_check: HealthCheckParam | Omit = omit,
http_idle_timeout_seconds: int | Omit = omit,
name: str | Omit = omit,
network: Literal["EXTERNAL", "INTERNAL"] | Omit = omit,
network_stack: Literal["IPV4", "DUALSTACK"] | Omit = omit,
project_id: str | Omit = omit,
redirect_http_to_https: bool | Omit = omit,
region: Literal[
"ams1",
"ams2",
"ams3",
"blr1",
"fra1",
"lon1",
"nyc1",
"nyc2",
"nyc3",
"sfo1",
"sfo2",
"sfo3",
"sgp1",
"tor1",
"syd1",
]
| Omit = omit,
size: Literal["lb-small", "lb-medium", "lb-large"] | Omit = omit,
size_unit: int | Omit = omit,
sticky_sessions: StickySessionsParam | Omit = omit,
target_load_balancer_ids: SequenceNotStr[str] | Omit = omit,
tls_cipher_policy: Literal["DEFAULT", "STRONG"] | Omit = omit,
type: Literal["REGIONAL", "REGIONAL_NETWORK", "GLOBAL"] | Omit = omit,
vpc_uuid: str | Omit = omit,
tag: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> LoadBalancerUpdateResponse:
if not lb_id:
raise ValueError(f"Expected a non-empty value for `lb_id` but received {lb_id!r}")
return self._put(
f"/v2/load_balancers/{lb_id}"
if self._client._base_url_overridden
else f"https://api.digitalocean.com/v2/load_balancers/{lb_id}",
body=maybe_transform(
{
"forwarding_rules": forwarding_rules,
"algorithm": algorithm,
"disable_lets_encrypt_dns_records": disable_lets_encrypt_dns_records,
"domains": domains,
"droplet_ids": droplet_ids,
"enable_backend_keepalive": enable_backend_keepalive,
"enable_proxy_protocol": enable_proxy_protocol,
"firewall": firewall,
"glb_settings": glb_settings,
"health_check": health_check,
"http_idle_timeout_seconds": http_idle_timeout_seconds,
"name": name,
"network": network,
"network_stack": network_stack,
"project_id": project_id,
"redirect_http_to_https": redirect_http_to_https,
"region": region,
"size": size,
"size_unit": size_unit,
"sticky_sessions": sticky_sessions,
"target_load_balancer_ids": target_load_balancer_ids,
"tls_cipher_policy": tls_cipher_policy,
"type": type,
"vpc_uuid": vpc_uuid,
"tag": tag,
},
load_balancer_update_params.LoadBalancerUpdateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=LoadBalancerUpdateResponse,
)
def list(
self,
*,
page: int | Omit = omit,
per_page: int | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> LoadBalancerListResponse:
"""
To list all of the load balancer instances on your account, send a GET request
to `/v2/load_balancers`.
Args:
page: Which 'page' of paginated results to return.
per_page: Number of items returned per page
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get(
"/v2/load_balancers"
if self._client._base_url_overridden
else "https://api.digitalocean.com/v2/load_balancers",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"page": page,
"per_page": per_page,