pulumi-snowflake 0.50.2a1709892015__py3-none-any.whl → 1.2.0a1736835738__py3-none-any.whl

pulumi_snowflake/config/__init__.pyi

@@ -4,30 +4,29 @@
 
 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
 
-account: Optional[str]
+accountName: Optional[str]
 """
-Specifies your Snowflake account identifier assigned, by Snowflake. For information about account identifiers, see the
-[Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html). Can also be sourced
-from the `SNOWFLAKE_ACCOUNT` environment variable. Required unless using `profile`.
+Specifies your Snowflake account name assigned by Snowflake. For information about account identifiers, see the
+[Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#account-name). Required
+unless using `profile`. Can also be sourced from the `SNOWFLAKE_ACCOUNT_NAME` environment variable.
 """
 
 authenticator: Optional[str]
 """
 Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when
-connecting to Snowflake. Valid values include: Snowflake, OAuth, ExternalBrowser, Okta, JWT, TokenAccessor,
-UsernamePasswordMFA. Can also be sourced from the `SNOWFLAKE_AUTHENTICATOR` environment variable. It has to be set
-explicitly to JWT for private key authentication.
-"""
-
-browserAuth: Optional[bool]
-"""
-Required when `oauth_refresh_token` is used. Can also be sourced from `SNOWFLAKE_USE_BROWSER_AUTH` environment variable.
+connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `SNOWFLAKE_JWT` |
+`TOKENACCESSOR` | `USERNAMEPASSWORDMFA`. Can also be sourced from the `SNOWFLAKE_AUTHENTICATOR` environment variable.
 """
 
 clientIp: Optional[str]
@@ -35,13 +34,13 @@ clientIp: Optional[str]
 IP address for network checks. Can also be sourced from the `SNOWFLAKE_CLIENT_IP` environment variable.
 """
 
-clientRequestMfaToken: Optional[bool]
+clientRequestMfaToken: Optional[str]
 """
 When true the MFA token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also
 be sourced from the `SNOWFLAKE_CLIENT_REQUEST_MFA_TOKEN` environment variable.
 """
 
-clientStoreTemporaryCredential: Optional[bool]
+clientStoreTemporaryCredential: Optional[str]
 """
 When true the ID token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also be
 sourced from the `SNOWFLAKE_CLIENT_STORE_TEMPORARY_CREDENTIAL` environment variable.
@@ -49,31 +48,49 @@ sourced from the `SNOWFLAKE_CLIENT_STORE_TEMPORARY_CREDENTIAL` environment varia
 
 clientTimeout: Optional[int]
 """
-The timeout in seconds for the client to complete the authentication. Default is 900 seconds. Can also be sourced from
-the `SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
+The timeout in seconds for the client to complete the authentication. Can also be sourced from the
+`SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
+"""
+
+disableConsoleLogin: Optional[str]
+"""
+Indicates whether console login should be disabled in the driver. Can also be sourced from the
+`SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
 """
 
 disableQueryContextCache: Optional[bool]
 """
-Should HTAP query context cache be disabled. Can also be sourced from the `SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE`
+Disables HTAP query context cache in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE`
 environment variable.
 """
 
 disableTelemetry: Optional[bool]
 """
-Indicates whether to disable telemetry. Can also be sourced from the `SNOWFLAKE_DISABLE_TELEMETRY` environment variable.
+Disables telemetry in the driver. Can also be sourced from the `DISABLE_TELEMETRY` environment variable.
+"""
+
+driverTracing: Optional[str]
+"""
+Specifies the logging level to be used by the driver. Valid options are: `trace` | `debug` | `info` | `print` |
+`warning` | `error` | `fatal` | `panic`. Can also be sourced from the `SNOWFLAKE_DRIVER_TRACING` environment variable.
 """
 
 externalBrowserTimeout: Optional[int]
 """
-The timeout in seconds for the external browser to complete the authentication. Default is 120 seconds. Can also be
-sourced from the `SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT` environment variable.
+The timeout in seconds for the external browser to complete the authentication. Can also be sourced from the
+`SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT` environment variable.
 """
 
 host: Optional[str]
 """
-Supports passing in a custom host value to the snowflake go driver for use with privatelink. Can also be sourced from
-the `SNOWFLAKE_HOST` environment variable.
+Specifies a custom host value used by the driver for privatelink connections. Can also be sourced from the
+`SNOWFLAKE_HOST` environment variable.
+"""
+
+includeRetryReason: Optional[str]
+"""
+Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment
+variable.
 """
 
 insecureMode: Optional[bool]
@@ -85,8 +102,8 @@ environment variable.
 
 jwtClientTimeout: Optional[int]
 """
-The timeout in seconds for the JWT client to complete the authentication. Default is 10 seconds. Can also be sourced
-from the `SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
+The timeout in seconds for the JWT client to complete the authentication. Can also be sourced from the
+`SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
 """
 
 jwtExpireTimeout: Optional[int]
@@ -102,48 +119,17 @@ Enables the session to persist even after the connection is closed. Can also be
 
 loginTimeout: Optional[int]
 """
-Login retry timeout EXCLUDING network roundtrip and read out http response. Can also be sourced from the
+Login retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
 `SNOWFLAKE_LOGIN_TIMEOUT` environment variable.
 """
 
-oauthAccessToken: Optional[str]
-"""
-Token for use with OAuth. Generating the token is left to other tools. Cannot be used with `browser_auth`,
-`private_key_path`, `oauth_refresh_token` or `password`. Can also be sourced from `SNOWFLAKE_OAUTH_ACCESS_TOKEN`
-environment variable.
-"""
-
-oauthClientId: Optional[str]
-"""
-Required when `oauth_refresh_token` is used. Can also be sourced from `SNOWFLAKE_OAUTH_CLIENT_ID` environment variable.
-"""
-
-oauthClientSecret: Optional[str]
-"""
-Required when `oauth_refresh_token` is used. Can also be sourced from `SNOWFLAKE_OAUTH_CLIENT_SECRET` environment
-variable.
-"""
-
-oauthEndpoint: Optional[str]
-"""
-Required when `oauth_refresh_token` is used. Can also be sourced from `SNOWFLAKE_OAUTH_ENDPOINT` environment variable.
-"""
-
-oauthRedirectUrl: Optional[str]
-"""
-Required when `oauth_refresh_token` is used. Can also be sourced from `SNOWFLAKE_OAUTH_REDIRECT_URL` environment
-variable.
-"""
-
-oauthRefreshToken: Optional[str]
+maxRetryCount: Optional[int]
 """
-Token for use with OAuth. Setup and generation of the token is left to other tools. Should be used in conjunction with
-`oauth_client_id`, `oauth_client_secret`, `oauth_endpoint`, `oauth_redirect_url`. Cannot be used with `browser_auth`,
-`private_key_path`, `oauth_access_token` or `password`. Can also be sourced from `SNOWFLAKE_OAUTH_REFRESH_TOKEN`
-environment variable.
+Specifies how many times non-periodic HTTP request can be retried by the driver. Can also be sourced from the
+`SNOWFLAKE_MAX_RETRY_COUNT` environment variable.
 """
 
-ocspFailOpen: Optional[bool]
+ocspFailOpen: Optional[str]
 """
 True represents OCSP fail open mode. False represents OCSP fail closed mode. Fail open true by default. Can also be
 sourced from the `SNOWFLAKE_OCSP_FAIL_OPEN` environment variable.
@@ -151,13 +137,22 @@ sourced from the `SNOWFLAKE_OCSP_FAIL_OPEN` environment variable.
 
 oktaUrl: Optional[str]
 """
-The URL of the Okta server. e.g. https://example.okta.com. Can also be sourced from the `SNOWFLAKE_OKTA_URL` environment
-variable.
+The URL of the Okta server. e.g. https://example.okta.com. Okta URL host needs to to have a suffix `okta.com`. Read more
+in Snowflake [docs](https://docs.snowflake.com/en/user-guide/oauth-okta). Can also be sourced from the
+`SNOWFLAKE_OKTA_URL` environment variable.
+"""
+
+organizationName: Optional[str]
+"""
+Specifies your Snowflake organization name assigned by Snowflake. For information about account identifiers, see the
+[Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#organization-name). Required
+unless using `profile`. Can also be sourced from the `SNOWFLAKE_ORGANIZATION_NAME` environment variable.
 """
 
 params: Optional[str]
 """
-Sets other connection (i.e. session) parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters)
+Sets other connection (i.e. session) parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters).
+This field can not be set with environmental variables.
 """
 
 passcode: Optional[str]
@@ -168,38 +163,34 @@ the `SNOWFLAKE_PASSCODE` environment variable.
 
 passcodeInPassword: Optional[bool]
 """
-False by default. Set to true if the MFA passcode is embedded in the login password. Appends the MFA passcode to the end
-of the password. Can also be sourced from the `SNOWFLAKE_PASSCODE_IN_PASSWORD` environment variable.
+False by default. Set to true if the MFA passcode is embedded to the configured password. Can also be sourced from the
+`SNOWFLAKE_PASSCODE_IN_PASSWORD` environment variable.
 """
 
 password: Optional[str]
 """
-Password for username+password auth. Cannot be used with `browser_auth` or `private_key_path`. Can also be sourced from
-the `SNOWFLAKE_PASSWORD` environment variable.
+Password for user + password auth. Cannot be used with `private_key` and `private_key_passphrase`. Can also be sourced
+from the `SNOWFLAKE_PASSWORD` environment variable.
 """
 
 port: Optional[int]
 """
-Support custom port values to snowflake go driver for use with privatelink. Can also be sourced from the
+Specifies a custom port value used by the driver for privatelink connections. Can also be sourced from the
 `SNOWFLAKE_PORT` environment variable.
 """
 
+previewFeaturesEnabled: Optional[str]
+
 privateKey: Optional[str]
 """
-Private Key for username+private-key auth. Cannot be used with `browser_auth` or `password`. Can also be sourced from
+Private Key for username+private-key auth. Cannot be used with `password`. Can also be sourced from the
 `SNOWFLAKE_PRIVATE_KEY` environment variable.
 """
 
 privateKeyPassphrase: Optional[str]
 """
 Supports the encryption ciphers aes-128-cbc, aes-128-gcm, aes-192-cbc, aes-192-gcm, aes-256-cbc, aes-256-gcm, and
-des-ede3-cbc. Can also be sourced from `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
-"""
-
-privateKeyPath: Optional[str]
-"""
-Path to a private key for using keypair authentication. Cannot be used with `browser_auth`, `oauth_access_token` or
-`password`. Can also be sourced from `SNOWFLAKE_PRIVATE_KEY_PATH` environment variable.
+des-ede3-cbc. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
 """
 
 profile: Optional[str]
@@ -210,34 +201,26 @@ variable.
 
 protocol: Optional[str]
 """
-Either http or https, defaults to https. Can also be sourced from the `SNOWFLAKE_PROTOCOL` environment variable.
-"""
-
-region: Optional[str]
-"""
-Snowflake region, such as "eu-central-1", with this parameter. However, since this parameter is deprecated, it is best
-to specify the region as part of the account parameter. For details, see the description of the account parameter.
-[Snowflake region](https://docs.snowflake.com/en/user-guide/intro-regions.html) to use. Required if using the [legacy
-format for the `account`
-identifier](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html#format-2-legacy-account-locator-in-a-region)
-in the form of `<cloud_region_id>.<cloud>`. Can also be sourced from the `SNOWFLAKE_REGION` environment variable.
+A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the
+`SNOWFLAKE_PROTOCOL` environment variable.
 """
 
 requestTimeout: Optional[int]
 """
-request retry timeout EXCLUDING network roundtrip and read out http response. Can also be sourced from the
+request retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
 `SNOWFLAKE_REQUEST_TIMEOUT` environment variable.
 """
 
 role: Optional[str]
 """
 Specifies the role to use by default for accessing Snowflake objects in the client session. Can also be sourced from the
-`SNOWFLAKE_ROLE` environment variable. .
+`SNOWFLAKE_ROLE` environment variable.
 """
 
-sessionParams: Optional[str]
+tmpDirectoryPath: Optional[str]
 """
-Sets session parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters)
+Sets temporary directory used by the driver for operations like encrypting, compressing etc. Can also be sourced from
+the `SNOWFLAKE_TMP_DIRECTORY_PATH` environment variable.
 """
 
 token: Optional[str]
@@ -250,16 +233,10 @@ tokenAccessor: Optional[str]
 
 user: Optional[str]
 """
-Username. Can also be sourced from the `SNOWFLAKE_USER` environment variable. Required unless using `profile`.
-"""
-
-username: Optional[str]
-"""
-Username for username+password authentication. Can also be sourced from the `SNOWFLAKE_USERNAME` environment variable.
-Required unless using `profile`.
+Username. Required unless using `profile`. Can also be sourced from the `SNOWFLAKE_USER` environment variable.
 """
 
-validateDefaultParameters: Optional[bool]
+validateDefaultParameters: Optional[str]
 """
 True by default. If false, disables the validation checks for Database, Schema, Warehouse and Role at the time a
 connection is established. Can also be sourced from the `SNOWFLAKE_VALIDATE_DEFAULT_PARAMETERS` environment variable.

pulumi_snowflake/config/outputs.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
 
 __all__ = [