pulumi-snowflake 1.2.0a1744266763__py3-none-any.whl → 1.2.0a1744642997__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/_inputs.py +27 -27
- pulumi_snowflake/account.py +7 -7
- pulumi_snowflake/alert.py +7 -7
- pulumi_snowflake/api_authentication_integration_with_authorization_code_grant.py +7 -7
- pulumi_snowflake/api_authentication_integration_with_client_credentials.py +7 -7
- pulumi_snowflake/api_authentication_integration_with_jwt_bearer.py +7 -7
- pulumi_snowflake/api_integration.py +35 -35
- pulumi_snowflake/authentication_policy.py +7 -7
- pulumi_snowflake/dynamic_table.py +21 -21
- pulumi_snowflake/external_function.py +28 -28
- pulumi_snowflake/external_table.py +21 -21
- pulumi_snowflake/external_volume.py +13 -9
- pulumi_snowflake/failover_group.py +7 -7
- pulumi_snowflake/function_java.py +14 -14
- pulumi_snowflake/function_javascript.py +14 -14
- pulumi_snowflake/function_python.py +21 -21
- pulumi_snowflake/function_scala.py +14 -14
- pulumi_snowflake/function_sql.py +14 -14
- pulumi_snowflake/get_alerts.py +6 -2
- pulumi_snowflake/get_cortex_search_services.py +6 -2
- pulumi_snowflake/get_current_account.py +6 -2
- pulumi_snowflake/get_current_role.py +6 -2
- pulumi_snowflake/get_database.py +6 -2
- pulumi_snowflake/get_database_role.py +6 -2
- pulumi_snowflake/get_databases.py +6 -6
- pulumi_snowflake/get_dynamic_tables.py +6 -2
- pulumi_snowflake/get_external_functions.py +6 -2
- pulumi_snowflake/get_external_tables.py +6 -2
- pulumi_snowflake/get_failover_groups.py +6 -2
- pulumi_snowflake/get_file_formats.py +6 -2
- pulumi_snowflake/get_functions.py +6 -2
- pulumi_snowflake/get_grants.py +4 -0
- pulumi_snowflake/get_masking_policies.py +3 -3
- pulumi_snowflake/get_materialized_views.py +6 -2
- pulumi_snowflake/get_network_policies.py +3 -3
- pulumi_snowflake/get_parameters.py +9 -5
- pulumi_snowflake/get_pipes.py +6 -2
- pulumi_snowflake/get_procedures.py +6 -2
- pulumi_snowflake/get_row_access_policies.py +3 -3
- pulumi_snowflake/get_schemas.py +6 -6
- pulumi_snowflake/get_secrets.py +7 -3
- pulumi_snowflake/get_security_integrations.py +3 -3
- pulumi_snowflake/get_sequences.py +6 -2
- pulumi_snowflake/get_shares.py +6 -2
- pulumi_snowflake/get_stages.py +6 -2
- pulumi_snowflake/get_storage_integrations.py +6 -2
- pulumi_snowflake/get_streamlits.py +3 -3
- pulumi_snowflake/get_streams.py +3 -3
- pulumi_snowflake/get_system_generate_scim_access_token.py +6 -2
- pulumi_snowflake/get_system_get_aws_sns_iam_policy.py +4 -0
- pulumi_snowflake/get_system_get_private_link_config.py +6 -2
- pulumi_snowflake/get_system_get_snowflake_platform_info.py +6 -2
- pulumi_snowflake/get_tables.py +6 -2
- pulumi_snowflake/get_tasks.py +3 -3
- pulumi_snowflake/get_users.py +6 -6
- pulumi_snowflake/get_views.py +3 -3
- pulumi_snowflake/get_warehouses.py +6 -6
- pulumi_snowflake/grant_privileges_to_account_role.py +28 -28
- pulumi_snowflake/grant_privileges_to_database_role.py +21 -21
- pulumi_snowflake/legacy_service_user.py +21 -21
- pulumi_snowflake/managed_account.py +7 -7
- pulumi_snowflake/masking_policy.py +7 -7
- pulumi_snowflake/materialized_view.py +14 -14
- pulumi_snowflake/network_policy_attachment.py +7 -7
- pulumi_snowflake/notification_integration.py +20 -7
- pulumi_snowflake/oauth_integration_for_custom_clients.py +35 -35
- pulumi_snowflake/oauth_integration_for_partner_applications.py +21 -21
- pulumi_snowflake/object_parameter.py +7 -7
- pulumi_snowflake/outputs.py +18 -18
- pulumi_snowflake/password_policy.py +97 -93
- pulumi_snowflake/pipe.py +7 -7
- pulumi_snowflake/procedure_java.py +14 -14
- pulumi_snowflake/procedure_javascript.py +14 -14
- pulumi_snowflake/procedure_python.py +14 -14
- pulumi_snowflake/procedure_scala.py +14 -14
- pulumi_snowflake/procedure_sql.py +14 -14
- pulumi_snowflake/pulumi-plugin.json +1 -1
- pulumi_snowflake/saml2_integration.py +28 -28
- pulumi_snowflake/schema.py +14 -14
- pulumi_snowflake/scim_integration.py +7 -7
- pulumi_snowflake/sequence.py +21 -21
- pulumi_snowflake/service_user.py +14 -14
- pulumi_snowflake/storage_integration.py +65 -0
- pulumi_snowflake/stream_on_external_table.py +7 -7
- pulumi_snowflake/stream_on_table.py +7 -7
- pulumi_snowflake/stream_on_view.py +7 -7
- pulumi_snowflake/table.py +14 -14
- pulumi_snowflake/table_constraint.py +42 -42
- pulumi_snowflake/tag_association.py +7 -7
- pulumi_snowflake/task.py +7 -7
- pulumi_snowflake/user.py +21 -21
- pulumi_snowflake/view.py +14 -14
- pulumi_snowflake/warehouse.py +28 -28
- {pulumi_snowflake-1.2.0a1744266763.dist-info → pulumi_snowflake-1.2.0a1744642997.dist-info}/METADATA +1 -1
- pulumi_snowflake-1.2.0a1744642997.dist-info/RECORD +148 -0
- pulumi_snowflake-1.2.0a1744266763.dist-info/RECORD +0 -148
- {pulumi_snowflake-1.2.0a1744266763.dist-info → pulumi_snowflake-1.2.0a1744642997.dist-info}/WHEEL +0 -0
- {pulumi_snowflake-1.2.0a1744266763.dist-info → pulumi_snowflake-1.2.0a1744642997.dist-info}/top_level.txt +0 -0
|
@@ -48,16 +48,16 @@ class ExternalFunctionArgs:
|
|
|
48
48
|
:param pulumi.Input[builtins.str] schema: The schema in which to create the external function.
|
|
49
49
|
: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
50
|
: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[builtins.str] comment: A description of the external function.
|
|
52
|
-
:param pulumi.Input[builtins.str] compression: 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.
|
|
51
|
+
:param pulumi.Input[builtins.str] comment: (Default: `user-defined function`) A description of the external function.
|
|
52
|
+
: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.
|
|
53
53
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] context_headers: Binds Snowflake context function results to HTTP headers.
|
|
54
54
|
: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
55
|
:param pulumi.Input[builtins.int] max_batch_rows: This specifies the maximum number of rows in each batch sent to the proxy service.
|
|
56
56
|
: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.
|
|
57
|
-
:param pulumi.Input[builtins.str] null_input_behavior: Specifies the behavior of the external function when called with null inputs.
|
|
57
|
+
: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.
|
|
58
58
|
:param pulumi.Input[builtins.str] request_translator: This specifies the name of the request translator function
|
|
59
59
|
:param pulumi.Input[builtins.str] response_translator: This specifies the name of the response translator function.
|
|
60
|
-
:param pulumi.Input[builtins.bool] return_null_allowed: Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
60
|
+
: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
61
|
"""
|
|
62
62
|
pulumi.set(__self__, "api_integration", api_integration)
|
|
63
63
|
pulumi.set(__self__, "database", database)
|
|
@@ -176,7 +176,7 @@ class ExternalFunctionArgs:
|
|
|
176
176
|
@pulumi.getter
|
|
177
177
|
def comment(self) -> Optional[pulumi.Input[builtins.str]]:
|
|
178
178
|
"""
|
|
179
|
-
A description of the external function.
|
|
179
|
+
(Default: `user-defined function`) A description of the external function.
|
|
180
180
|
"""
|
|
181
181
|
return pulumi.get(self, "comment")
|
|
182
182
|
|
|
@@ -188,7 +188,7 @@ class ExternalFunctionArgs:
|
|
|
188
188
|
@pulumi.getter
|
|
189
189
|
def compression(self) -> Optional[pulumi.Input[builtins.str]]:
|
|
190
190
|
"""
|
|
191
|
-
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.
|
|
191
|
+
(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
192
|
"""
|
|
193
193
|
return pulumi.get(self, "compression")
|
|
194
194
|
|
|
@@ -248,7 +248,7 @@ class ExternalFunctionArgs:
|
|
|
248
248
|
@pulumi.getter(name="nullInputBehavior")
|
|
249
249
|
def null_input_behavior(self) -> Optional[pulumi.Input[builtins.str]]:
|
|
250
250
|
"""
|
|
251
|
-
Specifies the behavior of the external function when called with null inputs.
|
|
251
|
+
(Default: `CALLED ON NULL INPUT`) Specifies the behavior of the external function when called with null inputs.
|
|
252
252
|
"""
|
|
253
253
|
return pulumi.get(self, "null_input_behavior")
|
|
254
254
|
|
|
@@ -284,7 +284,7 @@ class ExternalFunctionArgs:
|
|
|
284
284
|
@pulumi.getter(name="returnNullAllowed")
|
|
285
285
|
def return_null_allowed(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
286
286
|
"""
|
|
287
|
-
Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
287
|
+
(Default: `true`) Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
288
288
|
"""
|
|
289
289
|
return pulumi.get(self, "return_null_allowed")
|
|
290
290
|
|
|
@@ -319,8 +319,8 @@ class _ExternalFunctionState:
|
|
|
319
319
|
Input properties used for looking up and filtering ExternalFunction resources.
|
|
320
320
|
: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
321
|
: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[builtins.str] comment: A description of the external function.
|
|
323
|
-
:param pulumi.Input[builtins.str] compression: 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.
|
|
322
|
+
:param pulumi.Input[builtins.str] comment: (Default: `user-defined function`) A description of the external function.
|
|
323
|
+
: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.
|
|
324
324
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] context_headers: Binds Snowflake context function results to HTTP headers.
|
|
325
325
|
:param pulumi.Input[builtins.str] created_on: Date and time when the external function was created.
|
|
326
326
|
:param pulumi.Input[builtins.str] database: The database in which to create the external function.
|
|
@@ -328,11 +328,11 @@ class _ExternalFunctionState:
|
|
|
328
328
|
: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
329
|
:param pulumi.Input[builtins.int] max_batch_rows: This specifies the maximum number of rows in each batch sent to the proxy service.
|
|
330
330
|
: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.
|
|
331
|
-
:param pulumi.Input[builtins.str] null_input_behavior: Specifies the behavior of the external function when called with null inputs.
|
|
331
|
+
: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.
|
|
332
332
|
:param pulumi.Input[builtins.str] request_translator: This specifies the name of the request translator function
|
|
333
333
|
:param pulumi.Input[builtins.str] response_translator: This specifies the name of the response translator function.
|
|
334
334
|
:param pulumi.Input[builtins.str] return_behavior: Specifies the behavior of the function when returning results
|
|
335
|
-
:param pulumi.Input[builtins.bool] return_null_allowed: Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
335
|
+
: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).
|
|
336
336
|
:param pulumi.Input[builtins.str] return_type: Specifies the data type returned by the external function.
|
|
337
337
|
:param pulumi.Input[builtins.str] schema: The schema in which to create the external function.
|
|
338
338
|
: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.
|
|
@@ -404,7 +404,7 @@ class _ExternalFunctionState:
|
|
|
404
404
|
@pulumi.getter
|
|
405
405
|
def comment(self) -> Optional[pulumi.Input[builtins.str]]:
|
|
406
406
|
"""
|
|
407
|
-
A description of the external function.
|
|
407
|
+
(Default: `user-defined function`) A description of the external function.
|
|
408
408
|
"""
|
|
409
409
|
return pulumi.get(self, "comment")
|
|
410
410
|
|
|
@@ -416,7 +416,7 @@ class _ExternalFunctionState:
|
|
|
416
416
|
@pulumi.getter
|
|
417
417
|
def compression(self) -> Optional[pulumi.Input[builtins.str]]:
|
|
418
418
|
"""
|
|
419
|
-
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.
|
|
419
|
+
(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
420
|
"""
|
|
421
421
|
return pulumi.get(self, "compression")
|
|
422
422
|
|
|
@@ -512,7 +512,7 @@ class _ExternalFunctionState:
|
|
|
512
512
|
@pulumi.getter(name="nullInputBehavior")
|
|
513
513
|
def null_input_behavior(self) -> Optional[pulumi.Input[builtins.str]]:
|
|
514
514
|
"""
|
|
515
|
-
Specifies the behavior of the external function when called with null inputs.
|
|
515
|
+
(Default: `CALLED ON NULL INPUT`) Specifies the behavior of the external function when called with null inputs.
|
|
516
516
|
"""
|
|
517
517
|
return pulumi.get(self, "null_input_behavior")
|
|
518
518
|
|
|
@@ -560,7 +560,7 @@ class _ExternalFunctionState:
|
|
|
560
560
|
@pulumi.getter(name="returnNullAllowed")
|
|
561
561
|
def return_null_allowed(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
562
562
|
"""
|
|
563
|
-
Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
563
|
+
(Default: `true`) Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
564
564
|
"""
|
|
565
565
|
return pulumi.get(self, "return_null_allowed")
|
|
566
566
|
|
|
@@ -641,18 +641,18 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
641
641
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
642
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.
|
|
643
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.
|
|
644
|
-
:param pulumi.Input[builtins.str] comment: A description of the external function.
|
|
645
|
-
:param pulumi.Input[builtins.str] compression: 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.
|
|
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
646
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] context_headers: Binds Snowflake context function results to HTTP headers.
|
|
647
647
|
:param pulumi.Input[builtins.str] database: The database in which to create the external function.
|
|
648
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.
|
|
649
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
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: Specifies the behavior of the external function when called with null inputs.
|
|
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
652
|
:param pulumi.Input[builtins.str] request_translator: This specifies the name of the request translator function
|
|
653
653
|
:param pulumi.Input[builtins.str] response_translator: This specifies the name of the response translator function.
|
|
654
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: Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
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
656
|
:param pulumi.Input[builtins.str] return_type: Specifies the data type returned by the external function.
|
|
657
657
|
:param pulumi.Input[builtins.str] schema: The schema in which to create the external function.
|
|
658
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.
|
|
@@ -782,8 +782,8 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
782
782
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
783
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.
|
|
784
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.
|
|
785
|
-
:param pulumi.Input[builtins.str] comment: A description of the external function.
|
|
786
|
-
:param pulumi.Input[builtins.str] compression: 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.
|
|
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
787
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] context_headers: Binds Snowflake context function results to HTTP headers.
|
|
788
788
|
:param pulumi.Input[builtins.str] created_on: Date and time when the external function was created.
|
|
789
789
|
:param pulumi.Input[builtins.str] database: The database in which to create the external function.
|
|
@@ -791,11 +791,11 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
791
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.
|
|
792
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
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: Specifies the behavior of the external function when called with null inputs.
|
|
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
795
|
:param pulumi.Input[builtins.str] request_translator: This specifies the name of the request translator function
|
|
796
796
|
:param pulumi.Input[builtins.str] response_translator: This specifies the name of the response translator function.
|
|
797
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: Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
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
799
|
:param pulumi.Input[builtins.str] return_type: Specifies the data type returned by the external function.
|
|
800
800
|
:param pulumi.Input[builtins.str] schema: The schema in which to create the external function.
|
|
801
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.
|
|
@@ -845,7 +845,7 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
845
845
|
@pulumi.getter
|
|
846
846
|
def comment(self) -> pulumi.Output[Optional[builtins.str]]:
|
|
847
847
|
"""
|
|
848
|
-
A description of the external function.
|
|
848
|
+
(Default: `user-defined function`) A description of the external function.
|
|
849
849
|
"""
|
|
850
850
|
return pulumi.get(self, "comment")
|
|
851
851
|
|
|
@@ -853,7 +853,7 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
853
853
|
@pulumi.getter
|
|
854
854
|
def compression(self) -> pulumi.Output[Optional[builtins.str]]:
|
|
855
855
|
"""
|
|
856
|
-
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.
|
|
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.
|
|
857
857
|
"""
|
|
858
858
|
return pulumi.get(self, "compression")
|
|
859
859
|
|
|
@@ -917,7 +917,7 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
917
917
|
@pulumi.getter(name="nullInputBehavior")
|
|
918
918
|
def null_input_behavior(self) -> pulumi.Output[Optional[builtins.str]]:
|
|
919
919
|
"""
|
|
920
|
-
Specifies the behavior of the external function when called with null inputs.
|
|
920
|
+
(Default: `CALLED ON NULL INPUT`) Specifies the behavior of the external function when called with null inputs.
|
|
921
921
|
"""
|
|
922
922
|
return pulumi.get(self, "null_input_behavior")
|
|
923
923
|
|
|
@@ -949,7 +949,7 @@ class ExternalFunction(pulumi.CustomResource):
|
|
|
949
949
|
@pulumi.getter(name="returnNullAllowed")
|
|
950
950
|
def return_null_allowed(self) -> pulumi.Output[Optional[builtins.bool]]:
|
|
951
951
|
"""
|
|
952
|
-
Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
952
|
+
(Default: `true`) Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).
|
|
953
953
|
"""
|
|
954
954
|
return pulumi.get(self, "return_null_allowed")
|
|
955
955
|
|
|
@@ -44,14 +44,14 @@ class ExternalTableArgs:
|
|
|
44
44
|
:param pulumi.Input[builtins.str] file_format: Specifies the file format for the external table.
|
|
45
45
|
:param pulumi.Input[builtins.str] location: Specifies a location for the external table, using its FQDN. You can hardcode it (`"@MYDB.MYSCHEMA.MYSTAGE"`), or populate dynamically (`"@${snowflake_stage.mystage.fully_qualified_name}"`)
|
|
46
46
|
:param pulumi.Input[builtins.str] schema: The schema in which to create the external table.
|
|
47
|
-
:param pulumi.Input[builtins.bool] auto_refresh: Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
|
|
47
|
+
:param pulumi.Input[builtins.bool] auto_refresh: (Default: `true`) Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
|
|
48
48
|
:param pulumi.Input[builtins.str] aws_sns_topic: Specifies the aws sns topic for the external table.
|
|
49
49
|
:param pulumi.Input[builtins.str] comment: Specifies a comment for the external table.
|
|
50
|
-
:param pulumi.Input[builtins.bool] copy_grants: Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
|
|
50
|
+
:param pulumi.Input[builtins.bool] copy_grants: (Default: `false`) Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
|
|
51
51
|
:param pulumi.Input[builtins.str] name: Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
|
|
52
52
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] partition_bies: Specifies any partition columns to evaluate for the external table.
|
|
53
53
|
:param pulumi.Input[builtins.str] pattern: Specifies the file names and/or paths on the external stage to match.
|
|
54
|
-
:param pulumi.Input[builtins.bool] refresh_on_create: Specifies weather to refresh when an external table is created.
|
|
54
|
+
:param pulumi.Input[builtins.bool] refresh_on_create: (Default: `true`) Specifies weather to refresh when an external table is created.
|
|
55
55
|
:param pulumi.Input[builtins.str] table_format: Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
|
|
56
56
|
:param pulumi.Input[Sequence[pulumi.Input['ExternalTableTagArgs']]] tags: Definitions of a tag to associate with the resource.
|
|
57
57
|
"""
|
|
@@ -148,7 +148,7 @@ class ExternalTableArgs:
|
|
|
148
148
|
@pulumi.getter(name="autoRefresh")
|
|
149
149
|
def auto_refresh(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
150
150
|
"""
|
|
151
|
-
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
|
|
151
|
+
(Default: `true`) Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
|
|
152
152
|
"""
|
|
153
153
|
return pulumi.get(self, "auto_refresh")
|
|
154
154
|
|
|
@@ -184,7 +184,7 @@ class ExternalTableArgs:
|
|
|
184
184
|
@pulumi.getter(name="copyGrants")
|
|
185
185
|
def copy_grants(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
186
186
|
"""
|
|
187
|
-
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
|
|
187
|
+
(Default: `false`) Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
|
|
188
188
|
"""
|
|
189
189
|
return pulumi.get(self, "copy_grants")
|
|
190
190
|
|
|
@@ -232,7 +232,7 @@ class ExternalTableArgs:
|
|
|
232
232
|
@pulumi.getter(name="refreshOnCreate")
|
|
233
233
|
def refresh_on_create(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
234
234
|
"""
|
|
235
|
-
Specifies weather to refresh when an external table is created.
|
|
235
|
+
(Default: `true`) Specifies weather to refresh when an external table is created.
|
|
236
236
|
"""
|
|
237
237
|
return pulumi.get(self, "refresh_on_create")
|
|
238
238
|
|
|
@@ -288,11 +288,11 @@ class _ExternalTableState:
|
|
|
288
288
|
tags: Optional[pulumi.Input[Sequence[pulumi.Input['ExternalTableTagArgs']]]] = None):
|
|
289
289
|
"""
|
|
290
290
|
Input properties used for looking up and filtering ExternalTable resources.
|
|
291
|
-
:param pulumi.Input[builtins.bool] auto_refresh: Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
|
|
291
|
+
:param pulumi.Input[builtins.bool] auto_refresh: (Default: `true`) Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
|
|
292
292
|
:param pulumi.Input[builtins.str] aws_sns_topic: Specifies the aws sns topic for the external table.
|
|
293
293
|
:param pulumi.Input[Sequence[pulumi.Input['ExternalTableColumnArgs']]] columns: Definitions of a column to create in the external table. Minimum one required.
|
|
294
294
|
:param pulumi.Input[builtins.str] comment: Specifies a comment for the external table.
|
|
295
|
-
:param pulumi.Input[builtins.bool] copy_grants: Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
|
|
295
|
+
:param pulumi.Input[builtins.bool] copy_grants: (Default: `false`) Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
|
|
296
296
|
:param pulumi.Input[builtins.str] database: The database in which to create the external table.
|
|
297
297
|
:param pulumi.Input[builtins.str] file_format: Specifies the file format for the external table.
|
|
298
298
|
: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).
|
|
@@ -301,7 +301,7 @@ class _ExternalTableState:
|
|
|
301
301
|
:param pulumi.Input[builtins.str] owner: Name of the role that owns the external table.
|
|
302
302
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] partition_bies: Specifies any partition columns to evaluate for the external table.
|
|
303
303
|
:param pulumi.Input[builtins.str] pattern: Specifies the file names and/or paths on the external stage to match.
|
|
304
|
-
:param pulumi.Input[builtins.bool] refresh_on_create: Specifies weather to refresh when an external table is created.
|
|
304
|
+
:param pulumi.Input[builtins.bool] refresh_on_create: (Default: `true`) Specifies weather to refresh when an external table is created.
|
|
305
305
|
:param pulumi.Input[builtins.str] schema: The schema in which to create the external table.
|
|
306
306
|
:param pulumi.Input[builtins.str] table_format: Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
|
|
307
307
|
:param pulumi.Input[Sequence[pulumi.Input['ExternalTableTagArgs']]] tags: Definitions of a tag to associate with the resource.
|
|
@@ -348,7 +348,7 @@ class _ExternalTableState:
|
|
|
348
348
|
@pulumi.getter(name="autoRefresh")
|
|
349
349
|
def auto_refresh(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
350
350
|
"""
|
|
351
|
-
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
|
|
351
|
+
(Default: `true`) Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
|
|
352
352
|
"""
|
|
353
353
|
return pulumi.get(self, "auto_refresh")
|
|
354
354
|
|
|
@@ -396,7 +396,7 @@ class _ExternalTableState:
|
|
|
396
396
|
@pulumi.getter(name="copyGrants")
|
|
397
397
|
def copy_grants(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
398
398
|
"""
|
|
399
|
-
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
|
|
399
|
+
(Default: `false`) Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
|
|
400
400
|
"""
|
|
401
401
|
return pulumi.get(self, "copy_grants")
|
|
402
402
|
|
|
@@ -504,7 +504,7 @@ class _ExternalTableState:
|
|
|
504
504
|
@pulumi.getter(name="refreshOnCreate")
|
|
505
505
|
def refresh_on_create(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
506
506
|
"""
|
|
507
|
-
Specifies weather to refresh when an external table is created.
|
|
507
|
+
(Default: `true`) Specifies weather to refresh when an external table is created.
|
|
508
508
|
"""
|
|
509
509
|
return pulumi.get(self, "refresh_on_create")
|
|
510
510
|
|
|
@@ -582,18 +582,18 @@ class ExternalTable(pulumi.CustomResource):
|
|
|
582
582
|
|
|
583
583
|
:param str resource_name: The name of the resource.
|
|
584
584
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
585
|
-
:param pulumi.Input[builtins.bool] auto_refresh: Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
|
|
585
|
+
:param pulumi.Input[builtins.bool] auto_refresh: (Default: `true`) Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
|
|
586
586
|
:param pulumi.Input[builtins.str] aws_sns_topic: Specifies the aws sns topic for the external table.
|
|
587
587
|
:param pulumi.Input[Sequence[pulumi.Input[Union['ExternalTableColumnArgs', 'ExternalTableColumnArgsDict']]]] columns: Definitions of a column to create in the external table. Minimum one required.
|
|
588
588
|
:param pulumi.Input[builtins.str] comment: Specifies a comment for the external table.
|
|
589
|
-
:param pulumi.Input[builtins.bool] copy_grants: Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
|
|
589
|
+
:param pulumi.Input[builtins.bool] copy_grants: (Default: `false`) Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
|
|
590
590
|
:param pulumi.Input[builtins.str] database: The database in which to create the external table.
|
|
591
591
|
:param pulumi.Input[builtins.str] file_format: Specifies the file format for the external table.
|
|
592
592
|
:param pulumi.Input[builtins.str] location: Specifies a location for the external table, using its FQDN. You can hardcode it (`"@MYDB.MYSCHEMA.MYSTAGE"`), or populate dynamically (`"@${snowflake_stage.mystage.fully_qualified_name}"`)
|
|
593
593
|
:param pulumi.Input[builtins.str] name: Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
|
|
594
594
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] partition_bies: Specifies any partition columns to evaluate for the external table.
|
|
595
595
|
:param pulumi.Input[builtins.str] pattern: Specifies the file names and/or paths on the external stage to match.
|
|
596
|
-
:param pulumi.Input[builtins.bool] refresh_on_create: Specifies weather to refresh when an external table is created.
|
|
596
|
+
:param pulumi.Input[builtins.bool] refresh_on_create: (Default: `true`) Specifies weather to refresh when an external table is created.
|
|
597
597
|
:param pulumi.Input[builtins.str] schema: The schema in which to create the external table.
|
|
598
598
|
:param pulumi.Input[builtins.str] table_format: Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
|
|
599
599
|
:param pulumi.Input[Sequence[pulumi.Input[Union['ExternalTableTagArgs', 'ExternalTableTagArgsDict']]]] tags: Definitions of a tag to associate with the resource.
|
|
@@ -713,11 +713,11 @@ class ExternalTable(pulumi.CustomResource):
|
|
|
713
713
|
:param str resource_name: The unique name of the resulting resource.
|
|
714
714
|
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
|
715
715
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
716
|
-
:param pulumi.Input[builtins.bool] auto_refresh: Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
|
|
716
|
+
:param pulumi.Input[builtins.bool] auto_refresh: (Default: `true`) Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
|
|
717
717
|
:param pulumi.Input[builtins.str] aws_sns_topic: Specifies the aws sns topic for the external table.
|
|
718
718
|
:param pulumi.Input[Sequence[pulumi.Input[Union['ExternalTableColumnArgs', 'ExternalTableColumnArgsDict']]]] columns: Definitions of a column to create in the external table. Minimum one required.
|
|
719
719
|
:param pulumi.Input[builtins.str] comment: Specifies a comment for the external table.
|
|
720
|
-
:param pulumi.Input[builtins.bool] copy_grants: Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
|
|
720
|
+
:param pulumi.Input[builtins.bool] copy_grants: (Default: `false`) Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
|
|
721
721
|
:param pulumi.Input[builtins.str] database: The database in which to create the external table.
|
|
722
722
|
:param pulumi.Input[builtins.str] file_format: Specifies the file format for the external table.
|
|
723
723
|
: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).
|
|
@@ -726,7 +726,7 @@ class ExternalTable(pulumi.CustomResource):
|
|
|
726
726
|
:param pulumi.Input[builtins.str] owner: Name of the role that owns the external table.
|
|
727
727
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] partition_bies: Specifies any partition columns to evaluate for the external table.
|
|
728
728
|
:param pulumi.Input[builtins.str] pattern: Specifies the file names and/or paths on the external stage to match.
|
|
729
|
-
:param pulumi.Input[builtins.bool] refresh_on_create: Specifies weather to refresh when an external table is created.
|
|
729
|
+
:param pulumi.Input[builtins.bool] refresh_on_create: (Default: `true`) Specifies weather to refresh when an external table is created.
|
|
730
730
|
:param pulumi.Input[builtins.str] schema: The schema in which to create the external table.
|
|
731
731
|
:param pulumi.Input[builtins.str] table_format: Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
|
|
732
732
|
:param pulumi.Input[Sequence[pulumi.Input[Union['ExternalTableTagArgs', 'ExternalTableTagArgsDict']]]] tags: Definitions of a tag to associate with the resource.
|
|
@@ -758,7 +758,7 @@ class ExternalTable(pulumi.CustomResource):
|
|
|
758
758
|
@pulumi.getter(name="autoRefresh")
|
|
759
759
|
def auto_refresh(self) -> pulumi.Output[Optional[builtins.bool]]:
|
|
760
760
|
"""
|
|
761
|
-
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
|
|
761
|
+
(Default: `true`) Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
|
|
762
762
|
"""
|
|
763
763
|
return pulumi.get(self, "auto_refresh")
|
|
764
764
|
|
|
@@ -790,7 +790,7 @@ class ExternalTable(pulumi.CustomResource):
|
|
|
790
790
|
@pulumi.getter(name="copyGrants")
|
|
791
791
|
def copy_grants(self) -> pulumi.Output[Optional[builtins.bool]]:
|
|
792
792
|
"""
|
|
793
|
-
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
|
|
793
|
+
(Default: `false`) Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
|
|
794
794
|
"""
|
|
795
795
|
return pulumi.get(self, "copy_grants")
|
|
796
796
|
|
|
@@ -862,7 +862,7 @@ class ExternalTable(pulumi.CustomResource):
|
|
|
862
862
|
@pulumi.getter(name="refreshOnCreate")
|
|
863
863
|
def refresh_on_create(self) -> pulumi.Output[Optional[builtins.bool]]:
|
|
864
864
|
"""
|
|
865
|
-
Specifies weather to refresh when an external table is created.
|
|
865
|
+
(Default: `true`) Specifies weather to refresh when an external table is created.
|
|
866
866
|
"""
|
|
867
867
|
return pulumi.get(self, "refresh_on_create")
|
|
868
868
|
|
|
@@ -29,7 +29,7 @@ class ExternalVolumeArgs:
|
|
|
29
29
|
"""
|
|
30
30
|
The set of arguments for constructing a ExternalVolume resource.
|
|
31
31
|
:param pulumi.Input[Sequence[pulumi.Input['ExternalVolumeStorageLocationArgs']]] storage_locations: List of named cloud storage locations in different regions and, optionally, cloud platforms. Minimum 1 required. The order of the list is important as it impacts the active storage location, and updates will be triggered if it changes. Note that not all parameter combinations are valid as they depend on the given storage*provider. Consult [the docs](https://docs.snowflake.com/en/sql-reference/sql/create-external-volume#cloud-provider-parameters-cloudproviderparams) for more details on this.
|
|
32
|
-
:param pulumi.Input[builtins.str] allow_writes: Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
|
|
32
|
+
:param pulumi.Input[builtins.str] allow_writes: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (`default`)) Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
|
|
33
33
|
:param pulumi.Input[builtins.str] comment: Specifies a comment for the external volume.
|
|
34
34
|
:param pulumi.Input[builtins.str] name: Identifier for the external volume; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
|
|
35
35
|
"""
|
|
@@ -57,7 +57,7 @@ class ExternalVolumeArgs:
|
|
|
57
57
|
@pulumi.getter(name="allowWrites")
|
|
58
58
|
def allow_writes(self) -> Optional[pulumi.Input[builtins.str]]:
|
|
59
59
|
"""
|
|
60
|
-
Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
|
|
60
|
+
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (`default`)) Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
|
|
61
61
|
"""
|
|
62
62
|
return pulumi.get(self, "allow_writes")
|
|
63
63
|
|
|
@@ -102,7 +102,7 @@ class _ExternalVolumeState:
|
|
|
102
102
|
storage_locations: Optional[pulumi.Input[Sequence[pulumi.Input['ExternalVolumeStorageLocationArgs']]]] = None):
|
|
103
103
|
"""
|
|
104
104
|
Input properties used for looking up and filtering ExternalVolume resources.
|
|
105
|
-
:param pulumi.Input[builtins.str] allow_writes: Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
|
|
105
|
+
:param pulumi.Input[builtins.str] allow_writes: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (`default`)) Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
|
|
106
106
|
:param pulumi.Input[builtins.str] comment: Specifies a comment for the external volume.
|
|
107
107
|
:param pulumi.Input[Sequence[pulumi.Input['ExternalVolumeDescribeOutputArgs']]] describe_outputs: Outputs the result of `DESCRIBE EXTERNAL VOLUME` for the given external volume.
|
|
108
108
|
: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).
|
|
@@ -129,7 +129,7 @@ class _ExternalVolumeState:
|
|
|
129
129
|
@pulumi.getter(name="allowWrites")
|
|
130
130
|
def allow_writes(self) -> Optional[pulumi.Input[builtins.str]]:
|
|
131
131
|
"""
|
|
132
|
-
Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
|
|
132
|
+
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (`default`)) Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
|
|
133
133
|
"""
|
|
134
134
|
return pulumi.get(self, "allow_writes")
|
|
135
135
|
|
|
@@ -221,13 +221,15 @@ class ExternalVolume(pulumi.CustomResource):
|
|
|
221
221
|
storage_locations: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ExternalVolumeStorageLocationArgs', 'ExternalVolumeStorageLocationArgsDict']]]]] = None,
|
|
222
222
|
__props__=None):
|
|
223
223
|
"""
|
|
224
|
-
!> **Caution: Preview Feature** This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to `preview_features_enabled field
|
|
224
|
+
!> **Caution: Preview Feature** This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to `preview_features_enabled` field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.
|
|
225
225
|
|
|
226
226
|
Resource used to manage external volume objects. For more information, check [external volume documentation](https://docs.snowflake.com/en/sql-reference/commands-data-loading#external-volume).
|
|
227
227
|
|
|
228
|
+
> **Note** If a field has a default value, it is shown next to the type in the schema.
|
|
229
|
+
|
|
228
230
|
:param str resource_name: The name of the resource.
|
|
229
231
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
230
|
-
:param pulumi.Input[builtins.str] allow_writes: Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
|
|
232
|
+
:param pulumi.Input[builtins.str] allow_writes: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (`default`)) Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
|
|
231
233
|
:param pulumi.Input[builtins.str] comment: Specifies a comment for the external volume.
|
|
232
234
|
:param pulumi.Input[builtins.str] name: Identifier for the external volume; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
|
|
233
235
|
:param pulumi.Input[Sequence[pulumi.Input[Union['ExternalVolumeStorageLocationArgs', 'ExternalVolumeStorageLocationArgsDict']]]] storage_locations: List of named cloud storage locations in different regions and, optionally, cloud platforms. Minimum 1 required. The order of the list is important as it impacts the active storage location, and updates will be triggered if it changes. Note that not all parameter combinations are valid as they depend on the given storage*provider. Consult [the docs](https://docs.snowflake.com/en/sql-reference/sql/create-external-volume#cloud-provider-parameters-cloudproviderparams) for more details on this.
|
|
@@ -239,10 +241,12 @@ class ExternalVolume(pulumi.CustomResource):
|
|
|
239
241
|
args: ExternalVolumeArgs,
|
|
240
242
|
opts: Optional[pulumi.ResourceOptions] = None):
|
|
241
243
|
"""
|
|
242
|
-
!> **Caution: Preview Feature** This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to `preview_features_enabled field
|
|
244
|
+
!> **Caution: Preview Feature** This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to `preview_features_enabled` field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.
|
|
243
245
|
|
|
244
246
|
Resource used to manage external volume objects. For more information, check [external volume documentation](https://docs.snowflake.com/en/sql-reference/commands-data-loading#external-volume).
|
|
245
247
|
|
|
248
|
+
> **Note** If a field has a default value, it is shown next to the type in the schema.
|
|
249
|
+
|
|
246
250
|
:param str resource_name: The name of the resource.
|
|
247
251
|
:param ExternalVolumeArgs args: The arguments to use to populate this resource's properties.
|
|
248
252
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
@@ -304,7 +308,7 @@ class ExternalVolume(pulumi.CustomResource):
|
|
|
304
308
|
:param str resource_name: The unique name of the resulting resource.
|
|
305
309
|
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
|
306
310
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
307
|
-
:param pulumi.Input[builtins.str] allow_writes: Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
|
|
311
|
+
:param pulumi.Input[builtins.str] allow_writes: (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (`default`)) Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
|
|
308
312
|
:param pulumi.Input[builtins.str] comment: Specifies a comment for the external volume.
|
|
309
313
|
:param pulumi.Input[Sequence[pulumi.Input[Union['ExternalVolumeDescribeOutputArgs', 'ExternalVolumeDescribeOutputArgsDict']]]] describe_outputs: Outputs the result of `DESCRIBE EXTERNAL VOLUME` for the given external volume.
|
|
310
314
|
: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).
|
|
@@ -329,7 +333,7 @@ class ExternalVolume(pulumi.CustomResource):
|
|
|
329
333
|
@pulumi.getter(name="allowWrites")
|
|
330
334
|
def allow_writes(self) -> pulumi.Output[Optional[builtins.str]]:
|
|
331
335
|
"""
|
|
332
|
-
Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
|
|
336
|
+
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (`default`)) Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
|
|
333
337
|
"""
|
|
334
338
|
return pulumi.get(self, "allow_writes")
|
|
335
339
|
|
|
@@ -38,7 +38,7 @@ class FailoverGroupArgs:
|
|
|
38
38
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] allowed_integration_types: Type(s) of integrations for which you are enabling replication and failover from the source account to the target account. This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"
|
|
39
39
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] allowed_shares: Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
|
|
40
40
|
:param pulumi.Input['FailoverGroupFromReplicaArgs'] from_replica: Specifies the name of the replica to use as the source for the failover group.
|
|
41
|
-
:param pulumi.Input[builtins.bool] ignore_edition_check: Allows replicating objects to accounts on lower editions.
|
|
41
|
+
:param pulumi.Input[builtins.bool] ignore_edition_check: (Default: `false`) Allows replicating objects to accounts on lower editions.
|
|
42
42
|
:param pulumi.Input[builtins.str] name: Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
|
|
43
43
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] object_types: Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
|
|
44
44
|
:param pulumi.Input['FailoverGroupReplicationScheduleArgs'] replication_schedule: Specifies the schedule for refreshing secondary failover groups.
|
|
@@ -126,7 +126,7 @@ class FailoverGroupArgs:
|
|
|
126
126
|
@pulumi.getter(name="ignoreEditionCheck")
|
|
127
127
|
def ignore_edition_check(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
128
128
|
"""
|
|
129
|
-
Allows replicating objects to accounts on lower editions.
|
|
129
|
+
(Default: `false`) Allows replicating objects to accounts on lower editions.
|
|
130
130
|
"""
|
|
131
131
|
return pulumi.get(self, "ignore_edition_check")
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ class _FailoverGroupState:
|
|
|
192
192
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] allowed_shares: Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
|
|
193
193
|
:param pulumi.Input['FailoverGroupFromReplicaArgs'] from_replica: Specifies the name of the replica to use as the source for the failover group.
|
|
194
194
|
: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).
|
|
195
|
-
:param pulumi.Input[builtins.bool] ignore_edition_check: Allows replicating objects to accounts on lower editions.
|
|
195
|
+
:param pulumi.Input[builtins.bool] ignore_edition_check: (Default: `false`) Allows replicating objects to accounts on lower editions.
|
|
196
196
|
:param pulumi.Input[builtins.str] name: Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
|
|
197
197
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] object_types: Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
|
|
198
198
|
:param pulumi.Input['FailoverGroupReplicationScheduleArgs'] replication_schedule: Specifies the schedule for refreshing secondary failover groups.
|
|
@@ -294,7 +294,7 @@ class _FailoverGroupState:
|
|
|
294
294
|
@pulumi.getter(name="ignoreEditionCheck")
|
|
295
295
|
def ignore_edition_check(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
296
296
|
"""
|
|
297
|
-
Allows replicating objects to accounts on lower editions.
|
|
297
|
+
(Default: `false`) Allows replicating objects to accounts on lower editions.
|
|
298
298
|
"""
|
|
299
299
|
return pulumi.get(self, "ignore_edition_check")
|
|
300
300
|
|
|
@@ -368,7 +368,7 @@ class FailoverGroup(pulumi.CustomResource):
|
|
|
368
368
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] allowed_integration_types: Type(s) of integrations for which you are enabling replication and failover from the source account to the target account. This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"
|
|
369
369
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] allowed_shares: Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
|
|
370
370
|
:param pulumi.Input[Union['FailoverGroupFromReplicaArgs', 'FailoverGroupFromReplicaArgsDict']] from_replica: Specifies the name of the replica to use as the source for the failover group.
|
|
371
|
-
:param pulumi.Input[builtins.bool] ignore_edition_check: Allows replicating objects to accounts on lower editions.
|
|
371
|
+
:param pulumi.Input[builtins.bool] ignore_edition_check: (Default: `false`) Allows replicating objects to accounts on lower editions.
|
|
372
372
|
:param pulumi.Input[builtins.str] name: Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
|
|
373
373
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] object_types: Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
|
|
374
374
|
:param pulumi.Input[Union['FailoverGroupReplicationScheduleArgs', 'FailoverGroupReplicationScheduleArgsDict']] replication_schedule: Specifies the schedule for refreshing secondary failover groups.
|
|
@@ -462,7 +462,7 @@ class FailoverGroup(pulumi.CustomResource):
|
|
|
462
462
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] allowed_shares: Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
|
|
463
463
|
:param pulumi.Input[Union['FailoverGroupFromReplicaArgs', 'FailoverGroupFromReplicaArgsDict']] from_replica: Specifies the name of the replica to use as the source for the failover group.
|
|
464
464
|
: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).
|
|
465
|
-
:param pulumi.Input[builtins.bool] ignore_edition_check: Allows replicating objects to accounts on lower editions.
|
|
465
|
+
:param pulumi.Input[builtins.bool] ignore_edition_check: (Default: `false`) Allows replicating objects to accounts on lower editions.
|
|
466
466
|
:param pulumi.Input[builtins.str] name: Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
|
|
467
467
|
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] object_types: Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
|
|
468
468
|
:param pulumi.Input[Union['FailoverGroupReplicationScheduleArgs', 'FailoverGroupReplicationScheduleArgsDict']] replication_schedule: Specifies the schedule for refreshing secondary failover groups.
|
|
@@ -535,7 +535,7 @@ class FailoverGroup(pulumi.CustomResource):
|
|
|
535
535
|
@pulumi.getter(name="ignoreEditionCheck")
|
|
536
536
|
def ignore_edition_check(self) -> pulumi.Output[Optional[builtins.bool]]:
|
|
537
537
|
"""
|
|
538
|
-
Allows replicating objects to accounts on lower editions.
|
|
538
|
+
(Default: `false`) Allows replicating objects to accounts on lower editions.
|
|
539
539
|
"""
|
|
540
540
|
return pulumi.get(self, "ignore_edition_check")
|
|
541
541
|
|