pulumi-snowflake 2.2.0a1751946295__py3-none-any.whl → 2.3.0__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.
- pulumi_snowflake/__init__.py +20 -1
- pulumi_snowflake/_inputs.py +17236 -16797
- pulumi_snowflake/account.py +252 -253
- pulumi_snowflake/account_authentication_policy_attachment.py +18 -19
- pulumi_snowflake/account_parameter.py +35 -36
- pulumi_snowflake/account_password_policy_attachment.py +18 -19
- pulumi_snowflake/account_role.py +42 -43
- pulumi_snowflake/alert.py +149 -150
- pulumi_snowflake/api_authentication_integration_with_authorization_code_grant.py +197 -198
- pulumi_snowflake/api_authentication_integration_with_client_credentials.py +180 -181
- pulumi_snowflake/api_authentication_integration_with_jwt_bearer.py +193 -194
- pulumi_snowflake/api_integration.py +251 -252
- pulumi_snowflake/authentication_policy.py +167 -168
- pulumi_snowflake/compute_pool.py +167 -168
- pulumi_snowflake/config/__init__.py +1 -1
- pulumi_snowflake/config/__init__.pyi +1 -2
- pulumi_snowflake/config/outputs.py +21 -22
- pulumi_snowflake/config/vars.py +43 -44
- pulumi_snowflake/cortex_search_service.py +191 -192
- pulumi_snowflake/current_account.py +2096 -2097
- pulumi_snowflake/current_organization_account.py +5863 -0
- pulumi_snowflake/database.py +353 -354
- pulumi_snowflake/database_role.py +63 -64
- pulumi_snowflake/dynamic_table.py +274 -275
- pulumi_snowflake/email_notification_integration.py +70 -71
- pulumi_snowflake/execute.py +61 -62
- pulumi_snowflake/external_function.py +280 -281
- pulumi_snowflake/external_oauth_integration.py +288 -289
- pulumi_snowflake/external_table.py +246 -247
- pulumi_snowflake/external_volume.py +68 -69
- pulumi_snowflake/failover_group.py +135 -136
- pulumi_snowflake/file_format.py +622 -623
- pulumi_snowflake/function_java.py +320 -321
- pulumi_snowflake/function_javascript.py +243 -244
- pulumi_snowflake/function_python.py +334 -335
- pulumi_snowflake/function_scala.py +320 -321
- pulumi_snowflake/function_sql.py +226 -227
- pulumi_snowflake/get_account_roles.py +16 -17
- pulumi_snowflake/get_accounts.py +16 -17
- pulumi_snowflake/get_alerts.py +22 -23
- pulumi_snowflake/get_compute_pools.py +23 -24
- pulumi_snowflake/get_connections.py +10 -11
- pulumi_snowflake/get_cortex_search_services.py +18 -19
- pulumi_snowflake/get_current_account.py +9 -10
- pulumi_snowflake/get_current_role.py +5 -6
- pulumi_snowflake/get_database.py +25 -26
- pulumi_snowflake/get_database_role.py +19 -20
- pulumi_snowflake/get_database_roles.py +17 -18
- pulumi_snowflake/get_databases.py +29 -30
- pulumi_snowflake/get_dynamic_tables.py +13 -14
- pulumi_snowflake/get_external_functions.py +16 -17
- pulumi_snowflake/get_external_tables.py +16 -17
- pulumi_snowflake/get_failover_groups.py +10 -11
- pulumi_snowflake/get_file_formats.py +16 -17
- pulumi_snowflake/get_functions.py +16 -17
- pulumi_snowflake/get_git_repositories.py +18 -19
- pulumi_snowflake/get_grants.py +9 -10
- pulumi_snowflake/get_image_repositories.py +11 -12
- pulumi_snowflake/get_masking_policies.py +18 -19
- pulumi_snowflake/get_materialized_views.py +16 -17
- pulumi_snowflake/get_network_policies.py +16 -17
- pulumi_snowflake/get_parameters.py +34 -35
- pulumi_snowflake/get_pipes.py +16 -17
- pulumi_snowflake/get_procedures.py +16 -17
- pulumi_snowflake/get_resource_monitors.py +10 -11
- pulumi_snowflake/get_row_access_policies.py +18 -19
- pulumi_snowflake/get_schemas.py +30 -31
- pulumi_snowflake/get_secrets.py +17 -18
- pulumi_snowflake/get_security_integrations.py +16 -17
- pulumi_snowflake/get_sequences.py +16 -17
- pulumi_snowflake/get_services.py +30 -31
- pulumi_snowflake/get_shares.py +10 -11
- pulumi_snowflake/get_stages.py +16 -17
- pulumi_snowflake/get_storage_integrations.py +4 -5
- pulumi_snowflake/get_streamlits.py +18 -19
- pulumi_snowflake/get_streams.py +24 -25
- pulumi_snowflake/get_system_generate_scim_access_token.py +11 -12
- pulumi_snowflake/get_system_get_aws_sns_iam_policy.py +11 -12
- pulumi_snowflake/get_system_get_private_link_config.py +21 -22
- pulumi_snowflake/get_system_get_snowflake_platform_info.py +7 -8
- pulumi_snowflake/get_tables.py +24 -25
- pulumi_snowflake/get_tags.py +11 -12
- pulumi_snowflake/get_tasks.py +30 -31
- pulumi_snowflake/get_user_programmatic_access_tokens.py +113 -0
- pulumi_snowflake/get_users.py +29 -30
- pulumi_snowflake/get_views.py +24 -25
- pulumi_snowflake/get_warehouses.py +22 -23
- pulumi_snowflake/git_repository.py +133 -134
- pulumi_snowflake/grant_account_role.py +52 -53
- pulumi_snowflake/grant_application_role.py +52 -53
- pulumi_snowflake/grant_database_role.py +69 -70
- pulumi_snowflake/grant_ownership.py +55 -56
- pulumi_snowflake/grant_privileges_to_account_role.py +125 -126
- pulumi_snowflake/grant_privileges_to_database_role.py +122 -123
- pulumi_snowflake/grant_privileges_to_share.py +154 -155
- pulumi_snowflake/image_repository.py +80 -81
- pulumi_snowflake/job_service.py +148 -149
- pulumi_snowflake/legacy_service_user.py +1269 -1270
- pulumi_snowflake/managed_account.py +140 -141
- pulumi_snowflake/masking_policy.py +136 -137
- pulumi_snowflake/materialized_view.py +149 -150
- pulumi_snowflake/network_policy.py +116 -117
- pulumi_snowflake/network_policy_attachment.py +52 -53
- pulumi_snowflake/network_rule.py +129 -130
- pulumi_snowflake/notification_integration.py +298 -299
- pulumi_snowflake/oauth_integration_for_custom_clients.py +263 -264
- pulumi_snowflake/oauth_integration_for_partner_applications.py +169 -170
- pulumi_snowflake/object_parameter.py +72 -73
- pulumi_snowflake/outputs.py +15957 -15511
- pulumi_snowflake/password_policy.py +299 -300
- pulumi_snowflake/pipe.py +181 -182
- pulumi_snowflake/primary_connection.py +70 -71
- pulumi_snowflake/procedure_java.py +341 -342
- pulumi_snowflake/procedure_javascript.py +247 -248
- pulumi_snowflake/procedure_python.py +338 -339
- pulumi_snowflake/procedure_scala.py +341 -342
- pulumi_snowflake/procedure_sql.py +247 -248
- pulumi_snowflake/provider.py +377 -378
- pulumi_snowflake/pulumi-plugin.json +1 -1
- pulumi_snowflake/resource_monitor.py +165 -166
- pulumi_snowflake/row_access_policy.py +102 -103
- pulumi_snowflake/saml2_integration.py +303 -304
- pulumi_snowflake/schema.py +390 -391
- pulumi_snowflake/scim_integration.py +133 -134
- pulumi_snowflake/secondary_connection.py +72 -73
- pulumi_snowflake/secondary_database.py +350 -351
- pulumi_snowflake/secret_with_authorization_code_grant.py +138 -139
- pulumi_snowflake/secret_with_basic_authentication.py +121 -122
- pulumi_snowflake/secret_with_client_credentials.py +125 -126
- pulumi_snowflake/secret_with_generic_string.py +104 -105
- pulumi_snowflake/sequence.py +121 -122
- pulumi_snowflake/service.py +233 -234
- pulumi_snowflake/service_user.py +1239 -1240
- pulumi_snowflake/share.py +61 -62
- pulumi_snowflake/shared_database.py +299 -300
- pulumi_snowflake/stage.py +234 -235
- pulumi_snowflake/storage_integration.py +230 -231
- pulumi_snowflake/stream_on_directory_table.py +128 -129
- pulumi_snowflake/stream_on_external_table.py +151 -152
- pulumi_snowflake/stream_on_table.py +164 -165
- pulumi_snowflake/stream_on_view.py +164 -165
- pulumi_snowflake/streamlit.py +184 -185
- pulumi_snowflake/table.py +147 -148
- pulumi_snowflake/table_column_masking_policy_application.py +52 -53
- pulumi_snowflake/table_constraint.py +191 -192
- pulumi_snowflake/tag.py +114 -115
- pulumi_snowflake/tag_association.py +86 -87
- pulumi_snowflake/task.py +1224 -1225
- pulumi_snowflake/user.py +1346 -1347
- pulumi_snowflake/user_authentication_policy_attachment.py +35 -36
- pulumi_snowflake/user_password_policy_attachment.py +35 -36
- pulumi_snowflake/user_programmatic_access_token.py +598 -0
- pulumi_snowflake/user_public_keys.py +52 -53
- pulumi_snowflake/view.py +187 -188
- pulumi_snowflake/warehouse.py +286 -287
- {pulumi_snowflake-2.2.0a1751946295.dist-info → pulumi_snowflake-2.3.0.dist-info}/METADATA +1 -1
- pulumi_snowflake-2.3.0.dist-info/RECORD +161 -0
- pulumi_snowflake-2.2.0a1751946295.dist-info/RECORD +0 -158
- {pulumi_snowflake-2.2.0a1751946295.dist-info → pulumi_snowflake-2.3.0.dist-info}/WHEEL +0 -0
- {pulumi_snowflake-2.2.0a1751946295.dist-info → pulumi_snowflake-2.3.0.dist-info}/top_level.txt +0 -0
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
3
|
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
4
|
|
|
5
|
-
import builtins
|
|
6
|
-
import copy
|
|
5
|
+
import builtins as _builtins
|
|
7
6
|
import warnings
|
|
8
7
|
import sys
|
|
9
8
|
import pulumi
|
|
@@ -22,42 +21,42 @@ __all__ = ['ExternalFunctionArgs', 'ExternalFunction']
|
|
|
22
21
|
@pulumi.input_type
|
|
23
22
|
class ExternalFunctionArgs:
|
|
24
23
|
def __init__(__self__, *,
|
|
25
|
-
api_integration: pulumi.Input[
|
|
26
|
-
database: pulumi.Input[
|
|
27
|
-
return_behavior: pulumi.Input[
|
|
28
|
-
return_type: pulumi.Input[
|
|
29
|
-
schema: pulumi.Input[
|
|
30
|
-
url_of_proxy_and_resource: pulumi.Input[
|
|
24
|
+
api_integration: pulumi.Input[_builtins.str],
|
|
25
|
+
database: pulumi.Input[_builtins.str],
|
|
26
|
+
return_behavior: pulumi.Input[_builtins.str],
|
|
27
|
+
return_type: pulumi.Input[_builtins.str],
|
|
28
|
+
schema: pulumi.Input[_builtins.str],
|
|
29
|
+
url_of_proxy_and_resource: pulumi.Input[_builtins.str],
|
|
31
30
|
args: Optional[pulumi.Input[Sequence[pulumi.Input['ExternalFunctionArgArgs']]]] = None,
|
|
32
|
-
comment: Optional[pulumi.Input[
|
|
33
|
-
compression: Optional[pulumi.Input[
|
|
34
|
-
context_headers: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
31
|
+
comment: Optional[pulumi.Input[_builtins.str]] = None,
|
|
32
|
+
compression: Optional[pulumi.Input[_builtins.str]] = None,
|
|
33
|
+
context_headers: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
|
|
35
34
|
headers: Optional[pulumi.Input[Sequence[pulumi.Input['ExternalFunctionHeaderArgs']]]] = None,
|
|
36
|
-
max_batch_rows: Optional[pulumi.Input[
|
|
37
|
-
name: Optional[pulumi.Input[
|
|
38
|
-
null_input_behavior: Optional[pulumi.Input[
|
|
39
|
-
request_translator: Optional[pulumi.Input[
|
|
40
|
-
response_translator: Optional[pulumi.Input[
|
|
41
|
-
return_null_allowed: Optional[pulumi.Input[
|
|
35
|
+
max_batch_rows: Optional[pulumi.Input[_builtins.int]] = None,
|
|
36
|
+
name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
37
|
+
null_input_behavior: Optional[pulumi.Input[_builtins.str]] = None,
|
|
38
|
+
request_translator: Optional[pulumi.Input[_builtins.str]] = None,
|
|
39
|
+
response_translator: Optional[pulumi.Input[_builtins.str]] = None,
|
|
40
|
+
return_null_allowed: Optional[pulumi.Input[_builtins.bool]] = None):
|
|
42
41
|
"""
|
|
43
42
|
The set of arguments for constructing a ExternalFunction resource.
|
|
44
|
-
:param pulumi.Input[
|
|
45
|
-
:param pulumi.Input[
|
|
46
|
-
:param pulumi.Input[
|
|
47
|
-
:param pulumi.Input[
|
|
48
|
-
:param pulumi.Input[
|
|
49
|
-
:param pulumi.Input[
|
|
43
|
+
:param pulumi.Input[_builtins.str] api_integration: The name of the API integration object that should be used to authenticate the call to the proxy service.
|
|
44
|
+
:param pulumi.Input[_builtins.str] database: The database in which to create the external function.
|
|
45
|
+
:param pulumi.Input[_builtins.str] return_behavior: Specifies the behavior of the function when returning results
|
|
46
|
+
:param pulumi.Input[_builtins.str] return_type: Specifies the data type returned by the external function.
|
|
47
|
+
:param pulumi.Input[_builtins.str] schema: The schema in which to create the external function.
|
|
48
|
+
:param pulumi.Input[_builtins.str] url_of_proxy_and_resource: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.
|
|
50
49
|
:param pulumi.Input[Sequence[pulumi.Input['ExternalFunctionArgArgs']]] args: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
|
|
51
|
-
:param pulumi.Input[
|
|
52
|
-
:param pulumi.Input[
|
|
53
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
50
|
+
:param pulumi.Input[_builtins.str] comment: (Default: `user-defined function`) A description of the external function.
|
|
51
|
+
:param pulumi.Input[_builtins.str] compression: (Default: `AUTO`) If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
|
|
52
|
+
:param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] context_headers: Binds Snowflake context function results to HTTP headers.
|
|
54
53
|
:param pulumi.Input[Sequence[pulumi.Input['ExternalFunctionHeaderArgs']]] headers: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
|
|
55
|
-
:param pulumi.Input[
|
|
56
|
-
:param pulumi.Input[
|
|
57
|
-
:param pulumi.Input[
|
|
58
|
-
:param pulumi.Input[
|
|
59
|
-
:param pulumi.Input[
|
|
60
|
-
:param pulumi.Input[
|
|
54
|
+
:param pulumi.Input[_builtins.int] max_batch_rows: This specifies the maximum number of rows in each batch sent to the proxy service.
|
|
55
|
+
:param pulumi.Input[_builtins.str] name: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
|
|
56
|
+
:param pulumi.Input[_builtins.str] null_input_behavior: (Default: `CALLED ON NULL INPUT`) Specifies the behavior of the external function when called with null inputs.
|
|
57
|
+
:param pulumi.Input[_builtins.str] request_translator: This specifies the name of the request translator function
|
|
58
|
+
:param pulumi.Input[_builtins.str] response_translator: This specifies the name of the response translator function.
|
|
59
|
+
:param pulumi.Input[_builtins.bool] return_null_allowed: (Default: `true`) Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
61
60
|
"""
|
|
62
61
|
pulumi.set(__self__, "api_integration", api_integration)
|
|
63
62
|
pulumi.set(__self__, "database", database)
|
|
@@ -88,79 +87,79 @@ class ExternalFunctionArgs:
|
|
|
88
87
|
if return_null_allowed is not None:
|
|
89
88
|
pulumi.set(__self__, "return_null_allowed", return_null_allowed)
|
|
90
89
|
|
|
91
|
-
@property
|
|
90
|
+
@_builtins.property
|
|
92
91
|
@pulumi.getter(name="apiIntegration")
|
|
93
|
-
def api_integration(self) -> pulumi.Input[
|
|
92
|
+
def api_integration(self) -> pulumi.Input[_builtins.str]:
|
|
94
93
|
"""
|
|
95
94
|
The name of the API integration object that should be used to authenticate the call to the proxy service.
|
|
96
95
|
"""
|
|
97
96
|
return pulumi.get(self, "api_integration")
|
|
98
97
|
|
|
99
98
|
@api_integration.setter
|
|
100
|
-
def api_integration(self, value: pulumi.Input[
|
|
99
|
+
def api_integration(self, value: pulumi.Input[_builtins.str]):
|
|
101
100
|
pulumi.set(self, "api_integration", value)
|
|
102
101
|
|
|
103
|
-
@property
|
|
102
|
+
@_builtins.property
|
|
104
103
|
@pulumi.getter
|
|
105
|
-
def database(self) -> pulumi.Input[
|
|
104
|
+
def database(self) -> pulumi.Input[_builtins.str]:
|
|
106
105
|
"""
|
|
107
106
|
The database in which to create the external function.
|
|
108
107
|
"""
|
|
109
108
|
return pulumi.get(self, "database")
|
|
110
109
|
|
|
111
110
|
@database.setter
|
|
112
|
-
def database(self, value: pulumi.Input[
|
|
111
|
+
def database(self, value: pulumi.Input[_builtins.str]):
|
|
113
112
|
pulumi.set(self, "database", value)
|
|
114
113
|
|
|
115
|
-
@property
|
|
114
|
+
@_builtins.property
|
|
116
115
|
@pulumi.getter(name="returnBehavior")
|
|
117
|
-
def return_behavior(self) -> pulumi.Input[
|
|
116
|
+
def return_behavior(self) -> pulumi.Input[_builtins.str]:
|
|
118
117
|
"""
|
|
119
118
|
Specifies the behavior of the function when returning results
|
|
120
119
|
"""
|
|
121
120
|
return pulumi.get(self, "return_behavior")
|
|
122
121
|
|
|
123
122
|
@return_behavior.setter
|
|
124
|
-
def return_behavior(self, value: pulumi.Input[
|
|
123
|
+
def return_behavior(self, value: pulumi.Input[_builtins.str]):
|
|
125
124
|
pulumi.set(self, "return_behavior", value)
|
|
126
125
|
|
|
127
|
-
@property
|
|
126
|
+
@_builtins.property
|
|
128
127
|
@pulumi.getter(name="returnType")
|
|
129
|
-
def return_type(self) -> pulumi.Input[
|
|
128
|
+
def return_type(self) -> pulumi.Input[_builtins.str]:
|
|
130
129
|
"""
|
|
131
130
|
Specifies the data type returned by the external function.
|
|
132
131
|
"""
|
|
133
132
|
return pulumi.get(self, "return_type")
|
|
134
133
|
|
|
135
134
|
@return_type.setter
|
|
136
|
-
def return_type(self, value: pulumi.Input[
|
|
135
|
+
def return_type(self, value: pulumi.Input[_builtins.str]):
|
|
137
136
|
pulumi.set(self, "return_type", value)
|
|
138
137
|
|
|
139
|
-
@property
|
|
138
|
+
@_builtins.property
|
|
140
139
|
@pulumi.getter
|
|
141
|
-
def schema(self) -> pulumi.Input[
|
|
140
|
+
def schema(self) -> pulumi.Input[_builtins.str]:
|
|
142
141
|
"""
|
|
143
142
|
The schema in which to create the external function.
|
|
144
143
|
"""
|
|
145
144
|
return pulumi.get(self, "schema")
|
|
146
145
|
|
|
147
146
|
@schema.setter
|
|
148
|
-
def schema(self, value: pulumi.Input[
|
|
147
|
+
def schema(self, value: pulumi.Input[_builtins.str]):
|
|
149
148
|
pulumi.set(self, "schema", value)
|
|
150
149
|
|
|
151
|
-
@property
|
|
150
|
+
@_builtins.property
|
|
152
151
|
@pulumi.getter(name="urlOfProxyAndResource")
|
|
153
|
-
def url_of_proxy_and_resource(self) -> pulumi.Input[
|
|
152
|
+
def url_of_proxy_and_resource(self) -> pulumi.Input[_builtins.str]:
|
|
154
153
|
"""
|
|
155
154
|
This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.
|
|
156
155
|
"""
|
|
157
156
|
return pulumi.get(self, "url_of_proxy_and_resource")
|
|
158
157
|
|
|
159
158
|
@url_of_proxy_and_resource.setter
|
|
160
|
-
def url_of_proxy_and_resource(self, value: pulumi.Input[
|
|
159
|
+
def url_of_proxy_and_resource(self, value: pulumi.Input[_builtins.str]):
|
|
161
160
|
pulumi.set(self, "url_of_proxy_and_resource", value)
|
|
162
161
|
|
|
163
|
-
@property
|
|
162
|
+
@_builtins.property
|
|
164
163
|
@pulumi.getter
|
|
165
164
|
def args(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ExternalFunctionArgArgs']]]]:
|
|
166
165
|
"""
|
|
@@ -172,43 +171,43 @@ class ExternalFunctionArgs:
|
|
|
172
171
|
def args(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ExternalFunctionArgArgs']]]]):
|
|
173
172
|
pulumi.set(self, "args", value)
|
|
174
173
|
|
|
175
|
-
@property
|
|
174
|
+
@_builtins.property
|
|
176
175
|
@pulumi.getter
|
|
177
|
-
def comment(self) -> Optional[pulumi.Input[
|
|
176
|
+
def comment(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
178
177
|
"""
|
|
179
178
|
(Default: `user-defined function`) A description of the external function.
|
|
180
179
|
"""
|
|
181
180
|
return pulumi.get(self, "comment")
|
|
182
181
|
|
|
183
182
|
@comment.setter
|
|
184
|
-
def comment(self, value: Optional[pulumi.Input[
|
|
183
|
+
def comment(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
185
184
|
pulumi.set(self, "comment", value)
|
|
186
185
|
|
|
187
|
-
@property
|
|
186
|
+
@_builtins.property
|
|
188
187
|
@pulumi.getter
|
|
189
|
-
def compression(self) -> Optional[pulumi.Input[
|
|
188
|
+
def compression(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
190
189
|
"""
|
|
191
190
|
(Default: `AUTO`) If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
|
|
192
191
|
"""
|
|
193
192
|
return pulumi.get(self, "compression")
|
|
194
193
|
|
|
195
194
|
@compression.setter
|
|
196
|
-
def compression(self, value: Optional[pulumi.Input[
|
|
195
|
+
def compression(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
197
196
|
pulumi.set(self, "compression", value)
|
|
198
197
|
|
|
199
|
-
@property
|
|
198
|
+
@_builtins.property
|
|
200
199
|
@pulumi.getter(name="contextHeaders")
|
|
201
|
-
def context_headers(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
200
|
+
def context_headers(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]:
|
|
202
201
|
"""
|
|
203
202
|
Binds Snowflake context function results to HTTP headers.
|
|
204
203
|
"""
|
|
205
204
|
return pulumi.get(self, "context_headers")
|
|
206
205
|
|
|
207
206
|
@context_headers.setter
|
|
208
|
-
def context_headers(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
207
|
+
def context_headers(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]):
|
|
209
208
|
pulumi.set(self, "context_headers", value)
|
|
210
209
|
|
|
211
|
-
@property
|
|
210
|
+
@_builtins.property
|
|
212
211
|
@pulumi.getter
|
|
213
212
|
def headers(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ExternalFunctionHeaderArgs']]]]:
|
|
214
213
|
"""
|
|
@@ -220,122 +219,122 @@ class ExternalFunctionArgs:
|
|
|
220
219
|
def headers(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ExternalFunctionHeaderArgs']]]]):
|
|
221
220
|
pulumi.set(self, "headers", value)
|
|
222
221
|
|
|
223
|
-
@property
|
|
222
|
+
@_builtins.property
|
|
224
223
|
@pulumi.getter(name="maxBatchRows")
|
|
225
|
-
def max_batch_rows(self) -> Optional[pulumi.Input[
|
|
224
|
+
def max_batch_rows(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
226
225
|
"""
|
|
227
226
|
This specifies the maximum number of rows in each batch sent to the proxy service.
|
|
228
227
|
"""
|
|
229
228
|
return pulumi.get(self, "max_batch_rows")
|
|
230
229
|
|
|
231
230
|
@max_batch_rows.setter
|
|
232
|
-
def max_batch_rows(self, value: Optional[pulumi.Input[
|
|
231
|
+
def max_batch_rows(self, value: Optional[pulumi.Input[_builtins.int]]):
|
|
233
232
|
pulumi.set(self, "max_batch_rows", value)
|
|
234
233
|
|
|
235
|
-
@property
|
|
234
|
+
@_builtins.property
|
|
236
235
|
@pulumi.getter
|
|
237
|
-
def name(self) -> Optional[pulumi.Input[
|
|
236
|
+
def name(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
238
237
|
"""
|
|
239
238
|
Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
|
|
240
239
|
"""
|
|
241
240
|
return pulumi.get(self, "name")
|
|
242
241
|
|
|
243
242
|
@name.setter
|
|
244
|
-
def name(self, value: Optional[pulumi.Input[
|
|
243
|
+
def name(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
245
244
|
pulumi.set(self, "name", value)
|
|
246
245
|
|
|
247
|
-
@property
|
|
246
|
+
@_builtins.property
|
|
248
247
|
@pulumi.getter(name="nullInputBehavior")
|
|
249
|
-
def null_input_behavior(self) -> Optional[pulumi.Input[
|
|
248
|
+
def null_input_behavior(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
250
249
|
"""
|
|
251
250
|
(Default: `CALLED ON NULL INPUT`) Specifies the behavior of the external function when called with null inputs.
|
|
252
251
|
"""
|
|
253
252
|
return pulumi.get(self, "null_input_behavior")
|
|
254
253
|
|
|
255
254
|
@null_input_behavior.setter
|
|
256
|
-
def null_input_behavior(self, value: Optional[pulumi.Input[
|
|
255
|
+
def null_input_behavior(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
257
256
|
pulumi.set(self, "null_input_behavior", value)
|
|
258
257
|
|
|
259
|
-
@property
|
|
258
|
+
@_builtins.property
|
|
260
259
|
@pulumi.getter(name="requestTranslator")
|
|
261
|
-
def request_translator(self) -> Optional[pulumi.Input[
|
|
260
|
+
def request_translator(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
262
261
|
"""
|
|
263
262
|
This specifies the name of the request translator function
|
|
264
263
|
"""
|
|
265
264
|
return pulumi.get(self, "request_translator")
|
|
266
265
|
|
|
267
266
|
@request_translator.setter
|
|
268
|
-
def request_translator(self, value: Optional[pulumi.Input[
|
|
267
|
+
def request_translator(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
269
268
|
pulumi.set(self, "request_translator", value)
|
|
270
269
|
|
|
271
|
-
@property
|
|
270
|
+
@_builtins.property
|
|
272
271
|
@pulumi.getter(name="responseTranslator")
|
|
273
|
-
def response_translator(self) -> Optional[pulumi.Input[
|
|
272
|
+
def response_translator(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
274
273
|
"""
|
|
275
274
|
This specifies the name of the response translator function.
|
|
276
275
|
"""
|
|
277
276
|
return pulumi.get(self, "response_translator")
|
|
278
277
|
|
|
279
278
|
@response_translator.setter
|
|
280
|
-
def response_translator(self, value: Optional[pulumi.Input[
|
|
279
|
+
def response_translator(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
281
280
|
pulumi.set(self, "response_translator", value)
|
|
282
281
|
|
|
283
|
-
@property
|
|
282
|
+
@_builtins.property
|
|
284
283
|
@pulumi.getter(name="returnNullAllowed")
|
|
285
|
-
def return_null_allowed(self) -> Optional[pulumi.Input[
|
|
284
|
+
def return_null_allowed(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
286
285
|
"""
|
|
287
286
|
(Default: `true`) Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
288
287
|
"""
|
|
289
288
|
return pulumi.get(self, "return_null_allowed")
|
|
290
289
|
|
|
291
290
|
@return_null_allowed.setter
|
|
292
|
-
def return_null_allowed(self, value: Optional[pulumi.Input[
|
|
291
|
+
def return_null_allowed(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
293
292
|
pulumi.set(self, "return_null_allowed", value)
|
|
294
293
|
|
|
295
294
|
|
|
296
295
|
@pulumi.input_type
|
|
297
296
|
class _ExternalFunctionState:
|
|
298
297
|
def __init__(__self__, *,
|
|
299
|
-
api_integration: Optional[pulumi.Input[
|
|
298
|
+
api_integration: Optional[pulumi.Input[_builtins.str]] = None,
|
|
300
299
|
args: Optional[pulumi.Input[Sequence[pulumi.Input['ExternalFunctionArgArgs']]]] = None,
|
|
301
|
-
comment: Optional[pulumi.Input[
|
|
302
|
-
compression: Optional[pulumi.Input[
|
|
303
|
-
context_headers: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
304
|
-
created_on: Optional[pulumi.Input[
|
|
305
|
-
database: Optional[pulumi.Input[
|
|
306
|
-
fully_qualified_name: Optional[pulumi.Input[
|
|
300
|
+
comment: Optional[pulumi.Input[_builtins.str]] = None,
|
|
301
|
+
compression: Optional[pulumi.Input[_builtins.str]] = None,
|
|
302
|
+
context_headers: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
|
|
303
|
+
created_on: Optional[pulumi.Input[_builtins.str]] = None,
|
|
304
|
+
database: Optional[pulumi.Input[_builtins.str]] = None,
|
|
305
|
+
fully_qualified_name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
307
306
|
headers: Optional[pulumi.Input[Sequence[pulumi.Input['ExternalFunctionHeaderArgs']]]] = None,
|
|
308
|
-
max_batch_rows: Optional[pulumi.Input[
|
|
309
|
-
name: Optional[pulumi.Input[
|
|
310
|
-
null_input_behavior: Optional[pulumi.Input[
|
|
311
|
-
request_translator: Optional[pulumi.Input[
|
|
312
|
-
response_translator: Optional[pulumi.Input[
|
|
313
|
-
return_behavior: Optional[pulumi.Input[
|
|
314
|
-
return_null_allowed: Optional[pulumi.Input[
|
|
315
|
-
return_type: Optional[pulumi.Input[
|
|
316
|
-
schema: Optional[pulumi.Input[
|
|
317
|
-
url_of_proxy_and_resource: Optional[pulumi.Input[
|
|
307
|
+
max_batch_rows: Optional[pulumi.Input[_builtins.int]] = None,
|
|
308
|
+
name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
309
|
+
null_input_behavior: Optional[pulumi.Input[_builtins.str]] = None,
|
|
310
|
+
request_translator: Optional[pulumi.Input[_builtins.str]] = None,
|
|
311
|
+
response_translator: Optional[pulumi.Input[_builtins.str]] = None,
|
|
312
|
+
return_behavior: Optional[pulumi.Input[_builtins.str]] = None,
|
|
313
|
+
return_null_allowed: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
314
|
+
return_type: Optional[pulumi.Input[_builtins.str]] = None,
|
|
315
|
+
schema: Optional[pulumi.Input[_builtins.str]] = None,
|
|
316
|
+
url_of_proxy_and_resource: Optional[pulumi.Input[_builtins.str]] = None):
|
|
318
317
|
"""
|
|
319
318
|
Input properties used for looking up and filtering ExternalFunction resources.
|
|
320
|
-
:param pulumi.Input[
|
|
319
|
+
:param pulumi.Input[_builtins.str] api_integration: The name of the API integration object that should be used to authenticate the call to the proxy service.
|
|
321
320
|
:param pulumi.Input[Sequence[pulumi.Input['ExternalFunctionArgArgs']]] args: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
|
|
322
|
-
:param pulumi.Input[
|
|
323
|
-
:param pulumi.Input[
|
|
324
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
325
|
-
:param pulumi.Input[
|
|
326
|
-
:param pulumi.Input[
|
|
327
|
-
:param pulumi.Input[
|
|
321
|
+
:param pulumi.Input[_builtins.str] comment: (Default: `user-defined function`) A description of the external function.
|
|
322
|
+
:param pulumi.Input[_builtins.str] compression: (Default: `AUTO`) If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
|
|
323
|
+
:param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] context_headers: Binds Snowflake context function results to HTTP headers.
|
|
324
|
+
:param pulumi.Input[_builtins.str] created_on: Date and time when the external function was created.
|
|
325
|
+
:param pulumi.Input[_builtins.str] database: The database in which to create the external function.
|
|
326
|
+
:param pulumi.Input[_builtins.str] fully_qualified_name: Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
|
|
328
327
|
:param pulumi.Input[Sequence[pulumi.Input['ExternalFunctionHeaderArgs']]] headers: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
|
|
329
|
-
:param pulumi.Input[
|
|
330
|
-
:param pulumi.Input[
|
|
331
|
-
:param pulumi.Input[
|
|
332
|
-
:param pulumi.Input[
|
|
333
|
-
:param pulumi.Input[
|
|
334
|
-
:param pulumi.Input[
|
|
335
|
-
:param pulumi.Input[
|
|
336
|
-
:param pulumi.Input[
|
|
337
|
-
:param pulumi.Input[
|
|
338
|
-
:param pulumi.Input[
|
|
328
|
+
:param pulumi.Input[_builtins.int] max_batch_rows: This specifies the maximum number of rows in each batch sent to the proxy service.
|
|
329
|
+
:param pulumi.Input[_builtins.str] name: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
|
|
330
|
+
:param pulumi.Input[_builtins.str] null_input_behavior: (Default: `CALLED ON NULL INPUT`) Specifies the behavior of the external function when called with null inputs.
|
|
331
|
+
:param pulumi.Input[_builtins.str] request_translator: This specifies the name of the request translator function
|
|
332
|
+
:param pulumi.Input[_builtins.str] response_translator: This specifies the name of the response translator function.
|
|
333
|
+
:param pulumi.Input[_builtins.str] return_behavior: Specifies the behavior of the function when returning results
|
|
334
|
+
:param pulumi.Input[_builtins.bool] return_null_allowed: (Default: `true`) Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
335
|
+
:param pulumi.Input[_builtins.str] return_type: Specifies the data type returned by the external function.
|
|
336
|
+
:param pulumi.Input[_builtins.str] schema: The schema in which to create the external function.
|
|
337
|
+
:param pulumi.Input[_builtins.str] url_of_proxy_and_resource: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.
|
|
339
338
|
"""
|
|
340
339
|
if api_integration is not None:
|
|
341
340
|
pulumi.set(__self__, "api_integration", api_integration)
|
|
@@ -376,19 +375,19 @@ class _ExternalFunctionState:
|
|
|
376
375
|
if url_of_proxy_and_resource is not None:
|
|
377
376
|
pulumi.set(__self__, "url_of_proxy_and_resource", url_of_proxy_and_resource)
|
|
378
377
|
|
|
379
|
-
@property
|
|
378
|
+
@_builtins.property
|
|
380
379
|
@pulumi.getter(name="apiIntegration")
|
|
381
|
-
def api_integration(self) -> Optional[pulumi.Input[
|
|
380
|
+
def api_integration(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
382
381
|
"""
|
|
383
382
|
The name of the API integration object that should be used to authenticate the call to the proxy service.
|
|
384
383
|
"""
|
|
385
384
|
return pulumi.get(self, "api_integration")
|
|
386
385
|
|
|
387
386
|
@api_integration.setter
|
|
388
|
-
def api_integration(self, value: Optional[pulumi.Input[
|
|
387
|
+
def api_integration(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
389
388
|
pulumi.set(self, "api_integration", value)
|
|
390
389
|
|
|
391
|
-
@property
|
|
390
|
+
@_builtins.property
|
|
392
391
|
@pulumi.getter
|
|
393
392
|
def args(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ExternalFunctionArgArgs']]]]:
|
|
394
393
|
"""
|
|
@@ -400,79 +399,79 @@ class _ExternalFunctionState:
|
|
|
400
399
|
def args(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ExternalFunctionArgArgs']]]]):
|
|
401
400
|
pulumi.set(self, "args", value)
|
|
402
401
|
|
|
403
|
-
@property
|
|
402
|
+
@_builtins.property
|
|
404
403
|
@pulumi.getter
|
|
405
|
-
def comment(self) -> Optional[pulumi.Input[
|
|
404
|
+
def comment(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
406
405
|
"""
|
|
407
406
|
(Default: `user-defined function`) A description of the external function.
|
|
408
407
|
"""
|
|
409
408
|
return pulumi.get(self, "comment")
|
|
410
409
|
|
|
411
410
|
@comment.setter
|
|
412
|
-
def comment(self, value: Optional[pulumi.Input[
|
|
411
|
+
def comment(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
413
412
|
pulumi.set(self, "comment", value)
|
|
414
413
|
|
|
415
|
-
@property
|
|
414
|
+
@_builtins.property
|
|
416
415
|
@pulumi.getter
|
|
417
|
-
def compression(self) -> Optional[pulumi.Input[
|
|
416
|
+
def compression(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
418
417
|
"""
|
|
419
418
|
(Default: `AUTO`) If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
|
|
420
419
|
"""
|
|
421
420
|
return pulumi.get(self, "compression")
|
|
422
421
|
|
|
423
422
|
@compression.setter
|
|
424
|
-
def compression(self, value: Optional[pulumi.Input[
|
|
423
|
+
def compression(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
425
424
|
pulumi.set(self, "compression", value)
|
|
426
425
|
|
|
427
|
-
@property
|
|
426
|
+
@_builtins.property
|
|
428
427
|
@pulumi.getter(name="contextHeaders")
|
|
429
|
-
def context_headers(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
428
|
+
def context_headers(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]:
|
|
430
429
|
"""
|
|
431
430
|
Binds Snowflake context function results to HTTP headers.
|
|
432
431
|
"""
|
|
433
432
|
return pulumi.get(self, "context_headers")
|
|
434
433
|
|
|
435
434
|
@context_headers.setter
|
|
436
|
-
def context_headers(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
435
|
+
def context_headers(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]):
|
|
437
436
|
pulumi.set(self, "context_headers", value)
|
|
438
437
|
|
|
439
|
-
@property
|
|
438
|
+
@_builtins.property
|
|
440
439
|
@pulumi.getter(name="createdOn")
|
|
441
|
-
def created_on(self) -> Optional[pulumi.Input[
|
|
440
|
+
def created_on(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
442
441
|
"""
|
|
443
442
|
Date and time when the external function was created.
|
|
444
443
|
"""
|
|
445
444
|
return pulumi.get(self, "created_on")
|
|
446
445
|
|
|
447
446
|
@created_on.setter
|
|
448
|
-
def created_on(self, value: Optional[pulumi.Input[
|
|
447
|
+
def created_on(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
449
448
|
pulumi.set(self, "created_on", value)
|
|
450
449
|
|
|
451
|
-
@property
|
|
450
|
+
@_builtins.property
|
|
452
451
|
@pulumi.getter
|
|
453
|
-
def database(self) -> Optional[pulumi.Input[
|
|
452
|
+
def database(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
454
453
|
"""
|
|
455
454
|
The database in which to create the external function.
|
|
456
455
|
"""
|
|
457
456
|
return pulumi.get(self, "database")
|
|
458
457
|
|
|
459
458
|
@database.setter
|
|
460
|
-
def database(self, value: Optional[pulumi.Input[
|
|
459
|
+
def database(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
461
460
|
pulumi.set(self, "database", value)
|
|
462
461
|
|
|
463
|
-
@property
|
|
462
|
+
@_builtins.property
|
|
464
463
|
@pulumi.getter(name="fullyQualifiedName")
|
|
465
|
-
def fully_qualified_name(self) -> Optional[pulumi.Input[
|
|
464
|
+
def fully_qualified_name(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
466
465
|
"""
|
|
467
466
|
Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
|
|
468
467
|
"""
|
|
469
468
|
return pulumi.get(self, "fully_qualified_name")
|
|
470
469
|
|
|
471
470
|
@fully_qualified_name.setter
|
|
472
|
-
def fully_qualified_name(self, value: Optional[pulumi.Input[
|
|
471
|
+
def fully_qualified_name(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
473
472
|
pulumi.set(self, "fully_qualified_name", value)
|
|
474
473
|
|
|
475
|
-
@property
|
|
474
|
+
@_builtins.property
|
|
476
475
|
@pulumi.getter
|
|
477
476
|
def headers(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ExternalFunctionHeaderArgs']]]]:
|
|
478
477
|
"""
|
|
@@ -484,124 +483,124 @@ class _ExternalFunctionState:
|
|
|
484
483
|
def headers(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ExternalFunctionHeaderArgs']]]]):
|
|
485
484
|
pulumi.set(self, "headers", value)
|
|
486
485
|
|
|
487
|
-
@property
|
|
486
|
+
@_builtins.property
|
|
488
487
|
@pulumi.getter(name="maxBatchRows")
|
|
489
|
-
def max_batch_rows(self) -> Optional[pulumi.Input[
|
|
488
|
+
def max_batch_rows(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
490
489
|
"""
|
|
491
490
|
This specifies the maximum number of rows in each batch sent to the proxy service.
|
|
492
491
|
"""
|
|
493
492
|
return pulumi.get(self, "max_batch_rows")
|
|
494
493
|
|
|
495
494
|
@max_batch_rows.setter
|
|
496
|
-
def max_batch_rows(self, value: Optional[pulumi.Input[
|
|
495
|
+
def max_batch_rows(self, value: Optional[pulumi.Input[_builtins.int]]):
|
|
497
496
|
pulumi.set(self, "max_batch_rows", value)
|
|
498
497
|
|
|
499
|
-
@property
|
|
498
|
+
@_builtins.property
|
|
500
499
|
@pulumi.getter
|
|
501
|
-
def name(self) -> Optional[pulumi.Input[
|
|
500
|
+
def name(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
502
501
|
"""
|
|
503
502
|
Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
|
|
504
503
|
"""
|
|
505
504
|
return pulumi.get(self, "name")
|
|
506
505
|
|
|
507
506
|
@name.setter
|
|
508
|
-
def name(self, value: Optional[pulumi.Input[
|
|
507
|
+
def name(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
509
508
|
pulumi.set(self, "name", value)
|
|
510
509
|
|
|
511
|
-
@property
|
|
510
|
+
@_builtins.property
|
|
512
511
|
@pulumi.getter(name="nullInputBehavior")
|
|
513
|
-
def null_input_behavior(self) -> Optional[pulumi.Input[
|
|
512
|
+
def null_input_behavior(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
514
513
|
"""
|
|
515
514
|
(Default: `CALLED ON NULL INPUT`) Specifies the behavior of the external function when called with null inputs.
|
|
516
515
|
"""
|
|
517
516
|
return pulumi.get(self, "null_input_behavior")
|
|
518
517
|
|
|
519
518
|
@null_input_behavior.setter
|
|
520
|
-
def null_input_behavior(self, value: Optional[pulumi.Input[
|
|
519
|
+
def null_input_behavior(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
521
520
|
pulumi.set(self, "null_input_behavior", value)
|
|
522
521
|
|
|
523
|
-
@property
|
|
522
|
+
@_builtins.property
|
|
524
523
|
@pulumi.getter(name="requestTranslator")
|
|
525
|
-
def request_translator(self) -> Optional[pulumi.Input[
|
|
524
|
+
def request_translator(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
526
525
|
"""
|
|
527
526
|
This specifies the name of the request translator function
|
|
528
527
|
"""
|
|
529
528
|
return pulumi.get(self, "request_translator")
|
|
530
529
|
|
|
531
530
|
@request_translator.setter
|
|
532
|
-
def request_translator(self, value: Optional[pulumi.Input[
|
|
531
|
+
def request_translator(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
533
532
|
pulumi.set(self, "request_translator", value)
|
|
534
533
|
|
|
535
|
-
@property
|
|
534
|
+
@_builtins.property
|
|
536
535
|
@pulumi.getter(name="responseTranslator")
|
|
537
|
-
def response_translator(self) -> Optional[pulumi.Input[
|
|
536
|
+
def response_translator(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
538
537
|
"""
|
|
539
538
|
This specifies the name of the response translator function.
|
|
540
539
|
"""
|
|
541
540
|
return pulumi.get(self, "response_translator")
|
|
542
541
|
|
|
543
542
|
@response_translator.setter
|
|
544
|
-
def response_translator(self, value: Optional[pulumi.Input[
|
|
543
|
+
def response_translator(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
545
544
|
pulumi.set(self, "response_translator", value)
|
|
546
545
|
|
|
547
|
-
@property
|
|
546
|
+
@_builtins.property
|
|
548
547
|
@pulumi.getter(name="returnBehavior")
|
|
549
|
-
def return_behavior(self) -> Optional[pulumi.Input[
|
|
548
|
+
def return_behavior(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
550
549
|
"""
|
|
551
550
|
Specifies the behavior of the function when returning results
|
|
552
551
|
"""
|
|
553
552
|
return pulumi.get(self, "return_behavior")
|
|
554
553
|
|
|
555
554
|
@return_behavior.setter
|
|
556
|
-
def return_behavior(self, value: Optional[pulumi.Input[
|
|
555
|
+
def return_behavior(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
557
556
|
pulumi.set(self, "return_behavior", value)
|
|
558
557
|
|
|
559
|
-
@property
|
|
558
|
+
@_builtins.property
|
|
560
559
|
@pulumi.getter(name="returnNullAllowed")
|
|
561
|
-
def return_null_allowed(self) -> Optional[pulumi.Input[
|
|
560
|
+
def return_null_allowed(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
562
561
|
"""
|
|
563
562
|
(Default: `true`) Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
564
563
|
"""
|
|
565
564
|
return pulumi.get(self, "return_null_allowed")
|
|
566
565
|
|
|
567
566
|
@return_null_allowed.setter
|
|
568
|
-
def return_null_allowed(self, value: Optional[pulumi.Input[
|
|
567
|
+
def return_null_allowed(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
569
568
|
pulumi.set(self, "return_null_allowed", value)
|
|
570
569
|
|
|
571
|
-
@property
|
|
570
|
+
@_builtins.property
|
|
572
571
|
@pulumi.getter(name="returnType")
|
|
573
|
-
def return_type(self) -> Optional[pulumi.Input[
|
|
572
|
+
def return_type(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
574
573
|
"""
|
|
575
574
|
Specifies the data type returned by the external function.
|
|
576
575
|
"""
|
|
577
576
|
return pulumi.get(self, "return_type")
|
|
578
577
|
|
|
579
578
|
@return_type.setter
|
|
580
|
-
def return_type(self, value: Optional[pulumi.Input[
|
|
579
|
+
def return_type(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
581
580
|
pulumi.set(self, "return_type", value)
|
|
582
581
|
|
|
583
|
-
@property
|
|
582
|
+
@_builtins.property
|
|
584
583
|
@pulumi.getter
|
|
585
|
-
def schema(self) -> Optional[pulumi.Input[
|
|
584
|
+
def schema(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
586
585
|
"""
|
|
587
586
|
The schema in which to create the external function.
|
|
588
587
|
"""
|
|
589
588
|
return pulumi.get(self, "schema")
|
|
590
589
|
|
|
591
590
|
@schema.setter
|
|
592
|
-
def schema(self, value: Optional[pulumi.Input[
|
|
591
|
+
def schema(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
593
592
|
pulumi.set(self, "schema", value)
|
|
594
593
|
|
|
595
|
-
@property
|
|
594
|
+
@_builtins.property
|
|
596
595
|
@pulumi.getter(name="urlOfProxyAndResource")
|
|
597
|
-
def url_of_proxy_and_resource(self) -> Optional[pulumi.Input[
|
|
596
|
+
def url_of_proxy_and_resource(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
598
597
|
"""
|
|
599
598
|
This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.
|
|
600
599
|
"""
|
|
601
600
|
return pulumi.get(self, "url_of_proxy_and_resource")
|
|
602
601
|
|
|
603
602
|
@url_of_proxy_and_resource.setter
|
|
604
|
-
def url_of_proxy_and_resource(self, value: Optional[pulumi.Input[
|
|
603
|
+
def url_of_proxy_and_resource(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
605
604
|
pulumi.set(self, "url_of_proxy_and_resource", value)
|
|
606
605
|
|
|
607
606
|
|
|
@@ -611,23 +610,23 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
611
610
|
def __init__(__self__,
|
|
612
611
|
resource_name: str,
|
|
613
612
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
614
|
-
api_integration: Optional[pulumi.Input[
|
|
613
|
+
api_integration: Optional[pulumi.Input[_builtins.str]] = None,
|
|
615
614
|
args: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ExternalFunctionArgArgs', 'ExternalFunctionArgArgsDict']]]]] = None,
|
|
616
|
-
comment: Optional[pulumi.Input[
|
|
617
|
-
compression: Optional[pulumi.Input[
|
|
618
|
-
context_headers: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
619
|
-
database: Optional[pulumi.Input[
|
|
615
|
+
comment: Optional[pulumi.Input[_builtins.str]] = None,
|
|
616
|
+
compression: Optional[pulumi.Input[_builtins.str]] = None,
|
|
617
|
+
context_headers: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
|
|
618
|
+
database: Optional[pulumi.Input[_builtins.str]] = None,
|
|
620
619
|
headers: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ExternalFunctionHeaderArgs', 'ExternalFunctionHeaderArgsDict']]]]] = None,
|
|
621
|
-
max_batch_rows: Optional[pulumi.Input[
|
|
622
|
-
name: Optional[pulumi.Input[
|
|
623
|
-
null_input_behavior: Optional[pulumi.Input[
|
|
624
|
-
request_translator: Optional[pulumi.Input[
|
|
625
|
-
response_translator: Optional[pulumi.Input[
|
|
626
|
-
return_behavior: Optional[pulumi.Input[
|
|
627
|
-
return_null_allowed: Optional[pulumi.Input[
|
|
628
|
-
return_type: Optional[pulumi.Input[
|
|
629
|
-
schema: Optional[pulumi.Input[
|
|
630
|
-
url_of_proxy_and_resource: Optional[pulumi.Input[
|
|
620
|
+
max_batch_rows: Optional[pulumi.Input[_builtins.int]] = None,
|
|
621
|
+
name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
622
|
+
null_input_behavior: Optional[pulumi.Input[_builtins.str]] = None,
|
|
623
|
+
request_translator: Optional[pulumi.Input[_builtins.str]] = None,
|
|
624
|
+
response_translator: Optional[pulumi.Input[_builtins.str]] = None,
|
|
625
|
+
return_behavior: Optional[pulumi.Input[_builtins.str]] = None,
|
|
626
|
+
return_null_allowed: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
627
|
+
return_type: Optional[pulumi.Input[_builtins.str]] = None,
|
|
628
|
+
schema: Optional[pulumi.Input[_builtins.str]] = None,
|
|
629
|
+
url_of_proxy_and_resource: Optional[pulumi.Input[_builtins.str]] = None,
|
|
631
630
|
__props__=None):
|
|
632
631
|
"""
|
|
633
632
|
## Import
|
|
@@ -640,23 +639,23 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
640
639
|
|
|
641
640
|
:param str resource_name: The name of the resource.
|
|
642
641
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
643
|
-
:param pulumi.Input[
|
|
642
|
+
:param pulumi.Input[_builtins.str] api_integration: The name of the API integration object that should be used to authenticate the call to the proxy service.
|
|
644
643
|
:param pulumi.Input[Sequence[pulumi.Input[Union['ExternalFunctionArgArgs', 'ExternalFunctionArgArgsDict']]]] args: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
|
|
645
|
-
:param pulumi.Input[
|
|
646
|
-
:param pulumi.Input[
|
|
647
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
648
|
-
:param pulumi.Input[
|
|
644
|
+
:param pulumi.Input[_builtins.str] comment: (Default: `user-defined function`) A description of the external function.
|
|
645
|
+
:param pulumi.Input[_builtins.str] compression: (Default: `AUTO`) If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
|
|
646
|
+
:param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] context_headers: Binds Snowflake context function results to HTTP headers.
|
|
647
|
+
:param pulumi.Input[_builtins.str] database: The database in which to create the external function.
|
|
649
648
|
:param pulumi.Input[Sequence[pulumi.Input[Union['ExternalFunctionHeaderArgs', 'ExternalFunctionHeaderArgsDict']]]] headers: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
|
|
650
|
-
:param pulumi.Input[
|
|
651
|
-
:param pulumi.Input[
|
|
652
|
-
:param pulumi.Input[
|
|
653
|
-
:param pulumi.Input[
|
|
654
|
-
:param pulumi.Input[
|
|
655
|
-
:param pulumi.Input[
|
|
656
|
-
:param pulumi.Input[
|
|
657
|
-
:param pulumi.Input[
|
|
658
|
-
:param pulumi.Input[
|
|
659
|
-
:param pulumi.Input[
|
|
649
|
+
:param pulumi.Input[_builtins.int] max_batch_rows: This specifies the maximum number of rows in each batch sent to the proxy service.
|
|
650
|
+
:param pulumi.Input[_builtins.str] name: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
|
|
651
|
+
:param pulumi.Input[_builtins.str] null_input_behavior: (Default: `CALLED ON NULL INPUT`) Specifies the behavior of the external function when called with null inputs.
|
|
652
|
+
:param pulumi.Input[_builtins.str] request_translator: This specifies the name of the request translator function
|
|
653
|
+
:param pulumi.Input[_builtins.str] response_translator: This specifies the name of the response translator function.
|
|
654
|
+
:param pulumi.Input[_builtins.str] return_behavior: Specifies the behavior of the function when returning results
|
|
655
|
+
:param pulumi.Input[_builtins.bool] return_null_allowed: (Default: `true`) Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
656
|
+
:param pulumi.Input[_builtins.str] return_type: Specifies the data type returned by the external function.
|
|
657
|
+
:param pulumi.Input[_builtins.str] schema: The schema in which to create the external function.
|
|
658
|
+
:param pulumi.Input[_builtins.str] url_of_proxy_and_resource: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.
|
|
660
659
|
"""
|
|
661
660
|
...
|
|
662
661
|
@overload
|
|
@@ -688,23 +687,23 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
688
687
|
def _internal_init(__self__,
|
|
689
688
|
resource_name: str,
|
|
690
689
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
691
|
-
api_integration: Optional[pulumi.Input[
|
|
690
|
+
api_integration: Optional[pulumi.Input[_builtins.str]] = None,
|
|
692
691
|
args: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ExternalFunctionArgArgs', 'ExternalFunctionArgArgsDict']]]]] = None,
|
|
693
|
-
comment: Optional[pulumi.Input[
|
|
694
|
-
compression: Optional[pulumi.Input[
|
|
695
|
-
context_headers: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
696
|
-
database: Optional[pulumi.Input[
|
|
692
|
+
comment: Optional[pulumi.Input[_builtins.str]] = None,
|
|
693
|
+
compression: Optional[pulumi.Input[_builtins.str]] = None,
|
|
694
|
+
context_headers: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
|
|
695
|
+
database: Optional[pulumi.Input[_builtins.str]] = None,
|
|
697
696
|
headers: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ExternalFunctionHeaderArgs', 'ExternalFunctionHeaderArgsDict']]]]] = None,
|
|
698
|
-
max_batch_rows: Optional[pulumi.Input[
|
|
699
|
-
name: Optional[pulumi.Input[
|
|
700
|
-
null_input_behavior: Optional[pulumi.Input[
|
|
701
|
-
request_translator: Optional[pulumi.Input[
|
|
702
|
-
response_translator: Optional[pulumi.Input[
|
|
703
|
-
return_behavior: Optional[pulumi.Input[
|
|
704
|
-
return_null_allowed: Optional[pulumi.Input[
|
|
705
|
-
return_type: Optional[pulumi.Input[
|
|
706
|
-
schema: Optional[pulumi.Input[
|
|
707
|
-
url_of_proxy_and_resource: Optional[pulumi.Input[
|
|
697
|
+
max_batch_rows: Optional[pulumi.Input[_builtins.int]] = None,
|
|
698
|
+
name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
699
|
+
null_input_behavior: Optional[pulumi.Input[_builtins.str]] = None,
|
|
700
|
+
request_translator: Optional[pulumi.Input[_builtins.str]] = None,
|
|
701
|
+
response_translator: Optional[pulumi.Input[_builtins.str]] = None,
|
|
702
|
+
return_behavior: Optional[pulumi.Input[_builtins.str]] = None,
|
|
703
|
+
return_null_allowed: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
704
|
+
return_type: Optional[pulumi.Input[_builtins.str]] = None,
|
|
705
|
+
schema: Optional[pulumi.Input[_builtins.str]] = None,
|
|
706
|
+
url_of_proxy_and_resource: Optional[pulumi.Input[_builtins.str]] = None,
|
|
708
707
|
__props__=None):
|
|
709
708
|
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
|
|
710
709
|
if not isinstance(opts, pulumi.ResourceOptions):
|
|
@@ -755,25 +754,25 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
755
754
|
def get(resource_name: str,
|
|
756
755
|
id: pulumi.Input[str],
|
|
757
756
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
758
|
-
api_integration: Optional[pulumi.Input[
|
|
757
|
+
api_integration: Optional[pulumi.Input[_builtins.str]] = None,
|
|
759
758
|
args: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ExternalFunctionArgArgs', 'ExternalFunctionArgArgsDict']]]]] = None,
|
|
760
|
-
comment: Optional[pulumi.Input[
|
|
761
|
-
compression: Optional[pulumi.Input[
|
|
762
|
-
context_headers: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
763
|
-
created_on: Optional[pulumi.Input[
|
|
764
|
-
database: Optional[pulumi.Input[
|
|
765
|
-
fully_qualified_name: Optional[pulumi.Input[
|
|
759
|
+
comment: Optional[pulumi.Input[_builtins.str]] = None,
|
|
760
|
+
compression: Optional[pulumi.Input[_builtins.str]] = None,
|
|
761
|
+
context_headers: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
|
|
762
|
+
created_on: Optional[pulumi.Input[_builtins.str]] = None,
|
|
763
|
+
database: Optional[pulumi.Input[_builtins.str]] = None,
|
|
764
|
+
fully_qualified_name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
766
765
|
headers: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ExternalFunctionHeaderArgs', 'ExternalFunctionHeaderArgsDict']]]]] = None,
|
|
767
|
-
max_batch_rows: Optional[pulumi.Input[
|
|
768
|
-
name: Optional[pulumi.Input[
|
|
769
|
-
null_input_behavior: Optional[pulumi.Input[
|
|
770
|
-
request_translator: Optional[pulumi.Input[
|
|
771
|
-
response_translator: Optional[pulumi.Input[
|
|
772
|
-
return_behavior: Optional[pulumi.Input[
|
|
773
|
-
return_null_allowed: Optional[pulumi.Input[
|
|
774
|
-
return_type: Optional[pulumi.Input[
|
|
775
|
-
schema: Optional[pulumi.Input[
|
|
776
|
-
url_of_proxy_and_resource: Optional[pulumi.Input[
|
|
766
|
+
max_batch_rows: Optional[pulumi.Input[_builtins.int]] = None,
|
|
767
|
+
name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
768
|
+
null_input_behavior: Optional[pulumi.Input[_builtins.str]] = None,
|
|
769
|
+
request_translator: Optional[pulumi.Input[_builtins.str]] = None,
|
|
770
|
+
response_translator: Optional[pulumi.Input[_builtins.str]] = None,
|
|
771
|
+
return_behavior: Optional[pulumi.Input[_builtins.str]] = None,
|
|
772
|
+
return_null_allowed: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
773
|
+
return_type: Optional[pulumi.Input[_builtins.str]] = None,
|
|
774
|
+
schema: Optional[pulumi.Input[_builtins.str]] = None,
|
|
775
|
+
url_of_proxy_and_resource: Optional[pulumi.Input[_builtins.str]] = None) -> 'ExternalFunction':
|
|
777
776
|
"""
|
|
778
777
|
Get an existing ExternalFunction resource's state with the given name, id, and optional extra
|
|
779
778
|
properties used to qualify the lookup.
|
|
@@ -781,25 +780,25 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
781
780
|
:param str resource_name: The unique name of the resulting resource.
|
|
782
781
|
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
|
783
782
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
784
|
-
:param pulumi.Input[
|
|
783
|
+
:param pulumi.Input[_builtins.str] api_integration: The name of the API integration object that should be used to authenticate the call to the proxy service.
|
|
785
784
|
:param pulumi.Input[Sequence[pulumi.Input[Union['ExternalFunctionArgArgs', 'ExternalFunctionArgArgsDict']]]] args: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
|
|
786
|
-
:param pulumi.Input[
|
|
787
|
-
:param pulumi.Input[
|
|
788
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
789
|
-
:param pulumi.Input[
|
|
790
|
-
:param pulumi.Input[
|
|
791
|
-
:param pulumi.Input[
|
|
785
|
+
:param pulumi.Input[_builtins.str] comment: (Default: `user-defined function`) A description of the external function.
|
|
786
|
+
:param pulumi.Input[_builtins.str] compression: (Default: `AUTO`) If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
|
|
787
|
+
:param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] context_headers: Binds Snowflake context function results to HTTP headers.
|
|
788
|
+
:param pulumi.Input[_builtins.str] created_on: Date and time when the external function was created.
|
|
789
|
+
:param pulumi.Input[_builtins.str] database: The database in which to create the external function.
|
|
790
|
+
:param pulumi.Input[_builtins.str] fully_qualified_name: Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
|
|
792
791
|
:param pulumi.Input[Sequence[pulumi.Input[Union['ExternalFunctionHeaderArgs', 'ExternalFunctionHeaderArgsDict']]]] headers: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
|
|
793
|
-
:param pulumi.Input[
|
|
794
|
-
:param pulumi.Input[
|
|
795
|
-
:param pulumi.Input[
|
|
796
|
-
:param pulumi.Input[
|
|
797
|
-
:param pulumi.Input[
|
|
798
|
-
:param pulumi.Input[
|
|
799
|
-
:param pulumi.Input[
|
|
800
|
-
:param pulumi.Input[
|
|
801
|
-
:param pulumi.Input[
|
|
802
|
-
:param pulumi.Input[
|
|
792
|
+
:param pulumi.Input[_builtins.int] max_batch_rows: This specifies the maximum number of rows in each batch sent to the proxy service.
|
|
793
|
+
:param pulumi.Input[_builtins.str] name: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
|
|
794
|
+
:param pulumi.Input[_builtins.str] null_input_behavior: (Default: `CALLED ON NULL INPUT`) Specifies the behavior of the external function when called with null inputs.
|
|
795
|
+
:param pulumi.Input[_builtins.str] request_translator: This specifies the name of the request translator function
|
|
796
|
+
:param pulumi.Input[_builtins.str] response_translator: This specifies the name of the response translator function.
|
|
797
|
+
:param pulumi.Input[_builtins.str] return_behavior: Specifies the behavior of the function when returning results
|
|
798
|
+
:param pulumi.Input[_builtins.bool] return_null_allowed: (Default: `true`) Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
799
|
+
:param pulumi.Input[_builtins.str] return_type: Specifies the data type returned by the external function.
|
|
800
|
+
:param pulumi.Input[_builtins.str] schema: The schema in which to create the external function.
|
|
801
|
+
:param pulumi.Input[_builtins.str] url_of_proxy_and_resource: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.
|
|
803
802
|
"""
|
|
804
803
|
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
|
|
805
804
|
|
|
@@ -826,15 +825,15 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
826
825
|
__props__.__dict__["url_of_proxy_and_resource"] = url_of_proxy_and_resource
|
|
827
826
|
return ExternalFunction(resource_name, opts=opts, __props__=__props__)
|
|
828
827
|
|
|
829
|
-
@property
|
|
828
|
+
@_builtins.property
|
|
830
829
|
@pulumi.getter(name="apiIntegration")
|
|
831
|
-
def api_integration(self) -> pulumi.Output[
|
|
830
|
+
def api_integration(self) -> pulumi.Output[_builtins.str]:
|
|
832
831
|
"""
|
|
833
832
|
The name of the API integration object that should be used to authenticate the call to the proxy service.
|
|
834
833
|
"""
|
|
835
834
|
return pulumi.get(self, "api_integration")
|
|
836
835
|
|
|
837
|
-
@property
|
|
836
|
+
@_builtins.property
|
|
838
837
|
@pulumi.getter
|
|
839
838
|
def args(self) -> pulumi.Output[Optional[Sequence['outputs.ExternalFunctionArg']]]:
|
|
840
839
|
"""
|
|
@@ -842,55 +841,55 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
842
841
|
"""
|
|
843
842
|
return pulumi.get(self, "args")
|
|
844
843
|
|
|
845
|
-
@property
|
|
844
|
+
@_builtins.property
|
|
846
845
|
@pulumi.getter
|
|
847
|
-
def comment(self) -> pulumi.Output[Optional[
|
|
846
|
+
def comment(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
848
847
|
"""
|
|
849
848
|
(Default: `user-defined function`) A description of the external function.
|
|
850
849
|
"""
|
|
851
850
|
return pulumi.get(self, "comment")
|
|
852
851
|
|
|
853
|
-
@property
|
|
852
|
+
@_builtins.property
|
|
854
853
|
@pulumi.getter
|
|
855
|
-
def compression(self) -> pulumi.Output[Optional[
|
|
854
|
+
def compression(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
856
855
|
"""
|
|
857
856
|
(Default: `AUTO`) If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
|
|
858
857
|
"""
|
|
859
858
|
return pulumi.get(self, "compression")
|
|
860
859
|
|
|
861
|
-
@property
|
|
860
|
+
@_builtins.property
|
|
862
861
|
@pulumi.getter(name="contextHeaders")
|
|
863
|
-
def context_headers(self) -> pulumi.Output[Optional[Sequence[
|
|
862
|
+
def context_headers(self) -> pulumi.Output[Optional[Sequence[_builtins.str]]]:
|
|
864
863
|
"""
|
|
865
864
|
Binds Snowflake context function results to HTTP headers.
|
|
866
865
|
"""
|
|
867
866
|
return pulumi.get(self, "context_headers")
|
|
868
867
|
|
|
869
|
-
@property
|
|
868
|
+
@_builtins.property
|
|
870
869
|
@pulumi.getter(name="createdOn")
|
|
871
|
-
def created_on(self) -> pulumi.Output[
|
|
870
|
+
def created_on(self) -> pulumi.Output[_builtins.str]:
|
|
872
871
|
"""
|
|
873
872
|
Date and time when the external function was created.
|
|
874
873
|
"""
|
|
875
874
|
return pulumi.get(self, "created_on")
|
|
876
875
|
|
|
877
|
-
@property
|
|
876
|
+
@_builtins.property
|
|
878
877
|
@pulumi.getter
|
|
879
|
-
def database(self) -> pulumi.Output[
|
|
878
|
+
def database(self) -> pulumi.Output[_builtins.str]:
|
|
880
879
|
"""
|
|
881
880
|
The database in which to create the external function.
|
|
882
881
|
"""
|
|
883
882
|
return pulumi.get(self, "database")
|
|
884
883
|
|
|
885
|
-
@property
|
|
884
|
+
@_builtins.property
|
|
886
885
|
@pulumi.getter(name="fullyQualifiedName")
|
|
887
|
-
def fully_qualified_name(self) -> pulumi.Output[
|
|
886
|
+
def fully_qualified_name(self) -> pulumi.Output[_builtins.str]:
|
|
888
887
|
"""
|
|
889
888
|
Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
|
|
890
889
|
"""
|
|
891
890
|
return pulumi.get(self, "fully_qualified_name")
|
|
892
891
|
|
|
893
|
-
@property
|
|
892
|
+
@_builtins.property
|
|
894
893
|
@pulumi.getter
|
|
895
894
|
def headers(self) -> pulumi.Output[Optional[Sequence['outputs.ExternalFunctionHeader']]]:
|
|
896
895
|
"""
|
|
@@ -898,81 +897,81 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
898
897
|
"""
|
|
899
898
|
return pulumi.get(self, "headers")
|
|
900
899
|
|
|
901
|
-
@property
|
|
900
|
+
@_builtins.property
|
|
902
901
|
@pulumi.getter(name="maxBatchRows")
|
|
903
|
-
def max_batch_rows(self) -> pulumi.Output[Optional[
|
|
902
|
+
def max_batch_rows(self) -> pulumi.Output[Optional[_builtins.int]]:
|
|
904
903
|
"""
|
|
905
904
|
This specifies the maximum number of rows in each batch sent to the proxy service.
|
|
906
905
|
"""
|
|
907
906
|
return pulumi.get(self, "max_batch_rows")
|
|
908
907
|
|
|
909
|
-
@property
|
|
908
|
+
@_builtins.property
|
|
910
909
|
@pulumi.getter
|
|
911
|
-
def name(self) -> pulumi.Output[
|
|
910
|
+
def name(self) -> pulumi.Output[_builtins.str]:
|
|
912
911
|
"""
|
|
913
912
|
Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
|
|
914
913
|
"""
|
|
915
914
|
return pulumi.get(self, "name")
|
|
916
915
|
|
|
917
|
-
@property
|
|
916
|
+
@_builtins.property
|
|
918
917
|
@pulumi.getter(name="nullInputBehavior")
|
|
919
|
-
def null_input_behavior(self) -> pulumi.Output[Optional[
|
|
918
|
+
def null_input_behavior(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
920
919
|
"""
|
|
921
920
|
(Default: `CALLED ON NULL INPUT`) Specifies the behavior of the external function when called with null inputs.
|
|
922
921
|
"""
|
|
923
922
|
return pulumi.get(self, "null_input_behavior")
|
|
924
923
|
|
|
925
|
-
@property
|
|
924
|
+
@_builtins.property
|
|
926
925
|
@pulumi.getter(name="requestTranslator")
|
|
927
|
-
def request_translator(self) -> pulumi.Output[Optional[
|
|
926
|
+
def request_translator(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
928
927
|
"""
|
|
929
928
|
This specifies the name of the request translator function
|
|
930
929
|
"""
|
|
931
930
|
return pulumi.get(self, "request_translator")
|
|
932
931
|
|
|
933
|
-
@property
|
|
932
|
+
@_builtins.property
|
|
934
933
|
@pulumi.getter(name="responseTranslator")
|
|
935
|
-
def response_translator(self) -> pulumi.Output[Optional[
|
|
934
|
+
def response_translator(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
936
935
|
"""
|
|
937
936
|
This specifies the name of the response translator function.
|
|
938
937
|
"""
|
|
939
938
|
return pulumi.get(self, "response_translator")
|
|
940
939
|
|
|
941
|
-
@property
|
|
940
|
+
@_builtins.property
|
|
942
941
|
@pulumi.getter(name="returnBehavior")
|
|
943
|
-
def return_behavior(self) -> pulumi.Output[
|
|
942
|
+
def return_behavior(self) -> pulumi.Output[_builtins.str]:
|
|
944
943
|
"""
|
|
945
944
|
Specifies the behavior of the function when returning results
|
|
946
945
|
"""
|
|
947
946
|
return pulumi.get(self, "return_behavior")
|
|
948
947
|
|
|
949
|
-
@property
|
|
948
|
+
@_builtins.property
|
|
950
949
|
@pulumi.getter(name="returnNullAllowed")
|
|
951
|
-
def return_null_allowed(self) -> pulumi.Output[Optional[
|
|
950
|
+
def return_null_allowed(self) -> pulumi.Output[Optional[_builtins.bool]]:
|
|
952
951
|
"""
|
|
953
952
|
(Default: `true`) Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
954
953
|
"""
|
|
955
954
|
return pulumi.get(self, "return_null_allowed")
|
|
956
955
|
|
|
957
|
-
@property
|
|
956
|
+
@_builtins.property
|
|
958
957
|
@pulumi.getter(name="returnType")
|
|
959
|
-
def return_type(self) -> pulumi.Output[
|
|
958
|
+
def return_type(self) -> pulumi.Output[_builtins.str]:
|
|
960
959
|
"""
|
|
961
960
|
Specifies the data type returned by the external function.
|
|
962
961
|
"""
|
|
963
962
|
return pulumi.get(self, "return_type")
|
|
964
963
|
|
|
965
|
-
@property
|
|
964
|
+
@_builtins.property
|
|
966
965
|
@pulumi.getter
|
|
967
|
-
def schema(self) -> pulumi.Output[
|
|
966
|
+
def schema(self) -> pulumi.Output[_builtins.str]:
|
|
968
967
|
"""
|
|
969
968
|
The schema in which to create the external function.
|
|
970
969
|
"""
|
|
971
970
|
return pulumi.get(self, "schema")
|
|
972
971
|
|
|
973
|
-
@property
|
|
972
|
+
@_builtins.property
|
|
974
973
|
@pulumi.getter(name="urlOfProxyAndResource")
|
|
975
|
-
def url_of_proxy_and_resource(self) -> pulumi.Output[
|
|
974
|
+
def url_of_proxy_and_resource(self) -> pulumi.Output[_builtins.str]:
|
|
976
975
|
"""
|
|
977
976
|
This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.
|
|
978
977
|
"""
|