pulumi-snowflake 2.5.0a1756327504__py3-none-any.whl → 2.5.0a1756507143__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/config/__init__.pyi +36 -84
- pulumi_snowflake/config/vars.py +36 -84
- pulumi_snowflake/provider.py +130 -304
- pulumi_snowflake/pulumi-plugin.json +1 -1
- {pulumi_snowflake-2.5.0a1756327504.dist-info → pulumi_snowflake-2.5.0a1756507143.dist-info}/METADATA +1 -1
- {pulumi_snowflake-2.5.0a1756327504.dist-info → pulumi_snowflake-2.5.0a1756507143.dist-info}/RECORD +8 -8
- {pulumi_snowflake-2.5.0a1756327504.dist-info → pulumi_snowflake-2.5.0a1756507143.dist-info}/WHEEL +0 -0
- {pulumi_snowflake-2.5.0a1756327504.dist-info → pulumi_snowflake-2.5.0a1756507143.dist-info}/top_level.txt +0 -0
pulumi_snowflake/provider.py
CHANGED
|
@@ -64,94 +64,46 @@ class ProviderArgs:
|
|
|
64
64
|
warehouse: Optional[pulumi.Input[_builtins.str]] = None):
|
|
65
65
|
"""
|
|
66
66
|
The set of arguments for constructing a Provider resource.
|
|
67
|
-
:param pulumi.Input[_builtins.str] account_name: Specifies your Snowflake account name assigned by Snowflake. For information about account identifiers, see the
|
|
68
|
-
|
|
69
|
-
unless using `profile`. Can also be sourced from the `SNOWFLAKE_ACCOUNT_NAME` environment variable.
|
|
70
|
-
:param pulumi.Input[_builtins.str] authenticator: Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when
|
|
71
|
-
connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `SNOWFLAKE_JWT` |
|
|
72
|
-
`TOKENACCESSOR` | `USERNAMEPASSWORDMFA` | `PROGRAMMATIC_ACCESS_TOKEN`. Can also be sourced from the
|
|
73
|
-
`SNOWFLAKE_AUTHENTICATOR` environment variable.
|
|
67
|
+
:param pulumi.Input[_builtins.str] account_name: 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.
|
|
68
|
+
:param pulumi.Input[_builtins.str] authenticator: Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `SNOWFLAKE_JWT` | `TOKENACCESSOR` | `USERNAMEPASSWORDMFA` | `PROGRAMMATIC_ACCESS_TOKEN`. Can also be sourced from the `SNOWFLAKE_AUTHENTICATOR` environment variable.
|
|
74
69
|
:param pulumi.Input[_builtins.str] client_ip: IP address for network checks. Can also be sourced from the `SNOWFLAKE_CLIENT_IP` environment variable.
|
|
75
|
-
:param pulumi.Input[_builtins.str] client_request_mfa_token: When true the MFA token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also
|
|
76
|
-
|
|
77
|
-
:param pulumi.Input[_builtins.
|
|
78
|
-
|
|
79
|
-
:param pulumi.Input[_builtins.
|
|
80
|
-
`SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
|
|
81
|
-
:param pulumi.Input[_builtins.str] disable_console_login: Indicates whether console login should be disabled in the driver. Can also be sourced from the
|
|
82
|
-
`SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
|
|
83
|
-
:param pulumi.Input[_builtins.bool] disable_query_context_cache: Disables HTAP query context cache in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE`
|
|
84
|
-
environment variable.
|
|
70
|
+
:param pulumi.Input[_builtins.str] client_request_mfa_token: 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.
|
|
71
|
+
:param pulumi.Input[_builtins.str] client_store_temporary_credential: 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.
|
|
72
|
+
:param pulumi.Input[_builtins.int] client_timeout: The timeout in seconds for the client to complete the authentication. Can also be sourced from the `SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
|
|
73
|
+
:param pulumi.Input[_builtins.str] disable_console_login: Indicates whether console login should be disabled in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
|
|
74
|
+
:param pulumi.Input[_builtins.bool] 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.
|
|
85
75
|
:param pulumi.Input[_builtins.bool] disable_telemetry: Disables telemetry in the driver. Can also be sourced from the `DISABLE_TELEMETRY` environment variable.
|
|
86
|
-
:param pulumi.Input[_builtins.str] driver_tracing: Specifies the logging level to be used by the driver. Valid options are: `trace` | `debug` | `info` | `print` |
|
|
87
|
-
|
|
88
|
-
:param pulumi.Input[_builtins.
|
|
89
|
-
|
|
90
|
-
:param pulumi.Input[_builtins.
|
|
91
|
-
|
|
92
|
-
:param pulumi.Input[_builtins.str] include_retry_reason: Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment
|
|
93
|
-
variable.
|
|
94
|
-
:param pulumi.Input[_builtins.bool] insecure_mode: If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the
|
|
95
|
-
default value for testing or emergency situations only. Can also be sourced from the `SNOWFLAKE_INSECURE_MODE`
|
|
96
|
-
environment variable.
|
|
97
|
-
:param pulumi.Input[_builtins.int] jwt_client_timeout: The timeout in seconds for the JWT client to complete the authentication. Can also be sourced from the
|
|
98
|
-
`SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
|
|
76
|
+
:param pulumi.Input[_builtins.str] driver_tracing: 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.
|
|
77
|
+
:param pulumi.Input[_builtins.int] external_browser_timeout: The timeout in seconds for the external browser to complete the authentication. Can also be sourced from the `SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT` environment variable.
|
|
78
|
+
:param pulumi.Input[_builtins.str] host: Specifies a custom host value used by the driver for privatelink connections. Can also be sourced from the `SNOWFLAKE_HOST` environment variable.
|
|
79
|
+
:param pulumi.Input[_builtins.str] include_retry_reason: Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment variable.
|
|
80
|
+
:param pulumi.Input[_builtins.bool] insecure_mode: If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the default value for testing or emergency situations only. Can also be sourced from the `SNOWFLAKE_INSECURE_MODE` environment variable.
|
|
81
|
+
:param pulumi.Input[_builtins.int] jwt_client_timeout: The timeout in seconds for the JWT client to complete the authentication. Can also be sourced from the `SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
|
|
99
82
|
:param pulumi.Input[_builtins.int] jwt_expire_timeout: JWT expire after timeout in seconds. Can also be sourced from the `SNOWFLAKE_JWT_EXPIRE_TIMEOUT` environment variable.
|
|
100
|
-
:param pulumi.Input[_builtins.bool] keep_session_alive: Enables the session to persist even after the connection is closed. Can also be sourced from the
|
|
101
|
-
|
|
102
|
-
:param pulumi.Input[_builtins.int]
|
|
103
|
-
|
|
104
|
-
:param pulumi.Input[_builtins.
|
|
105
|
-
|
|
106
|
-
:param pulumi.Input[_builtins.str]
|
|
107
|
-
|
|
108
|
-
:param pulumi.Input[_builtins.
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
:param pulumi.Input[_builtins.str]
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
:param pulumi.Input[
|
|
115
|
-
|
|
116
|
-
:param pulumi.Input[_builtins.str]
|
|
117
|
-
|
|
118
|
-
:param pulumi.Input[_builtins.
|
|
119
|
-
|
|
120
|
-
:param pulumi.Input[_builtins.
|
|
121
|
-
[token](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens#generating-a-programmatic-access-token) for
|
|
122
|
-
[PAT auth](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens). Cannot be used with `private_key` and
|
|
123
|
-
`private_key_passphrase`. Can also be sourced from the `SNOWFLAKE_PASSWORD` environment variable.
|
|
124
|
-
:param pulumi.Input[_builtins.int] port: Specifies a custom port value used by the driver for privatelink connections. Can also be sourced from the
|
|
125
|
-
`SNOWFLAKE_PORT` environment variable.
|
|
126
|
-
:param pulumi.Input[_builtins.str] private_key: Private Key for username+private-key auth. Cannot be used with `password`. Can also be sourced from the
|
|
127
|
-
`SNOWFLAKE_PRIVATE_KEY` environment variable.
|
|
128
|
-
:param pulumi.Input[_builtins.str] private_key_passphrase: Supports the encryption ciphers aes-128-cbc, aes-128-gcm, aes-192-cbc, aes-192-gcm, aes-256-cbc, aes-256-gcm, and
|
|
129
|
-
des-ede3-cbc. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
|
|
130
|
-
:param pulumi.Input[_builtins.str] profile: Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the `SNOWFLAKE_PROFILE` environment
|
|
131
|
-
variable.
|
|
132
|
-
:param pulumi.Input[_builtins.str] protocol: A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the
|
|
133
|
-
`SNOWFLAKE_PROTOCOL` environment variable.
|
|
134
|
-
:param pulumi.Input[_builtins.int] request_timeout: request retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
135
|
-
`SNOWFLAKE_REQUEST_TIMEOUT` environment variable.
|
|
136
|
-
:param pulumi.Input[_builtins.str] role: Specifies the role to use by default for accessing Snowflake objects in the client session. Can also be sourced from the
|
|
137
|
-
`SNOWFLAKE_ROLE` environment variable.
|
|
138
|
-
:param pulumi.Input[_builtins.bool] skip_toml_file_permission_verification: False by default. Skips TOML configuration file permission verification. This flag has no effect on Windows systems, as
|
|
139
|
-
the permissions are not checked on this platform. Instead of skipping the permissions verification, we recommend setting
|
|
140
|
-
the proper privileges - see the section below. Can also be sourced from the
|
|
141
|
-
`SNOWFLAKE_SKIP_TOML_FILE_PERMISSION_VERIFICATION` environment variable.
|
|
142
|
-
:param pulumi.Input[_builtins.str] tmp_directory_path: Sets temporary directory used by the driver for operations like encrypting, compressing etc. Can also be sourced from
|
|
143
|
-
the `SNOWFLAKE_TMP_DIRECTORY_PATH` environment variable.
|
|
144
|
-
:param pulumi.Input[_builtins.str] token: Token to use for OAuth and other forms of token based auth. When this field is set here, or in the TOML file, the
|
|
145
|
-
provider sets the `authenticator` to `OAUTH`. Optionally, set the `authenticator` field to the authenticator you want to
|
|
146
|
-
use. Can also be sourced from the `SNOWFLAKE_TOKEN` environment variable.
|
|
147
|
-
:param pulumi.Input[_builtins.bool] use_legacy_toml_file: False by default. When this is set to true, the provider expects the legacy TOML format. Otherwise, it expects the new
|
|
148
|
-
format. See more in the section below Can also be sourced from the `SNOWFLAKE_USE_LEGACY_TOML_FILE` environment
|
|
149
|
-
variable.
|
|
83
|
+
:param pulumi.Input[_builtins.bool] keep_session_alive: Enables the session to persist even after the connection is closed. Can also be sourced from the `SNOWFLAKE_KEEP_SESSION_ALIVE` environment variable.
|
|
84
|
+
:param pulumi.Input[_builtins.int] login_timeout: Login retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the `SNOWFLAKE_LOGIN_TIMEOUT` environment variable.
|
|
85
|
+
:param pulumi.Input[_builtins.int] max_retry_count: 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.
|
|
86
|
+
:param pulumi.Input[_builtins.str] ocsp_fail_open: 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.
|
|
87
|
+
:param pulumi.Input[_builtins.str] okta_url: 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.
|
|
88
|
+
:param pulumi.Input[_builtins.str] organization_name: 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.
|
|
89
|
+
:param pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]] params: 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.
|
|
90
|
+
:param pulumi.Input[_builtins.str] passcode: Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login. Can also be sourced from the `SNOWFLAKE_PASSCODE` environment variable.
|
|
91
|
+
:param pulumi.Input[_builtins.bool] passcode_in_password: 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.
|
|
92
|
+
:param pulumi.Input[_builtins.str] password: Password for user + password or [token](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens#generating-a-programmatic-access-token) for [PAT auth](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens). Cannot be used with `private_key` and `private_key_passphrase`. Can also be sourced from the `SNOWFLAKE_PASSWORD` environment variable.
|
|
93
|
+
:param pulumi.Input[_builtins.int] port: Specifies a custom port value used by the driver for privatelink connections. Can also be sourced from the `SNOWFLAKE_PORT` environment variable.
|
|
94
|
+
:param pulumi.Input[_builtins.str] private_key: Private Key for username+private-key auth. Cannot be used with `password`. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY` environment variable.
|
|
95
|
+
:param pulumi.Input[_builtins.str] private_key_passphrase: 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 the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
|
|
96
|
+
:param pulumi.Input[_builtins.str] profile: Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the `SNOWFLAKE_PROFILE` environment variable.
|
|
97
|
+
:param pulumi.Input[_builtins.str] protocol: A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the `SNOWFLAKE_PROTOCOL` environment variable.
|
|
98
|
+
:param pulumi.Input[_builtins.int] request_timeout: request retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the `SNOWFLAKE_REQUEST_TIMEOUT` environment variable.
|
|
99
|
+
:param pulumi.Input[_builtins.str] role: 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.
|
|
100
|
+
:param pulumi.Input[_builtins.bool] skip_toml_file_permission_verification: False by default. Skips TOML configuration file permission verification. This flag has no effect on Windows systems, as the permissions are not checked on this platform. Instead of skipping the permissions verification, we recommend setting the proper privileges - see the section below. Can also be sourced from the `SNOWFLAKE_SKIP_TOML_FILE_PERMISSION_VERIFICATION` environment variable.
|
|
101
|
+
:param pulumi.Input[_builtins.str] tmp_directory_path: 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.
|
|
102
|
+
:param pulumi.Input[_builtins.str] token: Token to use for OAuth and other forms of token based auth. When this field is set here, or in the TOML file, the provider sets the `authenticator` to `OAUTH`. Optionally, set the `authenticator` field to the authenticator you want to use. Can also be sourced from the `SNOWFLAKE_TOKEN` environment variable.
|
|
103
|
+
:param pulumi.Input[_builtins.bool] use_legacy_toml_file: False by default. When this is set to true, the provider expects the legacy TOML format. Otherwise, it expects the new format. See more in the section below Can also be sourced from the `SNOWFLAKE_USE_LEGACY_TOML_FILE` environment variable.
|
|
150
104
|
:param pulumi.Input[_builtins.str] user: Username. Required unless using `profile`. Can also be sourced from the `SNOWFLAKE_USER` environment variable.
|
|
151
|
-
:param pulumi.Input[_builtins.str] validate_default_parameters: True by default. If false, disables the validation checks for Database, Schema, Warehouse and Role at the time a
|
|
152
|
-
|
|
153
|
-
:param pulumi.Input[_builtins.str] warehouse: Specifies the virtual warehouse to use by default for queries, loading, etc. in the client session. Can also be sourced
|
|
154
|
-
from the `SNOWFLAKE_WAREHOUSE` environment variable.
|
|
105
|
+
:param pulumi.Input[_builtins.str] validate_default_parameters: 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.
|
|
106
|
+
:param pulumi.Input[_builtins.str] warehouse: Specifies the virtual warehouse to use by default for queries, loading, etc. in the client session. Can also be sourced from the `SNOWFLAKE_WAREHOUSE` environment variable.
|
|
155
107
|
"""
|
|
156
108
|
if account_name is not None:
|
|
157
109
|
pulumi.set(__self__, "account_name", account_name)
|
|
@@ -256,9 +208,7 @@ class ProviderArgs:
|
|
|
256
208
|
@pulumi.getter(name="accountName")
|
|
257
209
|
def account_name(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
258
210
|
"""
|
|
259
|
-
Specifies your Snowflake account name assigned by Snowflake. For information about account identifiers, see the
|
|
260
|
-
[Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#account-name). Required
|
|
261
|
-
unless using `profile`. Can also be sourced from the `SNOWFLAKE_ACCOUNT_NAME` environment variable.
|
|
211
|
+
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.
|
|
262
212
|
"""
|
|
263
213
|
return pulumi.get(self, "account_name")
|
|
264
214
|
|
|
@@ -270,10 +220,7 @@ class ProviderArgs:
|
|
|
270
220
|
@pulumi.getter
|
|
271
221
|
def authenticator(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
272
222
|
"""
|
|
273
|
-
Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when
|
|
274
|
-
connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `SNOWFLAKE_JWT` |
|
|
275
|
-
`TOKENACCESSOR` | `USERNAMEPASSWORDMFA` | `PROGRAMMATIC_ACCESS_TOKEN`. Can also be sourced from the
|
|
276
|
-
`SNOWFLAKE_AUTHENTICATOR` environment variable.
|
|
223
|
+
Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `SNOWFLAKE_JWT` | `TOKENACCESSOR` | `USERNAMEPASSWORDMFA` | `PROGRAMMATIC_ACCESS_TOKEN`. Can also be sourced from the `SNOWFLAKE_AUTHENTICATOR` environment variable.
|
|
277
224
|
"""
|
|
278
225
|
return pulumi.get(self, "authenticator")
|
|
279
226
|
|
|
@@ -297,8 +244,7 @@ class ProviderArgs:
|
|
|
297
244
|
@pulumi.getter(name="clientRequestMfaToken")
|
|
298
245
|
def client_request_mfa_token(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
299
246
|
"""
|
|
300
|
-
When true the MFA token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also
|
|
301
|
-
be sourced from the `SNOWFLAKE_CLIENT_REQUEST_MFA_TOKEN` environment variable.
|
|
247
|
+
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.
|
|
302
248
|
"""
|
|
303
249
|
return pulumi.get(self, "client_request_mfa_token")
|
|
304
250
|
|
|
@@ -310,8 +256,7 @@ class ProviderArgs:
|
|
|
310
256
|
@pulumi.getter(name="clientStoreTemporaryCredential")
|
|
311
257
|
def client_store_temporary_credential(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
312
258
|
"""
|
|
313
|
-
When true the ID token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also be
|
|
314
|
-
sourced from the `SNOWFLAKE_CLIENT_STORE_TEMPORARY_CREDENTIAL` environment variable.
|
|
259
|
+
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.
|
|
315
260
|
"""
|
|
316
261
|
return pulumi.get(self, "client_store_temporary_credential")
|
|
317
262
|
|
|
@@ -323,8 +268,7 @@ class ProviderArgs:
|
|
|
323
268
|
@pulumi.getter(name="clientTimeout")
|
|
324
269
|
def client_timeout(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
325
270
|
"""
|
|
326
|
-
The timeout in seconds for the client to complete the authentication. Can also be sourced from the
|
|
327
|
-
`SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
|
|
271
|
+
The timeout in seconds for the client to complete the authentication. Can also be sourced from the `SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
|
|
328
272
|
"""
|
|
329
273
|
return pulumi.get(self, "client_timeout")
|
|
330
274
|
|
|
@@ -336,8 +280,7 @@ class ProviderArgs:
|
|
|
336
280
|
@pulumi.getter(name="disableConsoleLogin")
|
|
337
281
|
def disable_console_login(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
338
282
|
"""
|
|
339
|
-
Indicates whether console login should be disabled in the driver. Can also be sourced from the
|
|
340
|
-
`SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
|
|
283
|
+
Indicates whether console login should be disabled in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
|
|
341
284
|
"""
|
|
342
285
|
return pulumi.get(self, "disable_console_login")
|
|
343
286
|
|
|
@@ -349,8 +292,7 @@ class ProviderArgs:
|
|
|
349
292
|
@pulumi.getter(name="disableQueryContextCache")
|
|
350
293
|
def disable_query_context_cache(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
351
294
|
"""
|
|
352
|
-
Disables HTAP query context cache in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE`
|
|
353
|
-
environment variable.
|
|
295
|
+
Disables HTAP query context cache in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE` environment variable.
|
|
354
296
|
"""
|
|
355
297
|
return pulumi.get(self, "disable_query_context_cache")
|
|
356
298
|
|
|
@@ -374,8 +316,7 @@ class ProviderArgs:
|
|
|
374
316
|
@pulumi.getter(name="driverTracing")
|
|
375
317
|
def driver_tracing(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
376
318
|
"""
|
|
377
|
-
Specifies the logging level to be used by the driver. Valid options are: `trace` | `debug` | `info` | `print` |
|
|
378
|
-
`warning` | `error` | `fatal` | `panic`. Can also be sourced from the `SNOWFLAKE_DRIVER_TRACING` environment variable.
|
|
319
|
+
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.
|
|
379
320
|
"""
|
|
380
321
|
return pulumi.get(self, "driver_tracing")
|
|
381
322
|
|
|
@@ -387,8 +328,7 @@ class ProviderArgs:
|
|
|
387
328
|
@pulumi.getter(name="externalBrowserTimeout")
|
|
388
329
|
def external_browser_timeout(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
389
330
|
"""
|
|
390
|
-
The timeout in seconds for the external browser to complete the authentication. Can also be sourced from the
|
|
391
|
-
`SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT` environment variable.
|
|
331
|
+
The timeout in seconds for the external browser to complete the authentication. Can also be sourced from the `SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT` environment variable.
|
|
392
332
|
"""
|
|
393
333
|
return pulumi.get(self, "external_browser_timeout")
|
|
394
334
|
|
|
@@ -400,8 +340,7 @@ class ProviderArgs:
|
|
|
400
340
|
@pulumi.getter
|
|
401
341
|
def host(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
402
342
|
"""
|
|
403
|
-
Specifies a custom host value used by the driver for privatelink connections. Can also be sourced from the
|
|
404
|
-
`SNOWFLAKE_HOST` environment variable.
|
|
343
|
+
Specifies a custom host value used by the driver for privatelink connections. Can also be sourced from the `SNOWFLAKE_HOST` environment variable.
|
|
405
344
|
"""
|
|
406
345
|
return pulumi.get(self, "host")
|
|
407
346
|
|
|
@@ -413,8 +352,7 @@ class ProviderArgs:
|
|
|
413
352
|
@pulumi.getter(name="includeRetryReason")
|
|
414
353
|
def include_retry_reason(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
415
354
|
"""
|
|
416
|
-
Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment
|
|
417
|
-
variable.
|
|
355
|
+
Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment variable.
|
|
418
356
|
"""
|
|
419
357
|
return pulumi.get(self, "include_retry_reason")
|
|
420
358
|
|
|
@@ -426,9 +364,7 @@ class ProviderArgs:
|
|
|
426
364
|
@pulumi.getter(name="insecureMode")
|
|
427
365
|
def insecure_mode(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
428
366
|
"""
|
|
429
|
-
If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the
|
|
430
|
-
default value for testing or emergency situations only. Can also be sourced from the `SNOWFLAKE_INSECURE_MODE`
|
|
431
|
-
environment variable.
|
|
367
|
+
If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the default value for testing or emergency situations only. Can also be sourced from the `SNOWFLAKE_INSECURE_MODE` environment variable.
|
|
432
368
|
"""
|
|
433
369
|
return pulumi.get(self, "insecure_mode")
|
|
434
370
|
|
|
@@ -440,8 +376,7 @@ class ProviderArgs:
|
|
|
440
376
|
@pulumi.getter(name="jwtClientTimeout")
|
|
441
377
|
def jwt_client_timeout(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
442
378
|
"""
|
|
443
|
-
The timeout in seconds for the JWT client to complete the authentication. Can also be sourced from the
|
|
444
|
-
`SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
|
|
379
|
+
The timeout in seconds for the JWT client to complete the authentication. Can also be sourced from the `SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
|
|
445
380
|
"""
|
|
446
381
|
return pulumi.get(self, "jwt_client_timeout")
|
|
447
382
|
|
|
@@ -465,8 +400,7 @@ class ProviderArgs:
|
|
|
465
400
|
@pulumi.getter(name="keepSessionAlive")
|
|
466
401
|
def keep_session_alive(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
467
402
|
"""
|
|
468
|
-
Enables the session to persist even after the connection is closed. Can also be sourced from the
|
|
469
|
-
`SNOWFLAKE_KEEP_SESSION_ALIVE` environment variable.
|
|
403
|
+
Enables the session to persist even after the connection is closed. Can also be sourced from the `SNOWFLAKE_KEEP_SESSION_ALIVE` environment variable.
|
|
470
404
|
"""
|
|
471
405
|
return pulumi.get(self, "keep_session_alive")
|
|
472
406
|
|
|
@@ -478,8 +412,7 @@ class ProviderArgs:
|
|
|
478
412
|
@pulumi.getter(name="loginTimeout")
|
|
479
413
|
def login_timeout(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
480
414
|
"""
|
|
481
|
-
Login retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
482
|
-
`SNOWFLAKE_LOGIN_TIMEOUT` environment variable.
|
|
415
|
+
Login retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the `SNOWFLAKE_LOGIN_TIMEOUT` environment variable.
|
|
483
416
|
"""
|
|
484
417
|
return pulumi.get(self, "login_timeout")
|
|
485
418
|
|
|
@@ -491,8 +424,7 @@ class ProviderArgs:
|
|
|
491
424
|
@pulumi.getter(name="maxRetryCount")
|
|
492
425
|
def max_retry_count(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
493
426
|
"""
|
|
494
|
-
Specifies how many times non-periodic HTTP request can be retried by the driver. Can also be sourced from the
|
|
495
|
-
`SNOWFLAKE_MAX_RETRY_COUNT` environment variable.
|
|
427
|
+
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.
|
|
496
428
|
"""
|
|
497
429
|
return pulumi.get(self, "max_retry_count")
|
|
498
430
|
|
|
@@ -504,8 +436,7 @@ class ProviderArgs:
|
|
|
504
436
|
@pulumi.getter(name="ocspFailOpen")
|
|
505
437
|
def ocsp_fail_open(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
506
438
|
"""
|
|
507
|
-
True represents OCSP fail open mode. False represents OCSP fail closed mode. Fail open true by default. Can also be
|
|
508
|
-
sourced from the `SNOWFLAKE_OCSP_FAIL_OPEN` environment variable.
|
|
439
|
+
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.
|
|
509
440
|
"""
|
|
510
441
|
return pulumi.get(self, "ocsp_fail_open")
|
|
511
442
|
|
|
@@ -517,9 +448,7 @@ class ProviderArgs:
|
|
|
517
448
|
@pulumi.getter(name="oktaUrl")
|
|
518
449
|
def okta_url(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
519
450
|
"""
|
|
520
|
-
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
|
|
521
|
-
in Snowflake [docs](https://docs.snowflake.com/en/user-guide/oauth-okta). Can also be sourced from the
|
|
522
|
-
`SNOWFLAKE_OKTA_URL` environment variable.
|
|
451
|
+
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.
|
|
523
452
|
"""
|
|
524
453
|
return pulumi.get(self, "okta_url")
|
|
525
454
|
|
|
@@ -531,9 +460,7 @@ class ProviderArgs:
|
|
|
531
460
|
@pulumi.getter(name="organizationName")
|
|
532
461
|
def organization_name(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
533
462
|
"""
|
|
534
|
-
Specifies your Snowflake organization name assigned by Snowflake. For information about account identifiers, see the
|
|
535
|
-
[Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#organization-name). Required
|
|
536
|
-
unless using `profile`. Can also be sourced from the `SNOWFLAKE_ORGANIZATION_NAME` environment variable.
|
|
463
|
+
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.
|
|
537
464
|
"""
|
|
538
465
|
return pulumi.get(self, "organization_name")
|
|
539
466
|
|
|
@@ -545,8 +472,7 @@ class ProviderArgs:
|
|
|
545
472
|
@pulumi.getter
|
|
546
473
|
def params(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]:
|
|
547
474
|
"""
|
|
548
|
-
Sets other connection (i.e. session) parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters).
|
|
549
|
-
This field can not be set with environmental variables.
|
|
475
|
+
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.
|
|
550
476
|
"""
|
|
551
477
|
return pulumi.get(self, "params")
|
|
552
478
|
|
|
@@ -558,8 +484,7 @@ class ProviderArgs:
|
|
|
558
484
|
@pulumi.getter
|
|
559
485
|
def passcode(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
560
486
|
"""
|
|
561
|
-
Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login. Can also be sourced from
|
|
562
|
-
the `SNOWFLAKE_PASSCODE` environment variable.
|
|
487
|
+
Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login. Can also be sourced from the `SNOWFLAKE_PASSCODE` environment variable.
|
|
563
488
|
"""
|
|
564
489
|
return pulumi.get(self, "passcode")
|
|
565
490
|
|
|
@@ -571,8 +496,7 @@ class ProviderArgs:
|
|
|
571
496
|
@pulumi.getter(name="passcodeInPassword")
|
|
572
497
|
def passcode_in_password(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
573
498
|
"""
|
|
574
|
-
False by default. Set to true if the MFA passcode is embedded to the configured password. Can also be sourced from the
|
|
575
|
-
`SNOWFLAKE_PASSCODE_IN_PASSWORD` environment variable.
|
|
499
|
+
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.
|
|
576
500
|
"""
|
|
577
501
|
return pulumi.get(self, "passcode_in_password")
|
|
578
502
|
|
|
@@ -584,10 +508,7 @@ class ProviderArgs:
|
|
|
584
508
|
@pulumi.getter
|
|
585
509
|
def password(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
586
510
|
"""
|
|
587
|
-
Password for user + password or
|
|
588
|
-
[token](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens#generating-a-programmatic-access-token) for
|
|
589
|
-
[PAT auth](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens). Cannot be used with `private_key` and
|
|
590
|
-
`private_key_passphrase`. Can also be sourced from the `SNOWFLAKE_PASSWORD` environment variable.
|
|
511
|
+
Password for user + password or [token](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens#generating-a-programmatic-access-token) for [PAT auth](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens). Cannot be used with `private_key` and `private_key_passphrase`. Can also be sourced from the `SNOWFLAKE_PASSWORD` environment variable.
|
|
591
512
|
"""
|
|
592
513
|
return pulumi.get(self, "password")
|
|
593
514
|
|
|
@@ -599,8 +520,7 @@ class ProviderArgs:
|
|
|
599
520
|
@pulumi.getter
|
|
600
521
|
def port(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
601
522
|
"""
|
|
602
|
-
Specifies a custom port value used by the driver for privatelink connections. Can also be sourced from the
|
|
603
|
-
`SNOWFLAKE_PORT` environment variable.
|
|
523
|
+
Specifies a custom port value used by the driver for privatelink connections. Can also be sourced from the `SNOWFLAKE_PORT` environment variable.
|
|
604
524
|
"""
|
|
605
525
|
return pulumi.get(self, "port")
|
|
606
526
|
|
|
@@ -621,8 +541,7 @@ class ProviderArgs:
|
|
|
621
541
|
@pulumi.getter(name="privateKey")
|
|
622
542
|
def private_key(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
623
543
|
"""
|
|
624
|
-
Private Key for username+private-key auth. Cannot be used with `password`. Can also be sourced from the
|
|
625
|
-
`SNOWFLAKE_PRIVATE_KEY` environment variable.
|
|
544
|
+
Private Key for username+private-key auth. Cannot be used with `password`. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY` environment variable.
|
|
626
545
|
"""
|
|
627
546
|
return pulumi.get(self, "private_key")
|
|
628
547
|
|
|
@@ -634,8 +553,7 @@ class ProviderArgs:
|
|
|
634
553
|
@pulumi.getter(name="privateKeyPassphrase")
|
|
635
554
|
def private_key_passphrase(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
636
555
|
"""
|
|
637
|
-
Supports the encryption ciphers aes-128-cbc, aes-128-gcm, aes-192-cbc, aes-192-gcm, aes-256-cbc, aes-256-gcm, and
|
|
638
|
-
des-ede3-cbc. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
|
|
556
|
+
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 the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
|
|
639
557
|
"""
|
|
640
558
|
return pulumi.get(self, "private_key_passphrase")
|
|
641
559
|
|
|
@@ -647,8 +565,7 @@ class ProviderArgs:
|
|
|
647
565
|
@pulumi.getter
|
|
648
566
|
def profile(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
649
567
|
"""
|
|
650
|
-
Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the `SNOWFLAKE_PROFILE` environment
|
|
651
|
-
variable.
|
|
568
|
+
Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the `SNOWFLAKE_PROFILE` environment variable.
|
|
652
569
|
"""
|
|
653
570
|
return pulumi.get(self, "profile")
|
|
654
571
|
|
|
@@ -660,8 +577,7 @@ class ProviderArgs:
|
|
|
660
577
|
@pulumi.getter
|
|
661
578
|
def protocol(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
662
579
|
"""
|
|
663
|
-
A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the
|
|
664
|
-
`SNOWFLAKE_PROTOCOL` environment variable.
|
|
580
|
+
A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the `SNOWFLAKE_PROTOCOL` environment variable.
|
|
665
581
|
"""
|
|
666
582
|
return pulumi.get(self, "protocol")
|
|
667
583
|
|
|
@@ -673,8 +589,7 @@ class ProviderArgs:
|
|
|
673
589
|
@pulumi.getter(name="requestTimeout")
|
|
674
590
|
def request_timeout(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
675
591
|
"""
|
|
676
|
-
request retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
677
|
-
`SNOWFLAKE_REQUEST_TIMEOUT` environment variable.
|
|
592
|
+
request retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the `SNOWFLAKE_REQUEST_TIMEOUT` environment variable.
|
|
678
593
|
"""
|
|
679
594
|
return pulumi.get(self, "request_timeout")
|
|
680
595
|
|
|
@@ -686,8 +601,7 @@ class ProviderArgs:
|
|
|
686
601
|
@pulumi.getter
|
|
687
602
|
def role(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
688
603
|
"""
|
|
689
|
-
Specifies the role to use by default for accessing Snowflake objects in the client session. Can also be sourced from the
|
|
690
|
-
`SNOWFLAKE_ROLE` environment variable.
|
|
604
|
+
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.
|
|
691
605
|
"""
|
|
692
606
|
return pulumi.get(self, "role")
|
|
693
607
|
|
|
@@ -699,10 +613,7 @@ class ProviderArgs:
|
|
|
699
613
|
@pulumi.getter(name="skipTomlFilePermissionVerification")
|
|
700
614
|
def skip_toml_file_permission_verification(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
701
615
|
"""
|
|
702
|
-
False by default. Skips TOML configuration file permission verification. This flag has no effect on Windows systems, as
|
|
703
|
-
the permissions are not checked on this platform. Instead of skipping the permissions verification, we recommend setting
|
|
704
|
-
the proper privileges - see the section below. Can also be sourced from the
|
|
705
|
-
`SNOWFLAKE_SKIP_TOML_FILE_PERMISSION_VERIFICATION` environment variable.
|
|
616
|
+
False by default. Skips TOML configuration file permission verification. This flag has no effect on Windows systems, as the permissions are not checked on this platform. Instead of skipping the permissions verification, we recommend setting the proper privileges - see the section below. Can also be sourced from the `SNOWFLAKE_SKIP_TOML_FILE_PERMISSION_VERIFICATION` environment variable.
|
|
706
617
|
"""
|
|
707
618
|
return pulumi.get(self, "skip_toml_file_permission_verification")
|
|
708
619
|
|
|
@@ -714,8 +625,7 @@ class ProviderArgs:
|
|
|
714
625
|
@pulumi.getter(name="tmpDirectoryPath")
|
|
715
626
|
def tmp_directory_path(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
716
627
|
"""
|
|
717
|
-
Sets temporary directory used by the driver for operations like encrypting, compressing etc. Can also be sourced from
|
|
718
|
-
the `SNOWFLAKE_TMP_DIRECTORY_PATH` environment variable.
|
|
628
|
+
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.
|
|
719
629
|
"""
|
|
720
630
|
return pulumi.get(self, "tmp_directory_path")
|
|
721
631
|
|
|
@@ -727,9 +637,7 @@ class ProviderArgs:
|
|
|
727
637
|
@pulumi.getter
|
|
728
638
|
def token(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
729
639
|
"""
|
|
730
|
-
Token to use for OAuth and other forms of token based auth. When this field is set here, or in the TOML file, the
|
|
731
|
-
provider sets the `authenticator` to `OAUTH`. Optionally, set the `authenticator` field to the authenticator you want to
|
|
732
|
-
use. Can also be sourced from the `SNOWFLAKE_TOKEN` environment variable.
|
|
640
|
+
Token to use for OAuth and other forms of token based auth. When this field is set here, or in the TOML file, the provider sets the `authenticator` to `OAUTH`. Optionally, set the `authenticator` field to the authenticator you want to use. Can also be sourced from the `SNOWFLAKE_TOKEN` environment variable.
|
|
733
641
|
"""
|
|
734
642
|
return pulumi.get(self, "token")
|
|
735
643
|
|
|
@@ -750,9 +658,7 @@ class ProviderArgs:
|
|
|
750
658
|
@pulumi.getter(name="useLegacyTomlFile")
|
|
751
659
|
def use_legacy_toml_file(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
752
660
|
"""
|
|
753
|
-
False by default. When this is set to true, the provider expects the legacy TOML format. Otherwise, it expects the new
|
|
754
|
-
format. See more in the section below Can also be sourced from the `SNOWFLAKE_USE_LEGACY_TOML_FILE` environment
|
|
755
|
-
variable.
|
|
661
|
+
False by default. When this is set to true, the provider expects the legacy TOML format. Otherwise, it expects the new format. See more in the section below Can also be sourced from the `SNOWFLAKE_USE_LEGACY_TOML_FILE` environment variable.
|
|
756
662
|
"""
|
|
757
663
|
return pulumi.get(self, "use_legacy_toml_file")
|
|
758
664
|
|
|
@@ -776,8 +682,7 @@ class ProviderArgs:
|
|
|
776
682
|
@pulumi.getter(name="validateDefaultParameters")
|
|
777
683
|
def validate_default_parameters(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
778
684
|
"""
|
|
779
|
-
True by default. If false, disables the validation checks for Database, Schema, Warehouse and Role at the time a
|
|
780
|
-
connection is established. Can also be sourced from the `SNOWFLAKE_VALIDATE_DEFAULT_PARAMETERS` environment variable.
|
|
685
|
+
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.
|
|
781
686
|
"""
|
|
782
687
|
return pulumi.get(self, "validate_default_parameters")
|
|
783
688
|
|
|
@@ -789,8 +694,7 @@ class ProviderArgs:
|
|
|
789
694
|
@pulumi.getter
|
|
790
695
|
def warehouse(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
791
696
|
"""
|
|
792
|
-
Specifies the virtual warehouse to use by default for queries, loading, etc. in the client session. Can also be sourced
|
|
793
|
-
from the `SNOWFLAKE_WAREHOUSE` environment variable.
|
|
697
|
+
Specifies the virtual warehouse to use by default for queries, loading, etc. in the client session. Can also be sourced from the `SNOWFLAKE_WAREHOUSE` environment variable.
|
|
794
698
|
"""
|
|
795
699
|
return pulumi.get(self, "warehouse")
|
|
796
700
|
|
|
@@ -856,94 +760,46 @@ class Provider(pulumi.ProviderResource):
|
|
|
856
760
|
|
|
857
761
|
:param str resource_name: The name of the resource.
|
|
858
762
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
859
|
-
:param pulumi.Input[_builtins.str] account_name: Specifies your Snowflake account name assigned by Snowflake. For information about account identifiers, see the
|
|
860
|
-
|
|
861
|
-
unless using `profile`. Can also be sourced from the `SNOWFLAKE_ACCOUNT_NAME` environment variable.
|
|
862
|
-
:param pulumi.Input[_builtins.str] authenticator: Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when
|
|
863
|
-
connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `SNOWFLAKE_JWT` |
|
|
864
|
-
`TOKENACCESSOR` | `USERNAMEPASSWORDMFA` | `PROGRAMMATIC_ACCESS_TOKEN`. Can also be sourced from the
|
|
865
|
-
`SNOWFLAKE_AUTHENTICATOR` environment variable.
|
|
763
|
+
:param pulumi.Input[_builtins.str] account_name: 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.
|
|
764
|
+
:param pulumi.Input[_builtins.str] authenticator: Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `SNOWFLAKE_JWT` | `TOKENACCESSOR` | `USERNAMEPASSWORDMFA` | `PROGRAMMATIC_ACCESS_TOKEN`. Can also be sourced from the `SNOWFLAKE_AUTHENTICATOR` environment variable.
|
|
866
765
|
:param pulumi.Input[_builtins.str] client_ip: IP address for network checks. Can also be sourced from the `SNOWFLAKE_CLIENT_IP` environment variable.
|
|
867
|
-
:param pulumi.Input[_builtins.str] client_request_mfa_token: When true the MFA token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also
|
|
868
|
-
|
|
869
|
-
:param pulumi.Input[_builtins.
|
|
870
|
-
|
|
871
|
-
:param pulumi.Input[_builtins.
|
|
872
|
-
`SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
|
|
873
|
-
:param pulumi.Input[_builtins.str] disable_console_login: Indicates whether console login should be disabled in the driver. Can also be sourced from the
|
|
874
|
-
`SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
|
|
875
|
-
:param pulumi.Input[_builtins.bool] disable_query_context_cache: Disables HTAP query context cache in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE`
|
|
876
|
-
environment variable.
|
|
766
|
+
:param pulumi.Input[_builtins.str] client_request_mfa_token: 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.
|
|
767
|
+
:param pulumi.Input[_builtins.str] client_store_temporary_credential: 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.
|
|
768
|
+
:param pulumi.Input[_builtins.int] client_timeout: The timeout in seconds for the client to complete the authentication. Can also be sourced from the `SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
|
|
769
|
+
:param pulumi.Input[_builtins.str] disable_console_login: Indicates whether console login should be disabled in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
|
|
770
|
+
:param pulumi.Input[_builtins.bool] 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.
|
|
877
771
|
:param pulumi.Input[_builtins.bool] disable_telemetry: Disables telemetry in the driver. Can also be sourced from the `DISABLE_TELEMETRY` environment variable.
|
|
878
|
-
:param pulumi.Input[_builtins.str] driver_tracing: Specifies the logging level to be used by the driver. Valid options are: `trace` | `debug` | `info` | `print` |
|
|
879
|
-
|
|
880
|
-
:param pulumi.Input[_builtins.
|
|
881
|
-
|
|
882
|
-
:param pulumi.Input[_builtins.
|
|
883
|
-
|
|
884
|
-
:param pulumi.Input[_builtins.str] include_retry_reason: Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment
|
|
885
|
-
variable.
|
|
886
|
-
:param pulumi.Input[_builtins.bool] insecure_mode: If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the
|
|
887
|
-
default value for testing or emergency situations only. Can also be sourced from the `SNOWFLAKE_INSECURE_MODE`
|
|
888
|
-
environment variable.
|
|
889
|
-
:param pulumi.Input[_builtins.int] jwt_client_timeout: The timeout in seconds for the JWT client to complete the authentication. Can also be sourced from the
|
|
890
|
-
`SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
|
|
772
|
+
:param pulumi.Input[_builtins.str] driver_tracing: 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.
|
|
773
|
+
:param pulumi.Input[_builtins.int] external_browser_timeout: The timeout in seconds for the external browser to complete the authentication. Can also be sourced from the `SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT` environment variable.
|
|
774
|
+
:param pulumi.Input[_builtins.str] host: Specifies a custom host value used by the driver for privatelink connections. Can also be sourced from the `SNOWFLAKE_HOST` environment variable.
|
|
775
|
+
:param pulumi.Input[_builtins.str] include_retry_reason: Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment variable.
|
|
776
|
+
:param pulumi.Input[_builtins.bool] insecure_mode: If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the default value for testing or emergency situations only. Can also be sourced from the `SNOWFLAKE_INSECURE_MODE` environment variable.
|
|
777
|
+
:param pulumi.Input[_builtins.int] jwt_client_timeout: The timeout in seconds for the JWT client to complete the authentication. Can also be sourced from the `SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
|
|
891
778
|
:param pulumi.Input[_builtins.int] jwt_expire_timeout: JWT expire after timeout in seconds. Can also be sourced from the `SNOWFLAKE_JWT_EXPIRE_TIMEOUT` environment variable.
|
|
892
|
-
:param pulumi.Input[_builtins.bool] keep_session_alive: Enables the session to persist even after the connection is closed. Can also be sourced from the
|
|
893
|
-
|
|
894
|
-
:param pulumi.Input[_builtins.int]
|
|
895
|
-
|
|
896
|
-
:param pulumi.Input[_builtins.
|
|
897
|
-
|
|
898
|
-
:param pulumi.Input[_builtins.str]
|
|
899
|
-
|
|
900
|
-
:param pulumi.Input[_builtins.
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
:param pulumi.Input[_builtins.str]
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
:param pulumi.Input[
|
|
907
|
-
|
|
908
|
-
:param pulumi.Input[_builtins.str]
|
|
909
|
-
|
|
910
|
-
:param pulumi.Input[_builtins.
|
|
911
|
-
|
|
912
|
-
:param pulumi.Input[_builtins.
|
|
913
|
-
[token](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens#generating-a-programmatic-access-token) for
|
|
914
|
-
[PAT auth](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens). Cannot be used with `private_key` and
|
|
915
|
-
`private_key_passphrase`. Can also be sourced from the `SNOWFLAKE_PASSWORD` environment variable.
|
|
916
|
-
:param pulumi.Input[_builtins.int] port: Specifies a custom port value used by the driver for privatelink connections. Can also be sourced from the
|
|
917
|
-
`SNOWFLAKE_PORT` environment variable.
|
|
918
|
-
:param pulumi.Input[_builtins.str] private_key: Private Key for username+private-key auth. Cannot be used with `password`. Can also be sourced from the
|
|
919
|
-
`SNOWFLAKE_PRIVATE_KEY` environment variable.
|
|
920
|
-
:param pulumi.Input[_builtins.str] private_key_passphrase: Supports the encryption ciphers aes-128-cbc, aes-128-gcm, aes-192-cbc, aes-192-gcm, aes-256-cbc, aes-256-gcm, and
|
|
921
|
-
des-ede3-cbc. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
|
|
922
|
-
:param pulumi.Input[_builtins.str] profile: Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the `SNOWFLAKE_PROFILE` environment
|
|
923
|
-
variable.
|
|
924
|
-
:param pulumi.Input[_builtins.str] protocol: A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the
|
|
925
|
-
`SNOWFLAKE_PROTOCOL` environment variable.
|
|
926
|
-
:param pulumi.Input[_builtins.int] request_timeout: request retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
927
|
-
`SNOWFLAKE_REQUEST_TIMEOUT` environment variable.
|
|
928
|
-
:param pulumi.Input[_builtins.str] role: Specifies the role to use by default for accessing Snowflake objects in the client session. Can also be sourced from the
|
|
929
|
-
`SNOWFLAKE_ROLE` environment variable.
|
|
930
|
-
:param pulumi.Input[_builtins.bool] skip_toml_file_permission_verification: False by default. Skips TOML configuration file permission verification. This flag has no effect on Windows systems, as
|
|
931
|
-
the permissions are not checked on this platform. Instead of skipping the permissions verification, we recommend setting
|
|
932
|
-
the proper privileges - see the section below. Can also be sourced from the
|
|
933
|
-
`SNOWFLAKE_SKIP_TOML_FILE_PERMISSION_VERIFICATION` environment variable.
|
|
934
|
-
:param pulumi.Input[_builtins.str] tmp_directory_path: Sets temporary directory used by the driver for operations like encrypting, compressing etc. Can also be sourced from
|
|
935
|
-
the `SNOWFLAKE_TMP_DIRECTORY_PATH` environment variable.
|
|
936
|
-
:param pulumi.Input[_builtins.str] token: Token to use for OAuth and other forms of token based auth. When this field is set here, or in the TOML file, the
|
|
937
|
-
provider sets the `authenticator` to `OAUTH`. Optionally, set the `authenticator` field to the authenticator you want to
|
|
938
|
-
use. Can also be sourced from the `SNOWFLAKE_TOKEN` environment variable.
|
|
939
|
-
:param pulumi.Input[_builtins.bool] use_legacy_toml_file: False by default. When this is set to true, the provider expects the legacy TOML format. Otherwise, it expects the new
|
|
940
|
-
format. See more in the section below Can also be sourced from the `SNOWFLAKE_USE_LEGACY_TOML_FILE` environment
|
|
941
|
-
variable.
|
|
779
|
+
:param pulumi.Input[_builtins.bool] keep_session_alive: Enables the session to persist even after the connection is closed. Can also be sourced from the `SNOWFLAKE_KEEP_SESSION_ALIVE` environment variable.
|
|
780
|
+
:param pulumi.Input[_builtins.int] login_timeout: Login retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the `SNOWFLAKE_LOGIN_TIMEOUT` environment variable.
|
|
781
|
+
:param pulumi.Input[_builtins.int] max_retry_count: 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.
|
|
782
|
+
:param pulumi.Input[_builtins.str] ocsp_fail_open: 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.
|
|
783
|
+
:param pulumi.Input[_builtins.str] okta_url: 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.
|
|
784
|
+
:param pulumi.Input[_builtins.str] organization_name: 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.
|
|
785
|
+
:param pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]] params: 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.
|
|
786
|
+
:param pulumi.Input[_builtins.str] passcode: Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login. Can also be sourced from the `SNOWFLAKE_PASSCODE` environment variable.
|
|
787
|
+
:param pulumi.Input[_builtins.bool] passcode_in_password: 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.
|
|
788
|
+
:param pulumi.Input[_builtins.str] password: Password for user + password or [token](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens#generating-a-programmatic-access-token) for [PAT auth](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens). Cannot be used with `private_key` and `private_key_passphrase`. Can also be sourced from the `SNOWFLAKE_PASSWORD` environment variable.
|
|
789
|
+
:param pulumi.Input[_builtins.int] port: Specifies a custom port value used by the driver for privatelink connections. Can also be sourced from the `SNOWFLAKE_PORT` environment variable.
|
|
790
|
+
:param pulumi.Input[_builtins.str] private_key: Private Key for username+private-key auth. Cannot be used with `password`. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY` environment variable.
|
|
791
|
+
:param pulumi.Input[_builtins.str] private_key_passphrase: 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 the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
|
|
792
|
+
:param pulumi.Input[_builtins.str] profile: Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the `SNOWFLAKE_PROFILE` environment variable.
|
|
793
|
+
:param pulumi.Input[_builtins.str] protocol: A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the `SNOWFLAKE_PROTOCOL` environment variable.
|
|
794
|
+
:param pulumi.Input[_builtins.int] request_timeout: request retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the `SNOWFLAKE_REQUEST_TIMEOUT` environment variable.
|
|
795
|
+
:param pulumi.Input[_builtins.str] role: 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.
|
|
796
|
+
:param pulumi.Input[_builtins.bool] skip_toml_file_permission_verification: False by default. Skips TOML configuration file permission verification. This flag has no effect on Windows systems, as the permissions are not checked on this platform. Instead of skipping the permissions verification, we recommend setting the proper privileges - see the section below. Can also be sourced from the `SNOWFLAKE_SKIP_TOML_FILE_PERMISSION_VERIFICATION` environment variable.
|
|
797
|
+
:param pulumi.Input[_builtins.str] tmp_directory_path: 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.
|
|
798
|
+
:param pulumi.Input[_builtins.str] token: Token to use for OAuth and other forms of token based auth. When this field is set here, or in the TOML file, the provider sets the `authenticator` to `OAUTH`. Optionally, set the `authenticator` field to the authenticator you want to use. Can also be sourced from the `SNOWFLAKE_TOKEN` environment variable.
|
|
799
|
+
:param pulumi.Input[_builtins.bool] use_legacy_toml_file: False by default. When this is set to true, the provider expects the legacy TOML format. Otherwise, it expects the new format. See more in the section below Can also be sourced from the `SNOWFLAKE_USE_LEGACY_TOML_FILE` environment variable.
|
|
942
800
|
:param pulumi.Input[_builtins.str] user: Username. Required unless using `profile`. Can also be sourced from the `SNOWFLAKE_USER` environment variable.
|
|
943
|
-
:param pulumi.Input[_builtins.str] validate_default_parameters: True by default. If false, disables the validation checks for Database, Schema, Warehouse and Role at the time a
|
|
944
|
-
|
|
945
|
-
:param pulumi.Input[_builtins.str] warehouse: Specifies the virtual warehouse to use by default for queries, loading, etc. in the client session. Can also be sourced
|
|
946
|
-
from the `SNOWFLAKE_WAREHOUSE` environment variable.
|
|
801
|
+
:param pulumi.Input[_builtins.str] validate_default_parameters: 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.
|
|
802
|
+
:param pulumi.Input[_builtins.str] warehouse: Specifies the virtual warehouse to use by default for queries, loading, etc. in the client session. Can also be sourced from the `SNOWFLAKE_WAREHOUSE` environment variable.
|
|
947
803
|
"""
|
|
948
804
|
...
|
|
949
805
|
@overload
|
|
@@ -1091,9 +947,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1091
947
|
@pulumi.getter(name="accountName")
|
|
1092
948
|
def account_name(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1093
949
|
"""
|
|
1094
|
-
Specifies your Snowflake account name assigned by Snowflake. For information about account identifiers, see the
|
|
1095
|
-
[Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#account-name). Required
|
|
1096
|
-
unless using `profile`. Can also be sourced from the `SNOWFLAKE_ACCOUNT_NAME` environment variable.
|
|
950
|
+
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.
|
|
1097
951
|
"""
|
|
1098
952
|
return pulumi.get(self, "account_name")
|
|
1099
953
|
|
|
@@ -1101,10 +955,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1101
955
|
@pulumi.getter
|
|
1102
956
|
def authenticator(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1103
957
|
"""
|
|
1104
|
-
Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when
|
|
1105
|
-
connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `SNOWFLAKE_JWT` |
|
|
1106
|
-
`TOKENACCESSOR` | `USERNAMEPASSWORDMFA` | `PROGRAMMATIC_ACCESS_TOKEN`. Can also be sourced from the
|
|
1107
|
-
`SNOWFLAKE_AUTHENTICATOR` environment variable.
|
|
958
|
+
Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `SNOWFLAKE_JWT` | `TOKENACCESSOR` | `USERNAMEPASSWORDMFA` | `PROGRAMMATIC_ACCESS_TOKEN`. Can also be sourced from the `SNOWFLAKE_AUTHENTICATOR` environment variable.
|
|
1108
959
|
"""
|
|
1109
960
|
return pulumi.get(self, "authenticator")
|
|
1110
961
|
|
|
@@ -1120,8 +971,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1120
971
|
@pulumi.getter(name="clientRequestMfaToken")
|
|
1121
972
|
def client_request_mfa_token(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1122
973
|
"""
|
|
1123
|
-
When true the MFA token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also
|
|
1124
|
-
be sourced from the `SNOWFLAKE_CLIENT_REQUEST_MFA_TOKEN` environment variable.
|
|
974
|
+
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.
|
|
1125
975
|
"""
|
|
1126
976
|
return pulumi.get(self, "client_request_mfa_token")
|
|
1127
977
|
|
|
@@ -1129,8 +979,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1129
979
|
@pulumi.getter(name="clientStoreTemporaryCredential")
|
|
1130
980
|
def client_store_temporary_credential(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1131
981
|
"""
|
|
1132
|
-
When true the ID token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also be
|
|
1133
|
-
sourced from the `SNOWFLAKE_CLIENT_STORE_TEMPORARY_CREDENTIAL` environment variable.
|
|
982
|
+
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.
|
|
1134
983
|
"""
|
|
1135
984
|
return pulumi.get(self, "client_store_temporary_credential")
|
|
1136
985
|
|
|
@@ -1138,8 +987,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1138
987
|
@pulumi.getter(name="disableConsoleLogin")
|
|
1139
988
|
def disable_console_login(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1140
989
|
"""
|
|
1141
|
-
Indicates whether console login should be disabled in the driver. Can also be sourced from the
|
|
1142
|
-
`SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
|
|
990
|
+
Indicates whether console login should be disabled in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
|
|
1143
991
|
"""
|
|
1144
992
|
return pulumi.get(self, "disable_console_login")
|
|
1145
993
|
|
|
@@ -1147,8 +995,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1147
995
|
@pulumi.getter(name="driverTracing")
|
|
1148
996
|
def driver_tracing(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1149
997
|
"""
|
|
1150
|
-
Specifies the logging level to be used by the driver. Valid options are: `trace` | `debug` | `info` | `print` |
|
|
1151
|
-
`warning` | `error` | `fatal` | `panic`. Can also be sourced from the `SNOWFLAKE_DRIVER_TRACING` environment variable.
|
|
998
|
+
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.
|
|
1152
999
|
"""
|
|
1153
1000
|
return pulumi.get(self, "driver_tracing")
|
|
1154
1001
|
|
|
@@ -1156,8 +1003,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1156
1003
|
@pulumi.getter
|
|
1157
1004
|
def host(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1158
1005
|
"""
|
|
1159
|
-
Specifies a custom host value used by the driver for privatelink connections. Can also be sourced from the
|
|
1160
|
-
`SNOWFLAKE_HOST` environment variable.
|
|
1006
|
+
Specifies a custom host value used by the driver for privatelink connections. Can also be sourced from the `SNOWFLAKE_HOST` environment variable.
|
|
1161
1007
|
"""
|
|
1162
1008
|
return pulumi.get(self, "host")
|
|
1163
1009
|
|
|
@@ -1165,8 +1011,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1165
1011
|
@pulumi.getter(name="includeRetryReason")
|
|
1166
1012
|
def include_retry_reason(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1167
1013
|
"""
|
|
1168
|
-
Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment
|
|
1169
|
-
variable.
|
|
1014
|
+
Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment variable.
|
|
1170
1015
|
"""
|
|
1171
1016
|
return pulumi.get(self, "include_retry_reason")
|
|
1172
1017
|
|
|
@@ -1174,8 +1019,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1174
1019
|
@pulumi.getter(name="ocspFailOpen")
|
|
1175
1020
|
def ocsp_fail_open(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1176
1021
|
"""
|
|
1177
|
-
True represents OCSP fail open mode. False represents OCSP fail closed mode. Fail open true by default. Can also be
|
|
1178
|
-
sourced from the `SNOWFLAKE_OCSP_FAIL_OPEN` environment variable.
|
|
1022
|
+
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.
|
|
1179
1023
|
"""
|
|
1180
1024
|
return pulumi.get(self, "ocsp_fail_open")
|
|
1181
1025
|
|
|
@@ -1183,9 +1027,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1183
1027
|
@pulumi.getter(name="oktaUrl")
|
|
1184
1028
|
def okta_url(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1185
1029
|
"""
|
|
1186
|
-
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
|
|
1187
|
-
in Snowflake [docs](https://docs.snowflake.com/en/user-guide/oauth-okta). Can also be sourced from the
|
|
1188
|
-
`SNOWFLAKE_OKTA_URL` environment variable.
|
|
1030
|
+
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.
|
|
1189
1031
|
"""
|
|
1190
1032
|
return pulumi.get(self, "okta_url")
|
|
1191
1033
|
|
|
@@ -1193,9 +1035,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1193
1035
|
@pulumi.getter(name="organizationName")
|
|
1194
1036
|
def organization_name(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1195
1037
|
"""
|
|
1196
|
-
Specifies your Snowflake organization name assigned by Snowflake. For information about account identifiers, see the
|
|
1197
|
-
[Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#organization-name). Required
|
|
1198
|
-
unless using `profile`. Can also be sourced from the `SNOWFLAKE_ORGANIZATION_NAME` environment variable.
|
|
1038
|
+
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.
|
|
1199
1039
|
"""
|
|
1200
1040
|
return pulumi.get(self, "organization_name")
|
|
1201
1041
|
|
|
@@ -1203,8 +1043,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1203
1043
|
@pulumi.getter
|
|
1204
1044
|
def passcode(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1205
1045
|
"""
|
|
1206
|
-
Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login. Can also be sourced from
|
|
1207
|
-
the `SNOWFLAKE_PASSCODE` environment variable.
|
|
1046
|
+
Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login. Can also be sourced from the `SNOWFLAKE_PASSCODE` environment variable.
|
|
1208
1047
|
"""
|
|
1209
1048
|
return pulumi.get(self, "passcode")
|
|
1210
1049
|
|
|
@@ -1212,10 +1051,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1212
1051
|
@pulumi.getter
|
|
1213
1052
|
def password(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1214
1053
|
"""
|
|
1215
|
-
Password for user + password or
|
|
1216
|
-
[token](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens#generating-a-programmatic-access-token) for
|
|
1217
|
-
[PAT auth](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens). Cannot be used with `private_key` and
|
|
1218
|
-
`private_key_passphrase`. Can also be sourced from the `SNOWFLAKE_PASSWORD` environment variable.
|
|
1054
|
+
Password for user + password or [token](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens#generating-a-programmatic-access-token) for [PAT auth](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens). Cannot be used with `private_key` and `private_key_passphrase`. Can also be sourced from the `SNOWFLAKE_PASSWORD` environment variable.
|
|
1219
1055
|
"""
|
|
1220
1056
|
return pulumi.get(self, "password")
|
|
1221
1057
|
|
|
@@ -1223,8 +1059,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1223
1059
|
@pulumi.getter(name="privateKey")
|
|
1224
1060
|
def private_key(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1225
1061
|
"""
|
|
1226
|
-
Private Key for username+private-key auth. Cannot be used with `password`. Can also be sourced from the
|
|
1227
|
-
`SNOWFLAKE_PRIVATE_KEY` environment variable.
|
|
1062
|
+
Private Key for username+private-key auth. Cannot be used with `password`. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY` environment variable.
|
|
1228
1063
|
"""
|
|
1229
1064
|
return pulumi.get(self, "private_key")
|
|
1230
1065
|
|
|
@@ -1232,8 +1067,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1232
1067
|
@pulumi.getter(name="privateKeyPassphrase")
|
|
1233
1068
|
def private_key_passphrase(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1234
1069
|
"""
|
|
1235
|
-
Supports the encryption ciphers aes-128-cbc, aes-128-gcm, aes-192-cbc, aes-192-gcm, aes-256-cbc, aes-256-gcm, and
|
|
1236
|
-
des-ede3-cbc. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
|
|
1070
|
+
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 the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
|
|
1237
1071
|
"""
|
|
1238
1072
|
return pulumi.get(self, "private_key_passphrase")
|
|
1239
1073
|
|
|
@@ -1241,8 +1075,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1241
1075
|
@pulumi.getter
|
|
1242
1076
|
def profile(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1243
1077
|
"""
|
|
1244
|
-
Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the `SNOWFLAKE_PROFILE` environment
|
|
1245
|
-
variable.
|
|
1078
|
+
Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the `SNOWFLAKE_PROFILE` environment variable.
|
|
1246
1079
|
"""
|
|
1247
1080
|
return pulumi.get(self, "profile")
|
|
1248
1081
|
|
|
@@ -1250,8 +1083,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1250
1083
|
@pulumi.getter
|
|
1251
1084
|
def protocol(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1252
1085
|
"""
|
|
1253
|
-
A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the
|
|
1254
|
-
`SNOWFLAKE_PROTOCOL` environment variable.
|
|
1086
|
+
A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the `SNOWFLAKE_PROTOCOL` environment variable.
|
|
1255
1087
|
"""
|
|
1256
1088
|
return pulumi.get(self, "protocol")
|
|
1257
1089
|
|
|
@@ -1259,8 +1091,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1259
1091
|
@pulumi.getter
|
|
1260
1092
|
def role(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1261
1093
|
"""
|
|
1262
|
-
Specifies the role to use by default for accessing Snowflake objects in the client session. Can also be sourced from the
|
|
1263
|
-
`SNOWFLAKE_ROLE` environment variable.
|
|
1094
|
+
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.
|
|
1264
1095
|
"""
|
|
1265
1096
|
return pulumi.get(self, "role")
|
|
1266
1097
|
|
|
@@ -1268,8 +1099,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1268
1099
|
@pulumi.getter(name="tmpDirectoryPath")
|
|
1269
1100
|
def tmp_directory_path(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1270
1101
|
"""
|
|
1271
|
-
Sets temporary directory used by the driver for operations like encrypting, compressing etc. Can also be sourced from
|
|
1272
|
-
the `SNOWFLAKE_TMP_DIRECTORY_PATH` environment variable.
|
|
1102
|
+
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.
|
|
1273
1103
|
"""
|
|
1274
1104
|
return pulumi.get(self, "tmp_directory_path")
|
|
1275
1105
|
|
|
@@ -1277,9 +1107,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1277
1107
|
@pulumi.getter
|
|
1278
1108
|
def token(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1279
1109
|
"""
|
|
1280
|
-
Token to use for OAuth and other forms of token based auth. When this field is set here, or in the TOML file, the
|
|
1281
|
-
provider sets the `authenticator` to `OAUTH`. Optionally, set the `authenticator` field to the authenticator you want to
|
|
1282
|
-
use. Can also be sourced from the `SNOWFLAKE_TOKEN` environment variable.
|
|
1110
|
+
Token to use for OAuth and other forms of token based auth. When this field is set here, or in the TOML file, the provider sets the `authenticator` to `OAUTH`. Optionally, set the `authenticator` field to the authenticator you want to use. Can also be sourced from the `SNOWFLAKE_TOKEN` environment variable.
|
|
1283
1111
|
"""
|
|
1284
1112
|
return pulumi.get(self, "token")
|
|
1285
1113
|
|
|
@@ -1295,8 +1123,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1295
1123
|
@pulumi.getter(name="validateDefaultParameters")
|
|
1296
1124
|
def validate_default_parameters(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1297
1125
|
"""
|
|
1298
|
-
True by default. If false, disables the validation checks for Database, Schema, Warehouse and Role at the time a
|
|
1299
|
-
connection is established. Can also be sourced from the `SNOWFLAKE_VALIDATE_DEFAULT_PARAMETERS` environment variable.
|
|
1126
|
+
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.
|
|
1300
1127
|
"""
|
|
1301
1128
|
return pulumi.get(self, "validate_default_parameters")
|
|
1302
1129
|
|
|
@@ -1304,8 +1131,7 @@ class Provider(pulumi.ProviderResource):
|
|
|
1304
1131
|
@pulumi.getter
|
|
1305
1132
|
def warehouse(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
1306
1133
|
"""
|
|
1307
|
-
Specifies the virtual warehouse to use by default for queries, loading, etc. in the client session. Can also be sourced
|
|
1308
|
-
from the `SNOWFLAKE_WAREHOUSE` environment variable.
|
|
1134
|
+
Specifies the virtual warehouse to use by default for queries, loading, etc. in the client session. Can also be sourced from the `SNOWFLAKE_WAREHOUSE` environment variable.
|
|
1309
1135
|
"""
|
|
1310
1136
|
return pulumi.get(self, "warehouse")
|
|
1311
1137
|
|