pulumi-snowflake 0.50.3a1710160126__py3-none-any.whl → 1.2.0a1736849992__py3-none-any.whl

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.

Potentially problematic release.


This version of pulumi-snowflake might be problematic. Click here for more details.

Files changed (182) hide show
  1. pulumi_snowflake/__init__.py +224 -172
  2. pulumi_snowflake/_inputs.py +52857 -1665
  3. pulumi_snowflake/_utilities.py +41 -5
  4. pulumi_snowflake/account.py +188 -218
  5. pulumi_snowflake/account_authentication_policy_attachment.py +149 -0
  6. pulumi_snowflake/account_parameter.py +21 -48
  7. pulumi_snowflake/account_password_policy_attachment.py +7 -32
  8. pulumi_snowflake/account_role.py +250 -0
  9. pulumi_snowflake/alert.py +38 -47
  10. pulumi_snowflake/api_authentication_integration_with_authorization_code_grant.py +704 -0
  11. pulumi_snowflake/api_authentication_integration_with_client_credentials.py +657 -0
  12. pulumi_snowflake/api_authentication_integration_with_jwt_bearer.py +692 -0
  13. pulumi_snowflake/api_integration.py +33 -52
  14. pulumi_snowflake/authentication_policy.py +622 -0
  15. pulumi_snowflake/config/__init__.pyi +76 -99
  16. pulumi_snowflake/config/outputs.py +5 -0
  17. pulumi_snowflake/config/vars.py +93 -124
  18. pulumi_snowflake/cortex_search_service.py +596 -0
  19. pulumi_snowflake/database.py +819 -213
  20. pulumi_snowflake/database_role.py +81 -44
  21. pulumi_snowflake/dynamic_table.py +42 -49
  22. pulumi_snowflake/email_notification_integration.py +33 -28
  23. pulumi_snowflake/{unsafe_execute.py → execute.py} +36 -39
  24. pulumi_snowflake/external_function.py +54 -75
  25. pulumi_snowflake/external_oauth_integration.py +593 -542
  26. pulumi_snowflake/external_table.py +67 -90
  27. pulumi_snowflake/external_volume.py +382 -0
  28. pulumi_snowflake/failover_group.py +57 -98
  29. pulumi_snowflake/file_format.py +33 -28
  30. pulumi_snowflake/function_java.py +1211 -0
  31. pulumi_snowflake/function_javascript.py +882 -0
  32. pulumi_snowflake/function_python.py +1212 -0
  33. pulumi_snowflake/function_scala.py +1212 -0
  34. pulumi_snowflake/function_sql.py +835 -0
  35. pulumi_snowflake/get_account_roles.py +129 -0
  36. pulumi_snowflake/get_accounts.py +53 -22
  37. pulumi_snowflake/get_alerts.py +22 -9
  38. pulumi_snowflake/get_connections.py +109 -0
  39. pulumi_snowflake/get_cortex_search_services.py +216 -0
  40. pulumi_snowflake/get_current_account.py +24 -13
  41. pulumi_snowflake/get_current_role.py +14 -7
  42. pulumi_snowflake/get_database.py +25 -9
  43. pulumi_snowflake/get_database_role.py +162 -0
  44. pulumi_snowflake/get_database_roles.py +79 -47
  45. pulumi_snowflake/get_databases.py +91 -73
  46. pulumi_snowflake/get_dynamic_tables.py +36 -19
  47. pulumi_snowflake/get_external_functions.py +28 -9
  48. pulumi_snowflake/get_external_tables.py +28 -9
  49. pulumi_snowflake/get_failover_groups.py +18 -7
  50. pulumi_snowflake/get_file_formats.py +28 -9
  51. pulumi_snowflake/get_functions.py +28 -9
  52. pulumi_snowflake/get_grants.py +207 -84
  53. pulumi_snowflake/get_masking_policies.py +91 -51
  54. pulumi_snowflake/get_materialized_views.py +28 -9
  55. pulumi_snowflake/get_network_policies.py +129 -0
  56. pulumi_snowflake/get_parameters.py +38 -15
  57. pulumi_snowflake/get_pipes.py +28 -9
  58. pulumi_snowflake/get_procedures.py +28 -9
  59. pulumi_snowflake/get_resource_monitors.py +37 -24
  60. pulumi_snowflake/get_row_access_policies.py +91 -51
  61. pulumi_snowflake/get_schemas.py +145 -41
  62. pulumi_snowflake/get_secrets.py +200 -0
  63. pulumi_snowflake/get_security_integrations.py +129 -0
  64. pulumi_snowflake/get_sequences.py +28 -9
  65. pulumi_snowflake/get_shares.py +18 -9
  66. pulumi_snowflake/get_stages.py +28 -9
  67. pulumi_snowflake/get_storage_integrations.py +16 -9
  68. pulumi_snowflake/get_streamlits.py +170 -0
  69. pulumi_snowflake/get_streams.py +114 -54
  70. pulumi_snowflake/get_system_generate_scim_access_token.py +18 -9
  71. pulumi_snowflake/get_system_get_aws_sns_iam_policy.py +32 -7
  72. pulumi_snowflake/get_system_get_private_link_config.py +120 -5
  73. pulumi_snowflake/get_system_get_snowflake_platform_info.py +15 -7
  74. pulumi_snowflake/get_tables.py +28 -9
  75. pulumi_snowflake/get_tags.py +130 -0
  76. pulumi_snowflake/get_tasks.py +134 -54
  77. pulumi_snowflake/get_users.py +116 -44
  78. pulumi_snowflake/get_views.py +114 -54
  79. pulumi_snowflake/get_warehouses.py +79 -26
  80. pulumi_snowflake/grant_account_role.py +28 -75
  81. pulumi_snowflake/grant_application_role.py +257 -0
  82. pulumi_snowflake/grant_database_role.py +35 -94
  83. pulumi_snowflake/grant_ownership.py +382 -0
  84. pulumi_snowflake/grant_privileges_to_account_role.py +42 -78
  85. pulumi_snowflake/grant_privileges_to_database_role.py +37 -383
  86. pulumi_snowflake/grant_privileges_to_share.py +96 -44
  87. pulumi_snowflake/legacy_service_user.py +3670 -0
  88. pulumi_snowflake/managed_account.py +40 -11
  89. pulumi_snowflake/masking_policy.py +213 -310
  90. pulumi_snowflake/materialized_view.py +62 -71
  91. pulumi_snowflake/network_policy.py +217 -61
  92. pulumi_snowflake/network_policy_attachment.py +5 -34
  93. pulumi_snowflake/network_rule.py +473 -0
  94. pulumi_snowflake/notification_integration.py +49 -84
  95. pulumi_snowflake/oauth_integration_for_custom_clients.py +906 -0
  96. pulumi_snowflake/{oauth_integration.py → oauth_integration_for_partner_applications.py} +191 -192
  97. pulumi_snowflake/object_parameter.py +10 -101
  98. pulumi_snowflake/outputs.py +49200 -2928
  99. pulumi_snowflake/password_policy.py +41 -28
  100. pulumi_snowflake/pipe.py +33 -4
  101. pulumi_snowflake/primary_connection.py +330 -0
  102. pulumi_snowflake/procedure_java.py +1273 -0
  103. pulumi_snowflake/procedure_javascript.py +895 -0
  104. pulumi_snowflake/procedure_python.py +1226 -0
  105. pulumi_snowflake/procedure_scala.py +1273 -0
  106. pulumi_snowflake/procedure_sql.py +895 -0
  107. pulumi_snowflake/provider.py +378 -613
  108. pulumi_snowflake/pulumi-plugin.json +2 -1
  109. pulumi_snowflake/resource_monitor.py +118 -327
  110. pulumi_snowflake/row_access_policy.py +200 -149
  111. pulumi_snowflake/{saml_integration.py → saml2_integration.py} +356 -299
  112. pulumi_snowflake/schema.py +949 -178
  113. pulumi_snowflake/scim_integration.py +286 -109
  114. pulumi_snowflake/secondary_connection.py +339 -0
  115. pulumi_snowflake/secondary_database.py +1080 -0
  116. pulumi_snowflake/secret_with_authorization_code_grant.py +548 -0
  117. pulumi_snowflake/secret_with_basic_authentication.py +500 -0
  118. pulumi_snowflake/secret_with_client_credentials.py +511 -0
  119. pulumi_snowflake/secret_with_generic_string.py +452 -0
  120. pulumi_snowflake/sequence.py +9 -34
  121. pulumi_snowflake/service_user.py +3585 -0
  122. pulumi_snowflake/share.py +33 -28
  123. pulumi_snowflake/shared_database.py +939 -0
  124. pulumi_snowflake/stage.py +95 -84
  125. pulumi_snowflake/storage_integration.py +46 -4
  126. pulumi_snowflake/stream_on_directory_table.py +517 -0
  127. pulumi_snowflake/stream_on_external_table.py +632 -0
  128. pulumi_snowflake/stream_on_table.py +666 -0
  129. pulumi_snowflake/stream_on_view.py +666 -0
  130. pulumi_snowflake/streamlit.py +671 -0
  131. pulumi_snowflake/table.py +86 -97
  132. pulumi_snowflake/table_column_masking_policy_application.py +7 -14
  133. pulumi_snowflake/table_constraint.py +29 -172
  134. pulumi_snowflake/tag.py +142 -74
  135. pulumi_snowflake/tag_association.py +40 -215
  136. pulumi_snowflake/task.py +3048 -418
  137. pulumi_snowflake/user.py +3351 -384
  138. pulumi_snowflake/user_authentication_policy_attachment.py +197 -0
  139. pulumi_snowflake/user_password_policy_attachment.py +5 -4
  140. pulumi_snowflake/user_public_keys.py +5 -0
  141. pulumi_snowflake/view.py +466 -215
  142. pulumi_snowflake/warehouse.py +184 -168
  143. {pulumi_snowflake-0.50.3a1710160126.dist-info → pulumi_snowflake-1.2.0a1736849992.dist-info}/METADATA +7 -6
  144. pulumi_snowflake-1.2.0a1736849992.dist-info/RECORD +148 -0
  145. {pulumi_snowflake-0.50.3a1710160126.dist-info → pulumi_snowflake-1.2.0a1736849992.dist-info}/WHEEL +1 -1
  146. pulumi_snowflake/account_grant.py +0 -343
  147. pulumi_snowflake/database_grant.py +0 -495
  148. pulumi_snowflake/external_table_grant.py +0 -690
  149. pulumi_snowflake/failover_group_grant.py +0 -388
  150. pulumi_snowflake/file_format_grant.py +0 -635
  151. pulumi_snowflake/function.py +0 -872
  152. pulumi_snowflake/function_grant.py +0 -745
  153. pulumi_snowflake/get_role.py +0 -121
  154. pulumi_snowflake/get_roles.py +0 -120
  155. pulumi_snowflake/grant_privileges_to_role.py +0 -825
  156. pulumi_snowflake/integration_grant.py +0 -440
  157. pulumi_snowflake/masking_policy_grant.py +0 -542
  158. pulumi_snowflake/materialized_view_grant.py +0 -689
  159. pulumi_snowflake/pipe_grant.py +0 -587
  160. pulumi_snowflake/procedure.py +0 -887
  161. pulumi_snowflake/procedure_grant.py +0 -745
  162. pulumi_snowflake/resource_monitor_grant.py +0 -387
  163. pulumi_snowflake/role.py +0 -273
  164. pulumi_snowflake/role_grants.py +0 -352
  165. pulumi_snowflake/role_ownership_grant.py +0 -338
  166. pulumi_snowflake/row_access_policy_grant.py +0 -540
  167. pulumi_snowflake/schema_grant.py +0 -647
  168. pulumi_snowflake/sequence_grant.py +0 -635
  169. pulumi_snowflake/session_parameter.py +0 -332
  170. pulumi_snowflake/stage_grant.py +0 -635
  171. pulumi_snowflake/stream.py +0 -614
  172. pulumi_snowflake/stream_grant.py +0 -635
  173. pulumi_snowflake/table_grant.py +0 -677
  174. pulumi_snowflake/tag_grant.py +0 -532
  175. pulumi_snowflake/tag_masking_policy_association.py +0 -210
  176. pulumi_snowflake/task_grant.py +0 -635
  177. pulumi_snowflake/user_grant.py +0 -394
  178. pulumi_snowflake/user_ownership_grant.py +0 -286
  179. pulumi_snowflake/view_grant.py +0 -705
  180. pulumi_snowflake/warehouse_grant.py +0 -440
  181. pulumi_snowflake-0.50.3a1710160126.dist-info/RECORD +0 -136
  182. {pulumi_snowflake-0.50.3a1710160126.dist-info → pulumi_snowflake-1.2.0a1736849992.dist-info}/top_level.txt +0 -0
@@ -4,11 +4,17 @@
4
4
 
5
5
  import copy
6
6
  import warnings
7
+ import sys
7
8
  import pulumi
8
9
  import pulumi.runtime
9
10
  from typing import Any, Mapping, Optional, Sequence, Union, overload
11
+ if sys.version_info >= (3, 11):
12
+ from typing import NotRequired, TypedDict, TypeAlias
13
+ else:
14
+ from typing_extensions import NotRequired, TypedDict, TypeAlias
10
15
  from . import _utilities
11
16
  from . import outputs
17
+ from ._inputs import *
12
18
 
13
19
  __all__ = [
14
20
  'GetUsersResult',
@@ -22,16 +28,28 @@ class GetUsersResult:
22
28
  """
23
29
  A collection of values returned by getUsers.
24
30
  """
25
- def __init__(__self__, id=None, pattern=None, users=None):
31
+ def __init__(__self__, id=None, like=None, limit=None, starts_with=None, users=None, with_describe=None, with_parameters=None):
26
32
  if id and not isinstance(id, str):
27
33
  raise TypeError("Expected argument 'id' to be a str")
28
34
  pulumi.set(__self__, "id", id)
29
- if pattern and not isinstance(pattern, str):
30
- raise TypeError("Expected argument 'pattern' to be a str")
31
- pulumi.set(__self__, "pattern", pattern)
35
+ if like and not isinstance(like, str):
36
+ raise TypeError("Expected argument 'like' to be a str")
37
+ pulumi.set(__self__, "like", like)
38
+ if limit and not isinstance(limit, dict):
39
+ raise TypeError("Expected argument 'limit' to be a dict")
40
+ pulumi.set(__self__, "limit", limit)
41
+ if starts_with and not isinstance(starts_with, str):
42
+ raise TypeError("Expected argument 'starts_with' to be a str")
43
+ pulumi.set(__self__, "starts_with", starts_with)
32
44
  if users and not isinstance(users, list):
33
45
  raise TypeError("Expected argument 'users' to be a list")
34
46
  pulumi.set(__self__, "users", users)
47
+ if with_describe and not isinstance(with_describe, bool):
48
+ raise TypeError("Expected argument 'with_describe' to be a bool")
49
+ pulumi.set(__self__, "with_describe", with_describe)
50
+ if with_parameters and not isinstance(with_parameters, bool):
51
+ raise TypeError("Expected argument 'with_parameters' to be a bool")
52
+ pulumi.set(__self__, "with_parameters", with_parameters)
35
53
 
36
54
  @property
37
55
  @pulumi.getter
@@ -43,20 +61,52 @@ class GetUsersResult:
43
61
 
44
62
  @property
45
63
  @pulumi.getter
46
- def pattern(self) -> str:
64
+ def like(self) -> Optional[str]:
47
65
  """
48
- Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters
66
+ Filters the output with **case-insensitive** pattern, with support for SQL wildcard characters (`%` and `_`).
49
67
  """
50
- return pulumi.get(self, "pattern")
68
+ return pulumi.get(self, "like")
69
+
70
+ @property
71
+ @pulumi.getter
72
+ def limit(self) -> Optional['outputs.GetUsersLimitResult']:
73
+ """
74
+ Limits the number of rows returned. If the `limit.from` is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with `starts_with` or `like`.
75
+ """
76
+ return pulumi.get(self, "limit")
77
+
78
+ @property
79
+ @pulumi.getter(name="startsWith")
80
+ def starts_with(self) -> Optional[str]:
81
+ """
82
+ Filters the output with **case-sensitive** characters indicating the beginning of the object name.
83
+ """
84
+ return pulumi.get(self, "starts_with")
51
85
 
52
86
  @property
53
87
  @pulumi.getter
54
88
  def users(self) -> Sequence['outputs.GetUsersUserResult']:
55
89
  """
56
- The users in the database
90
+ Holds the aggregated output of all user details queries.
57
91
  """
58
92
  return pulumi.get(self, "users")
59
93
 
94
+ @property
95
+ @pulumi.getter(name="withDescribe")
96
+ def with_describe(self) -> Optional[bool]:
97
+ """
98
+ Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
99
+ """
100
+ return pulumi.get(self, "with_describe")
101
+
102
+ @property
103
+ @pulumi.getter(name="withParameters")
104
+ def with_parameters(self) -> Optional[bool]:
105
+ """
106
+ Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.
107
+ """
108
+ return pulumi.get(self, "with_parameters")
109
+
60
110
 
61
111
  class AwaitableGetUsersResult(GetUsersResult):
62
112
  # pylint: disable=using-constant-test
@@ -65,54 +115,76 @@ class AwaitableGetUsersResult(GetUsersResult):
65
115
  yield self
66
116
  return GetUsersResult(
67
117
  id=self.id,
68
- pattern=self.pattern,
69
- users=self.users)
70
-
71
-
72
- def get_users(pattern: Optional[str] = None,
118
+ like=self.like,
119
+ limit=self.limit,
120
+ starts_with=self.starts_with,
121
+ users=self.users,
122
+ with_describe=self.with_describe,
123
+ with_parameters=self.with_parameters)
124
+
125
+
126
+ def get_users(like: Optional[str] = None,
127
+ limit: Optional[Union['GetUsersLimitArgs', 'GetUsersLimitArgsDict']] = None,
128
+ starts_with: Optional[str] = None,
129
+ with_describe: Optional[bool] = None,
130
+ with_parameters: Optional[bool] = None,
73
131
  opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetUsersResult:
74
132
  """
75
- ## Example Usage
76
-
77
- <!--Start PulumiCodeChooser -->
78
- ```python
79
- import pulumi
80
- import pulumi_snowflake as snowflake
133
+ Data source used to get details of filtered users. Filtering is aligned with the current possibilities for [SHOW USERS](https://docs.snowflake.com/en/sql-reference/sql/show-users) query. The results of SHOW, DESCRIBE, and SHOW PARAMETERS IN are encapsulated in one output collection. Important note is that when querying users you don't have permissions to, the querying options are limited. You won't get almost any field in `show_output` (only empty or default values), the DESCRIBE command cannot be called, so you have to set `with_describe = false`. Only `parameters` output is not affected by the lack of privileges.
81
134
 
82
- current = snowflake.get_users(pattern="user1")
83
- ```
84
- <!--End PulumiCodeChooser -->
85
135
 
86
-
87
- :param str pattern: Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters
136
+ :param str like: Filters the output with **case-insensitive** pattern, with support for SQL wildcard characters (`%` and `_`).
137
+ :param Union['GetUsersLimitArgs', 'GetUsersLimitArgsDict'] limit: Limits the number of rows returned. If the `limit.from` is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with `starts_with` or `like`.
138
+ :param str starts_with: Filters the output with **case-sensitive** characters indicating the beginning of the object name.
139
+ :param bool with_describe: Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
140
+ :param bool with_parameters: Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.
88
141
  """
89
142
  __args__ = dict()
90
- __args__['pattern'] = pattern
143
+ __args__['like'] = like
144
+ __args__['limit'] = limit
145
+ __args__['startsWith'] = starts_with
146
+ __args__['withDescribe'] = with_describe
147
+ __args__['withParameters'] = with_parameters
91
148
  opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
92
149
  __ret__ = pulumi.runtime.invoke('snowflake:index/getUsers:getUsers', __args__, opts=opts, typ=GetUsersResult).value
93
150
 
94
151
  return AwaitableGetUsersResult(
95
152
  id=pulumi.get(__ret__, 'id'),
96
- pattern=pulumi.get(__ret__, 'pattern'),
97
- users=pulumi.get(__ret__, 'users'))
98
-
99
-
100
- @_utilities.lift_output_func(get_users)
101
- def get_users_output(pattern: Optional[pulumi.Input[str]] = None,
102
- opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetUsersResult]:
153
+ like=pulumi.get(__ret__, 'like'),
154
+ limit=pulumi.get(__ret__, 'limit'),
155
+ starts_with=pulumi.get(__ret__, 'starts_with'),
156
+ users=pulumi.get(__ret__, 'users'),
157
+ with_describe=pulumi.get(__ret__, 'with_describe'),
158
+ with_parameters=pulumi.get(__ret__, 'with_parameters'))
159
+ def get_users_output(like: Optional[pulumi.Input[Optional[str]]] = None,
160
+ limit: Optional[pulumi.Input[Optional[Union['GetUsersLimitArgs', 'GetUsersLimitArgsDict']]]] = None,
161
+ starts_with: Optional[pulumi.Input[Optional[str]]] = None,
162
+ with_describe: Optional[pulumi.Input[Optional[bool]]] = None,
163
+ with_parameters: Optional[pulumi.Input[Optional[bool]]] = None,
164
+ opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetUsersResult]:
103
165
  """
104
- ## Example Usage
166
+ Data source used to get details of filtered users. Filtering is aligned with the current possibilities for [SHOW USERS](https://docs.snowflake.com/en/sql-reference/sql/show-users) query. The results of SHOW, DESCRIBE, and SHOW PARAMETERS IN are encapsulated in one output collection. Important note is that when querying users you don't have permissions to, the querying options are limited. You won't get almost any field in `show_output` (only empty or default values), the DESCRIBE command cannot be called, so you have to set `with_describe = false`. Only `parameters` output is not affected by the lack of privileges.
105
167
 
106
- <!--Start PulumiCodeChooser -->
107
- ```python
108
- import pulumi
109
- import pulumi_snowflake as snowflake
110
168
 
111
- current = snowflake.get_users(pattern="user1")
112
- ```
113
- <!--End PulumiCodeChooser -->
114
-
115
-
116
- :param str pattern: Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters
169
+ :param str like: Filters the output with **case-insensitive** pattern, with support for SQL wildcard characters (`%` and `_`).
170
+ :param Union['GetUsersLimitArgs', 'GetUsersLimitArgsDict'] limit: Limits the number of rows returned. If the `limit.from` is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with `starts_with` or `like`.
171
+ :param str starts_with: Filters the output with **case-sensitive** characters indicating the beginning of the object name.
172
+ :param bool with_describe: Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
173
+ :param bool with_parameters: Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.
117
174
  """
118
- ...
175
+ __args__ = dict()
176
+ __args__['like'] = like
177
+ __args__['limit'] = limit
178
+ __args__['startsWith'] = starts_with
179
+ __args__['withDescribe'] = with_describe
180
+ __args__['withParameters'] = with_parameters
181
+ opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
182
+ __ret__ = pulumi.runtime.invoke_output('snowflake:index/getUsers:getUsers', __args__, opts=opts, typ=GetUsersResult)
183
+ return __ret__.apply(lambda __response__: GetUsersResult(
184
+ id=pulumi.get(__response__, 'id'),
185
+ like=pulumi.get(__response__, 'like'),
186
+ limit=pulumi.get(__response__, 'limit'),
187
+ starts_with=pulumi.get(__response__, 'starts_with'),
188
+ users=pulumi.get(__response__, 'users'),
189
+ with_describe=pulumi.get(__response__, 'with_describe'),
190
+ with_parameters=pulumi.get(__response__, 'with_parameters')))
@@ -4,11 +4,17 @@
4
4
 
5
5
  import copy
6
6
  import warnings
7
+ import sys
7
8
  import pulumi
8
9
  import pulumi.runtime
9
10
  from typing import Any, Mapping, Optional, Sequence, Union, overload
11
+ if sys.version_info >= (3, 11):
12
+ from typing import NotRequired, TypedDict, TypeAlias
13
+ else:
14
+ from typing_extensions import NotRequired, TypedDict, TypeAlias
10
15
  from . import _utilities
11
16
  from . import outputs
17
+ from ._inputs import *
12
18
 
13
19
  __all__ = [
14
20
  'GetViewsResult',
@@ -22,52 +28,85 @@ class GetViewsResult:
22
28
  """
23
29
  A collection of values returned by getViews.
24
30
  """
25
- def __init__(__self__, database=None, id=None, schema=None, views=None):
26
- if database and not isinstance(database, str):
27
- raise TypeError("Expected argument 'database' to be a str")
28
- pulumi.set(__self__, "database", database)
31
+ def __init__(__self__, id=None, in_=None, like=None, limit=None, starts_with=None, views=None, with_describe=None):
29
32
  if id and not isinstance(id, str):
30
33
  raise TypeError("Expected argument 'id' to be a str")
31
34
  pulumi.set(__self__, "id", id)
32
- if schema and not isinstance(schema, str):
33
- raise TypeError("Expected argument 'schema' to be a str")
34
- pulumi.set(__self__, "schema", schema)
35
+ if in_ and not isinstance(in_, dict):
36
+ raise TypeError("Expected argument 'in_' to be a dict")
37
+ pulumi.set(__self__, "in_", in_)
38
+ if like and not isinstance(like, str):
39
+ raise TypeError("Expected argument 'like' to be a str")
40
+ pulumi.set(__self__, "like", like)
41
+ if limit and not isinstance(limit, dict):
42
+ raise TypeError("Expected argument 'limit' to be a dict")
43
+ pulumi.set(__self__, "limit", limit)
44
+ if starts_with and not isinstance(starts_with, str):
45
+ raise TypeError("Expected argument 'starts_with' to be a str")
46
+ pulumi.set(__self__, "starts_with", starts_with)
35
47
  if views and not isinstance(views, list):
36
48
  raise TypeError("Expected argument 'views' to be a list")
37
49
  pulumi.set(__self__, "views", views)
50
+ if with_describe and not isinstance(with_describe, bool):
51
+ raise TypeError("Expected argument 'with_describe' to be a bool")
52
+ pulumi.set(__self__, "with_describe", with_describe)
38
53
 
39
54
  @property
40
55
  @pulumi.getter
41
- def database(self) -> str:
56
+ def id(self) -> str:
57
+ """
58
+ The provider-assigned unique ID for this managed resource.
59
+ """
60
+ return pulumi.get(self, "id")
61
+
62
+ @property
63
+ @pulumi.getter(name="in")
64
+ def in_(self) -> Optional['outputs.GetViewsInResult']:
42
65
  """
43
- The database from which to return the schemas from.
66
+ IN clause to filter the list of views
44
67
  """
45
- return pulumi.get(self, "database")
68
+ return pulumi.get(self, "in_")
46
69
 
47
70
  @property
48
71
  @pulumi.getter
49
- def id(self) -> str:
72
+ def like(self) -> Optional[str]:
50
73
  """
51
- The provider-assigned unique ID for this managed resource.
74
+ Filters the output with **case-insensitive** pattern, with support for SQL wildcard characters (`%` and `_`).
52
75
  """
53
- return pulumi.get(self, "id")
76
+ return pulumi.get(self, "like")
54
77
 
55
78
  @property
56
79
  @pulumi.getter
57
- def schema(self) -> str:
80
+ def limit(self) -> Optional['outputs.GetViewsLimitResult']:
58
81
  """
59
- The schema from which to return the views from.
82
+ Limits the number of rows returned. If the `limit.from` is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with `starts_with` or `like`.
60
83
  """
61
- return pulumi.get(self, "schema")
84
+ return pulumi.get(self, "limit")
85
+
86
+ @property
87
+ @pulumi.getter(name="startsWith")
88
+ def starts_with(self) -> Optional[str]:
89
+ """
90
+ Filters the output with **case-sensitive** characters indicating the beginning of the object name.
91
+ """
92
+ return pulumi.get(self, "starts_with")
62
93
 
63
94
  @property
64
95
  @pulumi.getter
65
96
  def views(self) -> Sequence['outputs.GetViewsViewResult']:
66
97
  """
67
- The views in the schema
98
+ Holds the aggregated output of all views details queries.
68
99
  """
69
100
  return pulumi.get(self, "views")
70
101
 
102
+ @property
103
+ @pulumi.getter(name="withDescribe")
104
+ def with_describe(self) -> Optional[bool]:
105
+ """
106
+ Runs DESC VIEW for each view returned by SHOW VIEWS. The output of describe is saved to the description field. By default this value is set to true.
107
+ """
108
+ return pulumi.get(self, "with_describe")
109
+
71
110
 
72
111
  class AwaitableGetViewsResult(GetViewsResult):
73
112
  # pylint: disable=using-constant-test
@@ -75,56 +114,77 @@ class AwaitableGetViewsResult(GetViewsResult):
75
114
  if False:
76
115
  yield self
77
116
  return GetViewsResult(
78
- database=self.database,
79
117
  id=self.id,
80
- schema=self.schema,
81
- views=self.views)
82
-
83
-
84
- def get_views(database: Optional[str] = None,
85
- schema: Optional[str] = None,
118
+ in_=self.in_,
119
+ like=self.like,
120
+ limit=self.limit,
121
+ starts_with=self.starts_with,
122
+ views=self.views,
123
+ with_describe=self.with_describe)
124
+
125
+
126
+ def get_views(in_: Optional[Union['GetViewsInArgs', 'GetViewsInArgsDict']] = None,
127
+ like: Optional[str] = None,
128
+ limit: Optional[Union['GetViewsLimitArgs', 'GetViewsLimitArgsDict']] = None,
129
+ starts_with: Optional[str] = None,
130
+ with_describe: Optional[bool] = None,
86
131
  opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetViewsResult:
87
132
  """
88
- ## Example Usage
133
+ Data source used to get details of filtered views. Filtering is aligned with the current possibilities for [SHOW VIEWS](https://docs.snowflake.com/en/sql-reference/sql/show-views) query (only `like` is supported). The results of SHOW and DESCRIBE are encapsulated in one output collection `views`.
89
134
 
90
- <!--Start PulumiCodeChooser -->
91
- ```python
92
- import pulumi
93
- import pulumi_snowflake as snowflake
94
135
 
95
- current = snowflake.get_views(database="MYDB",
96
- schema="MYSCHEMA")
97
- ```
98
- <!--End PulumiCodeChooser -->
136
+ :param Union['GetViewsInArgs', 'GetViewsInArgsDict'] in_: IN clause to filter the list of views
137
+ :param str like: Filters the output with **case-insensitive** pattern, with support for SQL wildcard characters (`%` and `_`).
138
+ :param Union['GetViewsLimitArgs', 'GetViewsLimitArgsDict'] limit: Limits the number of rows returned. If the `limit.from` is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with `starts_with` or `like`.
139
+ :param str starts_with: Filters the output with **case-sensitive** characters indicating the beginning of the object name.
140
+ :param bool with_describe: Runs DESC VIEW for each view returned by SHOW VIEWS. The output of describe is saved to the description field. By default this value is set to true.
99
141
  """
100
142
  __args__ = dict()
101
- __args__['database'] = database
102
- __args__['schema'] = schema
143
+ __args__['in'] = in_
144
+ __args__['like'] = like
145
+ __args__['limit'] = limit
146
+ __args__['startsWith'] = starts_with
147
+ __args__['withDescribe'] = with_describe
103
148
  opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
104
149
  __ret__ = pulumi.runtime.invoke('snowflake:index/getViews:getViews', __args__, opts=opts, typ=GetViewsResult).value
105
150
 
106
151
  return AwaitableGetViewsResult(
107
- database=pulumi.get(__ret__, 'database'),
108
152
  id=pulumi.get(__ret__, 'id'),
109
- schema=pulumi.get(__ret__, 'schema'),
110
- views=pulumi.get(__ret__, 'views'))
111
-
112
-
113
- @_utilities.lift_output_func(get_views)
114
- def get_views_output(database: Optional[pulumi.Input[str]] = None,
115
- schema: Optional[pulumi.Input[str]] = None,
116
- opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetViewsResult]:
153
+ in_=pulumi.get(__ret__, 'in_'),
154
+ like=pulumi.get(__ret__, 'like'),
155
+ limit=pulumi.get(__ret__, 'limit'),
156
+ starts_with=pulumi.get(__ret__, 'starts_with'),
157
+ views=pulumi.get(__ret__, 'views'),
158
+ with_describe=pulumi.get(__ret__, 'with_describe'))
159
+ def get_views_output(in_: Optional[pulumi.Input[Optional[Union['GetViewsInArgs', 'GetViewsInArgsDict']]]] = None,
160
+ like: Optional[pulumi.Input[Optional[str]]] = None,
161
+ limit: Optional[pulumi.Input[Optional[Union['GetViewsLimitArgs', 'GetViewsLimitArgsDict']]]] = None,
162
+ starts_with: Optional[pulumi.Input[Optional[str]]] = None,
163
+ with_describe: Optional[pulumi.Input[Optional[bool]]] = None,
164
+ opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetViewsResult]:
117
165
  """
118
- ## Example Usage
166
+ Data source used to get details of filtered views. Filtering is aligned with the current possibilities for [SHOW VIEWS](https://docs.snowflake.com/en/sql-reference/sql/show-views) query (only `like` is supported). The results of SHOW and DESCRIBE are encapsulated in one output collection `views`.
119
167
 
120
- <!--Start PulumiCodeChooser -->
121
- ```python
122
- import pulumi
123
- import pulumi_snowflake as snowflake
124
168
 
125
- current = snowflake.get_views(database="MYDB",
126
- schema="MYSCHEMA")
127
- ```
128
- <!--End PulumiCodeChooser -->
169
+ :param Union['GetViewsInArgs', 'GetViewsInArgsDict'] in_: IN clause to filter the list of views
170
+ :param str like: Filters the output with **case-insensitive** pattern, with support for SQL wildcard characters (`%` and `_`).
171
+ :param Union['GetViewsLimitArgs', 'GetViewsLimitArgsDict'] limit: Limits the number of rows returned. If the `limit.from` is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with `starts_with` or `like`.
172
+ :param str starts_with: Filters the output with **case-sensitive** characters indicating the beginning of the object name.
173
+ :param bool with_describe: Runs DESC VIEW for each view returned by SHOW VIEWS. The output of describe is saved to the description field. By default this value is set to true.
129
174
  """
130
- ...
175
+ __args__ = dict()
176
+ __args__['in'] = in_
177
+ __args__['like'] = like
178
+ __args__['limit'] = limit
179
+ __args__['startsWith'] = starts_with
180
+ __args__['withDescribe'] = with_describe
181
+ opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
182
+ __ret__ = pulumi.runtime.invoke_output('snowflake:index/getViews:getViews', __args__, opts=opts, typ=GetViewsResult)
183
+ return __ret__.apply(lambda __response__: GetViewsResult(
184
+ id=pulumi.get(__response__, 'id'),
185
+ in_=pulumi.get(__response__, 'in_'),
186
+ like=pulumi.get(__response__, 'like'),
187
+ limit=pulumi.get(__response__, 'limit'),
188
+ starts_with=pulumi.get(__response__, 'starts_with'),
189
+ views=pulumi.get(__response__, 'views'),
190
+ with_describe=pulumi.get(__response__, 'with_describe')))
@@ -4,9 +4,14 @@
4
4
 
5
5
  import copy
6
6
  import warnings
7
+ import sys
7
8
  import pulumi
8
9
  import pulumi.runtime
9
10
  from typing import Any, Mapping, Optional, Sequence, Union, overload
11
+ if sys.version_info >= (3, 11):
12
+ from typing import NotRequired, TypedDict, TypeAlias
13
+ else:
14
+ from typing_extensions import NotRequired, TypedDict, TypeAlias
10
15
  from . import _utilities
11
16
  from . import outputs
12
17
 
@@ -22,13 +27,22 @@ class GetWarehousesResult:
22
27
  """
23
28
  A collection of values returned by getWarehouses.
24
29
  """
25
- def __init__(__self__, id=None, warehouses=None):
30
+ def __init__(__self__, id=None, like=None, warehouses=None, with_describe=None, with_parameters=None):
26
31
  if id and not isinstance(id, str):
27
32
  raise TypeError("Expected argument 'id' to be a str")
28
33
  pulumi.set(__self__, "id", id)
34
+ if like and not isinstance(like, str):
35
+ raise TypeError("Expected argument 'like' to be a str")
36
+ pulumi.set(__self__, "like", like)
29
37
  if warehouses and not isinstance(warehouses, list):
30
38
  raise TypeError("Expected argument 'warehouses' to be a list")
31
39
  pulumi.set(__self__, "warehouses", warehouses)
40
+ if with_describe and not isinstance(with_describe, bool):
41
+ raise TypeError("Expected argument 'with_describe' to be a bool")
42
+ pulumi.set(__self__, "with_describe", with_describe)
43
+ if with_parameters and not isinstance(with_parameters, bool):
44
+ raise TypeError("Expected argument 'with_parameters' to be a bool")
45
+ pulumi.set(__self__, "with_parameters", with_parameters)
32
46
 
33
47
  @property
34
48
  @pulumi.getter
@@ -38,14 +52,38 @@ class GetWarehousesResult:
38
52
  """
39
53
  return pulumi.get(self, "id")
40
54
 
55
+ @property
56
+ @pulumi.getter
57
+ def like(self) -> Optional[str]:
58
+ """
59
+ Filters the output with **case-insensitive** pattern, with support for SQL wildcard characters (`%` and `_`).
60
+ """
61
+ return pulumi.get(self, "like")
62
+
41
63
  @property
42
64
  @pulumi.getter
43
65
  def warehouses(self) -> Sequence['outputs.GetWarehousesWarehouseResult']:
44
66
  """
45
- The warehouses in the database
67
+ Holds the aggregated output of all warehouse details queries.
46
68
  """
47
69
  return pulumi.get(self, "warehouses")
48
70
 
71
+ @property
72
+ @pulumi.getter(name="withDescribe")
73
+ def with_describe(self) -> Optional[bool]:
74
+ """
75
+ Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
76
+ """
77
+ return pulumi.get(self, "with_describe")
78
+
79
+ @property
80
+ @pulumi.getter(name="withParameters")
81
+ def with_parameters(self) -> Optional[bool]:
82
+ """
83
+ Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.
84
+ """
85
+ return pulumi.get(self, "with_parameters")
86
+
49
87
 
50
88
  class AwaitableGetWarehousesResult(GetWarehousesResult):
51
89
  # pylint: disable=using-constant-test
@@ -54,43 +92,58 @@ class AwaitableGetWarehousesResult(GetWarehousesResult):
54
92
  yield self
55
93
  return GetWarehousesResult(
56
94
  id=self.id,
57
- warehouses=self.warehouses)
95
+ like=self.like,
96
+ warehouses=self.warehouses,
97
+ with_describe=self.with_describe,
98
+ with_parameters=self.with_parameters)
58
99
 
59
100
 
60
- def get_warehouses(opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetWarehousesResult:
101
+ def get_warehouses(like: Optional[str] = None,
102
+ with_describe: Optional[bool] = None,
103
+ with_parameters: Optional[bool] = None,
104
+ opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetWarehousesResult:
61
105
  """
62
- ## Example Usage
106
+ Data source used to get details of filtered warehouses. Filtering is aligned with the current possibilities for [SHOW WAREHOUSES](https://docs.snowflake.com/en/sql-reference/sql/show-warehouses) query (only `like` is supported). The results of SHOW, DESCRIBE, and SHOW PARAMETERS IN are encapsulated in one output collection.
63
107
 
64
- <!--Start PulumiCodeChooser -->
65
- ```python
66
- import pulumi
67
- import pulumi_snowflake as snowflake
68
108
 
69
- current = snowflake.get_warehouses()
70
- ```
71
- <!--End PulumiCodeChooser -->
109
+ :param str like: Filters the output with **case-insensitive** pattern, with support for SQL wildcard characters (`%` and `_`).
110
+ :param bool with_describe: Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
111
+ :param bool with_parameters: Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.
72
112
  """
73
113
  __args__ = dict()
114
+ __args__['like'] = like
115
+ __args__['withDescribe'] = with_describe
116
+ __args__['withParameters'] = with_parameters
74
117
  opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
75
118
  __ret__ = pulumi.runtime.invoke('snowflake:index/getWarehouses:getWarehouses', __args__, opts=opts, typ=GetWarehousesResult).value
76
119
 
77
120
  return AwaitableGetWarehousesResult(
78
121
  id=pulumi.get(__ret__, 'id'),
79
- warehouses=pulumi.get(__ret__, 'warehouses'))
80
-
81
-
82
- @_utilities.lift_output_func(get_warehouses)
83
- def get_warehouses_output(opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetWarehousesResult]:
122
+ like=pulumi.get(__ret__, 'like'),
123
+ warehouses=pulumi.get(__ret__, 'warehouses'),
124
+ with_describe=pulumi.get(__ret__, 'with_describe'),
125
+ with_parameters=pulumi.get(__ret__, 'with_parameters'))
126
+ def get_warehouses_output(like: Optional[pulumi.Input[Optional[str]]] = None,
127
+ with_describe: Optional[pulumi.Input[Optional[bool]]] = None,
128
+ with_parameters: Optional[pulumi.Input[Optional[bool]]] = None,
129
+ opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetWarehousesResult]:
84
130
  """
85
- ## Example Usage
131
+ Data source used to get details of filtered warehouses. Filtering is aligned with the current possibilities for [SHOW WAREHOUSES](https://docs.snowflake.com/en/sql-reference/sql/show-warehouses) query (only `like` is supported). The results of SHOW, DESCRIBE, and SHOW PARAMETERS IN are encapsulated in one output collection.
86
132
 
87
- <!--Start PulumiCodeChooser -->
88
- ```python
89
- import pulumi
90
- import pulumi_snowflake as snowflake
91
133
 
92
- current = snowflake.get_warehouses()
93
- ```
94
- <!--End PulumiCodeChooser -->
134
+ :param str like: Filters the output with **case-insensitive** pattern, with support for SQL wildcard characters (`%` and `_`).
135
+ :param bool with_describe: Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
136
+ :param bool with_parameters: Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.
95
137
  """
96
- ...
138
+ __args__ = dict()
139
+ __args__['like'] = like
140
+ __args__['withDescribe'] = with_describe
141
+ __args__['withParameters'] = with_parameters
142
+ opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
143
+ __ret__ = pulumi.runtime.invoke_output('snowflake:index/getWarehouses:getWarehouses', __args__, opts=opts, typ=GetWarehousesResult)
144
+ return __ret__.apply(lambda __response__: GetWarehousesResult(
145
+ id=pulumi.get(__response__, 'id'),
146
+ like=pulumi.get(__response__, 'like'),
147
+ warehouses=pulumi.get(__response__, 'warehouses'),
148
+ with_describe=pulumi.get(__response__, 'with_describe'),
149
+ with_parameters=pulumi.get(__response__, 'with_parameters')))