strongdm 3.16.0__zip → 3.17.0__zip

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. {strongdm-3.16.0 → strongdm-3.17.0}/PKG-INFO +2 -2
  2. {strongdm-3.16.0 → strongdm-3.17.0}/setup.py +2 -2
  3. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/client.py +1 -1
  4. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/drivers_pb2.py +250 -162
  5. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/models.py +2101 -85
  6. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/nodes_pb2.py +14 -6
  7. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/plumbing.py +132 -0
  8. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/svc.py +2 -0
  9. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm.egg-info/PKG-INFO +2 -2
  10. {strongdm-3.16.0 → strongdm-3.17.0}/README.md +0 -0
  11. {strongdm-3.16.0 → strongdm-3.17.0}/setup.cfg +0 -0
  12. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/__init__.py +0 -0
  13. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/account_attachments_history_pb2.py +0 -0
  14. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/account_attachments_history_pb2_grpc.py +0 -0
  15. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/account_attachments_pb2.py +0 -0
  16. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/account_attachments_pb2_grpc.py +0 -0
  17. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/account_grants_history_pb2.py +0 -0
  18. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/account_grants_history_pb2_grpc.py +0 -0
  19. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/account_grants_pb2.py +0 -0
  20. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/account_grants_pb2_grpc.py +0 -0
  21. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/account_permissions_pb2.py +0 -0
  22. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/account_permissions_pb2_grpc.py +0 -0
  23. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/account_resources_history_pb2.py +0 -0
  24. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/account_resources_history_pb2_grpc.py +0 -0
  25. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/account_resources_pb2.py +0 -0
  26. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/account_resources_pb2_grpc.py +0 -0
  27. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/accounts_history_pb2.py +0 -0
  28. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/accounts_history_pb2_grpc.py +0 -0
  29. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/accounts_pb2.py +0 -0
  30. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/accounts_pb2_grpc.py +0 -0
  31. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/activities_pb2.py +0 -0
  32. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/activities_pb2_grpc.py +0 -0
  33. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/constants.py +0 -0
  34. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/control_panel_pb2.py +0 -0
  35. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/control_panel_pb2_grpc.py +0 -0
  36. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/drivers_pb2_grpc.py +0 -0
  37. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/errors.py +0 -0
  38. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/nodes_history_pb2.py +0 -0
  39. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/nodes_history_pb2_grpc.py +0 -0
  40. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/nodes_pb2_grpc.py +0 -0
  41. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/options_pb2.py +0 -0
  42. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/options_pb2_grpc.py +0 -0
  43. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/organization_history_pb2.py +0 -0
  44. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/organization_history_pb2_grpc.py +0 -0
  45. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/queries_pb2.py +0 -0
  46. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/queries_pb2_grpc.py +0 -0
  47. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/remote_identities_history_pb2.py +0 -0
  48. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/remote_identities_history_pb2_grpc.py +0 -0
  49. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/remote_identities_pb2.py +0 -0
  50. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/remote_identities_pb2_grpc.py +0 -0
  51. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/remote_identity_groups_history_pb2.py +0 -0
  52. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/remote_identity_groups_history_pb2_grpc.py +0 -0
  53. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/remote_identity_groups_pb2.py +0 -0
  54. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/remote_identity_groups_pb2_grpc.py +0 -0
  55. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/replays_pb2.py +0 -0
  56. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/replays_pb2_grpc.py +0 -0
  57. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/resources_history_pb2.py +0 -0
  58. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/resources_history_pb2_grpc.py +0 -0
  59. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/resources_pb2.py +0 -0
  60. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/resources_pb2_grpc.py +0 -0
  61. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/role_resources_history_pb2.py +0 -0
  62. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/role_resources_history_pb2_grpc.py +0 -0
  63. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/role_resources_pb2.py +0 -0
  64. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/role_resources_pb2_grpc.py +0 -0
  65. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/roles_history_pb2.py +0 -0
  66. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/roles_history_pb2_grpc.py +0 -0
  67. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/roles_pb2.py +0 -0
  68. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/roles_pb2_grpc.py +0 -0
  69. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/secret_store_types_pb2.py +0 -0
  70. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/secret_store_types_pb2_grpc.py +0 -0
  71. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/secret_stores_history_pb2.py +0 -0
  72. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/secret_stores_history_pb2_grpc.py +0 -0
  73. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/secret_stores_pb2.py +0 -0
  74. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/secret_stores_pb2_grpc.py +0 -0
  75. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/spec_pb2.py +0 -0
  76. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/spec_pb2_grpc.py +0 -0
  77. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/tags_pb2.py +0 -0
  78. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm/tags_pb2_grpc.py +0 -0
  79. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm.egg-info/SOURCES.txt +0 -0
  80. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm.egg-info/dependency_links.txt +0 -0
  81. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm.egg-info/requires.txt +0 -0
  82. {strongdm-3.16.0 → strongdm-3.17.0}/strongdm.egg-info/top_level.txt +0 -0
@@ -61,11 +61,20 @@ class AKS:
61
61
  ):
62
62
  self.bind_interface = bind_interface if bind_interface is not None else ''
63
63
  '''
64
- Bind interface
64
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
65
65
  '''
66
66
  self.certificate_authority = certificate_authority if certificate_authority is not None else ''
67
+ '''
68
+ The CA to authenticate TLS connections with.
69
+ '''
67
70
  self.client_certificate = client_certificate if client_certificate is not None else ''
71
+ '''
72
+ The certificate to authenticate TLS connections with.
73
+ '''
68
74
  self.client_key = client_key if client_key is not None else ''
75
+ '''
76
+ The key to authenticate TLS connections with.
77
+ '''
69
78
  self.egress_filter = egress_filter if egress_filter is not None else ''
70
79
  '''
71
80
  A filter applied to the routing logic to pin datasource to nodes.
@@ -79,6 +88,9 @@ class AKS:
79
88
  True if the datasource is reachable and the credentials are valid.
80
89
  '''
81
90
  self.hostname = hostname if hostname is not None else ''
91
+ '''
92
+ The host to dial to initiate a connection from the egress node to this resource.
93
+ '''
82
94
  self.id = id if id is not None else ''
83
95
  '''
84
96
  Unique identifier of the Resource.
@@ -88,9 +100,21 @@ class AKS:
88
100
  Unique human-readable name of the Resource.
89
101
  '''
90
102
  self.port = port if port is not None else 0
103
+ '''
104
+ The port to dial to initiate a connection from the egress node to this resource.
105
+ '''
91
106
  self.port_override = port_override if port_override is not None else 0
107
+ '''
108
+ The local port used by clients to connect to this resource.
109
+ '''
92
110
  self.remote_identity_group_id = remote_identity_group_id if remote_identity_group_id is not None else ''
111
+ '''
112
+ The ID of the remote identity group to use for remote identity connections.
113
+ '''
93
114
  self.remote_identity_healthcheck_username = remote_identity_healthcheck_username if remote_identity_healthcheck_username is not None else ''
115
+ '''
116
+ The username to use for healthchecks, when clients otherwise connect with their own remote identity username.
117
+ '''
94
118
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
95
119
  '''
96
120
  ID of the secret store containing credentials for this resource, if any.
@@ -208,7 +232,7 @@ class AKSBasicAuth:
208
232
  ):
209
233
  self.bind_interface = bind_interface if bind_interface is not None else ''
210
234
  '''
211
- Bind interface
235
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
212
236
  '''
213
237
  self.egress_filter = egress_filter if egress_filter is not None else ''
214
238
  '''
@@ -223,6 +247,9 @@ class AKSBasicAuth:
223
247
  True if the datasource is reachable and the credentials are valid.
224
248
  '''
225
249
  self.hostname = hostname if hostname is not None else ''
250
+ '''
251
+ The host to dial to initiate a connection from the egress node to this resource.
252
+ '''
226
253
  self.id = id if id is not None else ''
227
254
  '''
228
255
  Unique identifier of the Resource.
@@ -232,8 +259,17 @@ class AKSBasicAuth:
232
259
  Unique human-readable name of the Resource.
233
260
  '''
234
261
  self.password = password if password is not None else ''
262
+ '''
263
+ The password to authenticate with.
264
+ '''
235
265
  self.port = port if port is not None else 0
266
+ '''
267
+ The port to dial to initiate a connection from the egress node to this resource.
268
+ '''
236
269
  self.port_override = port_override if port_override is not None else 0
270
+ '''
271
+ The local port used by clients to connect to this resource.
272
+ '''
237
273
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
238
274
  '''
239
275
  ID of the secret store containing credentials for this resource, if any.
@@ -247,6 +283,9 @@ class AKSBasicAuth:
247
283
  Tags is a map of key, value pairs.
248
284
  '''
249
285
  self.username = username if username is not None else ''
286
+ '''
287
+ The username to authenticate with.
288
+ '''
250
289
 
251
290
  def __repr__(self):
252
291
  return '<sdm.AKSBasicAuth ' + \
@@ -343,7 +382,7 @@ class AKSServiceAccount:
343
382
  ):
344
383
  self.bind_interface = bind_interface if bind_interface is not None else ''
345
384
  '''
346
- Bind interface
385
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
347
386
  '''
348
387
  self.egress_filter = egress_filter if egress_filter is not None else ''
349
388
  '''
@@ -358,6 +397,9 @@ class AKSServiceAccount:
358
397
  True if the datasource is reachable and the credentials are valid.
359
398
  '''
360
399
  self.hostname = hostname if hostname is not None else ''
400
+ '''
401
+ The host to dial to initiate a connection from the egress node to this resource.
402
+ '''
361
403
  self.id = id if id is not None else ''
362
404
  '''
363
405
  Unique identifier of the Resource.
@@ -367,9 +409,21 @@ class AKSServiceAccount:
367
409
  Unique human-readable name of the Resource.
368
410
  '''
369
411
  self.port = port if port is not None else 0
412
+ '''
413
+ The port to dial to initiate a connection from the egress node to this resource.
414
+ '''
370
415
  self.port_override = port_override if port_override is not None else 0
416
+ '''
417
+ The local port used by clients to connect to this resource.
418
+ '''
371
419
  self.remote_identity_group_id = remote_identity_group_id if remote_identity_group_id is not None else ''
420
+ '''
421
+ The ID of the remote identity group to use for remote identity connections.
422
+ '''
372
423
  self.remote_identity_healthcheck_username = remote_identity_healthcheck_username if remote_identity_healthcheck_username is not None else ''
424
+ '''
425
+ The username to use for healthchecks, when clients otherwise connect with their own remote identity username.
426
+ '''
373
427
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
374
428
  '''
375
429
  ID of the secret store containing credentials for this resource, if any.
@@ -383,6 +437,9 @@ class AKSServiceAccount:
383
437
  Tags is a map of key, value pairs.
384
438
  '''
385
439
  self.token = token if token is not None else ''
440
+ '''
441
+ The API token to authenticate with.
442
+ '''
386
443
 
387
444
  def __repr__(self):
388
445
  return '<sdm.AKSServiceAccount ' + \
@@ -480,7 +537,7 @@ class AKSServiceAccountUserImpersonation:
480
537
  ):
481
538
  self.bind_interface = bind_interface if bind_interface is not None else ''
482
539
  '''
483
- Bind interface
540
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
484
541
  '''
485
542
  self.egress_filter = egress_filter if egress_filter is not None else ''
486
543
  '''
@@ -495,6 +552,9 @@ class AKSServiceAccountUserImpersonation:
495
552
  True if the datasource is reachable and the credentials are valid.
496
553
  '''
497
554
  self.hostname = hostname if hostname is not None else ''
555
+ '''
556
+ The host to dial to initiate a connection from the egress node to this resource.
557
+ '''
498
558
  self.id = id if id is not None else ''
499
559
  '''
500
560
  Unique identifier of the Resource.
@@ -504,7 +564,13 @@ class AKSServiceAccountUserImpersonation:
504
564
  Unique human-readable name of the Resource.
505
565
  '''
506
566
  self.port = port if port is not None else 0
567
+ '''
568
+ The port to dial to initiate a connection from the egress node to this resource.
569
+ '''
507
570
  self.port_override = port_override if port_override is not None else 0
571
+ '''
572
+ The local port used by clients to connect to this resource.
573
+ '''
508
574
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
509
575
  '''
510
576
  ID of the secret store containing credentials for this resource, if any.
@@ -518,6 +584,9 @@ class AKSServiceAccountUserImpersonation:
518
584
  Tags is a map of key, value pairs.
519
585
  '''
520
586
  self.token = token if token is not None else ''
587
+ '''
588
+ The API token to authenticate with.
589
+ '''
521
590
 
522
591
  def __repr__(self):
523
592
  return '<sdm.AKSServiceAccountUserImpersonation ' + \
@@ -611,11 +680,20 @@ class AKSUserImpersonation:
611
680
  ):
612
681
  self.bind_interface = bind_interface if bind_interface is not None else ''
613
682
  '''
614
- Bind interface
683
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
615
684
  '''
616
685
  self.certificate_authority = certificate_authority if certificate_authority is not None else ''
686
+ '''
687
+ The CA to authenticate TLS connections with.
688
+ '''
617
689
  self.client_certificate = client_certificate if client_certificate is not None else ''
690
+ '''
691
+ The certificate to authenticate TLS connections with.
692
+ '''
618
693
  self.client_key = client_key if client_key is not None else ''
694
+ '''
695
+ The key to authenticate TLS connections with.
696
+ '''
619
697
  self.egress_filter = egress_filter if egress_filter is not None else ''
620
698
  '''
621
699
  A filter applied to the routing logic to pin datasource to nodes.
@@ -629,6 +707,9 @@ class AKSUserImpersonation:
629
707
  True if the datasource is reachable and the credentials are valid.
630
708
  '''
631
709
  self.hostname = hostname if hostname is not None else ''
710
+ '''
711
+ The host to dial to initiate a connection from the egress node to this resource.
712
+ '''
632
713
  self.id = id if id is not None else ''
633
714
  '''
634
715
  Unique identifier of the Resource.
@@ -638,7 +719,13 @@ class AKSUserImpersonation:
638
719
  Unique human-readable name of the Resource.
639
720
  '''
640
721
  self.port = port if port is not None else 0
722
+ '''
723
+ The port to dial to initiate a connection from the egress node to this resource.
724
+ '''
641
725
  self.port_override = port_override if port_override is not None else 0
726
+ '''
727
+ The local port used by clients to connect to this resource.
728
+ '''
642
729
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
643
730
  '''
644
731
  ID of the secret store containing credentials for this resource, if any.
@@ -747,15 +834,21 @@ class AWS:
747
834
  tags=None,
748
835
  ):
749
836
  self.access_key = access_key if access_key is not None else ''
837
+ '''
838
+ The Access Key ID to use to authenticate.
839
+ '''
750
840
  self.bind_interface = bind_interface if bind_interface is not None else ''
751
841
  '''
752
- Bind interface
842
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
753
843
  '''
754
844
  self.egress_filter = egress_filter if egress_filter is not None else ''
755
845
  '''
756
846
  A filter applied to the routing logic to pin datasource to nodes.
757
847
  '''
758
848
  self.healthcheck_region = healthcheck_region if healthcheck_region is not None else ''
849
+ '''
850
+ The AWS region healthcheck requests should attempt to connect to.
851
+ '''
759
852
  self.healthy = healthy if healthy is not None else False
760
853
  '''
761
854
  True if the datasource is reachable and the credentials are valid.
@@ -769,9 +862,21 @@ class AWS:
769
862
  Unique human-readable name of the Resource.
770
863
  '''
771
864
  self.port_override = port_override if port_override is not None else 0
865
+ '''
866
+ The local port used by clients to connect to this resource.
867
+ '''
772
868
  self.role_arn = role_arn if role_arn is not None else ''
869
+ '''
870
+ The role to assume after logging in.
871
+ '''
773
872
  self.role_external_id = role_external_id if role_external_id is not None else ''
873
+ '''
874
+ The external ID to associate with assume role requests. Does nothing if a role ARN is not provided.
875
+ '''
774
876
  self.secret_access_key = secret_access_key if secret_access_key is not None else ''
877
+ '''
878
+ The Secret Access Key to use to authenticate.
879
+ '''
775
880
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
776
881
  '''
777
882
  ID of the secret store containing credentials for this resource, if any.
@@ -886,13 +991,16 @@ class AWSConsole:
886
991
  ):
887
992
  self.bind_interface = bind_interface if bind_interface is not None else ''
888
993
  '''
889
- Bind interface
994
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
890
995
  '''
891
996
  self.egress_filter = egress_filter if egress_filter is not None else ''
892
997
  '''
893
998
  A filter applied to the routing logic to pin datasource to nodes.
894
999
  '''
895
1000
  self.enable_env_variables = enable_env_variables if enable_env_variables is not None else False
1001
+ '''
1002
+ If true, prefer environment variables to authenticate connection even if EC2 roles are configured.
1003
+ '''
896
1004
  self.healthy = healthy if healthy is not None else False
897
1005
  '''
898
1006
  True if the datasource is reachable and the credentials are valid.
@@ -906,17 +1014,41 @@ class AWSConsole:
906
1014
  Unique human-readable name of the Resource.
907
1015
  '''
908
1016
  self.port_override = port_override if port_override is not None else 0
1017
+ '''
1018
+ The local port used by clients to connect to this resource.
1019
+ '''
909
1020
  self.region = region if region is not None else ''
1021
+ '''
1022
+ The AWS region to connect to.
1023
+ '''
910
1024
  self.remote_identity_group_id = remote_identity_group_id if remote_identity_group_id is not None else ''
1025
+ '''
1026
+ The ID of the remote identity group to use for remote identity connections.
1027
+ '''
911
1028
  self.remote_identity_healthcheck_username = remote_identity_healthcheck_username if remote_identity_healthcheck_username is not None else ''
1029
+ '''
1030
+ The username to use for healthchecks, when clients otherwise connect with their own remote identity username.
1031
+ '''
912
1032
  self.role_arn = role_arn if role_arn is not None else ''
1033
+ '''
1034
+ The role to assume after logging in.
1035
+ '''
913
1036
  self.role_external_id = role_external_id if role_external_id is not None else ''
1037
+ '''
1038
+ The external ID to associate with assume role requests. Does nothing if a role ARN is not provided.
1039
+ '''
914
1040
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
915
1041
  '''
916
1042
  ID of the secret store containing credentials for this resource, if any.
917
1043
  '''
918
1044
  self.session_expiry = session_expiry if session_expiry is not None else 0
1045
+ '''
1046
+ The length of time in seconds AWS console sessions will live before needing to reauthenticate.
1047
+ '''
919
1048
  self.subdomain = subdomain if subdomain is not None else ''
1049
+ '''
1050
+ Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)
1051
+ '''
920
1052
  self.tags = tags if tags is not None else _porcelain_zero_value_tags()
921
1053
  '''
922
1054
  Tags is a map of key, value pairs.
@@ -1032,9 +1164,12 @@ class AWSConsoleStaticKeyPair:
1032
1164
  tags=None,
1033
1165
  ):
1034
1166
  self.access_key = access_key if access_key is not None else ''
1167
+ '''
1168
+ The Access Key ID to authenticate with.
1169
+ '''
1035
1170
  self.bind_interface = bind_interface if bind_interface is not None else ''
1036
1171
  '''
1037
- Bind interface
1172
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
1038
1173
  '''
1039
1174
  self.egress_filter = egress_filter if egress_filter is not None else ''
1040
1175
  '''
@@ -1053,18 +1188,45 @@ class AWSConsoleStaticKeyPair:
1053
1188
  Unique human-readable name of the Resource.
1054
1189
  '''
1055
1190
  self.port_override = port_override if port_override is not None else 0
1191
+ '''
1192
+ The local port used by clients to connect to this resource.
1193
+ '''
1056
1194
  self.region = region if region is not None else ''
1195
+ '''
1196
+ The AWS region to connect to.
1197
+ '''
1057
1198
  self.remote_identity_group_id = remote_identity_group_id if remote_identity_group_id is not None else ''
1199
+ '''
1200
+ The ID of the remote identity group to use for remote identity connections.
1201
+ '''
1058
1202
  self.remote_identity_healthcheck_username = remote_identity_healthcheck_username if remote_identity_healthcheck_username is not None else ''
1203
+ '''
1204
+ The username to use for healthchecks, when clients otherwise connect with their own remote identity username.
1205
+ '''
1059
1206
  self.role_arn = role_arn if role_arn is not None else ''
1207
+ '''
1208
+ The role to assume after logging in.
1209
+ '''
1060
1210
  self.role_external_id = role_external_id if role_external_id is not None else ''
1211
+ '''
1212
+ The external ID to associate with assume role requests. Does nothing if a role ARN is not provided.
1213
+ '''
1061
1214
  self.secret_access_key = secret_access_key if secret_access_key is not None else ''
1215
+ '''
1216
+ The Secret Access Key to authenticate with.
1217
+ '''
1062
1218
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
1063
1219
  '''
1064
1220
  ID of the secret store containing credentials for this resource, if any.
1065
1221
  '''
1066
1222
  self.session_expiry = session_expiry if session_expiry is not None else 0
1223
+ '''
1224
+ The length of time in seconds AWS console sessions will live before needing to reauthenticate.
1225
+ '''
1067
1226
  self.subdomain = subdomain if subdomain is not None else ''
1227
+ '''
1228
+ Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)
1229
+ '''
1068
1230
  self.tags = tags if tags is not None else _porcelain_zero_value_tags()
1069
1231
  '''
1070
1232
  Tags is a map of key, value pairs.
@@ -1161,6 +1323,9 @@ class AWSStore:
1161
1323
  Unique human-readable name of the SecretStore.
1162
1324
  '''
1163
1325
  self.region = region if region is not None else ''
1326
+ '''
1327
+ The AWS region to target e.g. us-east-1
1328
+ '''
1164
1329
  self.tags = tags if tags is not None else _porcelain_zero_value_tags()
1165
1330
  '''
1166
1331
  Tags is a map of key, value pairs.
@@ -2570,17 +2735,29 @@ class AmazonEKS:
2570
2735
  tags=None,
2571
2736
  ):
2572
2737
  self.access_key = access_key if access_key is not None else ''
2738
+ '''
2739
+ The Access Key ID to use to authenticate.
2740
+ '''
2573
2741
  self.bind_interface = bind_interface if bind_interface is not None else ''
2574
2742
  '''
2575
- Bind interface
2743
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
2576
2744
  '''
2577
2745
  self.certificate_authority = certificate_authority if certificate_authority is not None else ''
2746
+ '''
2747
+ The CA to authenticate TLS connections with.
2748
+ '''
2578
2749
  self.cluster_name = cluster_name if cluster_name is not None else ''
2750
+ '''
2751
+ The name of the cluster to connect to.
2752
+ '''
2579
2753
  self.egress_filter = egress_filter if egress_filter is not None else ''
2580
2754
  '''
2581
2755
  A filter applied to the routing logic to pin datasource to nodes.
2582
2756
  '''
2583
2757
  self.endpoint = endpoint if endpoint is not None else ''
2758
+ '''
2759
+ The endpoint to dial.
2760
+ '''
2584
2761
  self.healthcheck_namespace = healthcheck_namespace if healthcheck_namespace is not None else ''
2585
2762
  '''
2586
2763
  The path used to check the health of your connection. Defaults to `default`.
@@ -2598,12 +2775,33 @@ class AmazonEKS:
2598
2775
  Unique human-readable name of the Resource.
2599
2776
  '''
2600
2777
  self.port_override = port_override if port_override is not None else 0
2778
+ '''
2779
+ The local port used by clients to connect to this resource.
2780
+ '''
2601
2781
  self.region = region if region is not None else ''
2782
+ '''
2783
+ The AWS region to connect to e.g. us-east-1.
2784
+ '''
2602
2785
  self.remote_identity_group_id = remote_identity_group_id if remote_identity_group_id is not None else ''
2786
+ '''
2787
+ The ID of the remote identity group to use for remote identity connections.
2788
+ '''
2603
2789
  self.remote_identity_healthcheck_username = remote_identity_healthcheck_username if remote_identity_healthcheck_username is not None else ''
2790
+ '''
2791
+ The username to use for healthchecks, when clients otherwise connect with their own remote identity username.
2792
+ '''
2604
2793
  self.role_arn = role_arn if role_arn is not None else ''
2794
+ '''
2795
+ The role to assume after logging in.
2796
+ '''
2605
2797
  self.role_external_id = role_external_id if role_external_id is not None else ''
2798
+ '''
2799
+ The external ID to associate with assume role requests. Does nothing if a role ARN is not provided.
2800
+ '''
2606
2801
  self.secret_access_key = secret_access_key if secret_access_key is not None else ''
2802
+ '''
2803
+ The Secret Access Key to use to authenticate.
2804
+ '''
2607
2805
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
2608
2806
  '''
2609
2807
  ID of the secret store containing credentials for this resource, if any.
@@ -2738,15 +2936,24 @@ class AmazonEKSInstanceProfile:
2738
2936
  ):
2739
2937
  self.bind_interface = bind_interface if bind_interface is not None else ''
2740
2938
  '''
2741
- Bind interface
2939
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
2742
2940
  '''
2743
2941
  self.certificate_authority = certificate_authority if certificate_authority is not None else ''
2942
+ '''
2943
+ The CA to authenticate TLS connections with.
2944
+ '''
2744
2945
  self.cluster_name = cluster_name if cluster_name is not None else ''
2946
+ '''
2947
+ The name of the cluster to connect to.
2948
+ '''
2745
2949
  self.egress_filter = egress_filter if egress_filter is not None else ''
2746
2950
  '''
2747
2951
  A filter applied to the routing logic to pin datasource to nodes.
2748
2952
  '''
2749
2953
  self.endpoint = endpoint if endpoint is not None else ''
2954
+ '''
2955
+ The endpoint to dial.
2956
+ '''
2750
2957
  self.healthcheck_namespace = healthcheck_namespace if healthcheck_namespace is not None else ''
2751
2958
  '''
2752
2959
  The path used to check the health of your connection. Defaults to `default`.
@@ -2764,11 +2971,29 @@ class AmazonEKSInstanceProfile:
2764
2971
  Unique human-readable name of the Resource.
2765
2972
  '''
2766
2973
  self.port_override = port_override if port_override is not None else 0
2974
+ '''
2975
+ The local port used by clients to connect to this resource.
2976
+ '''
2767
2977
  self.region = region if region is not None else ''
2978
+ '''
2979
+ The AWS region to connect to e.g. us-east-1.
2980
+ '''
2768
2981
  self.remote_identity_group_id = remote_identity_group_id if remote_identity_group_id is not None else ''
2982
+ '''
2983
+ The ID of the remote identity group to use for remote identity connections.
2984
+ '''
2769
2985
  self.remote_identity_healthcheck_username = remote_identity_healthcheck_username if remote_identity_healthcheck_username is not None else ''
2986
+ '''
2987
+ The username to use for healthchecks, when clients otherwise connect with their own remote identity username.
2988
+ '''
2770
2989
  self.role_arn = role_arn if role_arn is not None else ''
2990
+ '''
2991
+ The role to assume after logging in.
2992
+ '''
2771
2993
  self.role_external_id = role_external_id if role_external_id is not None else ''
2994
+ '''
2995
+ The external ID to associate with assume role requests. Does nothing if a role ARN is not provided.
2996
+ '''
2772
2997
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
2773
2998
  '''
2774
2999
  ID of the secret store containing credentials for this resource, if any.
@@ -2897,15 +3122,24 @@ class AmazonEKSInstanceProfileUserImpersonation:
2897
3122
  ):
2898
3123
  self.bind_interface = bind_interface if bind_interface is not None else ''
2899
3124
  '''
2900
- Bind interface
3125
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
2901
3126
  '''
2902
3127
  self.certificate_authority = certificate_authority if certificate_authority is not None else ''
3128
+ '''
3129
+ The CA to authenticate TLS connections with.
3130
+ '''
2903
3131
  self.cluster_name = cluster_name if cluster_name is not None else ''
3132
+ '''
3133
+ The name of the cluster to connect to.
3134
+ '''
2904
3135
  self.egress_filter = egress_filter if egress_filter is not None else ''
2905
3136
  '''
2906
3137
  A filter applied to the routing logic to pin datasource to nodes.
2907
3138
  '''
2908
3139
  self.endpoint = endpoint if endpoint is not None else ''
3140
+ '''
3141
+ The endpoint to dial.
3142
+ '''
2909
3143
  self.healthcheck_namespace = healthcheck_namespace if healthcheck_namespace is not None else ''
2910
3144
  '''
2911
3145
  The path used to check the health of your connection. Defaults to `default`.
@@ -2923,11 +3157,29 @@ class AmazonEKSInstanceProfileUserImpersonation:
2923
3157
  Unique human-readable name of the Resource.
2924
3158
  '''
2925
3159
  self.port_override = port_override if port_override is not None else 0
3160
+ '''
3161
+ The local port used by clients to connect to this resource.
3162
+ '''
2926
3163
  self.region = region if region is not None else ''
3164
+ '''
3165
+ The AWS region to connect to e.g. us-east-1.
3166
+ '''
2927
3167
  self.remote_identity_group_id = remote_identity_group_id if remote_identity_group_id is not None else ''
3168
+ '''
3169
+ The ID of the remote identity group to use for remote identity connections.
3170
+ '''
2928
3171
  self.remote_identity_healthcheck_username = remote_identity_healthcheck_username if remote_identity_healthcheck_username is not None else ''
3172
+ '''
3173
+ The username to use for healthchecks, when clients otherwise connect with their own remote identity username.
3174
+ '''
2929
3175
  self.role_arn = role_arn if role_arn is not None else ''
3176
+ '''
3177
+ The role to assume after logging in.
3178
+ '''
2930
3179
  self.role_external_id = role_external_id if role_external_id is not None else ''
3180
+ '''
3181
+ The external ID to associate with assume role requests. Does nothing if a role ARN is not provided.
3182
+ '''
2931
3183
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
2932
3184
  '''
2933
3185
  ID of the secret store containing credentials for this resource, if any.
@@ -3055,17 +3307,29 @@ class AmazonEKSUserImpersonation:
3055
3307
  tags=None,
3056
3308
  ):
3057
3309
  self.access_key = access_key if access_key is not None else ''
3310
+ '''
3311
+ The Access Key ID to use to authenticate.
3312
+ '''
3058
3313
  self.bind_interface = bind_interface if bind_interface is not None else ''
3059
3314
  '''
3060
- Bind interface
3315
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
3061
3316
  '''
3062
3317
  self.certificate_authority = certificate_authority if certificate_authority is not None else ''
3318
+ '''
3319
+ The CA to authenticate TLS connections with.
3320
+ '''
3063
3321
  self.cluster_name = cluster_name if cluster_name is not None else ''
3322
+ '''
3323
+ The name of the cluster to connect to.
3324
+ '''
3064
3325
  self.egress_filter = egress_filter if egress_filter is not None else ''
3065
3326
  '''
3066
3327
  A filter applied to the routing logic to pin datasource to nodes.
3067
3328
  '''
3068
3329
  self.endpoint = endpoint if endpoint is not None else ''
3330
+ '''
3331
+ The endpoint to dial.
3332
+ '''
3069
3333
  self.healthcheck_namespace = healthcheck_namespace if healthcheck_namespace is not None else ''
3070
3334
  '''
3071
3335
  The path used to check the health of your connection. Defaults to `default`.
@@ -3083,10 +3347,25 @@ class AmazonEKSUserImpersonation:
3083
3347
  Unique human-readable name of the Resource.
3084
3348
  '''
3085
3349
  self.port_override = port_override if port_override is not None else 0
3350
+ '''
3351
+ The local port used by clients to connect to this resource.
3352
+ '''
3086
3353
  self.region = region if region is not None else ''
3354
+ '''
3355
+ The AWS region to connect to e.g. us-east-1.
3356
+ '''
3087
3357
  self.role_arn = role_arn if role_arn is not None else ''
3358
+ '''
3359
+ The role to assume after logging in.
3360
+ '''
3088
3361
  self.role_external_id = role_external_id if role_external_id is not None else ''
3362
+ '''
3363
+ The external ID to associate with assume role requests. Does nothing if a role ARN is not provided.
3364
+ '''
3089
3365
  self.secret_access_key = secret_access_key if secret_access_key is not None else ''
3366
+ '''
3367
+ The Secret Access Key to use to authenticate.
3368
+ '''
3090
3369
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
3091
3370
  '''
3092
3371
  ID of the secret store containing credentials for this resource, if any.
@@ -3206,15 +3485,21 @@ class AmazonES:
3206
3485
  tags=None,
3207
3486
  ):
3208
3487
  self.access_key = access_key if access_key is not None else ''
3488
+ '''
3489
+ The Access Key ID to use to authenticate.
3490
+ '''
3209
3491
  self.bind_interface = bind_interface if bind_interface is not None else ''
3210
3492
  '''
3211
- Bind interface
3493
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
3212
3494
  '''
3213
3495
  self.egress_filter = egress_filter if egress_filter is not None else ''
3214
3496
  '''
3215
3497
  A filter applied to the routing logic to pin datasource to nodes.
3216
3498
  '''
3217
3499
  self.endpoint = endpoint if endpoint is not None else ''
3500
+ '''
3501
+ The endpoint to dial e.g. search-?.region.es.amazonaws.com"
3502
+ '''
3218
3503
  self.healthy = healthy if healthy is not None else False
3219
3504
  '''
3220
3505
  True if the datasource is reachable and the credentials are valid.
@@ -3228,10 +3513,25 @@ class AmazonES:
3228
3513
  Unique human-readable name of the Resource.
3229
3514
  '''
3230
3515
  self.port_override = port_override if port_override is not None else 0
3516
+ '''
3517
+ The local port used by clients to connect to this resource.
3518
+ '''
3231
3519
  self.region = region if region is not None else ''
3520
+ '''
3521
+ The AWS region to connect to e.g. us-east-1.
3522
+ '''
3232
3523
  self.role_arn = role_arn if role_arn is not None else ''
3524
+ '''
3525
+ The role to assume after logging in.
3526
+ '''
3233
3527
  self.role_external_id = role_external_id if role_external_id is not None else ''
3528
+ '''
3529
+ The external ID to associate with assume role requests. Does nothing if a role ARN is not provided.
3530
+ '''
3234
3531
  self.secret_access_key = secret_access_key if secret_access_key is not None else ''
3532
+ '''
3533
+ The Secret Access Key to use to authenticate.
3534
+ '''
3235
3535
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
3236
3536
  '''
3237
3537
  ID of the secret store containing credentials for this resource, if any.
@@ -3341,7 +3641,7 @@ class AmazonMQAMQP091:
3341
3641
  ):
3342
3642
  self.bind_interface = bind_interface if bind_interface is not None else ''
3343
3643
  '''
3344
- Bind interface
3644
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
3345
3645
  '''
3346
3646
  self.egress_filter = egress_filter if egress_filter is not None else ''
3347
3647
  '''
@@ -3352,6 +3652,9 @@ class AmazonMQAMQP091:
3352
3652
  True if the datasource is reachable and the credentials are valid.
3353
3653
  '''
3354
3654
  self.hostname = hostname if hostname is not None else ''
3655
+ '''
3656
+ The host to dial to initiate a connection from the egress node to this resource.
3657
+ '''
3355
3658
  self.id = id if id is not None else ''
3356
3659
  '''
3357
3660
  Unique identifier of the Resource.
@@ -3361,8 +3664,17 @@ class AmazonMQAMQP091:
3361
3664
  Unique human-readable name of the Resource.
3362
3665
  '''
3363
3666
  self.password = password if password is not None else ''
3667
+ '''
3668
+ The password to authenticate with.
3669
+ '''
3364
3670
  self.port = port if port is not None else 0
3671
+ '''
3672
+ The port to dial to initiate a connection from the egress node to this resource.
3673
+ '''
3365
3674
  self.port_override = port_override if port_override is not None else 0
3675
+ '''
3676
+ The local port used by clients to connect to this resource.
3677
+ '''
3366
3678
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
3367
3679
  '''
3368
3680
  ID of the secret store containing credentials for this resource, if any.
@@ -3376,7 +3688,13 @@ class AmazonMQAMQP091:
3376
3688
  Tags is a map of key, value pairs.
3377
3689
  '''
3378
3690
  self.tls_required = tls_required if tls_required is not None else False
3691
+ '''
3692
+ If set, TLS must be used to connect to this resource.
3693
+ '''
3379
3694
  self.username = username if username is not None else ''
3695
+ '''
3696
+ The username to authenticate with.
3697
+ '''
3380
3698
 
3381
3699
  def __repr__(self):
3382
3700
  return '<sdm.AmazonMQAMQP091 ' + \
@@ -3472,9 +3790,12 @@ class Athena:
3472
3790
  tags=None,
3473
3791
  ):
3474
3792
  self.access_key = access_key if access_key is not None else ''
3793
+ '''
3794
+ The Access Key ID to use to authenticate.
3795
+ '''
3475
3796
  self.bind_interface = bind_interface if bind_interface is not None else ''
3476
3797
  '''
3477
- Bind interface
3798
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
3478
3799
  '''
3479
3800
  self.egress_filter = egress_filter if egress_filter is not None else ''
3480
3801
  '''
@@ -3493,11 +3814,29 @@ class Athena:
3493
3814
  Unique human-readable name of the Resource.
3494
3815
  '''
3495
3816
  self.output = output if output is not None else ''
3817
+ '''
3818
+ The AWS S3 output location.
3819
+ '''
3496
3820
  self.port_override = port_override if port_override is not None else 0
3821
+ '''
3822
+ The local port used by clients to connect to this resource.
3823
+ '''
3497
3824
  self.region = region if region is not None else ''
3825
+ '''
3826
+ The AWS region to connect to e.g. us-east-1.
3827
+ '''
3498
3828
  self.role_arn = role_arn if role_arn is not None else ''
3829
+ '''
3830
+ The role to assume after logging in.
3831
+ '''
3499
3832
  self.role_external_id = role_external_id if role_external_id is not None else ''
3833
+ '''
3834
+ The external ID to associate with assume role requests. Does nothing if a role ARN is not provided.
3835
+ '''
3500
3836
  self.secret_access_key = secret_access_key if secret_access_key is not None else ''
3837
+ '''
3838
+ The Secret Access Key to use to authenticate.
3839
+ '''
3501
3840
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
3502
3841
  '''
3503
3842
  ID of the secret store containing credentials for this resource, if any.
@@ -3611,9 +3950,12 @@ class AuroraMysql:
3611
3950
  ):
3612
3951
  self.bind_interface = bind_interface if bind_interface is not None else ''
3613
3952
  '''
3614
- Bind interface
3953
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
3615
3954
  '''
3616
3955
  self.database = database if database is not None else ''
3956
+ '''
3957
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
3958
+ '''
3617
3959
  self.egress_filter = egress_filter if egress_filter is not None else ''
3618
3960
  '''
3619
3961
  A filter applied to the routing logic to pin datasource to nodes.
@@ -3623,6 +3965,9 @@ class AuroraMysql:
3623
3965
  True if the datasource is reachable and the credentials are valid.
3624
3966
  '''
3625
3967
  self.hostname = hostname if hostname is not None else ''
3968
+ '''
3969
+ The host to dial to initiate a connection from the egress node to this resource.
3970
+ '''
3626
3971
  self.id = id if id is not None else ''
3627
3972
  '''
3628
3973
  Unique identifier of the Resource.
@@ -3632,9 +3977,21 @@ class AuroraMysql:
3632
3977
  Unique human-readable name of the Resource.
3633
3978
  '''
3634
3979
  self.password = password if password is not None else ''
3980
+ '''
3981
+ The password to authenticate with.
3982
+ '''
3635
3983
  self.port = port if port is not None else 0
3984
+ '''
3985
+ The port to dial to initiate a connection from the egress node to this resource.
3986
+ '''
3636
3987
  self.port_override = port_override if port_override is not None else 0
3988
+ '''
3989
+ The local port used by clients to connect to this resource.
3990
+ '''
3637
3991
  self.require_native_auth = require_native_auth if require_native_auth is not None else False
3992
+ '''
3993
+ Whether native auth (mysql_native_password) is used for all connections (for backwards compatibility)
3994
+ '''
3638
3995
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
3639
3996
  '''
3640
3997
  ID of the secret store containing credentials for this resource, if any.
@@ -3648,7 +4005,13 @@ class AuroraMysql:
3648
4005
  Tags is a map of key, value pairs.
3649
4006
  '''
3650
4007
  self.use_azure_single_server_usernames = use_azure_single_server_usernames if use_azure_single_server_usernames is not None else False
4008
+ '''
4009
+ If true, appends the hostname to the username when hitting a database.azure.com address
4010
+ '''
3651
4011
  self.username = username if username is not None else ''
4012
+ '''
4013
+ The username to authenticate with.
4014
+ '''
3652
4015
 
3653
4016
  def __repr__(self):
3654
4017
  return '<sdm.AuroraMysql ' + \
@@ -3753,9 +4116,12 @@ class AuroraPostgres:
3753
4116
  ):
3754
4117
  self.bind_interface = bind_interface if bind_interface is not None else ''
3755
4118
  '''
3756
- Bind interface
4119
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
3757
4120
  '''
3758
4121
  self.database = database if database is not None else ''
4122
+ '''
4123
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
4124
+ '''
3759
4125
  self.egress_filter = egress_filter if egress_filter is not None else ''
3760
4126
  '''
3761
4127
  A filter applied to the routing logic to pin datasource to nodes.
@@ -3765,6 +4131,9 @@ class AuroraPostgres:
3765
4131
  True if the datasource is reachable and the credentials are valid.
3766
4132
  '''
3767
4133
  self.hostname = hostname if hostname is not None else ''
4134
+ '''
4135
+ The host to dial to initiate a connection from the egress node to this resource.
4136
+ '''
3768
4137
  self.id = id if id is not None else ''
3769
4138
  '''
3770
4139
  Unique identifier of the Resource.
@@ -3774,9 +4143,21 @@ class AuroraPostgres:
3774
4143
  Unique human-readable name of the Resource.
3775
4144
  '''
3776
4145
  self.override_database = override_database if override_database is not None else False
4146
+ '''
4147
+ If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.
4148
+ '''
3777
4149
  self.password = password if password is not None else ''
4150
+ '''
4151
+ The password to authenticate with.
4152
+ '''
3778
4153
  self.port = port if port is not None else 0
4154
+ '''
4155
+ The port to dial to initiate a connection from the egress node to this resource.
4156
+ '''
3779
4157
  self.port_override = port_override if port_override is not None else 0
4158
+ '''
4159
+ The local port used by clients to connect to this resource.
4160
+ '''
3780
4161
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
3781
4162
  '''
3782
4163
  ID of the secret store containing credentials for this resource, if any.
@@ -3790,6 +4171,9 @@ class AuroraPostgres:
3790
4171
  Tags is a map of key, value pairs.
3791
4172
  '''
3792
4173
  self.username = username if username is not None else ''
4174
+ '''
4175
+ The username to authenticate with.
4176
+ '''
3793
4177
 
3794
4178
  def __repr__(self):
3795
4179
  return '<sdm.AuroraPostgres ' + \
@@ -3882,9 +4266,12 @@ class Azure:
3882
4266
  tenant_id=None,
3883
4267
  ):
3884
4268
  self.app_id = app_id if app_id is not None else ''
4269
+ '''
4270
+ The application ID to authenticate with.
4271
+ '''
3885
4272
  self.bind_interface = bind_interface if bind_interface is not None else ''
3886
4273
  '''
3887
- Bind interface
4274
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
3888
4275
  '''
3889
4276
  self.egress_filter = egress_filter if egress_filter is not None else ''
3890
4277
  '''
@@ -3903,7 +4290,13 @@ class Azure:
3903
4290
  Unique human-readable name of the Resource.
3904
4291
  '''
3905
4292
  self.password = password if password is not None else ''
4293
+ '''
4294
+ The password to authenticate with.
4295
+ '''
3906
4296
  self.port_override = port_override if port_override is not None else 0
4297
+ '''
4298
+ The local port used by clients to connect to this resource.
4299
+ '''
3907
4300
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
3908
4301
  '''
3909
4302
  ID of the secret store containing credentials for this resource, if any.
@@ -3917,6 +4310,9 @@ class Azure:
3917
4310
  Tags is a map of key, value pairs.
3918
4311
  '''
3919
4312
  self.tenant_id = tenant_id if tenant_id is not None else ''
4313
+ '''
4314
+ The tenant ID to authenticate to.
4315
+ '''
3920
4316
 
3921
4317
  def __repr__(self):
3922
4318
  return '<sdm.Azure ' + \
@@ -4000,11 +4396,17 @@ class AzureCertificate:
4000
4396
  tenant_id=None,
4001
4397
  ):
4002
4398
  self.app_id = app_id if app_id is not None else ''
4399
+ '''
4400
+ The application ID to authenticate with.
4401
+ '''
4003
4402
  self.bind_interface = bind_interface if bind_interface is not None else ''
4004
4403
  '''
4005
- Bind interface
4404
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
4006
4405
  '''
4007
4406
  self.client_certificate = client_certificate if client_certificate is not None else ''
4407
+ '''
4408
+ The service Principal certificate file, both private and public key included.
4409
+ '''
4008
4410
  self.egress_filter = egress_filter if egress_filter is not None else ''
4009
4411
  '''
4010
4412
  A filter applied to the routing logic to pin datasource to nodes.
@@ -4022,6 +4424,9 @@ class AzureCertificate:
4022
4424
  Unique human-readable name of the Resource.
4023
4425
  '''
4024
4426
  self.port_override = port_override if port_override is not None else 0
4427
+ '''
4428
+ The local port used by clients to connect to this resource.
4429
+ '''
4025
4430
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
4026
4431
  '''
4027
4432
  ID of the secret store containing credentials for this resource, if any.
@@ -4035,6 +4440,9 @@ class AzureCertificate:
4035
4440
  Tags is a map of key, value pairs.
4036
4441
  '''
4037
4442
  self.tenant_id = tenant_id if tenant_id is not None else ''
4443
+ '''
4444
+ The tenant ID to authenticate to.
4445
+ '''
4038
4446
 
4039
4447
  def __repr__(self):
4040
4448
  return '<sdm.AzureCertificate ' + \
@@ -4127,9 +4535,12 @@ class AzureMysql:
4127
4535
  ):
4128
4536
  self.bind_interface = bind_interface if bind_interface is not None else ''
4129
4537
  '''
4130
- Bind interface
4538
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
4131
4539
  '''
4132
4540
  self.database = database if database is not None else ''
4541
+ '''
4542
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
4543
+ '''
4133
4544
  self.egress_filter = egress_filter if egress_filter is not None else ''
4134
4545
  '''
4135
4546
  A filter applied to the routing logic to pin datasource to nodes.
@@ -4139,6 +4550,9 @@ class AzureMysql:
4139
4550
  True if the datasource is reachable and the credentials are valid.
4140
4551
  '''
4141
4552
  self.hostname = hostname if hostname is not None else ''
4553
+ '''
4554
+ The host to dial to initiate a connection from the egress node to this resource.
4555
+ '''
4142
4556
  self.id = id if id is not None else ''
4143
4557
  '''
4144
4558
  Unique identifier of the Resource.
@@ -4148,9 +4562,21 @@ class AzureMysql:
4148
4562
  Unique human-readable name of the Resource.
4149
4563
  '''
4150
4564
  self.password = password if password is not None else ''
4565
+ '''
4566
+ The password to authenticate with.
4567
+ '''
4151
4568
  self.port = port if port is not None else 0
4569
+ '''
4570
+ The port to dial to initiate a connection from the egress node to this resource.
4571
+ '''
4152
4572
  self.port_override = port_override if port_override is not None else 0
4573
+ '''
4574
+ The local port used by clients to connect to this resource.
4575
+ '''
4153
4576
  self.require_native_auth = require_native_auth if require_native_auth is not None else False
4577
+ '''
4578
+ Whether native auth (mysql_native_password) is used for all connections (for backwards compatibility)
4579
+ '''
4154
4580
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
4155
4581
  '''
4156
4582
  ID of the secret store containing credentials for this resource, if any.
@@ -4164,7 +4590,13 @@ class AzureMysql:
4164
4590
  Tags is a map of key, value pairs.
4165
4591
  '''
4166
4592
  self.use_azure_single_server_usernames = use_azure_single_server_usernames if use_azure_single_server_usernames is not None else False
4593
+ '''
4594
+ If true, appends the hostname to the username when hitting a database.azure.com address
4595
+ '''
4167
4596
  self.username = username if username is not None else ''
4597
+ '''
4598
+ The username to authenticate with.
4599
+ '''
4168
4600
 
4169
4601
  def __repr__(self):
4170
4602
  return '<sdm.AzureMysql ' + \
@@ -4269,9 +4701,12 @@ class AzurePostgres:
4269
4701
  ):
4270
4702
  self.bind_interface = bind_interface if bind_interface is not None else ''
4271
4703
  '''
4272
- Bind interface
4704
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
4273
4705
  '''
4274
4706
  self.database = database if database is not None else ''
4707
+ '''
4708
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
4709
+ '''
4275
4710
  self.egress_filter = egress_filter if egress_filter is not None else ''
4276
4711
  '''
4277
4712
  A filter applied to the routing logic to pin datasource to nodes.
@@ -4281,6 +4716,9 @@ class AzurePostgres:
4281
4716
  True if the datasource is reachable and the credentials are valid.
4282
4717
  '''
4283
4718
  self.hostname = hostname if hostname is not None else ''
4719
+ '''
4720
+ The host to dial to initiate a connection from the egress node to this resource.
4721
+ '''
4284
4722
  self.id = id if id is not None else ''
4285
4723
  '''
4286
4724
  Unique identifier of the Resource.
@@ -4290,9 +4728,21 @@ class AzurePostgres:
4290
4728
  Unique human-readable name of the Resource.
4291
4729
  '''
4292
4730
  self.override_database = override_database if override_database is not None else False
4731
+ '''
4732
+ If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.
4733
+ '''
4293
4734
  self.password = password if password is not None else ''
4735
+ '''
4736
+ The password to authenticate with.
4737
+ '''
4294
4738
  self.port = port if port is not None else 0
4739
+ '''
4740
+ The port to dial to initiate a connection from the egress node to this resource.
4741
+ '''
4295
4742
  self.port_override = port_override if port_override is not None else 0
4743
+ '''
4744
+ The local port used by clients to connect to this resource.
4745
+ '''
4296
4746
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
4297
4747
  '''
4298
4748
  ID of the secret store containing credentials for this resource, if any.
@@ -4306,6 +4756,9 @@ class AzurePostgres:
4306
4756
  Tags is a map of key, value pairs.
4307
4757
  '''
4308
4758
  self.username = username if username is not None else ''
4759
+ '''
4760
+ The username to authenticate with.
4761
+ '''
4309
4762
 
4310
4763
  def __repr__(self):
4311
4764
  return '<sdm.AzurePostgres ' + \
@@ -4366,6 +4819,328 @@ class AzurePostgres:
4366
4819
  )
4367
4820
 
4368
4821
 
4822
+ class AzurePostgresFlexible:
4823
+ '''
4824
+ AzurePostgresFlexible is currently unstable, and its API may change, or it may be removed,
4825
+ without a major version bump.
4826
+ '''
4827
+ __slots__ = [
4828
+ 'bind_interface',
4829
+ 'database',
4830
+ 'egress_filter',
4831
+ 'healthy',
4832
+ 'hostname',
4833
+ 'id',
4834
+ 'name',
4835
+ 'override_database',
4836
+ 'password',
4837
+ 'port',
4838
+ 'port_override',
4839
+ 'secret_store_id',
4840
+ 'subdomain',
4841
+ 'tags',
4842
+ 'username',
4843
+ ]
4844
+
4845
+ def __init__(
4846
+ self,
4847
+ bind_interface=None,
4848
+ database=None,
4849
+ egress_filter=None,
4850
+ healthy=None,
4851
+ hostname=None,
4852
+ id=None,
4853
+ name=None,
4854
+ override_database=None,
4855
+ password=None,
4856
+ port=None,
4857
+ port_override=None,
4858
+ secret_store_id=None,
4859
+ subdomain=None,
4860
+ tags=None,
4861
+ username=None,
4862
+ ):
4863
+ self.bind_interface = bind_interface if bind_interface is not None else ''
4864
+ '''
4865
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
4866
+ '''
4867
+ self.database = database if database is not None else ''
4868
+ '''
4869
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
4870
+ '''
4871
+ self.egress_filter = egress_filter if egress_filter is not None else ''
4872
+ '''
4873
+ A filter applied to the routing logic to pin datasource to nodes.
4874
+ '''
4875
+ self.healthy = healthy if healthy is not None else False
4876
+ '''
4877
+ True if the datasource is reachable and the credentials are valid.
4878
+ '''
4879
+ self.hostname = hostname if hostname is not None else ''
4880
+ '''
4881
+ The host to dial to initiate a connection from the egress node to this resource.
4882
+ '''
4883
+ self.id = id if id is not None else ''
4884
+ '''
4885
+ Unique identifier of the Resource.
4886
+ '''
4887
+ self.name = name if name is not None else ''
4888
+ '''
4889
+ Unique human-readable name of the Resource.
4890
+ '''
4891
+ self.override_database = override_database if override_database is not None else False
4892
+ '''
4893
+ If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.
4894
+ '''
4895
+ self.password = password if password is not None else ''
4896
+ '''
4897
+ The password to authenticate with.
4898
+ '''
4899
+ self.port = port if port is not None else 0
4900
+ '''
4901
+ The port to dial to initiate a connection from the egress node to this resource.
4902
+ '''
4903
+ self.port_override = port_override if port_override is not None else 0
4904
+ '''
4905
+ The local port used by clients to connect to this resource.
4906
+ '''
4907
+ self.secret_store_id = secret_store_id if secret_store_id is not None else ''
4908
+ '''
4909
+ ID of the secret store containing credentials for this resource, if any.
4910
+ '''
4911
+ self.subdomain = subdomain if subdomain is not None else ''
4912
+ '''
4913
+ Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)
4914
+ '''
4915
+ self.tags = tags if tags is not None else _porcelain_zero_value_tags()
4916
+ '''
4917
+ Tags is a map of key, value pairs.
4918
+ '''
4919
+ self.username = username if username is not None else ''
4920
+ '''
4921
+ The username to authenticate with.
4922
+ '''
4923
+
4924
+ def __repr__(self):
4925
+ return '<sdm.AzurePostgresFlexible ' + \
4926
+ 'bind_interface: ' + repr(self.bind_interface) + ' ' +\
4927
+ 'database: ' + repr(self.database) + ' ' +\
4928
+ 'egress_filter: ' + repr(self.egress_filter) + ' ' +\
4929
+ 'healthy: ' + repr(self.healthy) + ' ' +\
4930
+ 'hostname: ' + repr(self.hostname) + ' ' +\
4931
+ 'id: ' + repr(self.id) + ' ' +\
4932
+ 'name: ' + repr(self.name) + ' ' +\
4933
+ 'override_database: ' + repr(self.override_database) + ' ' +\
4934
+ 'password: ' + repr(self.password) + ' ' +\
4935
+ 'port: ' + repr(self.port) + ' ' +\
4936
+ 'port_override: ' + repr(self.port_override) + ' ' +\
4937
+ 'secret_store_id: ' + repr(self.secret_store_id) + ' ' +\
4938
+ 'subdomain: ' + repr(self.subdomain) + ' ' +\
4939
+ 'tags: ' + repr(self.tags) + ' ' +\
4940
+ 'username: ' + repr(self.username) + ' ' +\
4941
+ '>'
4942
+
4943
+ def to_dict(self):
4944
+ return {
4945
+ 'bind_interface': self.bind_interface,
4946
+ 'database': self.database,
4947
+ 'egress_filter': self.egress_filter,
4948
+ 'healthy': self.healthy,
4949
+ 'hostname': self.hostname,
4950
+ 'id': self.id,
4951
+ 'name': self.name,
4952
+ 'override_database': self.override_database,
4953
+ 'password': self.password,
4954
+ 'port': self.port,
4955
+ 'port_override': self.port_override,
4956
+ 'secret_store_id': self.secret_store_id,
4957
+ 'subdomain': self.subdomain,
4958
+ 'tags': self.tags,
4959
+ 'username': self.username,
4960
+ }
4961
+
4962
+ @classmethod
4963
+ def from_dict(cls, d):
4964
+ return cls(
4965
+ bind_interface=d.get('bind_interface'),
4966
+ database=d.get('database'),
4967
+ egress_filter=d.get('egress_filter'),
4968
+ healthy=d.get('healthy'),
4969
+ hostname=d.get('hostname'),
4970
+ id=d.get('id'),
4971
+ name=d.get('name'),
4972
+ override_database=d.get('override_database'),
4973
+ password=d.get('password'),
4974
+ port=d.get('port'),
4975
+ port_override=d.get('port_override'),
4976
+ secret_store_id=d.get('secret_store_id'),
4977
+ subdomain=d.get('subdomain'),
4978
+ tags=d.get('tags'),
4979
+ username=d.get('username'),
4980
+ )
4981
+
4982
+
4983
+ class AzurePostgresSingle:
4984
+ '''
4985
+ AzurePostgresSingle is currently unstable, and its API may change, or it may be removed,
4986
+ without a major version bump.
4987
+ '''
4988
+ __slots__ = [
4989
+ 'bind_interface',
4990
+ 'database',
4991
+ 'egress_filter',
4992
+ 'healthy',
4993
+ 'hostname',
4994
+ 'id',
4995
+ 'name',
4996
+ 'override_database',
4997
+ 'password',
4998
+ 'port',
4999
+ 'port_override',
5000
+ 'secret_store_id',
5001
+ 'subdomain',
5002
+ 'tags',
5003
+ 'username',
5004
+ ]
5005
+
5006
+ def __init__(
5007
+ self,
5008
+ bind_interface=None,
5009
+ database=None,
5010
+ egress_filter=None,
5011
+ healthy=None,
5012
+ hostname=None,
5013
+ id=None,
5014
+ name=None,
5015
+ override_database=None,
5016
+ password=None,
5017
+ port=None,
5018
+ port_override=None,
5019
+ secret_store_id=None,
5020
+ subdomain=None,
5021
+ tags=None,
5022
+ username=None,
5023
+ ):
5024
+ self.bind_interface = bind_interface if bind_interface is not None else ''
5025
+ '''
5026
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
5027
+ '''
5028
+ self.database = database if database is not None else ''
5029
+ '''
5030
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
5031
+ '''
5032
+ self.egress_filter = egress_filter if egress_filter is not None else ''
5033
+ '''
5034
+ A filter applied to the routing logic to pin datasource to nodes.
5035
+ '''
5036
+ self.healthy = healthy if healthy is not None else False
5037
+ '''
5038
+ True if the datasource is reachable and the credentials are valid.
5039
+ '''
5040
+ self.hostname = hostname if hostname is not None else ''
5041
+ '''
5042
+ The host to dial to initiate a connection from the egress node to this resource.
5043
+ '''
5044
+ self.id = id if id is not None else ''
5045
+ '''
5046
+ Unique identifier of the Resource.
5047
+ '''
5048
+ self.name = name if name is not None else ''
5049
+ '''
5050
+ Unique human-readable name of the Resource.
5051
+ '''
5052
+ self.override_database = override_database if override_database is not None else False
5053
+ '''
5054
+ If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.
5055
+ '''
5056
+ self.password = password if password is not None else ''
5057
+ '''
5058
+ The password to authenticate with.
5059
+ '''
5060
+ self.port = port if port is not None else 0
5061
+ '''
5062
+ The port to dial to initiate a connection from the egress node to this resource.
5063
+ '''
5064
+ self.port_override = port_override if port_override is not None else 0
5065
+ '''
5066
+ The local port used by clients to connect to this resource.
5067
+ '''
5068
+ self.secret_store_id = secret_store_id if secret_store_id is not None else ''
5069
+ '''
5070
+ ID of the secret store containing credentials for this resource, if any.
5071
+ '''
5072
+ self.subdomain = subdomain if subdomain is not None else ''
5073
+ '''
5074
+ Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)
5075
+ '''
5076
+ self.tags = tags if tags is not None else _porcelain_zero_value_tags()
5077
+ '''
5078
+ Tags is a map of key, value pairs.
5079
+ '''
5080
+ self.username = username if username is not None else ''
5081
+ '''
5082
+ The username to authenticate with.
5083
+ '''
5084
+
5085
+ def __repr__(self):
5086
+ return '<sdm.AzurePostgresSingle ' + \
5087
+ 'bind_interface: ' + repr(self.bind_interface) + ' ' +\
5088
+ 'database: ' + repr(self.database) + ' ' +\
5089
+ 'egress_filter: ' + repr(self.egress_filter) + ' ' +\
5090
+ 'healthy: ' + repr(self.healthy) + ' ' +\
5091
+ 'hostname: ' + repr(self.hostname) + ' ' +\
5092
+ 'id: ' + repr(self.id) + ' ' +\
5093
+ 'name: ' + repr(self.name) + ' ' +\
5094
+ 'override_database: ' + repr(self.override_database) + ' ' +\
5095
+ 'password: ' + repr(self.password) + ' ' +\
5096
+ 'port: ' + repr(self.port) + ' ' +\
5097
+ 'port_override: ' + repr(self.port_override) + ' ' +\
5098
+ 'secret_store_id: ' + repr(self.secret_store_id) + ' ' +\
5099
+ 'subdomain: ' + repr(self.subdomain) + ' ' +\
5100
+ 'tags: ' + repr(self.tags) + ' ' +\
5101
+ 'username: ' + repr(self.username) + ' ' +\
5102
+ '>'
5103
+
5104
+ def to_dict(self):
5105
+ return {
5106
+ 'bind_interface': self.bind_interface,
5107
+ 'database': self.database,
5108
+ 'egress_filter': self.egress_filter,
5109
+ 'healthy': self.healthy,
5110
+ 'hostname': self.hostname,
5111
+ 'id': self.id,
5112
+ 'name': self.name,
5113
+ 'override_database': self.override_database,
5114
+ 'password': self.password,
5115
+ 'port': self.port,
5116
+ 'port_override': self.port_override,
5117
+ 'secret_store_id': self.secret_store_id,
5118
+ 'subdomain': self.subdomain,
5119
+ 'tags': self.tags,
5120
+ 'username': self.username,
5121
+ }
5122
+
5123
+ @classmethod
5124
+ def from_dict(cls, d):
5125
+ return cls(
5126
+ bind_interface=d.get('bind_interface'),
5127
+ database=d.get('database'),
5128
+ egress_filter=d.get('egress_filter'),
5129
+ healthy=d.get('healthy'),
5130
+ hostname=d.get('hostname'),
5131
+ id=d.get('id'),
5132
+ name=d.get('name'),
5133
+ override_database=d.get('override_database'),
5134
+ password=d.get('password'),
5135
+ port=d.get('port'),
5136
+ port_override=d.get('port_override'),
5137
+ secret_store_id=d.get('secret_store_id'),
5138
+ subdomain=d.get('subdomain'),
5139
+ tags=d.get('tags'),
5140
+ username=d.get('username'),
5141
+ )
5142
+
5143
+
4369
5144
  class AzureStore:
4370
5145
  __slots__ = [
4371
5146
  'id',
@@ -4394,6 +5169,9 @@ class AzureStore:
4394
5169
  Tags is a map of key, value pairs.
4395
5170
  '''
4396
5171
  self.vault_uri = vault_uri if vault_uri is not None else ''
5172
+ '''
5173
+ The URI of the key vault to target e.g. https://myvault.vault.azure.net
5174
+ '''
4397
5175
 
4398
5176
  def __repr__(self):
4399
5177
  return '<sdm.AzureStore ' + \
@@ -4456,13 +5234,16 @@ class BigQuery:
4456
5234
  ):
4457
5235
  self.bind_interface = bind_interface if bind_interface is not None else ''
4458
5236
  '''
4459
- Bind interface
5237
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
4460
5238
  '''
4461
5239
  self.egress_filter = egress_filter if egress_filter is not None else ''
4462
5240
  '''
4463
5241
  A filter applied to the routing logic to pin datasource to nodes.
4464
5242
  '''
4465
5243
  self.endpoint = endpoint if endpoint is not None else ''
5244
+ '''
5245
+ The endpoint to dial.
5246
+ '''
4466
5247
  self.healthy = healthy if healthy is not None else False
4467
5248
  '''
4468
5249
  True if the datasource is reachable and the credentials are valid.
@@ -4476,8 +5257,17 @@ class BigQuery:
4476
5257
  Unique human-readable name of the Resource.
4477
5258
  '''
4478
5259
  self.port_override = port_override if port_override is not None else 0
5260
+ '''
5261
+ The local port used by clients to connect to this resource.
5262
+ '''
4479
5263
  self.private_key = private_key if private_key is not None else ''
5264
+ '''
5265
+ The JSON Private key to authenticate with.
5266
+ '''
4480
5267
  self.project = project if project is not None else ''
5268
+ '''
5269
+ The project to connect to.
5270
+ '''
4481
5271
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
4482
5272
  '''
4483
5273
  ID of the secret store containing credentials for this resource, if any.
@@ -4491,6 +5281,9 @@ class BigQuery:
4491
5281
  Tags is a map of key, value pairs.
4492
5282
  '''
4493
5283
  self.username = username if username is not None else ''
5284
+ '''
5285
+ The username to authenticate with.
5286
+ '''
4494
5287
 
4495
5288
  def __repr__(self):
4496
5289
  return '<sdm.BigQuery ' + \
@@ -4582,7 +5375,7 @@ class Cassandra:
4582
5375
  ):
4583
5376
  self.bind_interface = bind_interface if bind_interface is not None else ''
4584
5377
  '''
4585
- Bind interface
5378
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
4586
5379
  '''
4587
5380
  self.egress_filter = egress_filter if egress_filter is not None else ''
4588
5381
  '''
@@ -4593,6 +5386,9 @@ class Cassandra:
4593
5386
  True if the datasource is reachable and the credentials are valid.
4594
5387
  '''
4595
5388
  self.hostname = hostname if hostname is not None else ''
5389
+ '''
5390
+ The host to dial to initiate a connection from the egress node to this resource.
5391
+ '''
4596
5392
  self.id = id if id is not None else ''
4597
5393
  '''
4598
5394
  Unique identifier of the Resource.
@@ -4602,8 +5398,17 @@ class Cassandra:
4602
5398
  Unique human-readable name of the Resource.
4603
5399
  '''
4604
5400
  self.password = password if password is not None else ''
5401
+ '''
5402
+ The password to authenticate with.
5403
+ '''
4605
5404
  self.port = port if port is not None else 0
5405
+ '''
5406
+ The port to dial to initiate a connection from the egress node to this resource.
5407
+ '''
4606
5408
  self.port_override = port_override if port_override is not None else 0
5409
+ '''
5410
+ The local port used by clients to connect to this resource.
5411
+ '''
4607
5412
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
4608
5413
  '''
4609
5414
  ID of the secret store containing credentials for this resource, if any.
@@ -4617,7 +5422,13 @@ class Cassandra:
4617
5422
  Tags is a map of key, value pairs.
4618
5423
  '''
4619
5424
  self.tls_required = tls_required if tls_required is not None else False
5425
+ '''
5426
+ If set, TLS must be used to connect to this resource.
5427
+ '''
4620
5428
  self.username = username if username is not None else ''
5429
+ '''
5430
+ The username to authenticate with.
5431
+ '''
4621
5432
 
4622
5433
  def __repr__(self):
4623
5434
  return '<sdm.Cassandra ' + \
@@ -4714,9 +5525,12 @@ class Citus:
4714
5525
  ):
4715
5526
  self.bind_interface = bind_interface if bind_interface is not None else ''
4716
5527
  '''
4717
- Bind interface
5528
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
4718
5529
  '''
4719
5530
  self.database = database if database is not None else ''
5531
+ '''
5532
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
5533
+ '''
4720
5534
  self.egress_filter = egress_filter if egress_filter is not None else ''
4721
5535
  '''
4722
5536
  A filter applied to the routing logic to pin datasource to nodes.
@@ -4726,6 +5540,9 @@ class Citus:
4726
5540
  True if the datasource is reachable and the credentials are valid.
4727
5541
  '''
4728
5542
  self.hostname = hostname if hostname is not None else ''
5543
+ '''
5544
+ The host to dial to initiate a connection from the egress node to this resource.
5545
+ '''
4729
5546
  self.id = id if id is not None else ''
4730
5547
  '''
4731
5548
  Unique identifier of the Resource.
@@ -4735,9 +5552,21 @@ class Citus:
4735
5552
  Unique human-readable name of the Resource.
4736
5553
  '''
4737
5554
  self.override_database = override_database if override_database is not None else False
5555
+ '''
5556
+ If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.
5557
+ '''
4738
5558
  self.password = password if password is not None else ''
5559
+ '''
5560
+ The password to authenticate with.
5561
+ '''
4739
5562
  self.port = port if port is not None else 0
5563
+ '''
5564
+ The port to dial to initiate a connection from the egress node to this resource.
5565
+ '''
4740
5566
  self.port_override = port_override if port_override is not None else 0
5567
+ '''
5568
+ The local port used by clients to connect to this resource.
5569
+ '''
4741
5570
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
4742
5571
  '''
4743
5572
  ID of the secret store containing credentials for this resource, if any.
@@ -4751,6 +5580,9 @@ class Citus:
4751
5580
  Tags is a map of key, value pairs.
4752
5581
  '''
4753
5582
  self.username = username if username is not None else ''
5583
+ '''
5584
+ The username to authenticate with.
5585
+ '''
4754
5586
 
4755
5587
  def __repr__(self):
4756
5588
  return '<sdm.Citus ' + \
@@ -4852,9 +5684,12 @@ class Clustrix:
4852
5684
  ):
4853
5685
  self.bind_interface = bind_interface if bind_interface is not None else ''
4854
5686
  '''
4855
- Bind interface
5687
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
4856
5688
  '''
4857
5689
  self.database = database if database is not None else ''
5690
+ '''
5691
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
5692
+ '''
4858
5693
  self.egress_filter = egress_filter if egress_filter is not None else ''
4859
5694
  '''
4860
5695
  A filter applied to the routing logic to pin datasource to nodes.
@@ -4864,6 +5699,9 @@ class Clustrix:
4864
5699
  True if the datasource is reachable and the credentials are valid.
4865
5700
  '''
4866
5701
  self.hostname = hostname if hostname is not None else ''
5702
+ '''
5703
+ The host to dial to initiate a connection from the egress node to this resource.
5704
+ '''
4867
5705
  self.id = id if id is not None else ''
4868
5706
  '''
4869
5707
  Unique identifier of the Resource.
@@ -4873,9 +5711,21 @@ class Clustrix:
4873
5711
  Unique human-readable name of the Resource.
4874
5712
  '''
4875
5713
  self.password = password if password is not None else ''
5714
+ '''
5715
+ The password to authenticate with.
5716
+ '''
4876
5717
  self.port = port if port is not None else 0
5718
+ '''
5719
+ The port to dial to initiate a connection from the egress node to this resource.
5720
+ '''
4877
5721
  self.port_override = port_override if port_override is not None else 0
5722
+ '''
5723
+ The local port used by clients to connect to this resource.
5724
+ '''
4878
5725
  self.require_native_auth = require_native_auth if require_native_auth is not None else False
5726
+ '''
5727
+ Whether native auth (mysql_native_password) is used for all connections (for backwards compatibility)
5728
+ '''
4879
5729
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
4880
5730
  '''
4881
5731
  ID of the secret store containing credentials for this resource, if any.
@@ -4889,7 +5739,13 @@ class Clustrix:
4889
5739
  Tags is a map of key, value pairs.
4890
5740
  '''
4891
5741
  self.use_azure_single_server_usernames = use_azure_single_server_usernames if use_azure_single_server_usernames is not None else False
5742
+ '''
5743
+ If true, appends the hostname to the username when hitting a database.azure.com address
5744
+ '''
4892
5745
  self.username = username if username is not None else ''
5746
+ '''
5747
+ The username to authenticate with.
5748
+ '''
4893
5749
 
4894
5750
  def __repr__(self):
4895
5751
  return '<sdm.Clustrix ' + \
@@ -4994,9 +5850,12 @@ class Cockroach:
4994
5850
  ):
4995
5851
  self.bind_interface = bind_interface if bind_interface is not None else ''
4996
5852
  '''
4997
- Bind interface
5853
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
4998
5854
  '''
4999
5855
  self.database = database if database is not None else ''
5856
+ '''
5857
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
5858
+ '''
5000
5859
  self.egress_filter = egress_filter if egress_filter is not None else ''
5001
5860
  '''
5002
5861
  A filter applied to the routing logic to pin datasource to nodes.
@@ -5006,6 +5865,9 @@ class Cockroach:
5006
5865
  True if the datasource is reachable and the credentials are valid.
5007
5866
  '''
5008
5867
  self.hostname = hostname if hostname is not None else ''
5868
+ '''
5869
+ The host to dial to initiate a connection from the egress node to this resource.
5870
+ '''
5009
5871
  self.id = id if id is not None else ''
5010
5872
  '''
5011
5873
  Unique identifier of the Resource.
@@ -5015,9 +5877,21 @@ class Cockroach:
5015
5877
  Unique human-readable name of the Resource.
5016
5878
  '''
5017
5879
  self.override_database = override_database if override_database is not None else False
5880
+ '''
5881
+ If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.
5882
+ '''
5018
5883
  self.password = password if password is not None else ''
5884
+ '''
5885
+ The password to authenticate with.
5886
+ '''
5019
5887
  self.port = port if port is not None else 0
5888
+ '''
5889
+ The port to dial to initiate a connection from the egress node to this resource.
5890
+ '''
5020
5891
  self.port_override = port_override if port_override is not None else 0
5892
+ '''
5893
+ The local port used by clients to connect to this resource.
5894
+ '''
5021
5895
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
5022
5896
  '''
5023
5897
  ID of the secret store containing credentials for this resource, if any.
@@ -5031,6 +5905,9 @@ class Cockroach:
5031
5905
  Tags is a map of key, value pairs.
5032
5906
  '''
5033
5907
  self.username = username if username is not None else ''
5908
+ '''
5909
+ The username to authenticate with.
5910
+ '''
5034
5911
 
5035
5912
  def __repr__(self):
5036
5913
  return '<sdm.Cockroach ' + \
@@ -5234,6 +6111,9 @@ class CyberarkConjurStore:
5234
6111
  tags=None,
5235
6112
  ):
5236
6113
  self.appurl = appurl if appurl is not None else ''
6114
+ '''
6115
+ The URL of the Cyberark instance
6116
+ '''
5237
6117
  self.id = id if id is not None else ''
5238
6118
  '''
5239
6119
  Unique identifier of the SecretStore.
@@ -5293,6 +6173,9 @@ class CyberarkPAMExperimentalStore:
5293
6173
  tags=None,
5294
6174
  ):
5295
6175
  self.appurl = appurl if appurl is not None else ''
6176
+ '''
6177
+ The URL of the Cyberark instance
6178
+ '''
5296
6179
  self.id = id if id is not None else ''
5297
6180
  '''
5298
6181
  Unique identifier of the SecretStore.
@@ -5348,6 +6231,9 @@ class CyberarkPAMStore:
5348
6231
  tags=None,
5349
6232
  ):
5350
6233
  self.appurl = appurl if appurl is not None else ''
6234
+ '''
6235
+ The URL of the Cyberark instance
6236
+ '''
5351
6237
  self.id = id if id is not None else ''
5352
6238
  '''
5353
6239
  Unique identifier of the SecretStore.
@@ -5424,7 +6310,7 @@ class DB2I:
5424
6310
  ):
5425
6311
  self.bind_interface = bind_interface if bind_interface is not None else ''
5426
6312
  '''
5427
- Bind interface
6313
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
5428
6314
  '''
5429
6315
  self.egress_filter = egress_filter if egress_filter is not None else ''
5430
6316
  '''
@@ -5435,6 +6321,9 @@ class DB2I:
5435
6321
  True if the datasource is reachable and the credentials are valid.
5436
6322
  '''
5437
6323
  self.hostname = hostname if hostname is not None else ''
6324
+ '''
6325
+ The host to dial to initiate a connection from the egress node to this resource.
6326
+ '''
5438
6327
  self.id = id if id is not None else ''
5439
6328
  '''
5440
6329
  Unique identifier of the Resource.
@@ -5444,8 +6333,17 @@ class DB2I:
5444
6333
  Unique human-readable name of the Resource.
5445
6334
  '''
5446
6335
  self.password = password if password is not None else ''
6336
+ '''
6337
+ The password to authenticate with.
6338
+ '''
5447
6339
  self.port = port if port is not None else 0
6340
+ '''
6341
+ The port to dial to initiate a connection from the egress node to this resource.
6342
+ '''
5448
6343
  self.port_override = port_override if port_override is not None else 0
6344
+ '''
6345
+ The local port used by clients to connect to this resource.
6346
+ '''
5449
6347
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
5450
6348
  '''
5451
6349
  ID of the secret store containing credentials for this resource, if any.
@@ -5459,7 +6357,13 @@ class DB2I:
5459
6357
  Tags is a map of key, value pairs.
5460
6358
  '''
5461
6359
  self.tls_required = tls_required if tls_required is not None else False
6360
+ '''
6361
+ If set, TLS must be used to connect to this resource.
6362
+ '''
5462
6363
  self.username = username if username is not None else ''
6364
+ '''
6365
+ The username to authenticate with.
6366
+ '''
5463
6367
 
5464
6368
  def __repr__(self):
5465
6369
  return '<sdm.DB2I ' + \
@@ -5554,9 +6458,12 @@ class DB2LUW:
5554
6458
  ):
5555
6459
  self.bind_interface = bind_interface if bind_interface is not None else ''
5556
6460
  '''
5557
- Bind interface
6461
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
5558
6462
  '''
5559
6463
  self.database = database if database is not None else ''
6464
+ '''
6465
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
6466
+ '''
5560
6467
  self.egress_filter = egress_filter if egress_filter is not None else ''
5561
6468
  '''
5562
6469
  A filter applied to the routing logic to pin datasource to nodes.
@@ -5566,6 +6473,9 @@ class DB2LUW:
5566
6473
  True if the datasource is reachable and the credentials are valid.
5567
6474
  '''
5568
6475
  self.hostname = hostname if hostname is not None else ''
6476
+ '''
6477
+ The host to dial to initiate a connection from the egress node to this resource.
6478
+ '''
5569
6479
  self.id = id if id is not None else ''
5570
6480
  '''
5571
6481
  Unique identifier of the Resource.
@@ -5575,8 +6485,17 @@ class DB2LUW:
5575
6485
  Unique human-readable name of the Resource.
5576
6486
  '''
5577
6487
  self.password = password if password is not None else ''
6488
+ '''
6489
+ The password to authenticate with.
6490
+ '''
5578
6491
  self.port = port if port is not None else 0
6492
+ '''
6493
+ The port to dial to initiate a connection from the egress node to this resource.
6494
+ '''
5579
6495
  self.port_override = port_override if port_override is not None else 0
6496
+ '''
6497
+ The local port used by clients to connect to this resource.
6498
+ '''
5580
6499
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
5581
6500
  '''
5582
6501
  ID of the secret store containing credentials for this resource, if any.
@@ -5590,6 +6509,9 @@ class DB2LUW:
5590
6509
  Tags is a map of key, value pairs.
5591
6510
  '''
5592
6511
  self.username = username if username is not None else ''
6512
+ '''
6513
+ The username to authenticate with.
6514
+ '''
5593
6515
 
5594
6516
  def __repr__(self):
5595
6517
  return '<sdm.DB2LUW ' + \
@@ -5694,11 +6616,17 @@ class DelineaStore:
5694
6616
  Unique human-readable name of the SecretStore.
5695
6617
  '''
5696
6618
  self.server_url = server_url if server_url is not None else ''
6619
+ '''
6620
+ The URL of the Delinea instance
6621
+ '''
5697
6622
  self.tags = tags if tags is not None else _porcelain_zero_value_tags()
5698
6623
  '''
5699
6624
  Tags is a map of key, value pairs.
5700
6625
  '''
5701
6626
  self.tenant_name = tenant_name if tenant_name is not None else ''
6627
+ '''
6628
+ The tenant name to target
6629
+ '''
5702
6630
 
5703
6631
  def __repr__(self):
5704
6632
  return '<sdm.DelineaStore ' + \
@@ -5765,9 +6693,12 @@ class DocumentDBHost:
5765
6693
  username=None,
5766
6694
  ):
5767
6695
  self.auth_database = auth_database if auth_database is not None else ''
6696
+ '''
6697
+ The authentication database to use.
6698
+ '''
5768
6699
  self.bind_interface = bind_interface if bind_interface is not None else ''
5769
6700
  '''
5770
- Bind interface
6701
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
5771
6702
  '''
5772
6703
  self.egress_filter = egress_filter if egress_filter is not None else ''
5773
6704
  '''
@@ -5778,6 +6709,9 @@ class DocumentDBHost:
5778
6709
  True if the datasource is reachable and the credentials are valid.
5779
6710
  '''
5780
6711
  self.hostname = hostname if hostname is not None else ''
6712
+ '''
6713
+ The host to dial to initiate a connection from the egress node to this resource.
6714
+ '''
5781
6715
  self.id = id if id is not None else ''
5782
6716
  '''
5783
6717
  Unique identifier of the Resource.
@@ -5787,8 +6721,17 @@ class DocumentDBHost:
5787
6721
  Unique human-readable name of the Resource.
5788
6722
  '''
5789
6723
  self.password = password if password is not None else ''
6724
+ '''
6725
+ The password to authenticate with.
6726
+ '''
5790
6727
  self.port = port if port is not None else 0
6728
+ '''
6729
+ The port to dial to initiate a connection from the egress node to this resource.
6730
+ '''
5791
6731
  self.port_override = port_override if port_override is not None else 0
6732
+ '''
6733
+ The local port used by clients to connect to this resource.
6734
+ '''
5792
6735
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
5793
6736
  '''
5794
6737
  ID of the secret store containing credentials for this resource, if any.
@@ -5802,6 +6745,9 @@ class DocumentDBHost:
5802
6745
  Tags is a map of key, value pairs.
5803
6746
  '''
5804
6747
  self.username = username if username is not None else ''
6748
+ '''
6749
+ The username to authenticate with.
6750
+ '''
5805
6751
 
5806
6752
  def __repr__(self):
5807
6753
  return '<sdm.DocumentDBHost ' + \
@@ -5897,11 +6843,17 @@ class DocumentDBReplicaSet:
5897
6843
  username=None,
5898
6844
  ):
5899
6845
  self.auth_database = auth_database if auth_database is not None else ''
6846
+ '''
6847
+ The authentication database to use.
6848
+ '''
5900
6849
  self.bind_interface = bind_interface if bind_interface is not None else ''
5901
6850
  '''
5902
- Bind interface
6851
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
5903
6852
  '''
5904
6853
  self.connect_to_replica = connect_to_replica if connect_to_replica is not None else False
6854
+ '''
6855
+ Set to connect to a replica instead of the primary node.
6856
+ '''
5905
6857
  self.egress_filter = egress_filter if egress_filter is not None else ''
5906
6858
  '''
5907
6859
  A filter applied to the routing logic to pin datasource to nodes.
@@ -5923,8 +6875,17 @@ class DocumentDBReplicaSet:
5923
6875
  Unique human-readable name of the Resource.
5924
6876
  '''
5925
6877
  self.password = password if password is not None else ''
6878
+ '''
6879
+ The password to authenticate with.
6880
+ '''
5926
6881
  self.port_override = port_override if port_override is not None else 0
6882
+ '''
6883
+ The local port used by clients to connect to this resource.
6884
+ '''
5927
6885
  self.replica_set = replica_set if replica_set is not None else ''
6886
+ '''
6887
+ The name of the mongo replicaset.
6888
+ '''
5928
6889
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
5929
6890
  '''
5930
6891
  ID of the secret store containing credentials for this resource, if any.
@@ -5938,6 +6899,9 @@ class DocumentDBReplicaSet:
5938
6899
  Tags is a map of key, value pairs.
5939
6900
  '''
5940
6901
  self.username = username if username is not None else ''
6902
+ '''
6903
+ The username to authenticate with.
6904
+ '''
5941
6905
 
5942
6906
  def __repr__(self):
5943
6907
  return '<sdm.DocumentDBReplicaSet ' + \
@@ -6033,7 +6997,7 @@ class Druid:
6033
6997
  ):
6034
6998
  self.bind_interface = bind_interface if bind_interface is not None else ''
6035
6999
  '''
6036
- Bind interface
7000
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
6037
7001
  '''
6038
7002
  self.egress_filter = egress_filter if egress_filter is not None else ''
6039
7003
  '''
@@ -6044,6 +7008,9 @@ class Druid:
6044
7008
  True if the datasource is reachable and the credentials are valid.
6045
7009
  '''
6046
7010
  self.hostname = hostname if hostname is not None else ''
7011
+ '''
7012
+ The host to dial to initiate a connection from the egress node to this resource.
7013
+ '''
6047
7014
  self.id = id if id is not None else ''
6048
7015
  '''
6049
7016
  Unique identifier of the Resource.
@@ -6053,8 +7020,17 @@ class Druid:
6053
7020
  Unique human-readable name of the Resource.
6054
7021
  '''
6055
7022
  self.password = password if password is not None else ''
7023
+ '''
7024
+ The password to authenticate with.
7025
+ '''
6056
7026
  self.port = port if port is not None else 0
7027
+ '''
7028
+ The port to dial to initiate a connection from the egress node to this resource.
7029
+ '''
6057
7030
  self.port_override = port_override if port_override is not None else 0
7031
+ '''
7032
+ The local port used by clients to connect to this resource.
7033
+ '''
6058
7034
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
6059
7035
  '''
6060
7036
  ID of the secret store containing credentials for this resource, if any.
@@ -6068,6 +7044,9 @@ class Druid:
6068
7044
  Tags is a map of key, value pairs.
6069
7045
  '''
6070
7046
  self.username = username if username is not None else ''
7047
+ '''
7048
+ The username to authenticate with.
7049
+ '''
6071
7050
 
6072
7051
  def __repr__(self):
6073
7052
  return '<sdm.Druid ' + \
@@ -6160,15 +7139,21 @@ class DynamoDB:
6160
7139
  tags=None,
6161
7140
  ):
6162
7141
  self.access_key = access_key if access_key is not None else ''
7142
+ '''
7143
+ The Access Key ID to use to authenticate.
7144
+ '''
6163
7145
  self.bind_interface = bind_interface if bind_interface is not None else ''
6164
7146
  '''
6165
- Bind interface
7147
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
6166
7148
  '''
6167
7149
  self.egress_filter = egress_filter if egress_filter is not None else ''
6168
7150
  '''
6169
7151
  A filter applied to the routing logic to pin datasource to nodes.
6170
7152
  '''
6171
7153
  self.endpoint = endpoint if endpoint is not None else ''
7154
+ '''
7155
+ The endpoint to dial e.g. dynamodb.region.amazonaws.com
7156
+ '''
6172
7157
  self.healthy = healthy if healthy is not None else False
6173
7158
  '''
6174
7159
  True if the datasource is reachable and the credentials are valid.
@@ -6182,10 +7167,25 @@ class DynamoDB:
6182
7167
  Unique human-readable name of the Resource.
6183
7168
  '''
6184
7169
  self.port_override = port_override if port_override is not None else 0
7170
+ '''
7171
+ The local port used by clients to connect to this resource.
7172
+ '''
6185
7173
  self.region = region if region is not None else ''
7174
+ '''
7175
+ The region to authenticate requests against e.g. us-east-1
7176
+ '''
6186
7177
  self.role_arn = role_arn if role_arn is not None else ''
7178
+ '''
7179
+ The role to assume after logging in.
7180
+ '''
6187
7181
  self.role_external_id = role_external_id if role_external_id is not None else ''
7182
+ '''
7183
+ The external ID to associate with assume role requests. Does nothing if a role ARN is not provided.
7184
+ '''
6188
7185
  self.secret_access_key = secret_access_key if secret_access_key is not None else ''
7186
+ '''
7187
+ The Secret Access Key to use to authenticate.
7188
+ '''
6189
7189
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
6190
7190
  '''
6191
7191
  ID of the secret store containing credentials for this resource, if any.
@@ -6295,7 +7295,7 @@ class Elastic:
6295
7295
  ):
6296
7296
  self.bind_interface = bind_interface if bind_interface is not None else ''
6297
7297
  '''
6298
- Bind interface
7298
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
6299
7299
  '''
6300
7300
  self.egress_filter = egress_filter if egress_filter is not None else ''
6301
7301
  '''
@@ -6306,6 +7306,9 @@ class Elastic:
6306
7306
  True if the datasource is reachable and the credentials are valid.
6307
7307
  '''
6308
7308
  self.hostname = hostname if hostname is not None else ''
7309
+ '''
7310
+ The host to dial to initiate a connection from the egress node to this resource.
7311
+ '''
6309
7312
  self.id = id if id is not None else ''
6310
7313
  '''
6311
7314
  Unique identifier of the Resource.
@@ -6315,8 +7318,17 @@ class Elastic:
6315
7318
  Unique human-readable name of the Resource.
6316
7319
  '''
6317
7320
  self.password = password if password is not None else ''
7321
+ '''
7322
+ The password to authenticate with.
7323
+ '''
6318
7324
  self.port = port if port is not None else 0
7325
+ '''
7326
+ The port to dial to initiate a connection from the egress node to this resource.
7327
+ '''
6319
7328
  self.port_override = port_override if port_override is not None else 0
7329
+ '''
7330
+ The local port used by clients to connect to this resource.
7331
+ '''
6320
7332
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
6321
7333
  '''
6322
7334
  ID of the secret store containing credentials for this resource, if any.
@@ -6330,7 +7342,13 @@ class Elastic:
6330
7342
  Tags is a map of key, value pairs.
6331
7343
  '''
6332
7344
  self.tls_required = tls_required if tls_required is not None else False
7345
+ '''
7346
+ If set, TLS must be used to connect to this resource.
7347
+ '''
6333
7348
  self.username = username if username is not None else ''
7349
+ '''
7350
+ The username to authenticate with.
7351
+ '''
6334
7352
 
6335
7353
  def __repr__(self):
6336
7354
  return '<sdm.Elastic ' + \
@@ -6425,7 +7443,7 @@ class ElasticacheRedis:
6425
7443
  ):
6426
7444
  self.bind_interface = bind_interface if bind_interface is not None else ''
6427
7445
  '''
6428
- Bind interface
7446
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
6429
7447
  '''
6430
7448
  self.egress_filter = egress_filter if egress_filter is not None else ''
6431
7449
  '''
@@ -6436,6 +7454,9 @@ class ElasticacheRedis:
6436
7454
  True if the datasource is reachable and the credentials are valid.
6437
7455
  '''
6438
7456
  self.hostname = hostname if hostname is not None else ''
7457
+ '''
7458
+ The host to dial to initiate a connection from the egress node to this resource.
7459
+ '''
6439
7460
  self.id = id if id is not None else ''
6440
7461
  '''
6441
7462
  Unique identifier of the Resource.
@@ -6445,8 +7466,17 @@ class ElasticacheRedis:
6445
7466
  Unique human-readable name of the Resource.
6446
7467
  '''
6447
7468
  self.password = password if password is not None else ''
7469
+ '''
7470
+ The password to authenticate with.
7471
+ '''
6448
7472
  self.port = port if port is not None else 0
7473
+ '''
7474
+ The port to dial to initiate a connection from the egress node to this resource.
7475
+ '''
6449
7476
  self.port_override = port_override if port_override is not None else 0
7477
+ '''
7478
+ The local port used by clients to connect to this resource.
7479
+ '''
6450
7480
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
6451
7481
  '''
6452
7482
  ID of the secret store containing credentials for this resource, if any.
@@ -6460,7 +7490,13 @@ class ElasticacheRedis:
6460
7490
  Tags is a map of key, value pairs.
6461
7491
  '''
6462
7492
  self.tls_required = tls_required if tls_required is not None else False
7493
+ '''
7494
+ If set, TLS must be used to connect to this resource.
7495
+ '''
6463
7496
  self.username = username if username is not None else ''
7497
+ '''
7498
+ The username to authenticate with.
7499
+ '''
6464
7500
 
6465
7501
  def __repr__(self):
6466
7502
  return '<sdm.ElasticacheRedis ' + \
@@ -6549,7 +7585,7 @@ class GCP:
6549
7585
  ):
6550
7586
  self.bind_interface = bind_interface if bind_interface is not None else ''
6551
7587
  '''
6552
- Bind interface
7588
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
6553
7589
  '''
6554
7590
  self.egress_filter = egress_filter if egress_filter is not None else ''
6555
7591
  '''
@@ -6564,12 +7600,21 @@ class GCP:
6564
7600
  Unique identifier of the Resource.
6565
7601
  '''
6566
7602
  self.keyfile = keyfile if keyfile is not None else ''
7603
+ '''
7604
+ The service account keyfile to authenticate with.
7605
+ '''
6567
7606
  self.name = name if name is not None else ''
6568
7607
  '''
6569
7608
  Unique human-readable name of the Resource.
6570
7609
  '''
6571
7610
  self.port_override = port_override if port_override is not None else 0
7611
+ '''
7612
+ The local port used by clients to connect to this resource.
7613
+ '''
6572
7614
  self.scopes = scopes if scopes is not None else ''
7615
+ '''
7616
+ Space separated scopes that this login should assume into when authenticating.
7617
+ '''
6573
7618
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
6574
7619
  '''
6575
7620
  ID of the secret store containing credentials for this resource, if any.
@@ -6654,6 +7699,9 @@ class GCPStore:
6654
7699
  Unique human-readable name of the SecretStore.
6655
7700
  '''
6656
7701
  self.projectid = projectid if projectid is not None else ''
7702
+ '''
7703
+ The GCP project ID to target.
7704
+ '''
6657
7705
  self.tags = tags if tags is not None else _porcelain_zero_value_tags()
6658
7706
  '''
6659
7707
  Tags is a map of key, value pairs.
@@ -6691,6 +7739,7 @@ class Gateway:
6691
7739
  '''
6692
7740
  __slots__ = [
6693
7741
  'bind_address',
7742
+ 'connects_to',
6694
7743
  'device',
6695
7744
  'gateway_filter',
6696
7745
  'id',
@@ -6705,6 +7754,7 @@ class Gateway:
6705
7754
  def __init__(
6706
7755
  self,
6707
7756
  bind_address=None,
7757
+ connects_to=None,
6708
7758
  device=None,
6709
7759
  gateway_filter=None,
6710
7760
  id=None,
@@ -6720,15 +7770,20 @@ class Gateway:
6720
7770
  The hostname/port tuple which the gateway daemon will bind to.
6721
7771
  If not provided on create, set to "0.0.0.0:listen_address_port".
6722
7772
  '''
7773
+ self.connects_to = connects_to if connects_to is not None else ''
7774
+ '''
7775
+ ConnectsTo can be used to restrict the peering between relays and
7776
+ gateways.
7777
+ '''
6723
7778
  self.device = device if device is not None else ''
6724
7779
  '''
6725
- Device is a read only device name uploaded by the gateway process when
7780
+ Device is a read only device name uploaded by the gateway process when
6726
7781
  it comes online.
6727
7782
  '''
6728
7783
  self.gateway_filter = gateway_filter if gateway_filter is not None else ''
6729
7784
  '''
6730
7785
  GatewayFilter can be used to restrict the peering between relays and
6731
- gateways.
7786
+ gateways. Deprecated.
6732
7787
  '''
6733
7788
  self.id = id if id is not None else ''
6734
7789
  '''
@@ -6765,6 +7820,7 @@ class Gateway:
6765
7820
  def __repr__(self):
6766
7821
  return '<sdm.Gateway ' + \
6767
7822
  'bind_address: ' + repr(self.bind_address) + ' ' +\
7823
+ 'connects_to: ' + repr(self.connects_to) + ' ' +\
6768
7824
  'device: ' + repr(self.device) + ' ' +\
6769
7825
  'gateway_filter: ' + repr(self.gateway_filter) + ' ' +\
6770
7826
  'id: ' + repr(self.id) + ' ' +\
@@ -6779,6 +7835,7 @@ class Gateway:
6779
7835
  def to_dict(self):
6780
7836
  return {
6781
7837
  'bind_address': self.bind_address,
7838
+ 'connects_to': self.connects_to,
6782
7839
  'device': self.device,
6783
7840
  'gateway_filter': self.gateway_filter,
6784
7841
  'id': self.id,
@@ -6794,6 +7851,7 @@ class Gateway:
6794
7851
  def from_dict(cls, d):
6795
7852
  return cls(
6796
7853
  bind_address=d.get('bind_address'),
7854
+ connects_to=d.get('connects_to'),
6797
7855
  device=d.get('device'),
6798
7856
  gateway_filter=d.get('gateway_filter'),
6799
7857
  id=d.get('id'),
@@ -6864,14 +7922,20 @@ class GoogleGKE:
6864
7922
  ):
6865
7923
  self.bind_interface = bind_interface if bind_interface is not None else ''
6866
7924
  '''
6867
- Bind interface
7925
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
6868
7926
  '''
6869
7927
  self.certificate_authority = certificate_authority if certificate_authority is not None else ''
7928
+ '''
7929
+ The CA to authenticate TLS connections with.
7930
+ '''
6870
7931
  self.egress_filter = egress_filter if egress_filter is not None else ''
6871
7932
  '''
6872
7933
  A filter applied to the routing logic to pin datasource to nodes.
6873
7934
  '''
6874
7935
  self.endpoint = endpoint if endpoint is not None else ''
7936
+ '''
7937
+ The endpoint to dial.
7938
+ '''
6875
7939
  self.healthcheck_namespace = healthcheck_namespace if healthcheck_namespace is not None else ''
6876
7940
  '''
6877
7941
  The path used to check the health of your connection. Defaults to `default`.
@@ -6889,12 +7953,21 @@ class GoogleGKE:
6889
7953
  Unique human-readable name of the Resource.
6890
7954
  '''
6891
7955
  self.remote_identity_group_id = remote_identity_group_id if remote_identity_group_id is not None else ''
7956
+ '''
7957
+ The ID of the remote identity group to use for remote identity connections.
7958
+ '''
6892
7959
  self.remote_identity_healthcheck_username = remote_identity_healthcheck_username if remote_identity_healthcheck_username is not None else ''
7960
+ '''
7961
+ The username to use for healthchecks, when clients otherwise connect with their own remote identity username.
7962
+ '''
6893
7963
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
6894
7964
  '''
6895
7965
  ID of the secret store containing credentials for this resource, if any.
6896
7966
  '''
6897
7967
  self.service_account_key = service_account_key if service_account_key is not None else ''
7968
+ '''
7969
+ The service account key to authenticate with.
7970
+ '''
6898
7971
  self.subdomain = subdomain if subdomain is not None else ''
6899
7972
  '''
6900
7973
  Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)
@@ -6995,14 +8068,20 @@ class GoogleGKEUserImpersonation:
6995
8068
  ):
6996
8069
  self.bind_interface = bind_interface if bind_interface is not None else ''
6997
8070
  '''
6998
- Bind interface
8071
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
6999
8072
  '''
7000
8073
  self.certificate_authority = certificate_authority if certificate_authority is not None else ''
8074
+ '''
8075
+ The CA to authenticate TLS connections with.
8076
+ '''
7001
8077
  self.egress_filter = egress_filter if egress_filter is not None else ''
7002
8078
  '''
7003
8079
  A filter applied to the routing logic to pin datasource to nodes.
7004
8080
  '''
7005
8081
  self.endpoint = endpoint if endpoint is not None else ''
8082
+ '''
8083
+ The endpoint to dial.
8084
+ '''
7006
8085
  self.healthcheck_namespace = healthcheck_namespace if healthcheck_namespace is not None else ''
7007
8086
  '''
7008
8087
  The path used to check the health of your connection. Defaults to `default`.
@@ -7024,6 +8103,9 @@ class GoogleGKEUserImpersonation:
7024
8103
  ID of the secret store containing credentials for this resource, if any.
7025
8104
  '''
7026
8105
  self.service_account_key = service_account_key if service_account_key is not None else ''
8106
+ '''
8107
+ The service account key to authenticate with.
8108
+ '''
7027
8109
  self.subdomain = subdomain if subdomain is not None else ''
7028
8110
  '''
7029
8111
  Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)
@@ -7122,9 +8204,12 @@ class Greenplum:
7122
8204
  ):
7123
8205
  self.bind_interface = bind_interface if bind_interface is not None else ''
7124
8206
  '''
7125
- Bind interface
8207
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
7126
8208
  '''
7127
8209
  self.database = database if database is not None else ''
8210
+ '''
8211
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
8212
+ '''
7128
8213
  self.egress_filter = egress_filter if egress_filter is not None else ''
7129
8214
  '''
7130
8215
  A filter applied to the routing logic to pin datasource to nodes.
@@ -7134,6 +8219,9 @@ class Greenplum:
7134
8219
  True if the datasource is reachable and the credentials are valid.
7135
8220
  '''
7136
8221
  self.hostname = hostname if hostname is not None else ''
8222
+ '''
8223
+ The host to dial to initiate a connection from the egress node to this resource.
8224
+ '''
7137
8225
  self.id = id if id is not None else ''
7138
8226
  '''
7139
8227
  Unique identifier of the Resource.
@@ -7143,9 +8231,21 @@ class Greenplum:
7143
8231
  Unique human-readable name of the Resource.
7144
8232
  '''
7145
8233
  self.override_database = override_database if override_database is not None else False
8234
+ '''
8235
+ If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.
8236
+ '''
7146
8237
  self.password = password if password is not None else ''
8238
+ '''
8239
+ The password to authenticate with.
8240
+ '''
7147
8241
  self.port = port if port is not None else 0
8242
+ '''
8243
+ The port to dial to initiate a connection from the egress node to this resource.
8244
+ '''
7148
8245
  self.port_override = port_override if port_override is not None else 0
8246
+ '''
8247
+ The local port used by clients to connect to this resource.
8248
+ '''
7149
8249
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
7150
8250
  '''
7151
8251
  ID of the secret store containing credentials for this resource, if any.
@@ -7159,6 +8259,9 @@ class Greenplum:
7159
8259
  Tags is a map of key, value pairs.
7160
8260
  '''
7161
8261
  self.username = username if username is not None else ''
8262
+ '''
8263
+ The username to authenticate with.
8264
+ '''
7162
8265
 
7163
8266
  def __repr__(self):
7164
8267
  return '<sdm.Greenplum ' + \
@@ -7255,22 +8358,37 @@ class HTTPAuth:
7255
8358
  url=None,
7256
8359
  ):
7257
8360
  self.auth_header = auth_header if auth_header is not None else ''
8361
+ '''
8362
+ The content to set as the authorization header.
8363
+ '''
7258
8364
  self.bind_interface = bind_interface if bind_interface is not None else ''
7259
8365
  '''
7260
- Bind interface
8366
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
7261
8367
  '''
7262
8368
  self.default_path = default_path if default_path is not None else ''
8369
+ '''
8370
+ Automatically redirect to this path upon connecting.
8371
+ '''
7263
8372
  self.egress_filter = egress_filter if egress_filter is not None else ''
7264
8373
  '''
7265
8374
  A filter applied to the routing logic to pin datasource to nodes.
7266
8375
  '''
7267
8376
  self.headers_blacklist = headers_blacklist if headers_blacklist is not None else ''
8377
+ '''
8378
+ Header names (e.g. Authorization), to omit from logs.
8379
+ '''
7268
8380
  self.healthcheck_path = healthcheck_path if healthcheck_path is not None else ''
8381
+ '''
8382
+ This path will be used to check the health of your site.
8383
+ '''
7269
8384
  self.healthy = healthy if healthy is not None else False
7270
8385
  '''
7271
8386
  True if the datasource is reachable and the credentials are valid.
7272
8387
  '''
7273
8388
  self.host_override = host_override if host_override is not None else ''
8389
+ '''
8390
+ The host header will be overwritten with this field if provided.
8391
+ '''
7274
8392
  self.id = id if id is not None else ''
7275
8393
  '''
7276
8394
  Unique identifier of the Resource.
@@ -7284,11 +8402,17 @@ class HTTPAuth:
7284
8402
  ID of the secret store containing credentials for this resource, if any.
7285
8403
  '''
7286
8404
  self.subdomain = subdomain if subdomain is not None else ''
8405
+ '''
8406
+ Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)
8407
+ '''
7287
8408
  self.tags = tags if tags is not None else _porcelain_zero_value_tags()
7288
8409
  '''
7289
8410
  Tags is a map of key, value pairs.
7290
8411
  '''
7291
8412
  self.url = url if url is not None else ''
8413
+ '''
8414
+ The base address of your website without the path.
8415
+ '''
7292
8416
 
7293
8417
  def __repr__(self):
7294
8418
  return '<sdm.HTTPAuth ' + \
@@ -7385,20 +8509,32 @@ class HTTPBasicAuth:
7385
8509
  ):
7386
8510
  self.bind_interface = bind_interface if bind_interface is not None else ''
7387
8511
  '''
7388
- Bind interface
8512
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
7389
8513
  '''
7390
8514
  self.default_path = default_path if default_path is not None else ''
8515
+ '''
8516
+ Automatically redirect to this path upon connecting.
8517
+ '''
7391
8518
  self.egress_filter = egress_filter if egress_filter is not None else ''
7392
8519
  '''
7393
8520
  A filter applied to the routing logic to pin datasource to nodes.
7394
8521
  '''
7395
8522
  self.headers_blacklist = headers_blacklist if headers_blacklist is not None else ''
8523
+ '''
8524
+ Header names (e.g. Authorization), to omit from logs.
8525
+ '''
7396
8526
  self.healthcheck_path = healthcheck_path if healthcheck_path is not None else ''
8527
+ '''
8528
+ This path will be used to check the health of your site.
8529
+ '''
7397
8530
  self.healthy = healthy if healthy is not None else False
7398
8531
  '''
7399
8532
  True if the datasource is reachable and the credentials are valid.
7400
8533
  '''
7401
8534
  self.host_override = host_override if host_override is not None else ''
8535
+ '''
8536
+ The host header will be overwritten with this field if provided.
8537
+ '''
7402
8538
  self.id = id if id is not None else ''
7403
8539
  '''
7404
8540
  Unique identifier of the Resource.
@@ -7408,17 +8544,29 @@ class HTTPBasicAuth:
7408
8544
  Unique human-readable name of the Resource.
7409
8545
  '''
7410
8546
  self.password = password if password is not None else ''
8547
+ '''
8548
+ The password to authenticate with.
8549
+ '''
7411
8550
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
7412
8551
  '''
7413
8552
  ID of the secret store containing credentials for this resource, if any.
7414
8553
  '''
7415
8554
  self.subdomain = subdomain if subdomain is not None else ''
8555
+ '''
8556
+ Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)
8557
+ '''
7416
8558
  self.tags = tags if tags is not None else _porcelain_zero_value_tags()
7417
8559
  '''
7418
8560
  Tags is a map of key, value pairs.
7419
8561
  '''
7420
8562
  self.url = url if url is not None else ''
8563
+ '''
8564
+ The base address of your website without the path.
8565
+ '''
7421
8566
  self.username = username if username is not None else ''
8567
+ '''
8568
+ The username to authenticate with.
8569
+ '''
7422
8570
 
7423
8571
  def __repr__(self):
7424
8572
  return '<sdm.HTTPBasicAuth ' + \
@@ -7514,20 +8662,32 @@ class HTTPNoAuth:
7514
8662
  ):
7515
8663
  self.bind_interface = bind_interface if bind_interface is not None else ''
7516
8664
  '''
7517
- Bind interface
8665
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
7518
8666
  '''
7519
8667
  self.default_path = default_path if default_path is not None else ''
8668
+ '''
8669
+ Automatically redirect to this path upon connecting.
8670
+ '''
7520
8671
  self.egress_filter = egress_filter if egress_filter is not None else ''
7521
8672
  '''
7522
8673
  A filter applied to the routing logic to pin datasource to nodes.
7523
8674
  '''
7524
8675
  self.headers_blacklist = headers_blacklist if headers_blacklist is not None else ''
8676
+ '''
8677
+ Header names (e.g. Authorization), to omit from logs.
8678
+ '''
7525
8679
  self.healthcheck_path = healthcheck_path if healthcheck_path is not None else ''
8680
+ '''
8681
+ This path will be used to check the health of your site.
8682
+ '''
7526
8683
  self.healthy = healthy if healthy is not None else False
7527
8684
  '''
7528
8685
  True if the datasource is reachable and the credentials are valid.
7529
8686
  '''
7530
8687
  self.host_override = host_override if host_override is not None else ''
8688
+ '''
8689
+ The host header will be overwritten with this field if provided.
8690
+ '''
7531
8691
  self.id = id if id is not None else ''
7532
8692
  '''
7533
8693
  Unique identifier of the Resource.
@@ -7541,11 +8701,17 @@ class HTTPNoAuth:
7541
8701
  ID of the secret store containing credentials for this resource, if any.
7542
8702
  '''
7543
8703
  self.subdomain = subdomain if subdomain is not None else ''
8704
+ '''
8705
+ Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)
8706
+ '''
7544
8707
  self.tags = tags if tags is not None else _porcelain_zero_value_tags()
7545
8708
  '''
7546
8709
  Tags is a map of key, value pairs.
7547
8710
  '''
7548
8711
  self.url = url if url is not None else ''
8712
+ '''
8713
+ The base address of your website without the path.
8714
+ '''
7549
8715
 
7550
8716
  def __repr__(self):
7551
8717
  return '<sdm.HTTPNoAuth ' + \
@@ -7643,11 +8809,20 @@ class Kubernetes:
7643
8809
  ):
7644
8810
  self.bind_interface = bind_interface if bind_interface is not None else ''
7645
8811
  '''
7646
- Bind interface
8812
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
7647
8813
  '''
7648
8814
  self.certificate_authority = certificate_authority if certificate_authority is not None else ''
8815
+ '''
8816
+ The CA to authenticate TLS connections with.
8817
+ '''
7649
8818
  self.client_certificate = client_certificate if client_certificate is not None else ''
8819
+ '''
8820
+ The certificate to authenticate TLS connections with.
8821
+ '''
7650
8822
  self.client_key = client_key if client_key is not None else ''
8823
+ '''
8824
+ The key to authenticate TLS connections with.
8825
+ '''
7651
8826
  self.egress_filter = egress_filter if egress_filter is not None else ''
7652
8827
  '''
7653
8828
  A filter applied to the routing logic to pin datasource to nodes.
@@ -7661,6 +8836,9 @@ class Kubernetes:
7661
8836
  True if the datasource is reachable and the credentials are valid.
7662
8837
  '''
7663
8838
  self.hostname = hostname if hostname is not None else ''
8839
+ '''
8840
+ The host to dial to initiate a connection from the egress node to this resource.
8841
+ '''
7664
8842
  self.id = id if id is not None else ''
7665
8843
  '''
7666
8844
  Unique identifier of the Resource.
@@ -7670,9 +8848,21 @@ class Kubernetes:
7670
8848
  Unique human-readable name of the Resource.
7671
8849
  '''
7672
8850
  self.port = port if port is not None else 0
8851
+ '''
8852
+ The port to dial to initiate a connection from the egress node to this resource.
8853
+ '''
7673
8854
  self.port_override = port_override if port_override is not None else 0
8855
+ '''
8856
+ The local port used by clients to connect to this resource.
8857
+ '''
7674
8858
  self.remote_identity_group_id = remote_identity_group_id if remote_identity_group_id is not None else ''
8859
+ '''
8860
+ The ID of the remote identity group to use for remote identity connections.
8861
+ '''
7675
8862
  self.remote_identity_healthcheck_username = remote_identity_healthcheck_username if remote_identity_healthcheck_username is not None else ''
8863
+ '''
8864
+ The username to use for healthchecks, when clients otherwise connect with their own remote identity username.
8865
+ '''
7676
8866
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
7677
8867
  '''
7678
8868
  ID of the secret store containing credentials for this resource, if any.
@@ -7790,7 +8980,7 @@ class KubernetesBasicAuth:
7790
8980
  ):
7791
8981
  self.bind_interface = bind_interface if bind_interface is not None else ''
7792
8982
  '''
7793
- Bind interface
8983
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
7794
8984
  '''
7795
8985
  self.egress_filter = egress_filter if egress_filter is not None else ''
7796
8986
  '''
@@ -7805,6 +8995,9 @@ class KubernetesBasicAuth:
7805
8995
  True if the datasource is reachable and the credentials are valid.
7806
8996
  '''
7807
8997
  self.hostname = hostname if hostname is not None else ''
8998
+ '''
8999
+ The host to dial to initiate a connection from the egress node to this resource.
9000
+ '''
7808
9001
  self.id = id if id is not None else ''
7809
9002
  '''
7810
9003
  Unique identifier of the Resource.
@@ -7814,8 +9007,17 @@ class KubernetesBasicAuth:
7814
9007
  Unique human-readable name of the Resource.
7815
9008
  '''
7816
9009
  self.password = password if password is not None else ''
9010
+ '''
9011
+ The password to authenticate with.
9012
+ '''
7817
9013
  self.port = port if port is not None else 0
9014
+ '''
9015
+ The port to dial to initiate a connection from the egress node to this resource.
9016
+ '''
7818
9017
  self.port_override = port_override if port_override is not None else 0
9018
+ '''
9019
+ The local port used by clients to connect to this resource.
9020
+ '''
7819
9021
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
7820
9022
  '''
7821
9023
  ID of the secret store containing credentials for this resource, if any.
@@ -7829,6 +9031,9 @@ class KubernetesBasicAuth:
7829
9031
  Tags is a map of key, value pairs.
7830
9032
  '''
7831
9033
  self.username = username if username is not None else ''
9034
+ '''
9035
+ The username to authenticate with.
9036
+ '''
7832
9037
 
7833
9038
  def __repr__(self):
7834
9039
  return '<sdm.KubernetesBasicAuth ' + \
@@ -7925,7 +9130,7 @@ class KubernetesServiceAccount:
7925
9130
  ):
7926
9131
  self.bind_interface = bind_interface if bind_interface is not None else ''
7927
9132
  '''
7928
- Bind interface
9133
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
7929
9134
  '''
7930
9135
  self.egress_filter = egress_filter if egress_filter is not None else ''
7931
9136
  '''
@@ -7940,6 +9145,9 @@ class KubernetesServiceAccount:
7940
9145
  True if the datasource is reachable and the credentials are valid.
7941
9146
  '''
7942
9147
  self.hostname = hostname if hostname is not None else ''
9148
+ '''
9149
+ The host to dial to initiate a connection from the egress node to this resource.
9150
+ '''
7943
9151
  self.id = id if id is not None else ''
7944
9152
  '''
7945
9153
  Unique identifier of the Resource.
@@ -7949,9 +9157,21 @@ class KubernetesServiceAccount:
7949
9157
  Unique human-readable name of the Resource.
7950
9158
  '''
7951
9159
  self.port = port if port is not None else 0
9160
+ '''
9161
+ The port to dial to initiate a connection from the egress node to this resource.
9162
+ '''
7952
9163
  self.port_override = port_override if port_override is not None else 0
9164
+ '''
9165
+ The local port used by clients to connect to this resource.
9166
+ '''
7953
9167
  self.remote_identity_group_id = remote_identity_group_id if remote_identity_group_id is not None else ''
9168
+ '''
9169
+ The ID of the remote identity group to use for remote identity connections.
9170
+ '''
7954
9171
  self.remote_identity_healthcheck_username = remote_identity_healthcheck_username if remote_identity_healthcheck_username is not None else ''
9172
+ '''
9173
+ The username to use for healthchecks, when clients otherwise connect with their own remote identity username.
9174
+ '''
7955
9175
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
7956
9176
  '''
7957
9177
  ID of the secret store containing credentials for this resource, if any.
@@ -7965,6 +9185,9 @@ class KubernetesServiceAccount:
7965
9185
  Tags is a map of key, value pairs.
7966
9186
  '''
7967
9187
  self.token = token if token is not None else ''
9188
+ '''
9189
+ The API token to authenticate with.
9190
+ '''
7968
9191
 
7969
9192
  def __repr__(self):
7970
9193
  return '<sdm.KubernetesServiceAccount ' + \
@@ -8062,7 +9285,7 @@ class KubernetesServiceAccountUserImpersonation:
8062
9285
  ):
8063
9286
  self.bind_interface = bind_interface if bind_interface is not None else ''
8064
9287
  '''
8065
- Bind interface
9288
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
8066
9289
  '''
8067
9290
  self.egress_filter = egress_filter if egress_filter is not None else ''
8068
9291
  '''
@@ -8077,6 +9300,9 @@ class KubernetesServiceAccountUserImpersonation:
8077
9300
  True if the datasource is reachable and the credentials are valid.
8078
9301
  '''
8079
9302
  self.hostname = hostname if hostname is not None else ''
9303
+ '''
9304
+ The host to dial to initiate a connection from the egress node to this resource.
9305
+ '''
8080
9306
  self.id = id if id is not None else ''
8081
9307
  '''
8082
9308
  Unique identifier of the Resource.
@@ -8086,7 +9312,13 @@ class KubernetesServiceAccountUserImpersonation:
8086
9312
  Unique human-readable name of the Resource.
8087
9313
  '''
8088
9314
  self.port = port if port is not None else 0
9315
+ '''
9316
+ The port to dial to initiate a connection from the egress node to this resource.
9317
+ '''
8089
9318
  self.port_override = port_override if port_override is not None else 0
9319
+ '''
9320
+ The local port used by clients to connect to this resource.
9321
+ '''
8090
9322
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
8091
9323
  '''
8092
9324
  ID of the secret store containing credentials for this resource, if any.
@@ -8100,6 +9332,9 @@ class KubernetesServiceAccountUserImpersonation:
8100
9332
  Tags is a map of key, value pairs.
8101
9333
  '''
8102
9334
  self.token = token if token is not None else ''
9335
+ '''
9336
+ The API token to authenticate with.
9337
+ '''
8103
9338
 
8104
9339
  def __repr__(self):
8105
9340
  return '<sdm.KubernetesServiceAccountUserImpersonation ' + \
@@ -8193,11 +9428,20 @@ class KubernetesUserImpersonation:
8193
9428
  ):
8194
9429
  self.bind_interface = bind_interface if bind_interface is not None else ''
8195
9430
  '''
8196
- Bind interface
9431
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
8197
9432
  '''
8198
9433
  self.certificate_authority = certificate_authority if certificate_authority is not None else ''
9434
+ '''
9435
+ The CA to authenticate TLS connections with.
9436
+ '''
8199
9437
  self.client_certificate = client_certificate if client_certificate is not None else ''
9438
+ '''
9439
+ The certificate to authenticate TLS connections with.
9440
+ '''
8200
9441
  self.client_key = client_key if client_key is not None else ''
9442
+ '''
9443
+ The key to authenticate TLS connections with.
9444
+ '''
8201
9445
  self.egress_filter = egress_filter if egress_filter is not None else ''
8202
9446
  '''
8203
9447
  A filter applied to the routing logic to pin datasource to nodes.
@@ -8210,7 +9454,10 @@ class KubernetesUserImpersonation:
8210
9454
  '''
8211
9455
  True if the datasource is reachable and the credentials are valid.
8212
9456
  '''
8213
- self.hostname = hostname if hostname is not None else ''
9457
+ self.hostname = hostname if hostname is not None else ''
9458
+ '''
9459
+ The host to dial to initiate a connection from the egress node to this resource.
9460
+ '''
8214
9461
  self.id = id if id is not None else ''
8215
9462
  '''
8216
9463
  Unique identifier of the Resource.
@@ -8220,7 +9467,13 @@ class KubernetesUserImpersonation:
8220
9467
  Unique human-readable name of the Resource.
8221
9468
  '''
8222
9469
  self.port = port if port is not None else 0
9470
+ '''
9471
+ The port to dial to initiate a connection from the egress node to this resource.
9472
+ '''
8223
9473
  self.port_override = port_override if port_override is not None else 0
9474
+ '''
9475
+ The local port used by clients to connect to this resource.
9476
+ '''
8224
9477
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
8225
9478
  '''
8226
9479
  ID of the secret store containing credentials for this resource, if any.
@@ -8346,12 +9599,24 @@ class MTLSMysql:
8346
9599
  ):
8347
9600
  self.bind_interface = bind_interface if bind_interface is not None else ''
8348
9601
  '''
8349
- Bind interface
9602
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
8350
9603
  '''
8351
9604
  self.certificate_authority = certificate_authority if certificate_authority is not None else ''
9605
+ '''
9606
+ The CA to authenticate TLS connections with.
9607
+ '''
8352
9608
  self.client_certificate = client_certificate if client_certificate is not None else ''
9609
+ '''
9610
+ The certificate to authenticate TLS connections with.
9611
+ '''
8353
9612
  self.client_key = client_key if client_key is not None else ''
9613
+ '''
9614
+ The key to authenticate TLS connections with.
9615
+ '''
8354
9616
  self.database = database if database is not None else ''
9617
+ '''
9618
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
9619
+ '''
8355
9620
  self.egress_filter = egress_filter if egress_filter is not None else ''
8356
9621
  '''
8357
9622
  A filter applied to the routing logic to pin datasource to nodes.
@@ -8361,6 +9626,9 @@ class MTLSMysql:
8361
9626
  True if the datasource is reachable and the credentials are valid.
8362
9627
  '''
8363
9628
  self.hostname = hostname if hostname is not None else ''
9629
+ '''
9630
+ The host to dial to initiate a connection from the egress node to this resource.
9631
+ '''
8364
9632
  self.id = id if id is not None else ''
8365
9633
  '''
8366
9634
  Unique identifier of the Resource.
@@ -8370,14 +9638,29 @@ class MTLSMysql:
8370
9638
  Unique human-readable name of the Resource.
8371
9639
  '''
8372
9640
  self.password = password if password is not None else ''
9641
+ '''
9642
+ The password to authenticate with.
9643
+ '''
8373
9644
  self.port = port if port is not None else 0
9645
+ '''
9646
+ The port to dial to initiate a connection from the egress node to this resource.
9647
+ '''
8374
9648
  self.port_override = port_override if port_override is not None else 0
9649
+ '''
9650
+ The local port used by clients to connect to this resource.
9651
+ '''
8375
9652
  self.require_native_auth = require_native_auth if require_native_auth is not None else False
9653
+ '''
9654
+ Whether native auth (mysql_native_password) is used for all connections (for backwards compatibility)
9655
+ '''
8376
9656
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
8377
9657
  '''
8378
9658
  ID of the secret store containing credentials for this resource, if any.
8379
9659
  '''
8380
9660
  self.server_name = server_name if server_name is not None else ''
9661
+ '''
9662
+ Server name for TLS verification (unverified by StrongDM if empty)
9663
+ '''
8381
9664
  self.subdomain = subdomain if subdomain is not None else ''
8382
9665
  '''
8383
9666
  Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)
@@ -8387,7 +9670,13 @@ class MTLSMysql:
8387
9670
  Tags is a map of key, value pairs.
8388
9671
  '''
8389
9672
  self.use_azure_single_server_usernames = use_azure_single_server_usernames if use_azure_single_server_usernames is not None else False
9673
+ '''
9674
+ If true, appends the hostname to the username when hitting a database.azure.com address
9675
+ '''
8390
9676
  self.username = username if username is not None else ''
9677
+ '''
9678
+ The username to authenticate with.
9679
+ '''
8391
9680
 
8392
9681
  def __repr__(self):
8393
9682
  return '<sdm.MTLSMysql ' + \
@@ -8512,12 +9801,24 @@ class MTLSPostgres:
8512
9801
  ):
8513
9802
  self.bind_interface = bind_interface if bind_interface is not None else ''
8514
9803
  '''
8515
- Bind interface
9804
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
8516
9805
  '''
8517
9806
  self.certificate_authority = certificate_authority if certificate_authority is not None else ''
9807
+ '''
9808
+ The CA to authenticate TLS connections with.
9809
+ '''
8518
9810
  self.client_certificate = client_certificate if client_certificate is not None else ''
9811
+ '''
9812
+ The certificate to authenticate TLS connections with.
9813
+ '''
8519
9814
  self.client_key = client_key if client_key is not None else ''
9815
+ '''
9816
+ The key to authenticate TLS connections with.
9817
+ '''
8520
9818
  self.database = database if database is not None else ''
9819
+ '''
9820
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
9821
+ '''
8521
9822
  self.egress_filter = egress_filter if egress_filter is not None else ''
8522
9823
  '''
8523
9824
  A filter applied to the routing logic to pin datasource to nodes.
@@ -8527,6 +9828,9 @@ class MTLSPostgres:
8527
9828
  True if the datasource is reachable and the credentials are valid.
8528
9829
  '''
8529
9830
  self.hostname = hostname if hostname is not None else ''
9831
+ '''
9832
+ The host to dial to initiate a connection from the egress node to this resource.
9833
+ '''
8530
9834
  self.id = id if id is not None else ''
8531
9835
  '''
8532
9836
  Unique identifier of the Resource.
@@ -8536,14 +9840,29 @@ class MTLSPostgres:
8536
9840
  Unique human-readable name of the Resource.
8537
9841
  '''
8538
9842
  self.override_database = override_database if override_database is not None else False
9843
+ '''
9844
+ If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.
9845
+ '''
8539
9846
  self.password = password if password is not None else ''
9847
+ '''
9848
+ The password to authenticate with.
9849
+ '''
8540
9850
  self.port = port if port is not None else 0
9851
+ '''
9852
+ The port to dial to initiate a connection from the egress node to this resource.
9853
+ '''
8541
9854
  self.port_override = port_override if port_override is not None else 0
9855
+ '''
9856
+ The local port used by clients to connect to this resource.
9857
+ '''
8542
9858
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
8543
9859
  '''
8544
9860
  ID of the secret store containing credentials for this resource, if any.
8545
9861
  '''
8546
9862
  self.server_name = server_name if server_name is not None else ''
9863
+ '''
9864
+ Server name for TLS verification (unverified by StrongDM if empty)
9865
+ '''
8547
9866
  self.subdomain = subdomain if subdomain is not None else ''
8548
9867
  '''
8549
9868
  Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)
@@ -8553,6 +9872,9 @@ class MTLSPostgres:
8553
9872
  Tags is a map of key, value pairs.
8554
9873
  '''
8555
9874
  self.username = username if username is not None else ''
9875
+ '''
9876
+ The username to authenticate with.
9877
+ '''
8556
9878
 
8557
9879
  def __repr__(self):
8558
9880
  return '<sdm.MTLSPostgres ' + \
@@ -8666,9 +9988,12 @@ class Maria:
8666
9988
  ):
8667
9989
  self.bind_interface = bind_interface if bind_interface is not None else ''
8668
9990
  '''
8669
- Bind interface
9991
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
8670
9992
  '''
8671
9993
  self.database = database if database is not None else ''
9994
+ '''
9995
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
9996
+ '''
8672
9997
  self.egress_filter = egress_filter if egress_filter is not None else ''
8673
9998
  '''
8674
9999
  A filter applied to the routing logic to pin datasource to nodes.
@@ -8678,6 +10003,9 @@ class Maria:
8678
10003
  True if the datasource is reachable and the credentials are valid.
8679
10004
  '''
8680
10005
  self.hostname = hostname if hostname is not None else ''
10006
+ '''
10007
+ The host to dial to initiate a connection from the egress node to this resource.
10008
+ '''
8681
10009
  self.id = id if id is not None else ''
8682
10010
  '''
8683
10011
  Unique identifier of the Resource.
@@ -8687,9 +10015,21 @@ class Maria:
8687
10015
  Unique human-readable name of the Resource.
8688
10016
  '''
8689
10017
  self.password = password if password is not None else ''
10018
+ '''
10019
+ The password to authenticate with.
10020
+ '''
8690
10021
  self.port = port if port is not None else 0
10022
+ '''
10023
+ The port to dial to initiate a connection from the egress node to this resource.
10024
+ '''
8691
10025
  self.port_override = port_override if port_override is not None else 0
10026
+ '''
10027
+ The local port used by clients to connect to this resource.
10028
+ '''
8692
10029
  self.require_native_auth = require_native_auth if require_native_auth is not None else False
10030
+ '''
10031
+ Whether native auth (mysql_native_password) is used for all connections (for backwards compatibility)
10032
+ '''
8693
10033
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
8694
10034
  '''
8695
10035
  ID of the secret store containing credentials for this resource, if any.
@@ -8703,7 +10043,13 @@ class Maria:
8703
10043
  Tags is a map of key, value pairs.
8704
10044
  '''
8705
10045
  self.use_azure_single_server_usernames = use_azure_single_server_usernames if use_azure_single_server_usernames is not None else False
10046
+ '''
10047
+ If true, appends the hostname to the username when hitting a database.azure.com address
10048
+ '''
8706
10049
  self.username = username if username is not None else ''
10050
+ '''
10051
+ The username to authenticate with.
10052
+ '''
8707
10053
 
8708
10054
  def __repr__(self):
8709
10055
  return '<sdm.Maria ' + \
@@ -8800,7 +10146,7 @@ class Memcached:
8800
10146
  ):
8801
10147
  self.bind_interface = bind_interface if bind_interface is not None else ''
8802
10148
  '''
8803
- Bind interface
10149
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
8804
10150
  '''
8805
10151
  self.egress_filter = egress_filter if egress_filter is not None else ''
8806
10152
  '''
@@ -8811,6 +10157,9 @@ class Memcached:
8811
10157
  True if the datasource is reachable and the credentials are valid.
8812
10158
  '''
8813
10159
  self.hostname = hostname if hostname is not None else ''
10160
+ '''
10161
+ The host to dial to initiate a connection from the egress node to this resource.
10162
+ '''
8814
10163
  self.id = id if id is not None else ''
8815
10164
  '''
8816
10165
  Unique identifier of the Resource.
@@ -8820,7 +10169,13 @@ class Memcached:
8820
10169
  Unique human-readable name of the Resource.
8821
10170
  '''
8822
10171
  self.port = port if port is not None else 0
10172
+ '''
10173
+ The port to dial to initiate a connection from the egress node to this resource.
10174
+ '''
8823
10175
  self.port_override = port_override if port_override is not None else 0
10176
+ '''
10177
+ The local port used by clients to connect to this resource.
10178
+ '''
8824
10179
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
8825
10180
  '''
8826
10181
  ID of the secret store containing credentials for this resource, if any.
@@ -8922,9 +10277,12 @@ class Memsql:
8922
10277
  ):
8923
10278
  self.bind_interface = bind_interface if bind_interface is not None else ''
8924
10279
  '''
8925
- Bind interface
10280
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
8926
10281
  '''
8927
10282
  self.database = database if database is not None else ''
10283
+ '''
10284
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
10285
+ '''
8928
10286
  self.egress_filter = egress_filter if egress_filter is not None else ''
8929
10287
  '''
8930
10288
  A filter applied to the routing logic to pin datasource to nodes.
@@ -8934,6 +10292,9 @@ class Memsql:
8934
10292
  True if the datasource is reachable and the credentials are valid.
8935
10293
  '''
8936
10294
  self.hostname = hostname if hostname is not None else ''
10295
+ '''
10296
+ The host to dial to initiate a connection from the egress node to this resource.
10297
+ '''
8937
10298
  self.id = id if id is not None else ''
8938
10299
  '''
8939
10300
  Unique identifier of the Resource.
@@ -8943,9 +10304,21 @@ class Memsql:
8943
10304
  Unique human-readable name of the Resource.
8944
10305
  '''
8945
10306
  self.password = password if password is not None else ''
10307
+ '''
10308
+ The password to authenticate with.
10309
+ '''
8946
10310
  self.port = port if port is not None else 0
10311
+ '''
10312
+ The port to dial to initiate a connection from the egress node to this resource.
10313
+ '''
8947
10314
  self.port_override = port_override if port_override is not None else 0
10315
+ '''
10316
+ The local port used by clients to connect to this resource.
10317
+ '''
8948
10318
  self.require_native_auth = require_native_auth if require_native_auth is not None else False
10319
+ '''
10320
+ Whether native auth (mysql_native_password) is used for all connections (for backwards compatibility)
10321
+ '''
8949
10322
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
8950
10323
  '''
8951
10324
  ID of the secret store containing credentials for this resource, if any.
@@ -8959,7 +10332,13 @@ class Memsql:
8959
10332
  Tags is a map of key, value pairs.
8960
10333
  '''
8961
10334
  self.use_azure_single_server_usernames = use_azure_single_server_usernames if use_azure_single_server_usernames is not None else False
10335
+ '''
10336
+ If true, appends the hostname to the username when hitting a database.azure.com address
10337
+ '''
8962
10338
  self.username = username if username is not None else ''
10339
+ '''
10340
+ The username to authenticate with.
10341
+ '''
8963
10342
 
8964
10343
  def __repr__(self):
8965
10344
  return '<sdm.Memsql ' + \
@@ -9067,9 +10446,12 @@ class MongoHost:
9067
10446
  username=None,
9068
10447
  ):
9069
10448
  self.auth_database = auth_database if auth_database is not None else ''
10449
+ '''
10450
+ The authentication database to use.
10451
+ '''
9070
10452
  self.bind_interface = bind_interface if bind_interface is not None else ''
9071
10453
  '''
9072
- Bind interface
10454
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
9073
10455
  '''
9074
10456
  self.egress_filter = egress_filter if egress_filter is not None else ''
9075
10457
  '''
@@ -9080,6 +10462,9 @@ class MongoHost:
9080
10462
  True if the datasource is reachable and the credentials are valid.
9081
10463
  '''
9082
10464
  self.hostname = hostname if hostname is not None else ''
10465
+ '''
10466
+ The host to dial to initiate a connection from the egress node to this resource.
10467
+ '''
9083
10468
  self.id = id if id is not None else ''
9084
10469
  '''
9085
10470
  Unique identifier of the Resource.
@@ -9089,8 +10474,17 @@ class MongoHost:
9089
10474
  Unique human-readable name of the Resource.
9090
10475
  '''
9091
10476
  self.password = password if password is not None else ''
10477
+ '''
10478
+ The password to authenticate with.
10479
+ '''
9092
10480
  self.port = port if port is not None else 0
10481
+ '''
10482
+ The port to dial to initiate a connection from the egress node to this resource.
10483
+ '''
9093
10484
  self.port_override = port_override if port_override is not None else 0
10485
+ '''
10486
+ The local port used by clients to connect to this resource.
10487
+ '''
9094
10488
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
9095
10489
  '''
9096
10490
  ID of the secret store containing credentials for this resource, if any.
@@ -9104,7 +10498,13 @@ class MongoHost:
9104
10498
  Tags is a map of key, value pairs.
9105
10499
  '''
9106
10500
  self.tls_required = tls_required if tls_required is not None else False
10501
+ '''
10502
+ If set, TLS must be used to connect to this resource.
10503
+ '''
9107
10504
  self.username = username if username is not None else ''
10505
+ '''
10506
+ The username to authenticate with.
10507
+ '''
9108
10508
 
9109
10509
  def __repr__(self):
9110
10510
  return '<sdm.MongoHost ' + \
@@ -9205,9 +10605,12 @@ class MongoLegacyHost:
9205
10605
  username=None,
9206
10606
  ):
9207
10607
  self.auth_database = auth_database if auth_database is not None else ''
10608
+ '''
10609
+ The authentication database to use.
10610
+ '''
9208
10611
  self.bind_interface = bind_interface if bind_interface is not None else ''
9209
10612
  '''
9210
- Bind interface
10613
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
9211
10614
  '''
9212
10615
  self.egress_filter = egress_filter if egress_filter is not None else ''
9213
10616
  '''
@@ -9218,6 +10621,9 @@ class MongoLegacyHost:
9218
10621
  True if the datasource is reachable and the credentials are valid.
9219
10622
  '''
9220
10623
  self.hostname = hostname if hostname is not None else ''
10624
+ '''
10625
+ The host to dial to initiate a connection from the egress node to this resource.
10626
+ '''
9221
10627
  self.id = id if id is not None else ''
9222
10628
  '''
9223
10629
  Unique identifier of the Resource.
@@ -9227,9 +10633,21 @@ class MongoLegacyHost:
9227
10633
  Unique human-readable name of the Resource.
9228
10634
  '''
9229
10635
  self.password = password if password is not None else ''
10636
+ '''
10637
+ The password to authenticate with.
10638
+ '''
9230
10639
  self.port = port if port is not None else 0
10640
+ '''
10641
+ The port to dial to initiate a connection from the egress node to this resource.
10642
+ '''
9231
10643
  self.port_override = port_override if port_override is not None else 0
10644
+ '''
10645
+ The local port used by clients to connect to this resource.
10646
+ '''
9232
10647
  self.replica_set = replica_set if replica_set is not None else ''
10648
+ '''
10649
+ The name of the mongo replicaset.
10650
+ '''
9233
10651
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
9234
10652
  '''
9235
10653
  ID of the secret store containing credentials for this resource, if any.
@@ -9243,7 +10661,13 @@ class MongoLegacyHost:
9243
10661
  Tags is a map of key, value pairs.
9244
10662
  '''
9245
10663
  self.tls_required = tls_required if tls_required is not None else False
10664
+ '''
10665
+ If set, TLS must be used to connect to this resource.
10666
+ '''
9246
10667
  self.username = username if username is not None else ''
10668
+ '''
10669
+ The username to authenticate with.
10670
+ '''
9247
10671
 
9248
10672
  def __repr__(self):
9249
10673
  return '<sdm.MongoLegacyHost ' + \
@@ -9349,11 +10773,17 @@ class MongoLegacyReplicaset:
9349
10773
  username=None,
9350
10774
  ):
9351
10775
  self.auth_database = auth_database if auth_database is not None else ''
10776
+ '''
10777
+ The authentication database to use.
10778
+ '''
9352
10779
  self.bind_interface = bind_interface if bind_interface is not None else ''
9353
10780
  '''
9354
- Bind interface
10781
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
9355
10782
  '''
9356
10783
  self.connect_to_replica = connect_to_replica if connect_to_replica is not None else False
10784
+ '''
10785
+ Set to connect to a replica instead of the primary node.
10786
+ '''
9357
10787
  self.egress_filter = egress_filter if egress_filter is not None else ''
9358
10788
  '''
9359
10789
  A filter applied to the routing logic to pin datasource to nodes.
@@ -9363,6 +10793,9 @@ class MongoLegacyReplicaset:
9363
10793
  True if the datasource is reachable and the credentials are valid.
9364
10794
  '''
9365
10795
  self.hostname = hostname if hostname is not None else ''
10796
+ '''
10797
+ The host to dial to initiate a connection from the egress node to this resource.
10798
+ '''
9366
10799
  self.id = id if id is not None else ''
9367
10800
  '''
9368
10801
  Unique identifier of the Resource.
@@ -9372,9 +10805,21 @@ class MongoLegacyReplicaset:
9372
10805
  Unique human-readable name of the Resource.
9373
10806
  '''
9374
10807
  self.password = password if password is not None else ''
10808
+ '''
10809
+ The password to authenticate with.
10810
+ '''
9375
10811
  self.port = port if port is not None else 0
10812
+ '''
10813
+ The port to dial to initiate a connection from the egress node to this resource.
10814
+ '''
9376
10815
  self.port_override = port_override if port_override is not None else 0
10816
+ '''
10817
+ The local port used by clients to connect to this resource.
10818
+ '''
9377
10819
  self.replica_set = replica_set if replica_set is not None else ''
10820
+ '''
10821
+ The name of the mongo replicaset.
10822
+ '''
9378
10823
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
9379
10824
  '''
9380
10825
  ID of the secret store containing credentials for this resource, if any.
@@ -9388,7 +10833,13 @@ class MongoLegacyReplicaset:
9388
10833
  Tags is a map of key, value pairs.
9389
10834
  '''
9390
10835
  self.tls_required = tls_required if tls_required is not None else False
10836
+ '''
10837
+ If set, TLS must be used to connect to this resource.
10838
+ '''
9391
10839
  self.username = username if username is not None else ''
10840
+ '''
10841
+ The username to authenticate with.
10842
+ '''
9392
10843
 
9393
10844
  def __repr__(self):
9394
10845
  return '<sdm.MongoLegacyReplicaset ' + \
@@ -9501,11 +10952,17 @@ class MongoReplicaSet:
9501
10952
  username=None,
9502
10953
  ):
9503
10954
  self.auth_database = auth_database if auth_database is not None else ''
10955
+ '''
10956
+ The authentication database to use.
10957
+ '''
9504
10958
  self.bind_interface = bind_interface if bind_interface is not None else ''
9505
10959
  '''
9506
- Bind interface
10960
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
9507
10961
  '''
9508
10962
  self.connect_to_replica = connect_to_replica if connect_to_replica is not None else False
10963
+ '''
10964
+ Set to connect to a replica instead of the primary node.
10965
+ '''
9509
10966
  self.egress_filter = egress_filter if egress_filter is not None else ''
9510
10967
  '''
9511
10968
  A filter applied to the routing logic to pin datasource to nodes.
@@ -9515,6 +10972,9 @@ class MongoReplicaSet:
9515
10972
  True if the datasource is reachable and the credentials are valid.
9516
10973
  '''
9517
10974
  self.hostname = hostname if hostname is not None else ''
10975
+ '''
10976
+ The host to dial to initiate a connection from the egress node to this resource.
10977
+ '''
9518
10978
  self.id = id if id is not None else ''
9519
10979
  '''
9520
10980
  Unique identifier of the Resource.
@@ -9524,9 +10984,21 @@ class MongoReplicaSet:
9524
10984
  Unique human-readable name of the Resource.
9525
10985
  '''
9526
10986
  self.password = password if password is not None else ''
10987
+ '''
10988
+ The password to authenticate with.
10989
+ '''
9527
10990
  self.port = port if port is not None else 0
10991
+ '''
10992
+ The port to dial to initiate a connection from the egress node to this resource.
10993
+ '''
9528
10994
  self.port_override = port_override if port_override is not None else 0
10995
+ '''
10996
+ The local port used by clients to connect to this resource.
10997
+ '''
9529
10998
  self.replica_set = replica_set if replica_set is not None else ''
10999
+ '''
11000
+ The name of the mongo replicaset.
11001
+ '''
9530
11002
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
9531
11003
  '''
9532
11004
  ID of the secret store containing credentials for this resource, if any.
@@ -9540,7 +11012,13 @@ class MongoReplicaSet:
9540
11012
  Tags is a map of key, value pairs.
9541
11013
  '''
9542
11014
  self.tls_required = tls_required if tls_required is not None else False
11015
+ '''
11016
+ If set, TLS must be used to connect to this resource.
11017
+ '''
9543
11018
  self.username = username if username is not None else ''
11019
+ '''
11020
+ The username to authenticate with.
11021
+ '''
9544
11022
 
9545
11023
  def __repr__(self):
9546
11024
  return '<sdm.MongoReplicaSet ' + \
@@ -9647,9 +11125,12 @@ class MongoShardedCluster:
9647
11125
  username=None,
9648
11126
  ):
9649
11127
  self.auth_database = auth_database if auth_database is not None else ''
11128
+ '''
11129
+ The authentication database to use.
11130
+ '''
9650
11131
  self.bind_interface = bind_interface if bind_interface is not None else ''
9651
11132
  '''
9652
- Bind interface
11133
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
9653
11134
  '''
9654
11135
  self.egress_filter = egress_filter if egress_filter is not None else ''
9655
11136
  '''
@@ -9660,6 +11141,9 @@ class MongoShardedCluster:
9660
11141
  True if the datasource is reachable and the credentials are valid.
9661
11142
  '''
9662
11143
  self.hostname = hostname if hostname is not None else ''
11144
+ '''
11145
+ The host to dial to initiate a connection from the egress node to this resource.
11146
+ '''
9663
11147
  self.id = id if id is not None else ''
9664
11148
  '''
9665
11149
  Unique identifier of the Resource.
@@ -9669,7 +11153,13 @@ class MongoShardedCluster:
9669
11153
  Unique human-readable name of the Resource.
9670
11154
  '''
9671
11155
  self.password = password if password is not None else ''
11156
+ '''
11157
+ The password to authenticate with.
11158
+ '''
9672
11159
  self.port_override = port_override if port_override is not None else 0
11160
+ '''
11161
+ The local port used by clients to connect to this resource.
11162
+ '''
9673
11163
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
9674
11164
  '''
9675
11165
  ID of the secret store containing credentials for this resource, if any.
@@ -9683,7 +11173,13 @@ class MongoShardedCluster:
9683
11173
  Tags is a map of key, value pairs.
9684
11174
  '''
9685
11175
  self.tls_required = tls_required if tls_required is not None else False
11176
+ '''
11177
+ If set, TLS must be used to connect to this resource.
11178
+ '''
9686
11179
  self.username = username if username is not None else ''
11180
+ '''
11181
+ The username to authenticate with.
11182
+ '''
9687
11183
 
9688
11184
  def __repr__(self):
9689
11185
  return '<sdm.MongoShardedCluster ' + \
@@ -9782,9 +11278,12 @@ class Mysql:
9782
11278
  ):
9783
11279
  self.bind_interface = bind_interface if bind_interface is not None else ''
9784
11280
  '''
9785
- Bind interface
11281
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
9786
11282
  '''
9787
11283
  self.database = database if database is not None else ''
11284
+ '''
11285
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
11286
+ '''
9788
11287
  self.egress_filter = egress_filter if egress_filter is not None else ''
9789
11288
  '''
9790
11289
  A filter applied to the routing logic to pin datasource to nodes.
@@ -9794,6 +11293,9 @@ class Mysql:
9794
11293
  True if the datasource is reachable and the credentials are valid.
9795
11294
  '''
9796
11295
  self.hostname = hostname if hostname is not None else ''
11296
+ '''
11297
+ The host to dial to initiate a connection from the egress node to this resource.
11298
+ '''
9797
11299
  self.id = id if id is not None else ''
9798
11300
  '''
9799
11301
  Unique identifier of the Resource.
@@ -9803,9 +11305,21 @@ class Mysql:
9803
11305
  Unique human-readable name of the Resource.
9804
11306
  '''
9805
11307
  self.password = password if password is not None else ''
11308
+ '''
11309
+ The password to authenticate with.
11310
+ '''
9806
11311
  self.port = port if port is not None else 0
11312
+ '''
11313
+ The port to dial to initiate a connection from the egress node to this resource.
11314
+ '''
9807
11315
  self.port_override = port_override if port_override is not None else 0
11316
+ '''
11317
+ The local port used by clients to connect to this resource.
11318
+ '''
9808
11319
  self.require_native_auth = require_native_auth if require_native_auth is not None else False
11320
+ '''
11321
+ Whether native auth (mysql_native_password) is used for all connections (for backwards compatibility)
11322
+ '''
9809
11323
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
9810
11324
  '''
9811
11325
  ID of the secret store containing credentials for this resource, if any.
@@ -9819,7 +11333,13 @@ class Mysql:
9819
11333
  Tags is a map of key, value pairs.
9820
11334
  '''
9821
11335
  self.use_azure_single_server_usernames = use_azure_single_server_usernames if use_azure_single_server_usernames is not None else False
11336
+ '''
11337
+ If true, appends the hostname to the username when hitting a database.azure.com address
11338
+ '''
9822
11339
  self.username = username if username is not None else ''
11340
+ '''
11341
+ The username to authenticate with.
11342
+ '''
9823
11343
 
9824
11344
  def __repr__(self):
9825
11345
  return '<sdm.Mysql ' + \
@@ -9916,13 +11436,16 @@ class Neptune:
9916
11436
  ):
9917
11437
  self.bind_interface = bind_interface if bind_interface is not None else ''
9918
11438
  '''
9919
- Bind interface
11439
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
9920
11440
  '''
9921
11441
  self.egress_filter = egress_filter if egress_filter is not None else ''
9922
11442
  '''
9923
11443
  A filter applied to the routing logic to pin datasource to nodes.
9924
11444
  '''
9925
11445
  self.endpoint = endpoint if endpoint is not None else ''
11446
+ '''
11447
+ The neptune endpoint to connect to as in endpoint.region.neptune.amazonaws.com
11448
+ '''
9926
11449
  self.healthy = healthy if healthy is not None else False
9927
11450
  '''
9928
11451
  True if the datasource is reachable and the credentials are valid.
@@ -9936,7 +11459,13 @@ class Neptune:
9936
11459
  Unique human-readable name of the Resource.
9937
11460
  '''
9938
11461
  self.port = port if port is not None else 0
11462
+ '''
11463
+ The port to dial to initiate a connection from the egress node to this resource.
11464
+ '''
9939
11465
  self.port_override = port_override if port_override is not None else 0
11466
+ '''
11467
+ The local port used by clients to connect to this resource.
11468
+ '''
9940
11469
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
9941
11470
  '''
9942
11471
  ID of the secret store containing credentials for this resource, if any.
@@ -10037,15 +11566,21 @@ class NeptuneIAM:
10037
11566
  tags=None,
10038
11567
  ):
10039
11568
  self.access_key = access_key if access_key is not None else ''
11569
+ '''
11570
+ The Access Key ID to use to authenticate.
11571
+ '''
10040
11572
  self.bind_interface = bind_interface if bind_interface is not None else ''
10041
11573
  '''
10042
- Bind interface
11574
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
10043
11575
  '''
10044
11576
  self.egress_filter = egress_filter if egress_filter is not None else ''
10045
11577
  '''
10046
11578
  A filter applied to the routing logic to pin datasource to nodes.
10047
11579
  '''
10048
11580
  self.endpoint = endpoint if endpoint is not None else ''
11581
+ '''
11582
+ The neptune endpoint to connect to as in endpoint.region.neptune.amazonaws.com
11583
+ '''
10049
11584
  self.healthy = healthy if healthy is not None else False
10050
11585
  '''
10051
11586
  True if the datasource is reachable and the credentials are valid.
@@ -10059,11 +11594,29 @@ class NeptuneIAM:
10059
11594
  Unique human-readable name of the Resource.
10060
11595
  '''
10061
11596
  self.port = port if port is not None else 0
11597
+ '''
11598
+ The port to dial to initiate a connection from the egress node to this resource.
11599
+ '''
10062
11600
  self.port_override = port_override if port_override is not None else 0
11601
+ '''
11602
+ The local port used by clients to connect to this resource.
11603
+ '''
10063
11604
  self.region = region if region is not None else ''
11605
+ '''
11606
+ The AWS region to connect to.
11607
+ '''
10064
11608
  self.role_arn = role_arn if role_arn is not None else ''
11609
+ '''
11610
+ The role to assume after logging in.
11611
+ '''
10065
11612
  self.role_external_id = role_external_id if role_external_id is not None else ''
11613
+ '''
11614
+ The external ID to associate with assume role requests. Does nothing if a role ARN is not provided.
11615
+ '''
10066
11616
  self.secret_access_key = secret_access_key if secret_access_key is not None else ''
11617
+ '''
11618
+ The Secret Access Key to use to authenticate.
11619
+ '''
10067
11620
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
10068
11621
  '''
10069
11622
  ID of the secret store containing credentials for this resource, if any.
@@ -10452,9 +12005,12 @@ class Oracle:
10452
12005
  ):
10453
12006
  self.bind_interface = bind_interface if bind_interface is not None else ''
10454
12007
  '''
10455
- Bind interface
12008
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
10456
12009
  '''
10457
12010
  self.database = database if database is not None else ''
12011
+ '''
12012
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
12013
+ '''
10458
12014
  self.egress_filter = egress_filter if egress_filter is not None else ''
10459
12015
  '''
10460
12016
  A filter applied to the routing logic to pin datasource to nodes.
@@ -10464,6 +12020,9 @@ class Oracle:
10464
12020
  True if the datasource is reachable and the credentials are valid.
10465
12021
  '''
10466
12022
  self.hostname = hostname if hostname is not None else ''
12023
+ '''
12024
+ The host to dial to initiate a connection from the egress node to this resource.
12025
+ '''
10467
12026
  self.id = id if id is not None else ''
10468
12027
  '''
10469
12028
  Unique identifier of the Resource.
@@ -10473,8 +12032,17 @@ class Oracle:
10473
12032
  Unique human-readable name of the Resource.
10474
12033
  '''
10475
12034
  self.password = password if password is not None else ''
12035
+ '''
12036
+ The password to authenticate with.
12037
+ '''
10476
12038
  self.port = port if port is not None else 0
12039
+ '''
12040
+ The port to dial to initiate a connection from the egress node to this resource.
12041
+ '''
10477
12042
  self.port_override = port_override if port_override is not None else 0
12043
+ '''
12044
+ The local port used by clients to connect to this resource.
12045
+ '''
10478
12046
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
10479
12047
  '''
10480
12048
  ID of the secret store containing credentials for this resource, if any.
@@ -10488,7 +12056,13 @@ class Oracle:
10488
12056
  Tags is a map of key, value pairs.
10489
12057
  '''
10490
12058
  self.tls_required = tls_required if tls_required is not None else False
12059
+ '''
12060
+ If set, TLS must be used to connect to this resource.
12061
+ '''
10491
12062
  self.username = username if username is not None else ''
12063
+ '''
12064
+ The username to authenticate with.
12065
+ '''
10492
12066
 
10493
12067
  def __repr__(self):
10494
12068
  return '<sdm.Oracle ' + \
@@ -10884,9 +12458,12 @@ class Postgres:
10884
12458
  ):
10885
12459
  self.bind_interface = bind_interface if bind_interface is not None else ''
10886
12460
  '''
10887
- Bind interface
12461
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
10888
12462
  '''
10889
12463
  self.database = database if database is not None else ''
12464
+ '''
12465
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
12466
+ '''
10890
12467
  self.egress_filter = egress_filter if egress_filter is not None else ''
10891
12468
  '''
10892
12469
  A filter applied to the routing logic to pin datasource to nodes.
@@ -10896,6 +12473,9 @@ class Postgres:
10896
12473
  True if the datasource is reachable and the credentials are valid.
10897
12474
  '''
10898
12475
  self.hostname = hostname if hostname is not None else ''
12476
+ '''
12477
+ The host to dial to initiate a connection from the egress node to this resource.
12478
+ '''
10899
12479
  self.id = id if id is not None else ''
10900
12480
  '''
10901
12481
  Unique identifier of the Resource.
@@ -10905,9 +12485,21 @@ class Postgres:
10905
12485
  Unique human-readable name of the Resource.
10906
12486
  '''
10907
12487
  self.override_database = override_database if override_database is not None else False
12488
+ '''
12489
+ If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.
12490
+ '''
10908
12491
  self.password = password if password is not None else ''
12492
+ '''
12493
+ The password to authenticate with.
12494
+ '''
10909
12495
  self.port = port if port is not None else 0
12496
+ '''
12497
+ The port to dial to initiate a connection from the egress node to this resource.
12498
+ '''
10910
12499
  self.port_override = port_override if port_override is not None else 0
12500
+ '''
12501
+ The local port used by clients to connect to this resource.
12502
+ '''
10911
12503
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
10912
12504
  '''
10913
12505
  ID of the secret store containing credentials for this resource, if any.
@@ -10921,6 +12513,9 @@ class Postgres:
10921
12513
  Tags is a map of key, value pairs.
10922
12514
  '''
10923
12515
  self.username = username if username is not None else ''
12516
+ '''
12517
+ The username to authenticate with.
12518
+ '''
10924
12519
 
10925
12520
  def __repr__(self):
10926
12521
  return '<sdm.Postgres ' + \
@@ -11020,9 +12615,12 @@ class Presto:
11020
12615
  ):
11021
12616
  self.bind_interface = bind_interface if bind_interface is not None else ''
11022
12617
  '''
11023
- Bind interface
12618
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
11024
12619
  '''
11025
12620
  self.database = database if database is not None else ''
12621
+ '''
12622
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
12623
+ '''
11026
12624
  self.egress_filter = egress_filter if egress_filter is not None else ''
11027
12625
  '''
11028
12626
  A filter applied to the routing logic to pin datasource to nodes.
@@ -11032,6 +12630,9 @@ class Presto:
11032
12630
  True if the datasource is reachable and the credentials are valid.
11033
12631
  '''
11034
12632
  self.hostname = hostname if hostname is not None else ''
12633
+ '''
12634
+ The host to dial to initiate a connection from the egress node to this resource.
12635
+ '''
11035
12636
  self.id = id if id is not None else ''
11036
12637
  '''
11037
12638
  Unique identifier of the Resource.
@@ -11041,8 +12642,17 @@ class Presto:
11041
12642
  Unique human-readable name of the Resource.
11042
12643
  '''
11043
12644
  self.password = password if password is not None else ''
12645
+ '''
12646
+ The password to authenticate with.
12647
+ '''
11044
12648
  self.port = port if port is not None else 0
12649
+ '''
12650
+ The port to dial to initiate a connection from the egress node to this resource.
12651
+ '''
11045
12652
  self.port_override = port_override if port_override is not None else 0
12653
+ '''
12654
+ The local port used by clients to connect to this resource.
12655
+ '''
11046
12656
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
11047
12657
  '''
11048
12658
  ID of the secret store containing credentials for this resource, if any.
@@ -11056,7 +12666,13 @@ class Presto:
11056
12666
  Tags is a map of key, value pairs.
11057
12667
  '''
11058
12668
  self.tls_required = tls_required if tls_required is not None else False
12669
+ '''
12670
+ If set, TLS must be used to connect to this resource.
12671
+ '''
11059
12672
  self.username = username if username is not None else ''
12673
+ '''
12674
+ The username to authenticate with.
12675
+ '''
11060
12676
 
11061
12677
  def __repr__(self):
11062
12678
  return '<sdm.Presto ' + \
@@ -11546,9 +13162,12 @@ class RDP:
11546
13162
  ):
11547
13163
  self.bind_interface = bind_interface if bind_interface is not None else ''
11548
13164
  '''
11549
- Bind interface
13165
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
11550
13166
  '''
11551
13167
  self.downgrade_nla_connections = downgrade_nla_connections if downgrade_nla_connections is not None else False
13168
+ '''
13169
+ When set, network level authentication will not be used. May resolve unexpected authentication errors to older servers. When set, healthchecks cannot detect if a provided username / password pair is correct.
13170
+ '''
11552
13171
  self.egress_filter = egress_filter if egress_filter is not None else ''
11553
13172
  '''
11554
13173
  A filter applied to the routing logic to pin datasource to nodes.
@@ -11558,6 +13177,9 @@ class RDP:
11558
13177
  True if the datasource is reachable and the credentials are valid.
11559
13178
  '''
11560
13179
  self.hostname = hostname if hostname is not None else ''
13180
+ '''
13181
+ The host to dial to initiate a connection from the egress node to this resource.
13182
+ '''
11561
13183
  self.id = id if id is not None else ''
11562
13184
  '''
11563
13185
  Unique identifier of the Resource.
@@ -11567,8 +13189,17 @@ class RDP:
11567
13189
  Unique human-readable name of the Resource.
11568
13190
  '''
11569
13191
  self.password = password if password is not None else ''
13192
+ '''
13193
+ The password to authenticate with.
13194
+ '''
11570
13195
  self.port = port if port is not None else 0
13196
+ '''
13197
+ The port to dial to initiate a connection from the egress node to this resource.
13198
+ '''
11571
13199
  self.port_override = port_override if port_override is not None else 0
13200
+ '''
13201
+ The local port used by clients to connect to this resource.
13202
+ '''
11572
13203
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
11573
13204
  '''
11574
13205
  ID of the secret store containing credentials for this resource, if any.
@@ -11582,6 +13213,9 @@ class RDP:
11582
13213
  Tags is a map of key, value pairs.
11583
13214
  '''
11584
13215
  self.username = username if username is not None else ''
13216
+ '''
13217
+ The username to authenticate with.
13218
+ '''
11585
13219
 
11586
13220
  def __repr__(self):
11587
13221
  return '<sdm.RDP ' + \
@@ -11676,7 +13310,7 @@ class RabbitMQAMQP091:
11676
13310
  ):
11677
13311
  self.bind_interface = bind_interface if bind_interface is not None else ''
11678
13312
  '''
11679
- Bind interface
13313
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
11680
13314
  '''
11681
13315
  self.egress_filter = egress_filter if egress_filter is not None else ''
11682
13316
  '''
@@ -11687,6 +13321,9 @@ class RabbitMQAMQP091:
11687
13321
  True if the datasource is reachable and the credentials are valid.
11688
13322
  '''
11689
13323
  self.hostname = hostname if hostname is not None else ''
13324
+ '''
13325
+ The host to dial to initiate a connection from the egress node to this resource.
13326
+ '''
11690
13327
  self.id = id if id is not None else ''
11691
13328
  '''
11692
13329
  Unique identifier of the Resource.
@@ -11696,8 +13333,17 @@ class RabbitMQAMQP091:
11696
13333
  Unique human-readable name of the Resource.
11697
13334
  '''
11698
13335
  self.password = password if password is not None else ''
13336
+ '''
13337
+ The password to authenticate with.
13338
+ '''
11699
13339
  self.port = port if port is not None else 0
13340
+ '''
13341
+ The port to dial to initiate a connection from the egress node to this resource.
13342
+ '''
11700
13343
  self.port_override = port_override if port_override is not None else 0
13344
+ '''
13345
+ The local port used by clients to connect to this resource.
13346
+ '''
11701
13347
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
11702
13348
  '''
11703
13349
  ID of the secret store containing credentials for this resource, if any.
@@ -11711,7 +13357,13 @@ class RabbitMQAMQP091:
11711
13357
  Tags is a map of key, value pairs.
11712
13358
  '''
11713
13359
  self.tls_required = tls_required if tls_required is not None else False
13360
+ '''
13361
+ If set, TLS must be used to connect to this resource.
13362
+ '''
11714
13363
  self.username = username if username is not None else ''
13364
+ '''
13365
+ The username to authenticate with.
13366
+ '''
11715
13367
 
11716
13368
  def __repr__(self):
11717
13369
  return '<sdm.RabbitMQAMQP091 ' + \
@@ -11864,7 +13516,7 @@ class RawTCP:
11864
13516
  ):
11865
13517
  self.bind_interface = bind_interface if bind_interface is not None else ''
11866
13518
  '''
11867
- Bind interface
13519
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
11868
13520
  '''
11869
13521
  self.egress_filter = egress_filter if egress_filter is not None else ''
11870
13522
  '''
@@ -11875,6 +13527,9 @@ class RawTCP:
11875
13527
  True if the datasource is reachable and the credentials are valid.
11876
13528
  '''
11877
13529
  self.hostname = hostname if hostname is not None else ''
13530
+ '''
13531
+ The host to dial to initiate a connection from the egress node to this resource.
13532
+ '''
11878
13533
  self.id = id if id is not None else ''
11879
13534
  '''
11880
13535
  Unique identifier of the Resource.
@@ -11884,7 +13539,13 @@ class RawTCP:
11884
13539
  Unique human-readable name of the Resource.
11885
13540
  '''
11886
13541
  self.port = port if port is not None else 0
13542
+ '''
13543
+ The port to dial to initiate a connection from the egress node to this resource.
13544
+ '''
11887
13545
  self.port_override = port_override if port_override is not None else 0
13546
+ '''
13547
+ The local port used by clients to connect to this resource.
13548
+ '''
11888
13549
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
11889
13550
  '''
11890
13551
  ID of the secret store containing credentials for this resource, if any.
@@ -11982,7 +13643,7 @@ class Redis:
11982
13643
  ):
11983
13644
  self.bind_interface = bind_interface if bind_interface is not None else ''
11984
13645
  '''
11985
- Bind interface
13646
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
11986
13647
  '''
11987
13648
  self.egress_filter = egress_filter if egress_filter is not None else ''
11988
13649
  '''
@@ -11993,6 +13654,9 @@ class Redis:
11993
13654
  True if the datasource is reachable and the credentials are valid.
11994
13655
  '''
11995
13656
  self.hostname = hostname if hostname is not None else ''
13657
+ '''
13658
+ The host to dial to initiate a connection from the egress node to this resource.
13659
+ '''
11996
13660
  self.id = id if id is not None else ''
11997
13661
  '''
11998
13662
  Unique identifier of the Resource.
@@ -12002,8 +13666,17 @@ class Redis:
12002
13666
  Unique human-readable name of the Resource.
12003
13667
  '''
12004
13668
  self.password = password if password is not None else ''
13669
+ '''
13670
+ The password to authenticate with.
13671
+ '''
12005
13672
  self.port = port if port is not None else 0
13673
+ '''
13674
+ The port to dial to initiate a connection from the egress node to this resource.
13675
+ '''
12006
13676
  self.port_override = port_override if port_override is not None else 0
13677
+ '''
13678
+ The local port used by clients to connect to this resource.
13679
+ '''
12007
13680
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
12008
13681
  '''
12009
13682
  ID of the secret store containing credentials for this resource, if any.
@@ -12017,7 +13690,13 @@ class Redis:
12017
13690
  Tags is a map of key, value pairs.
12018
13691
  '''
12019
13692
  self.tls_required = tls_required if tls_required is not None else False
13693
+ '''
13694
+ If set, TLS must be used to connect to this resource.
13695
+ '''
12020
13696
  self.username = username if username is not None else ''
13697
+ '''
13698
+ The username to authenticate with.
13699
+ '''
12021
13700
 
12022
13701
  def __repr__(self):
12023
13702
  return '<sdm.Redis ' + \
@@ -12114,9 +13793,12 @@ class Redshift:
12114
13793
  ):
12115
13794
  self.bind_interface = bind_interface if bind_interface is not None else ''
12116
13795
  '''
12117
- Bind interface
13796
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
12118
13797
  '''
12119
13798
  self.database = database if database is not None else ''
13799
+ '''
13800
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
13801
+ '''
12120
13802
  self.egress_filter = egress_filter if egress_filter is not None else ''
12121
13803
  '''
12122
13804
  A filter applied to the routing logic to pin datasource to nodes.
@@ -12126,6 +13808,9 @@ class Redshift:
12126
13808
  True if the datasource is reachable and the credentials are valid.
12127
13809
  '''
12128
13810
  self.hostname = hostname if hostname is not None else ''
13811
+ '''
13812
+ The host to dial to initiate a connection from the egress node to this resource.
13813
+ '''
12129
13814
  self.id = id if id is not None else ''
12130
13815
  '''
12131
13816
  Unique identifier of the Resource.
@@ -12135,9 +13820,21 @@ class Redshift:
12135
13820
  Unique human-readable name of the Resource.
12136
13821
  '''
12137
13822
  self.override_database = override_database if override_database is not None else False
13823
+ '''
13824
+ If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.
13825
+ '''
12138
13826
  self.password = password if password is not None else ''
13827
+ '''
13828
+ The password to authenticate with.
13829
+ '''
12139
13830
  self.port = port if port is not None else 0
13831
+ '''
13832
+ The port to dial to initiate a connection from the egress node to this resource.
13833
+ '''
12140
13834
  self.port_override = port_override if port_override is not None else 0
13835
+ '''
13836
+ The local port used by clients to connect to this resource.
13837
+ '''
12141
13838
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
12142
13839
  '''
12143
13840
  ID of the secret store containing credentials for this resource, if any.
@@ -12151,6 +13848,9 @@ class Redshift:
12151
13848
  Tags is a map of key, value pairs.
12152
13849
  '''
12153
13850
  self.username = username if username is not None else ''
13851
+ '''
13852
+ The username to authenticate with.
13853
+ '''
12154
13854
 
12155
13855
  def __repr__(self):
12156
13856
  return '<sdm.Redshift ' + \
@@ -12216,6 +13916,7 @@ class Relay:
12216
13916
  Relay represents a StrongDM CLI installation running in relay mode.
12217
13917
  '''
12218
13918
  __slots__ = [
13919
+ 'connects_to',
12219
13920
  'device',
12220
13921
  'gateway_filter',
12221
13922
  'id',
@@ -12228,6 +13929,7 @@ class Relay:
12228
13929
 
12229
13930
  def __init__(
12230
13931
  self,
13932
+ connects_to=None,
12231
13933
  device=None,
12232
13934
  gateway_filter=None,
12233
13935
  id=None,
@@ -12237,15 +13939,20 @@ class Relay:
12237
13939
  tags=None,
12238
13940
  version=None,
12239
13941
  ):
13942
+ self.connects_to = connects_to if connects_to is not None else ''
13943
+ '''
13944
+ ConnectsTo can be used to restrict the peering between relays and
13945
+ gateways.
13946
+ '''
12240
13947
  self.device = device if device is not None else ''
12241
13948
  '''
12242
- Device is a read only device name uploaded by the gateway process when
13949
+ Device is a read only device name uploaded by the gateway process when
12243
13950
  it comes online.
12244
13951
  '''
12245
13952
  self.gateway_filter = gateway_filter if gateway_filter is not None else ''
12246
13953
  '''
12247
13954
  GatewayFilter can be used to restrict the peering between relays and
12248
- gateways.
13955
+ gateways. Deprecated.
12249
13956
  '''
12250
13957
  self.id = id if id is not None else ''
12251
13958
  '''
@@ -12278,6 +13985,7 @@ class Relay:
12278
13985
 
12279
13986
  def __repr__(self):
12280
13987
  return '<sdm.Relay ' + \
13988
+ 'connects_to: ' + repr(self.connects_to) + ' ' +\
12281
13989
  'device: ' + repr(self.device) + ' ' +\
12282
13990
  'gateway_filter: ' + repr(self.gateway_filter) + ' ' +\
12283
13991
  'id: ' + repr(self.id) + ' ' +\
@@ -12290,6 +13998,7 @@ class Relay:
12290
13998
 
12291
13999
  def to_dict(self):
12292
14000
  return {
14001
+ 'connects_to': self.connects_to,
12293
14002
  'device': self.device,
12294
14003
  'gateway_filter': self.gateway_filter,
12295
14004
  'id': self.id,
@@ -12303,6 +14012,7 @@ class Relay:
12303
14012
  @classmethod
12304
14013
  def from_dict(cls, d):
12305
14014
  return cls(
14015
+ connects_to=d.get('connects_to'),
12306
14016
  device=d.get('device'),
12307
14017
  gateway_filter=d.get('gateway_filter'),
12308
14018
  id=d.get('id'),
@@ -13647,9 +15357,12 @@ class SQLServer:
13647
15357
  ):
13648
15358
  self.bind_interface = bind_interface if bind_interface is not None else ''
13649
15359
  '''
13650
- Bind interface
15360
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
13651
15361
  '''
13652
15362
  self.database = database if database is not None else ''
15363
+ '''
15364
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
15365
+ '''
13653
15366
  self.egress_filter = egress_filter if egress_filter is not None else ''
13654
15367
  '''
13655
15368
  A filter applied to the routing logic to pin datasource to nodes.
@@ -13659,6 +15372,9 @@ class SQLServer:
13659
15372
  True if the datasource is reachable and the credentials are valid.
13660
15373
  '''
13661
15374
  self.hostname = hostname if hostname is not None else ''
15375
+ '''
15376
+ The host to dial to initiate a connection from the egress node to this resource.
15377
+ '''
13662
15378
  self.id = id if id is not None else ''
13663
15379
  '''
13664
15380
  Unique identifier of the Resource.
@@ -13668,10 +15384,25 @@ class SQLServer:
13668
15384
  Unique human-readable name of the Resource.
13669
15385
  '''
13670
15386
  self.override_database = override_database if override_database is not None else False
15387
+ '''
15388
+ If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.
15389
+ '''
13671
15390
  self.password = password if password is not None else ''
15391
+ '''
15392
+ The password to authenticate with.
15393
+ '''
13672
15394
  self.port = port if port is not None else 0
15395
+ '''
15396
+ The port to dial to initiate a connection from the egress node to this resource.
15397
+ '''
13673
15398
  self.port_override = port_override if port_override is not None else 0
15399
+ '''
15400
+ The local port used by clients to connect to this resource.
15401
+ '''
13674
15402
  self.schema = schema if schema is not None else ''
15403
+ '''
15404
+ The Schema to use to direct initial requests.
15405
+ '''
13675
15406
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
13676
15407
  '''
13677
15408
  ID of the secret store containing credentials for this resource, if any.
@@ -13685,6 +15416,9 @@ class SQLServer:
13685
15416
  Tags is a map of key, value pairs.
13686
15417
  '''
13687
15418
  self.username = username if username is not None else ''
15419
+ '''
15420
+ The username to authenticate with.
15421
+ '''
13688
15422
 
13689
15423
  def __repr__(self):
13690
15424
  return '<sdm.SQLServer ' + \
@@ -13791,10 +15525,16 @@ class SQLServerAzureAD:
13791
15525
  ):
13792
15526
  self.bind_interface = bind_interface if bind_interface is not None else ''
13793
15527
  '''
13794
- Bind interface
15528
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
13795
15529
  '''
13796
15530
  self.client_id = client_id if client_id is not None else ''
15531
+ '''
15532
+ The Azure AD application (client) ID with which to authenticate.
15533
+ '''
13797
15534
  self.database = database if database is not None else ''
15535
+ '''
15536
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
15537
+ '''
13798
15538
  self.egress_filter = egress_filter if egress_filter is not None else ''
13799
15539
  '''
13800
15540
  A filter applied to the routing logic to pin datasource to nodes.
@@ -13804,6 +15544,9 @@ class SQLServerAzureAD:
13804
15544
  True if the datasource is reachable and the credentials are valid.
13805
15545
  '''
13806
15546
  self.hostname = hostname if hostname is not None else ''
15547
+ '''
15548
+ The host to dial to initiate a connection from the egress node to this resource.
15549
+ '''
13807
15550
  self.id = id if id is not None else ''
13808
15551
  '''
13809
15552
  Unique identifier of the Resource.
@@ -13813,10 +15556,25 @@ class SQLServerAzureAD:
13813
15556
  Unique human-readable name of the Resource.
13814
15557
  '''
13815
15558
  self.override_database = override_database if override_database is not None else False
15559
+ '''
15560
+ If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.
15561
+ '''
13816
15562
  self.port = port if port is not None else 0
15563
+ '''
15564
+ The port to dial to initiate a connection from the egress node to this resource.
15565
+ '''
13817
15566
  self.port_override = port_override if port_override is not None else 0
15567
+ '''
15568
+ The local port used by clients to connect to this resource.
15569
+ '''
13818
15570
  self.schema = schema if schema is not None else ''
15571
+ '''
15572
+ The Schema to use to direct initial requests.
15573
+ '''
13819
15574
  self.secret = secret if secret is not None else ''
15575
+ '''
15576
+ The Azure AD client secret (application password) with which to authenticate.
15577
+ '''
13820
15578
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
13821
15579
  '''
13822
15580
  ID of the secret store containing credentials for this resource, if any.
@@ -13830,6 +15588,9 @@ class SQLServerAzureAD:
13830
15588
  Tags is a map of key, value pairs.
13831
15589
  '''
13832
15590
  self.tenant_id = tenant_id if tenant_id is not None else ''
15591
+ '''
15592
+ The Azure AD directory (tenant) ID with which to authenticate.
15593
+ '''
13833
15594
 
13834
15595
  def __repr__(self):
13835
15596
  return '<sdm.SQLServerAzureAD ' + \
@@ -13943,9 +15704,12 @@ class SQLServerKerberosAD:
13943
15704
  ):
13944
15705
  self.bind_interface = bind_interface if bind_interface is not None else ''
13945
15706
  '''
13946
- Bind interface
15707
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
13947
15708
  '''
13948
15709
  self.database = database if database is not None else ''
15710
+ '''
15711
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
15712
+ '''
13949
15713
  self.egress_filter = egress_filter if egress_filter is not None else ''
13950
15714
  '''
13951
15715
  A filter applied to the routing logic to pin datasource to nodes.
@@ -13955,26 +15719,53 @@ class SQLServerKerberosAD:
13955
15719
  True if the datasource is reachable and the credentials are valid.
13956
15720
  '''
13957
15721
  self.hostname = hostname if hostname is not None else ''
15722
+ '''
15723
+ The host to dial to initiate a connection from the egress node to this resource.
15724
+ '''
13958
15725
  self.id = id if id is not None else ''
13959
15726
  '''
13960
15727
  Unique identifier of the Resource.
13961
15728
  '''
13962
15729
  self.keytab = keytab if keytab is not None else ''
15730
+ '''
15731
+ The keytab file in base64 format containing an entry with the principal name (username@realm) and key version number with which to authenticate.
15732
+ '''
13963
15733
  self.krb_config = krb_config if krb_config is not None else ''
15734
+ '''
15735
+ The Kerberos 5 configuration file (krb5.conf) specifying the Active Directory server (KDC) for the configured realm.
15736
+ '''
13964
15737
  self.name = name if name is not None else ''
13965
15738
  '''
13966
15739
  Unique human-readable name of the Resource.
13967
15740
  '''
13968
15741
  self.override_database = override_database if override_database is not None else False
15742
+ '''
15743
+ If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.
15744
+ '''
13969
15745
  self.port = port if port is not None else 0
15746
+ '''
15747
+ The port to dial to initiate a connection from the egress node to this resource.
15748
+ '''
13970
15749
  self.port_override = port_override if port_override is not None else 0
15750
+ '''
15751
+ The local port used by clients to connect to this resource.
15752
+ '''
13971
15753
  self.realm = realm if realm is not None else ''
15754
+ '''
15755
+ The Active Directory domain (realm) to which the configured username belongs.
15756
+ '''
13972
15757
  self.schema = schema if schema is not None else ''
15758
+ '''
15759
+ The Schema to use to direct initial requests.
15760
+ '''
13973
15761
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
13974
15762
  '''
13975
15763
  ID of the secret store containing credentials for this resource, if any.
13976
15764
  '''
13977
15765
  self.server_spn = server_spn if server_spn is not None else ''
15766
+ '''
15767
+ The Service Principal Name of the Microsoft SQL Server instance in Active Directory.
15768
+ '''
13978
15769
  self.subdomain = subdomain if subdomain is not None else ''
13979
15770
  '''
13980
15771
  Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)
@@ -13984,6 +15775,9 @@ class SQLServerKerberosAD:
13984
15775
  Tags is a map of key, value pairs.
13985
15776
  '''
13986
15777
  self.username = username if username is not None else ''
15778
+ '''
15779
+ The username to authenticate with.
15780
+ '''
13987
15781
 
13988
15782
  def __repr__(self):
13989
15783
  return '<sdm.SQLServerKerberosAD ' + \
@@ -14096,9 +15890,12 @@ class SSH:
14096
15890
  username=None,
14097
15891
  ):
14098
15892
  self.allow_deprecated_key_exchanges = allow_deprecated_key_exchanges if allow_deprecated_key_exchanges is not None else False
15893
+ '''
15894
+ Whether deprecated, insecure key exchanges are allowed for use to connect to the target ssh server.
15895
+ '''
14099
15896
  self.bind_interface = bind_interface if bind_interface is not None else ''
14100
15897
  '''
14101
- Bind interface
15898
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
14102
15899
  '''
14103
15900
  self.egress_filter = egress_filter if egress_filter is not None else ''
14104
15901
  '''
@@ -14109,19 +15906,37 @@ class SSH:
14109
15906
  True if the datasource is reachable and the credentials are valid.
14110
15907
  '''
14111
15908
  self.hostname = hostname if hostname is not None else ''
15909
+ '''
15910
+ The host to dial to initiate a connection from the egress node to this resource.
15911
+ '''
14112
15912
  self.id = id if id is not None else ''
14113
15913
  '''
14114
15914
  Unique identifier of the Resource.
14115
15915
  '''
14116
15916
  self.key_type = key_type if key_type is not None else ''
15917
+ '''
15918
+ The key type to use e.g. rsa-2048 or ed25519
15919
+ '''
14117
15920
  self.name = name if name is not None else ''
14118
15921
  '''
14119
15922
  Unique human-readable name of the Resource.
14120
15923
  '''
14121
15924
  self.port = port if port is not None else 0
15925
+ '''
15926
+ The port to dial to initiate a connection from the egress node to this resource.
15927
+ '''
14122
15928
  self.port_forwarding = port_forwarding if port_forwarding is not None else False
15929
+ '''
15930
+ Whether port forwarding is allowed through this server.
15931
+ '''
14123
15932
  self.port_override = port_override if port_override is not None else 0
15933
+ '''
15934
+ The local port used by clients to connect to this resource.
15935
+ '''
14124
15936
  self.public_key = public_key if public_key is not None else ''
15937
+ '''
15938
+ The public key to append to a server's authorized keys. This will be generated after resource creation.
15939
+ '''
14125
15940
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
14126
15941
  '''
14127
15942
  ID of the secret store containing credentials for this resource, if any.
@@ -14135,6 +15950,9 @@ class SSH:
14135
15950
  Tags is a map of key, value pairs.
14136
15951
  '''
14137
15952
  self.username = username if username is not None else ''
15953
+ '''
15954
+ The username to authenticate with.
15955
+ '''
14138
15956
 
14139
15957
  def __repr__(self):
14140
15958
  return '<sdm.SSH ' + \
@@ -14242,9 +16060,12 @@ class SSHCert:
14242
16060
  username=None,
14243
16061
  ):
14244
16062
  self.allow_deprecated_key_exchanges = allow_deprecated_key_exchanges if allow_deprecated_key_exchanges is not None else False
16063
+ '''
16064
+ Whether deprecated, insecure key exchanges are allowed for use to connect to the target ssh server.
16065
+ '''
14245
16066
  self.bind_interface = bind_interface if bind_interface is not None else ''
14246
16067
  '''
14247
- Bind interface
16068
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
14248
16069
  '''
14249
16070
  self.egress_filter = egress_filter if egress_filter is not None else ''
14250
16071
  '''
@@ -14255,20 +16076,41 @@ class SSHCert:
14255
16076
  True if the datasource is reachable and the credentials are valid.
14256
16077
  '''
14257
16078
  self.hostname = hostname if hostname is not None else ''
16079
+ '''
16080
+ The host to dial to initiate a connection from the egress node to this resource.
16081
+ '''
14258
16082
  self.id = id if id is not None else ''
14259
16083
  '''
14260
16084
  Unique identifier of the Resource.
14261
16085
  '''
14262
16086
  self.key_type = key_type if key_type is not None else ''
16087
+ '''
16088
+ The key type to use e.g. rsa-2048 or ed25519
16089
+ '''
14263
16090
  self.name = name if name is not None else ''
14264
16091
  '''
14265
16092
  Unique human-readable name of the Resource.
14266
16093
  '''
14267
16094
  self.port = port if port is not None else 0
16095
+ '''
16096
+ The port to dial to initiate a connection from the egress node to this resource.
16097
+ '''
14268
16098
  self.port_forwarding = port_forwarding if port_forwarding is not None else False
16099
+ '''
16100
+ Whether port forwarding is allowed through this server.
16101
+ '''
14269
16102
  self.port_override = port_override if port_override is not None else 0
16103
+ '''
16104
+ The local port used by clients to connect to this resource.
16105
+ '''
14270
16106
  self.remote_identity_group_id = remote_identity_group_id if remote_identity_group_id is not None else ''
16107
+ '''
16108
+ The ID of the remote identity group to use for remote identity connections.
16109
+ '''
14271
16110
  self.remote_identity_healthcheck_username = remote_identity_healthcheck_username if remote_identity_healthcheck_username is not None else ''
16111
+ '''
16112
+ The username to use for healthchecks, when clients otherwise connect with their own remote identity username.
16113
+ '''
14272
16114
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
14273
16115
  '''
14274
16116
  ID of the secret store containing credentials for this resource, if any.
@@ -14282,6 +16124,9 @@ class SSHCert:
14282
16124
  Tags is a map of key, value pairs.
14283
16125
  '''
14284
16126
  self.username = username if username is not None else ''
16127
+ '''
16128
+ The username to authenticate with.
16129
+ '''
14285
16130
 
14286
16131
  def __repr__(self):
14287
16132
  return '<sdm.SSHCert ' + \
@@ -14390,9 +16235,12 @@ class SSHCustomerKey:
14390
16235
  username=None,
14391
16236
  ):
14392
16237
  self.allow_deprecated_key_exchanges = allow_deprecated_key_exchanges if allow_deprecated_key_exchanges is not None else False
16238
+ '''
16239
+ Whether deprecated, insecure key exchanges are allowed for use to connect to the target ssh server.
16240
+ '''
14393
16241
  self.bind_interface = bind_interface if bind_interface is not None else ''
14394
16242
  '''
14395
- Bind interface
16243
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
14396
16244
  '''
14397
16245
  self.egress_filter = egress_filter if egress_filter is not None else ''
14398
16246
  '''
@@ -14403,6 +16251,9 @@ class SSHCustomerKey:
14403
16251
  True if the datasource is reachable and the credentials are valid.
14404
16252
  '''
14405
16253
  self.hostname = hostname if hostname is not None else ''
16254
+ '''
16255
+ The host to dial to initiate a connection from the egress node to this resource.
16256
+ '''
14406
16257
  self.id = id if id is not None else ''
14407
16258
  '''
14408
16259
  Unique identifier of the Resource.
@@ -14412,9 +16263,21 @@ class SSHCustomerKey:
14412
16263
  Unique human-readable name of the Resource.
14413
16264
  '''
14414
16265
  self.port = port if port is not None else 0
16266
+ '''
16267
+ The port to dial to initiate a connection from the egress node to this resource.
16268
+ '''
14415
16269
  self.port_forwarding = port_forwarding if port_forwarding is not None else False
16270
+ '''
16271
+ Whether port forwarding is allowed through this server.
16272
+ '''
14416
16273
  self.port_override = port_override if port_override is not None else 0
16274
+ '''
16275
+ The local port used by clients to connect to this resource.
16276
+ '''
14417
16277
  self.private_key = private_key if private_key is not None else ''
16278
+ '''
16279
+ The private key used to authenticate with the server.
16280
+ '''
14418
16281
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
14419
16282
  '''
14420
16283
  ID of the secret store containing credentials for this resource, if any.
@@ -14428,6 +16291,9 @@ class SSHCustomerKey:
14428
16291
  Tags is a map of key, value pairs.
14429
16292
  '''
14430
16293
  self.username = username if username is not None else ''
16294
+ '''
16295
+ The username to authenticate with.
16296
+ '''
14431
16297
 
14432
16298
  def __repr__(self):
14433
16299
  return '<sdm.SSHCustomerKey ' + \
@@ -14857,9 +16723,12 @@ class SingleStore:
14857
16723
  ):
14858
16724
  self.bind_interface = bind_interface if bind_interface is not None else ''
14859
16725
  '''
14860
- Bind interface
16726
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
14861
16727
  '''
14862
16728
  self.database = database if database is not None else ''
16729
+ '''
16730
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
16731
+ '''
14863
16732
  self.egress_filter = egress_filter if egress_filter is not None else ''
14864
16733
  '''
14865
16734
  A filter applied to the routing logic to pin datasource to nodes.
@@ -14869,6 +16738,9 @@ class SingleStore:
14869
16738
  True if the datasource is reachable and the credentials are valid.
14870
16739
  '''
14871
16740
  self.hostname = hostname if hostname is not None else ''
16741
+ '''
16742
+ The host to dial to initiate a connection from the egress node to this resource.
16743
+ '''
14872
16744
  self.id = id if id is not None else ''
14873
16745
  '''
14874
16746
  Unique identifier of the Resource.
@@ -14878,9 +16750,21 @@ class SingleStore:
14878
16750
  Unique human-readable name of the Resource.
14879
16751
  '''
14880
16752
  self.password = password if password is not None else ''
16753
+ '''
16754
+ The password to authenticate with.
16755
+ '''
14881
16756
  self.port = port if port is not None else 0
16757
+ '''
16758
+ The port to dial to initiate a connection from the egress node to this resource.
16759
+ '''
14882
16760
  self.port_override = port_override if port_override is not None else 0
16761
+ '''
16762
+ The local port used by clients to connect to this resource.
16763
+ '''
14883
16764
  self.require_native_auth = require_native_auth if require_native_auth is not None else False
16765
+ '''
16766
+ Whether native auth (mysql_native_password) is used for all connections (for backwards compatibility)
16767
+ '''
14884
16768
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
14885
16769
  '''
14886
16770
  ID of the secret store containing credentials for this resource, if any.
@@ -14894,7 +16778,13 @@ class SingleStore:
14894
16778
  Tags is a map of key, value pairs.
14895
16779
  '''
14896
16780
  self.use_azure_single_server_usernames = use_azure_single_server_usernames if use_azure_single_server_usernames is not None else False
16781
+ '''
16782
+ If true, appends the hostname to the username when hitting a database.azure.com address
16783
+ '''
14897
16784
  self.username = username if username is not None else ''
16785
+ '''
16786
+ The username to authenticate with.
16787
+ '''
14898
16788
 
14899
16789
  def __repr__(self):
14900
16790
  return '<sdm.SingleStore ' + \
@@ -14997,9 +16887,12 @@ class Snowflake:
14997
16887
  ):
14998
16888
  self.bind_interface = bind_interface if bind_interface is not None else ''
14999
16889
  '''
15000
- Bind interface
16890
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
15001
16891
  '''
15002
16892
  self.database = database if database is not None else ''
16893
+ '''
16894
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
16895
+ '''
15003
16896
  self.egress_filter = egress_filter if egress_filter is not None else ''
15004
16897
  '''
15005
16898
  A filter applied to the routing logic to pin datasource to nodes.
@@ -15009,6 +16902,9 @@ class Snowflake:
15009
16902
  True if the datasource is reachable and the credentials are valid.
15010
16903
  '''
15011
16904
  self.hostname = hostname if hostname is not None else ''
16905
+ '''
16906
+ The host to dial to initiate a connection from the egress node to this resource.
16907
+ '''
15012
16908
  self.id = id if id is not None else ''
15013
16909
  '''
15014
16910
  Unique identifier of the Resource.
@@ -15018,8 +16914,17 @@ class Snowflake:
15018
16914
  Unique human-readable name of the Resource.
15019
16915
  '''
15020
16916
  self.password = password if password is not None else ''
16917
+ '''
16918
+ The password to authenticate with.
16919
+ '''
15021
16920
  self.port_override = port_override if port_override is not None else 0
16921
+ '''
16922
+ The local port used by clients to connect to this resource.
16923
+ '''
15022
16924
  self.schema = schema if schema is not None else ''
16925
+ '''
16926
+ The schema to provide on authentication.
16927
+ '''
15023
16928
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
15024
16929
  '''
15025
16930
  ID of the secret store containing credentials for this resource, if any.
@@ -15033,6 +16938,9 @@ class Snowflake:
15033
16938
  Tags is a map of key, value pairs.
15034
16939
  '''
15035
16940
  self.username = username if username is not None else ''
16941
+ '''
16942
+ The username to authenticate with.
16943
+ '''
15036
16944
 
15037
16945
  def __repr__(self):
15038
16946
  return '<sdm.Snowflake ' + \
@@ -15125,13 +17033,16 @@ class Snowsight:
15125
17033
  ):
15126
17034
  self.bind_interface = bind_interface if bind_interface is not None else ''
15127
17035
  '''
15128
- Bind interface
17036
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
15129
17037
  '''
15130
17038
  self.egress_filter = egress_filter if egress_filter is not None else ''
15131
17039
  '''
15132
17040
  A filter applied to the routing logic to pin datasource to nodes.
15133
17041
  '''
15134
17042
  self.healthcheck_username = healthcheck_username if healthcheck_username is not None else ''
17043
+ '''
17044
+ The StrongDM user email to use for healthchecks.
17045
+ '''
15135
17046
  self.healthy = healthy if healthy is not None else False
15136
17047
  '''
15137
17048
  True if the datasource is reachable and the credentials are valid.
@@ -15145,12 +17056,21 @@ class Snowsight:
15145
17056
  Unique human-readable name of the Resource.
15146
17057
  '''
15147
17058
  self.port_override = port_override if port_override is not None else 0
17059
+ '''
17060
+ The local port used by clients to connect to this resource.
17061
+ '''
15148
17062
  self.samlmetadata = samlmetadata if samlmetadata is not None else ''
17063
+ '''
17064
+ The Metadata for your snowflake IDP integration
17065
+ '''
15149
17066
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
15150
17067
  '''
15151
17068
  ID of the secret store containing credentials for this resource, if any.
15152
17069
  '''
15153
17070
  self.subdomain = subdomain if subdomain is not None else ''
17071
+ '''
17072
+ Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)
17073
+ '''
15154
17074
  self.tags = tags if tags is not None else _porcelain_zero_value_tags()
15155
17075
  '''
15156
17076
  Tags is a map of key, value pairs.
@@ -15238,7 +17158,7 @@ class Sybase:
15238
17158
  ):
15239
17159
  self.bind_interface = bind_interface if bind_interface is not None else ''
15240
17160
  '''
15241
- Bind interface
17161
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
15242
17162
  '''
15243
17163
  self.egress_filter = egress_filter if egress_filter is not None else ''
15244
17164
  '''
@@ -15249,6 +17169,9 @@ class Sybase:
15249
17169
  True if the datasource is reachable and the credentials are valid.
15250
17170
  '''
15251
17171
  self.hostname = hostname if hostname is not None else ''
17172
+ '''
17173
+ The host to dial to initiate a connection from the egress node to this resource.
17174
+ '''
15252
17175
  self.id = id if id is not None else ''
15253
17176
  '''
15254
17177
  Unique identifier of the Resource.
@@ -15258,8 +17181,17 @@ class Sybase:
15258
17181
  Unique human-readable name of the Resource.
15259
17182
  '''
15260
17183
  self.password = password if password is not None else ''
17184
+ '''
17185
+ The password to authenticate with.
17186
+ '''
15261
17187
  self.port = port if port is not None else 0
17188
+ '''
17189
+ The port to dial to initiate a connection from the egress node to this resource.
17190
+ '''
15262
17191
  self.port_override = port_override if port_override is not None else 0
17192
+ '''
17193
+ The local port used by clients to connect to this resource.
17194
+ '''
15263
17195
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
15264
17196
  '''
15265
17197
  ID of the secret store containing credentials for this resource, if any.
@@ -15273,6 +17205,9 @@ class Sybase:
15273
17205
  Tags is a map of key, value pairs.
15274
17206
  '''
15275
17207
  self.username = username if username is not None else ''
17208
+ '''
17209
+ The username to authenticate with.
17210
+ '''
15276
17211
 
15277
17212
  def __repr__(self):
15278
17213
  return '<sdm.Sybase ' + \
@@ -15362,7 +17297,7 @@ class SybaseIQ:
15362
17297
  ):
15363
17298
  self.bind_interface = bind_interface if bind_interface is not None else ''
15364
17299
  '''
15365
- Bind interface
17300
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
15366
17301
  '''
15367
17302
  self.egress_filter = egress_filter if egress_filter is not None else ''
15368
17303
  '''
@@ -15373,6 +17308,9 @@ class SybaseIQ:
15373
17308
  True if the datasource is reachable and the credentials are valid.
15374
17309
  '''
15375
17310
  self.hostname = hostname if hostname is not None else ''
17311
+ '''
17312
+ The host to dial to initiate a connection from the egress node to this resource.
17313
+ '''
15376
17314
  self.id = id if id is not None else ''
15377
17315
  '''
15378
17316
  Unique identifier of the Resource.
@@ -15382,8 +17320,17 @@ class SybaseIQ:
15382
17320
  Unique human-readable name of the Resource.
15383
17321
  '''
15384
17322
  self.password = password if password is not None else ''
17323
+ '''
17324
+ The password to authenticate with.
17325
+ '''
15385
17326
  self.port = port if port is not None else 0
17327
+ '''
17328
+ The port to dial to initiate a connection from the egress node to this resource.
17329
+ '''
15386
17330
  self.port_override = port_override if port_override is not None else 0
17331
+ '''
17332
+ The local port used by clients to connect to this resource.
17333
+ '''
15387
17334
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
15388
17335
  '''
15389
17336
  ID of the secret store containing credentials for this resource, if any.
@@ -15397,6 +17344,9 @@ class SybaseIQ:
15397
17344
  Tags is a map of key, value pairs.
15398
17345
  '''
15399
17346
  self.username = username if username is not None else ''
17347
+ '''
17348
+ The username to authenticate with.
17349
+ '''
15400
17350
 
15401
17351
  def __repr__(self):
15402
17352
  return '<sdm.SybaseIQ ' + \
@@ -15463,7 +17413,13 @@ class Tag:
15463
17413
  value=None,
15464
17414
  ):
15465
17415
  self.name = name if name is not None else ''
17416
+ '''
17417
+ The name or key of this tag. Each name can only refer to one value on a tagged entity.
17418
+ '''
15466
17419
  self.value = value if value is not None else ''
17420
+ '''
17421
+ The value of this tag.
17422
+ '''
15467
17423
 
15468
17424
  def __repr__(self):
15469
17425
  return '<sdm.Tag ' + \
@@ -15520,7 +17476,7 @@ class Teradata:
15520
17476
  ):
15521
17477
  self.bind_interface = bind_interface if bind_interface is not None else ''
15522
17478
  '''
15523
- Bind interface
17479
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
15524
17480
  '''
15525
17481
  self.egress_filter = egress_filter if egress_filter is not None else ''
15526
17482
  '''
@@ -15531,6 +17487,9 @@ class Teradata:
15531
17487
  True if the datasource is reachable and the credentials are valid.
15532
17488
  '''
15533
17489
  self.hostname = hostname if hostname is not None else ''
17490
+ '''
17491
+ The host to dial to initiate a connection from the egress node to this resource.
17492
+ '''
15534
17493
  self.id = id if id is not None else ''
15535
17494
  '''
15536
17495
  Unique identifier of the Resource.
@@ -15540,8 +17499,17 @@ class Teradata:
15540
17499
  Unique human-readable name of the Resource.
15541
17500
  '''
15542
17501
  self.password = password if password is not None else ''
17502
+ '''
17503
+ The password to authenticate with.
17504
+ '''
15543
17505
  self.port = port if port is not None else 0
17506
+ '''
17507
+ The port to dial to initiate a connection from the egress node to this resource.
17508
+ '''
15544
17509
  self.port_override = port_override if port_override is not None else 0
17510
+ '''
17511
+ The local port used by clients to connect to this resource.
17512
+ '''
15545
17513
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
15546
17514
  '''
15547
17515
  ID of the secret store containing credentials for this resource, if any.
@@ -15555,6 +17523,9 @@ class Teradata:
15555
17523
  Tags is a map of key, value pairs.
15556
17524
  '''
15557
17525
  self.username = username if username is not None else ''
17526
+ '''
17527
+ The username to authenticate with.
17528
+ '''
15558
17529
 
15559
17530
  def __repr__(self):
15560
17531
  return '<sdm.Teradata ' + \
@@ -15650,9 +17621,12 @@ class Trino:
15650
17621
  ):
15651
17622
  self.bind_interface = bind_interface if bind_interface is not None else ''
15652
17623
  '''
15653
- Bind interface
17624
+ The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.
15654
17625
  '''
15655
17626
  self.database = database if database is not None else ''
17627
+ '''
17628
+ The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.
17629
+ '''
15656
17630
  self.egress_filter = egress_filter if egress_filter is not None else ''
15657
17631
  '''
15658
17632
  A filter applied to the routing logic to pin datasource to nodes.
@@ -15662,6 +17636,9 @@ class Trino:
15662
17636
  True if the datasource is reachable and the credentials are valid.
15663
17637
  '''
15664
17638
  self.hostname = hostname if hostname is not None else ''
17639
+ '''
17640
+ The host to dial to initiate a connection from the egress node to this resource.
17641
+ '''
15665
17642
  self.id = id if id is not None else ''
15666
17643
  '''
15667
17644
  Unique identifier of the Resource.
@@ -15671,8 +17648,17 @@ class Trino:
15671
17648
  Unique human-readable name of the Resource.
15672
17649
  '''
15673
17650
  self.password = password if password is not None else ''
17651
+ '''
17652
+ The password to authenticate with.
17653
+ '''
15674
17654
  self.port = port if port is not None else 0
17655
+ '''
17656
+ The port to dial to initiate a connection from the egress node to this resource.
17657
+ '''
15675
17658
  self.port_override = port_override if port_override is not None else 0
17659
+ '''
17660
+ The local port used by clients to connect to this resource.
17661
+ '''
15676
17662
  self.secret_store_id = secret_store_id if secret_store_id is not None else ''
15677
17663
  '''
15678
17664
  ID of the secret store containing credentials for this resource, if any.
@@ -15686,6 +17672,9 @@ class Trino:
15686
17672
  Tags is a map of key, value pairs.
15687
17673
  '''
15688
17674
  self.username = username if username is not None else ''
17675
+ '''
17676
+ The username to authenticate with.
17677
+ '''
15689
17678
 
15690
17679
  def __repr__(self):
15691
17680
  return '<sdm.Trino ' + \
@@ -15897,7 +17886,13 @@ class VaultAppRoleStore:
15897
17886
  Unique human-readable name of the SecretStore.
15898
17887
  '''
15899
17888
  self.namespace = namespace if namespace is not None else ''
17889
+ '''
17890
+ The namespace to make requests within
17891
+ '''
15900
17892
  self.server_address = server_address if server_address is not None else ''
17893
+ '''
17894
+ The URL of the Vault to target
17895
+ '''
15901
17896
  self.tags = tags if tags is not None else _porcelain_zero_value_tags()
15902
17897
  '''
15903
17898
  Tags is a map of key, value pairs.
@@ -15956,8 +17951,17 @@ class VaultTLSStore:
15956
17951
  tags=None,
15957
17952
  ):
15958
17953
  self.ca_cert_path = ca_cert_path if ca_cert_path is not None else ''
17954
+ '''
17955
+ A path to a CA file accessible by a Node
17956
+ '''
15959
17957
  self.client_cert_path = client_cert_path if client_cert_path is not None else ''
17958
+ '''
17959
+ A path to a client certificate file accessible by a Node
17960
+ '''
15960
17961
  self.client_key_path = client_key_path if client_key_path is not None else ''
17962
+ '''
17963
+ A path to a client key file accessible by a Node
17964
+ '''
15961
17965
  self.id = id if id is not None else ''
15962
17966
  '''
15963
17967
  Unique identifier of the SecretStore.
@@ -15967,7 +17971,13 @@ class VaultTLSStore:
15967
17971
  Unique human-readable name of the SecretStore.
15968
17972
  '''
15969
17973
  self.namespace = namespace if namespace is not None else ''
17974
+ '''
17975
+ The namespace to make requests within
17976
+ '''
15970
17977
  self.server_address = server_address if server_address is not None else ''
17978
+ '''
17979
+ The URL of the Vault to target
17980
+ '''
15971
17981
  self.tags = tags if tags is not None else _porcelain_zero_value_tags()
15972
17982
  '''
15973
17983
  Tags is a map of key, value pairs.
@@ -16037,7 +18047,13 @@ class VaultTokenStore:
16037
18047
  Unique human-readable name of the SecretStore.
16038
18048
  '''
16039
18049
  self.namespace = namespace if namespace is not None else ''
18050
+ '''
18051
+ The namespace to make requests within
18052
+ '''
16040
18053
  self.server_address = server_address if server_address is not None else ''
18054
+ '''
18055
+ The URL of the Vault to target
18056
+ '''
16041
18057
  self.tags = tags if tags is not None else _porcelain_zero_value_tags()
16042
18058
  '''
16043
18059
  Tags is a map of key, value pairs.