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

pulumi_snowflake/get_functions.py

@@ -4,9 +4,14 @@
 
 import copy
 import warnings
+import sys
 import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
 from . import _utilities
 from . import outputs
 
@@ -85,9 +90,10 @@ def get_functions(database: Optional[str] = None,
                   schema: Optional[str] = None,
                   opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetFunctionsResult:
     """
+    !> **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.
+
     ## Example Usage
 
-    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_snowflake as snowflake
@@ -95,7 +101,10 @@ def get_functions(database: Optional[str] = None,
     current = snowflake.get_functions(database="MYDB",
         schema="MYSCHEMA")
     ```
-    <!--End PulumiCodeChooser -->
+
+
+    :param str database: The database from which to return the schemas from.
+    :param str schema: The schema from which to return the functions from.
     """
     __args__ = dict()
     __args__['database'] = database
@@ -108,16 +117,14 @@ def get_functions(database: Optional[str] = None,
         functions=pulumi.get(__ret__, 'functions'),
         id=pulumi.get(__ret__, 'id'),
         schema=pulumi.get(__ret__, 'schema'))
-
-
-@_utilities.lift_output_func(get_functions)
 def get_functions_output(database: Optional[pulumi.Input[str]] = None,
                          schema: Optional[pulumi.Input[str]] = None,
-                         opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetFunctionsResult]:
+                         opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetFunctionsResult]:
     """
+    !> **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.
+
     ## Example Usage
 
-    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_snowflake as snowflake
@@ -125,6 +132,18 @@ def get_functions_output(database: Optional[pulumi.Input[str]] = None,
     current = snowflake.get_functions(database="MYDB",
         schema="MYSCHEMA")
     ```
-    <!--End PulumiCodeChooser -->
+
+
+    :param str database: The database from which to return the schemas from.
+    :param str schema: The schema from which to return the functions from.
     """
-    ...
+    __args__ = dict()
+    __args__['database'] = database
+    __args__['schema'] = schema
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('snowflake:index/getFunctions:getFunctions', __args__, opts=opts, typ=GetFunctionsResult)
+    return __ret__.apply(lambda __response__: GetFunctionsResult(
+        database=pulumi.get(__response__, 'database'),
+        functions=pulumi.get(__response__, 'functions'),
+        id=pulumi.get(__response__, 'id'),
+        schema=pulumi.get(__response__, 'schema')))

pulumi_snowflake/get_grants.py

@@ -4,9 +4,14 @@
 
 import copy
 import warnings
+import sys
 import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
 from . import _utilities
 from . import outputs
 from ._inputs import *
@@ -50,7 +55,7 @@ class GetGrantsResult:
     @pulumi.getter(name="futureGrantsIn")
     def future_grants_in(self) -> Optional['outputs.GetGrantsFutureGrantsInResult']:
         """
-        Lists all privileges on new (i.e. future) objects
+        Lists all privileges on new (i.e. future) objects.
         """
         return pulumi.get(self, "future_grants_in")
 
@@ -58,7 +63,7 @@ class GetGrantsResult:
     @pulumi.getter(name="futureGrantsTo")
     def future_grants_to(self) -> Optional['outputs.GetGrantsFutureGrantsToResult']:
         """
-        Lists all privileges granted to the object on new (i.e. future) objects
+        Lists all privileges granted to the object on new (i.e. future) objects.
         """
         return pulumi.get(self, "future_grants_to")
 
@@ -74,7 +79,7 @@ class GetGrantsResult:
     @pulumi.getter(name="grantsOf")
     def grants_of(self) -> Optional['outputs.GetGrantsGrantsOfResult']:
         """
-        Lists all objects to which the given object has been granted
+        Lists all objects to which the given object has been granted.
         """
         return pulumi.get(self, "grants_of")
 
@@ -82,7 +87,7 @@ class GetGrantsResult:
     @pulumi.getter(name="grantsOn")
     def grants_on(self) -> Optional['outputs.GetGrantsGrantsOnResult']:
         """
-        Lists all privileges that have been granted on an object or account
+        Lists all privileges that have been granted on an object or on an account.
         """
         return pulumi.get(self, "grants_on")
 
@@ -90,7 +95,7 @@ class GetGrantsResult:
     @pulumi.getter(name="grantsTo")
     def grants_to(self) -> Optional['outputs.GetGrantsGrantsToResult']:
         """
-        Lists all privileges granted to the object
+        Lists all privileges granted to the object.
         """
         return pulumi.get(self, "grants_to")
 
@@ -118,54 +123,107 @@ class AwaitableGetGrantsResult(GetGrantsResult):
             id=self.id)
 
 
-def get_grants(future_grants_in: Optional[pulumi.InputType['GetGrantsFutureGrantsInArgs']] = None,
-               future_grants_to: Optional[pulumi.InputType['GetGrantsFutureGrantsToArgs']] = None,
-               grants_of: Optional[pulumi.InputType['GetGrantsGrantsOfArgs']] = None,
-               grants_on: Optional[pulumi.InputType['GetGrantsGrantsOnArgs']] = None,
-               grants_to: Optional[pulumi.InputType['GetGrantsGrantsToArgs']] = None,
+def get_grants(future_grants_in: Optional[Union['GetGrantsFutureGrantsInArgs', 'GetGrantsFutureGrantsInArgsDict']] = None,
+               future_grants_to: Optional[Union['GetGrantsFutureGrantsToArgs', 'GetGrantsFutureGrantsToArgsDict']] = None,
+               grants_of: Optional[Union['GetGrantsGrantsOfArgs', 'GetGrantsGrantsOfArgsDict']] = None,
+               grants_on: Optional[Union['GetGrantsGrantsOnArgs', 'GetGrantsGrantsOnArgsDict']] = None,
+               grants_to: Optional[Union['GetGrantsGrantsToArgs', 'GetGrantsGrantsToArgsDict']] = None,
                opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetGrantsResult:
     """
     ## Example Usage
 
-    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_snowflake as snowflake
 
-    grants = snowflake.get_grants(grants_on=snowflake.GetGrantsGrantsOnArgs(
-        account=True,
-    ))
-    grants2 = snowflake.get_grants(grants_on=snowflake.GetGrantsGrantsOnArgs(
-        object_name="\\"tst\\"",
-        object_type="DATABASE",
-    ))
-    grants3 = snowflake.get_grants(grants_to=snowflake.GetGrantsGrantsToArgs(
-        role="ACCOUNTADMIN",
-    ))
-    grants4 = snowflake.get_grants(grants_of=snowflake.GetGrantsGrantsOfArgs(
-        role="ACCOUNTADMIN",
-    ))
-    grants5 = snowflake.get_grants(future_grants_in=snowflake.GetGrantsFutureGrantsInArgs(
-        database="\\"tst\\"",
-    ))
-    grants6 = snowflake.get_grants(future_grants_in=snowflake.GetGrantsFutureGrantsInArgs(
-        schema=snowflake.GetGrantsFutureGrantsInSchemaArgs(
-            database_name="\\"mydatabase\\"",
-            schema_name="\\"myschema\\"",
-        ),
-    ))
-    grants7 = snowflake.get_grants(future_grants_to=snowflake.GetGrantsFutureGrantsToArgs(
-        role="ACCOUNTADMIN",
-    ))
+    ##################################
+    ### SHOW GRANTS ON ...
+    ##################################
+    # account
+    example_on_account = snowflake.get_grants(grants_on={
+        "account": True,
+    })
+    # account object (e.g. database)
+    example_on_account_object = snowflake.get_grants(grants_on={
+        "object_name": "some_database",
+        "object_type": "DATABASE",
+    })
+    # database object (e.g. schema)
+    example_on_database_object = snowflake.get_grants(grants_on={
+        "object_name": "\\"some_database\\".\\"some_schema\\"",
+        "object_type": "SCHEMA",
+    })
+    # schema object (e.g. table)
+    example_on_schema_object = snowflake.get_grants(grants_on={
+        "object_name": "\\"some_database\\".\\"some_schema\\".\\"some_table\\"",
+        "object_type": "TABLE",
+    })
+    # application
+    example_to_application = snowflake.get_grants(grants_to={
+        "application": "some_application",
+    })
+    # application role
+    example_to_application_role = snowflake.get_grants(grants_to={
+        "application_role": "\\"some_application\\".\\"some_application_role\\"",
+    })
+    # account role
+    example_to_role = snowflake.get_grants(grants_to={
+        "account_role": "some_role",
+    })
+    # database role
+    example_to_database_role = snowflake.get_grants(grants_to={
+        "database_role": "\\"some_database\\".\\"some_database_role\\"",
+    })
+    # share
+    example_to_share = snowflake.get_grants(grants_to={
+        "share": {
+            "share_name": "some_share",
+        },
+    })
+    # user
+    example_to_user = snowflake.get_grants(grants_to={
+        "user": "some_user",
+    })
+    # application role
+    example_of_application_role = snowflake.get_grants(grants_of={
+        "application_role": "\\"some_application\\".\\"some_application_role\\"",
+    })
+    # database role
+    example_of_database_role = snowflake.get_grants(grants_of={
+        "database_role": "\\"some_database\\".\\"some_database_role\\"",
+    })
+    # account role
+    example_of_role = snowflake.get_grants(grants_of={
+        "account_role": "some_role",
+    })
+    # share
+    example_of_share = snowflake.get_grants(grants_of={
+        "share": "some_share",
+    })
+    # database
+    example_future_in_database = snowflake.get_grants(future_grants_in={
+        "database": "some_database",
+    })
+    # schema
+    example_future_in_schema = snowflake.get_grants(future_grants_in={
+        "schema": "\\"some_database\\".\\"some_schema\\"",
+    })
+    # account role
+    example_future_to_role = snowflake.get_grants(future_grants_to={
+        "account_role": "some_role",
+    })
+    # database role
+    example_future_to_database_role = snowflake.get_grants(future_grants_to={
+        "database_role": "\\"some_database\\".\\"some_database_role\\"",
+    })
     ```
-    <!--End PulumiCodeChooser -->
 
 
-    :param pulumi.InputType['GetGrantsFutureGrantsInArgs'] future_grants_in: Lists all privileges on new (i.e. future) objects
-    :param pulumi.InputType['GetGrantsFutureGrantsToArgs'] future_grants_to: Lists all privileges granted to the object on new (i.e. future) objects
-    :param pulumi.InputType['GetGrantsGrantsOfArgs'] grants_of: Lists all objects to which the given object has been granted
-    :param pulumi.InputType['GetGrantsGrantsOnArgs'] grants_on: Lists all privileges that have been granted on an object or account
-    :param pulumi.InputType['GetGrantsGrantsToArgs'] grants_to: Lists all privileges granted to the object
+    :param Union['GetGrantsFutureGrantsInArgs', 'GetGrantsFutureGrantsInArgsDict'] future_grants_in: Lists all privileges on new (i.e. future) objects.
+    :param Union['GetGrantsFutureGrantsToArgs', 'GetGrantsFutureGrantsToArgsDict'] future_grants_to: Lists all privileges granted to the object on new (i.e. future) objects.
+    :param Union['GetGrantsGrantsOfArgs', 'GetGrantsGrantsOfArgsDict'] grants_of: Lists all objects to which the given object has been granted.
+    :param Union['GetGrantsGrantsOnArgs', 'GetGrantsGrantsOnArgsDict'] grants_on: Lists all privileges that have been granted on an object or on an account.
+    :param Union['GetGrantsGrantsToArgs', 'GetGrantsGrantsToArgsDict'] grants_to: Lists all privileges granted to the object.
     """
     __args__ = dict()
     __args__['futureGrantsIn'] = future_grants_in
@@ -184,56 +242,121 @@ def get_grants(future_grants_in: Optional[pulumi.InputType['GetGrantsFutureGrant
         grants_on=pulumi.get(__ret__, 'grants_on'),
         grants_to=pulumi.get(__ret__, 'grants_to'),
         id=pulumi.get(__ret__, 'id'))
-
-
-@_utilities.lift_output_func(get_grants)
-def get_grants_output(future_grants_in: Optional[pulumi.Input[Optional[pulumi.InputType['GetGrantsFutureGrantsInArgs']]]] = None,
-                      future_grants_to: Optional[pulumi.Input[Optional[pulumi.InputType['GetGrantsFutureGrantsToArgs']]]] = None,
-                      grants_of: Optional[pulumi.Input[Optional[pulumi.InputType['GetGrantsGrantsOfArgs']]]] = None,
-                      grants_on: Optional[pulumi.Input[Optional[pulumi.InputType['GetGrantsGrantsOnArgs']]]] = None,
-                      grants_to: Optional[pulumi.Input[Optional[pulumi.InputType['GetGrantsGrantsToArgs']]]] = None,
-                      opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetGrantsResult]:
+def get_grants_output(future_grants_in: Optional[pulumi.Input[Optional[Union['GetGrantsFutureGrantsInArgs', 'GetGrantsFutureGrantsInArgsDict']]]] = None,
+                      future_grants_to: Optional[pulumi.Input[Optional[Union['GetGrantsFutureGrantsToArgs', 'GetGrantsFutureGrantsToArgsDict']]]] = None,
+                      grants_of: Optional[pulumi.Input[Optional[Union['GetGrantsGrantsOfArgs', 'GetGrantsGrantsOfArgsDict']]]] = None,
+                      grants_on: Optional[pulumi.Input[Optional[Union['GetGrantsGrantsOnArgs', 'GetGrantsGrantsOnArgsDict']]]] = None,
+                      grants_to: Optional[pulumi.Input[Optional[Union['GetGrantsGrantsToArgs', 'GetGrantsGrantsToArgsDict']]]] = None,
+                      opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetGrantsResult]:
     """
     ## Example Usage
 
-    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_snowflake as snowflake
 
-    grants = snowflake.get_grants(grants_on=snowflake.GetGrantsGrantsOnArgs(
-        account=True,
-    ))
-    grants2 = snowflake.get_grants(grants_on=snowflake.GetGrantsGrantsOnArgs(
-        object_name="\\"tst\\"",
-        object_type="DATABASE",
-    ))
-    grants3 = snowflake.get_grants(grants_to=snowflake.GetGrantsGrantsToArgs(
-        role="ACCOUNTADMIN",
-    ))
-    grants4 = snowflake.get_grants(grants_of=snowflake.GetGrantsGrantsOfArgs(
-        role="ACCOUNTADMIN",
-    ))
-    grants5 = snowflake.get_grants(future_grants_in=snowflake.GetGrantsFutureGrantsInArgs(
-        database="\\"tst\\"",
-    ))
-    grants6 = snowflake.get_grants(future_grants_in=snowflake.GetGrantsFutureGrantsInArgs(
-        schema=snowflake.GetGrantsFutureGrantsInSchemaArgs(
-            database_name="\\"mydatabase\\"",
-            schema_name="\\"myschema\\"",
-        ),
-    ))
-    grants7 = snowflake.get_grants(future_grants_to=snowflake.GetGrantsFutureGrantsToArgs(
-        role="ACCOUNTADMIN",
-    ))
+    ##################################
+    ### SHOW GRANTS ON ...
+    ##################################
+    # account
+    example_on_account = snowflake.get_grants(grants_on={
+        "account": True,
+    })
+    # account object (e.g. database)
+    example_on_account_object = snowflake.get_grants(grants_on={
+        "object_name": "some_database",
+        "object_type": "DATABASE",
+    })
+    # database object (e.g. schema)
+    example_on_database_object = snowflake.get_grants(grants_on={
+        "object_name": "\\"some_database\\".\\"some_schema\\"",
+        "object_type": "SCHEMA",
+    })
+    # schema object (e.g. table)
+    example_on_schema_object = snowflake.get_grants(grants_on={
+        "object_name": "\\"some_database\\".\\"some_schema\\".\\"some_table\\"",
+        "object_type": "TABLE",
+    })
+    # application
+    example_to_application = snowflake.get_grants(grants_to={
+        "application": "some_application",
+    })
+    # application role
+    example_to_application_role = snowflake.get_grants(grants_to={
+        "application_role": "\\"some_application\\".\\"some_application_role\\"",
+    })
+    # account role
+    example_to_role = snowflake.get_grants(grants_to={
+        "account_role": "some_role",
+    })
+    # database role
+    example_to_database_role = snowflake.get_grants(grants_to={
+        "database_role": "\\"some_database\\".\\"some_database_role\\"",
+    })
+    # share
+    example_to_share = snowflake.get_grants(grants_to={
+        "share": {
+            "share_name": "some_share",
+        },
+    })
+    # user
+    example_to_user = snowflake.get_grants(grants_to={
+        "user": "some_user",
+    })
+    # application role
+    example_of_application_role = snowflake.get_grants(grants_of={
+        "application_role": "\\"some_application\\".\\"some_application_role\\"",
+    })
+    # database role
+    example_of_database_role = snowflake.get_grants(grants_of={
+        "database_role": "\\"some_database\\".\\"some_database_role\\"",
+    })
+    # account role
+    example_of_role = snowflake.get_grants(grants_of={
+        "account_role": "some_role",
+    })
+    # share
+    example_of_share = snowflake.get_grants(grants_of={
+        "share": "some_share",
+    })
+    # database
+    example_future_in_database = snowflake.get_grants(future_grants_in={
+        "database": "some_database",
+    })
+    # schema
+    example_future_in_schema = snowflake.get_grants(future_grants_in={
+        "schema": "\\"some_database\\".\\"some_schema\\"",
+    })
+    # account role
+    example_future_to_role = snowflake.get_grants(future_grants_to={
+        "account_role": "some_role",
+    })
+    # database role
+    example_future_to_database_role = snowflake.get_grants(future_grants_to={
+        "database_role": "\\"some_database\\".\\"some_database_role\\"",
+    })
     ```
-    <!--End PulumiCodeChooser -->
 
 
-    :param pulumi.InputType['GetGrantsFutureGrantsInArgs'] future_grants_in: Lists all privileges on new (i.e. future) objects
-    :param pulumi.InputType['GetGrantsFutureGrantsToArgs'] future_grants_to: Lists all privileges granted to the object on new (i.e. future) objects
-    :param pulumi.InputType['GetGrantsGrantsOfArgs'] grants_of: Lists all objects to which the given object has been granted
-    :param pulumi.InputType['GetGrantsGrantsOnArgs'] grants_on: Lists all privileges that have been granted on an object or account
-    :param pulumi.InputType['GetGrantsGrantsToArgs'] grants_to: Lists all privileges granted to the object
+    :param Union['GetGrantsFutureGrantsInArgs', 'GetGrantsFutureGrantsInArgsDict'] future_grants_in: Lists all privileges on new (i.e. future) objects.
+    :param Union['GetGrantsFutureGrantsToArgs', 'GetGrantsFutureGrantsToArgsDict'] future_grants_to: Lists all privileges granted to the object on new (i.e. future) objects.
+    :param Union['GetGrantsGrantsOfArgs', 'GetGrantsGrantsOfArgsDict'] grants_of: Lists all objects to which the given object has been granted.
+    :param Union['GetGrantsGrantsOnArgs', 'GetGrantsGrantsOnArgsDict'] grants_on: Lists all privileges that have been granted on an object or on an account.
+    :param Union['GetGrantsGrantsToArgs', 'GetGrantsGrantsToArgsDict'] grants_to: Lists all privileges granted to the object.
     """
-    ...
+    __args__ = dict()
+    __args__['futureGrantsIn'] = future_grants_in
+    __args__['futureGrantsTo'] = future_grants_to
+    __args__['grantsOf'] = grants_of
+    __args__['grantsOn'] = grants_on
+    __args__['grantsTo'] = grants_to
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('snowflake:index/getGrants:getGrants', __args__, opts=opts, typ=GetGrantsResult)
+    return __ret__.apply(lambda __response__: GetGrantsResult(
+        future_grants_in=pulumi.get(__response__, 'future_grants_in'),
+        future_grants_to=pulumi.get(__response__, 'future_grants_to'),
+        grants=pulumi.get(__response__, 'grants'),
+        grants_of=pulumi.get(__response__, 'grants_of'),
+        grants_on=pulumi.get(__response__, 'grants_on'),
+        grants_to=pulumi.get(__response__, 'grants_to'),
+        id=pulumi.get(__response__, 'id')))