Skip to content

Latest commit

 

History

History
3592 lines (2245 loc) · 171 KB

provider.java.md

File metadata and controls

3592 lines (2245 loc) · 171 KB
Raw

provider Submodule

Constructs

SnowflakeProvider

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs snowflake}.

Initializers 

import com.hashicorp.cdktf.providers.snowflake.provider.SnowflakeProvider;

SnowflakeProvider.Builder.create(Construct scope, java.lang.String id)
//  .account(java.lang.String)
//  .accountName(java.lang.String)
//  .alias(java.lang.String)
//  .authenticator(java.lang.String)
//  .browserAuth(java.lang.Boolean)
//  .browserAuth(IResolvable)
//  .clientIp(java.lang.String)
//  .clientRequestMfaToken(java.lang.String)
//  .clientStoreTemporaryCredential(java.lang.String)
//  .clientTimeout(java.lang.Number)
//  .disableConsoleLogin(java.lang.String)
//  .disableQueryContextCache(java.lang.Boolean)
//  .disableQueryContextCache(IResolvable)
//  .disableTelemetry(java.lang.Boolean)
//  .disableTelemetry(IResolvable)
//  .driverTracing(java.lang.String)
//  .externalBrowserTimeout(java.lang.Number)
//  .host(java.lang.String)
//  .includeRetryReason(java.lang.String)
//  .insecureMode(java.lang.Boolean)
//  .insecureMode(IResolvable)
//  .jwtClientTimeout(java.lang.Number)
//  .jwtExpireTimeout(java.lang.Number)
//  .keepSessionAlive(java.lang.Boolean)
//  .keepSessionAlive(IResolvable)
//  .loginTimeout(java.lang.Number)
//  .maxRetryCount(java.lang.Number)
//  .oauthAccessToken(java.lang.String)
//  .oauthClientId(java.lang.String)
//  .oauthClientSecret(java.lang.String)
//  .oauthEndpoint(java.lang.String)
//  .oauthRedirectUrl(java.lang.String)
//  .oauthRefreshToken(java.lang.String)
//  .ocspFailOpen(java.lang.String)
//  .oktaUrl(java.lang.String)
//  .organizationName(java.lang.String)
//  .params(java.util.Map<java.lang.String, java.lang.String>)
//  .passcode(java.lang.String)
//  .passcodeInPassword(java.lang.Boolean)
//  .passcodeInPassword(IResolvable)
//  .password(java.lang.String)
//  .port(java.lang.Number)
//  .privateKey(java.lang.String)
//  .privateKeyPassphrase(java.lang.String)
//  .privateKeyPath(java.lang.String)
//  .profile(java.lang.String)
//  .protocol(java.lang.String)
//  .region(java.lang.String)
//  .requestTimeout(java.lang.Number)
//  .role(java.lang.String)
//  .sessionParams(java.util.Map<java.lang.String, java.lang.String>)
//  .tmpDirectoryPath(java.lang.String)
//  .token(java.lang.String)
//  .tokenAccessor(SnowflakeProviderTokenAccessor)
//  .user(java.lang.String)
//  .username(java.lang.String)
//  .validateDefaultParameters(java.lang.String)
//  .warehouse(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
account java.lang.String Use account_name and organization_name instead.
accountName java.lang.String Specifies your Snowflake account name assigned by Snowflake.
alias java.lang.String Alias name.
authenticator java.lang.String Specifies the authentication type to use when connecting to Snowflake. Valid options are: SNOWFLAKE | OAUTH | EXTERNALBROWSER | OKTA | JWT | SNOWFLAKE_JWT | TOKENACCESSOR | USERNAMEPASSWORDMFA. Value JWT is deprecated and will be removed in future releases. Can also be sourced from the SNOWFLAKE_AUTHENTICATOR environment variable.
browserAuth java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_USE_BROWSER_AUTH environment variable.
clientIp java.lang.String IP address for network checks. Can also be sourced from the SNOWFLAKE_CLIENT_IP environment variable.
clientRequestMfaToken java.lang.String When true the MFA token is cached in the credential manager.
clientStoreTemporaryCredential java.lang.String When true the ID token is cached in the credential manager.
clientTimeout java.lang.Number The timeout in seconds for the client to complete the authentication.
disableConsoleLogin java.lang.String Indicates whether console login should be disabled in the driver. Can also be sourced from the SNOWFLAKE_DISABLE_CONSOLE_LOGIN environment variable.
disableQueryContextCache java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Disables HTAP query context cache in the driver. Can also be sourced from the SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE environment variable.
disableTelemetry java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Disables telemetry in the driver. Can also be sourced from the DISABLE_TELEMETRY environment variable.
driverTracing java.lang.String Specifies the logging level to be used by the driver.
externalBrowserTimeout java.lang.Number The timeout in seconds for the external browser to complete the authentication.
host java.lang.String Specifies a custom host value used by the driver for privatelink connections.
includeRetryReason java.lang.String Should retried request contain retry reason. Can also be sourced from the SNOWFLAKE_INCLUDE_RETRY_REASON environment variable.
insecureMode java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check.
jwtClientTimeout java.lang.Number The timeout in seconds for the JWT client to complete the authentication.
jwtExpireTimeout java.lang.Number JWT expire after timeout in seconds. Can also be sourced from the SNOWFLAKE_JWT_EXPIRE_TIMEOUT environment variable.
keepSessionAlive java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enables the session to persist even after the connection is closed.
loginTimeout java.lang.Number Login retry timeout in seconds EXCLUDING network roundtrip and read out http response.
maxRetryCount java.lang.Number Specifies how many times non-periodic HTTP request can be retried by the driver.
oauthAccessToken java.lang.String Token for use with OAuth.
oauthClientId java.lang.String Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_CLIENT_ID environment variable.
oauthClientSecret java.lang.String Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_CLIENT_SECRET environment variable.
oauthEndpoint java.lang.String Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_ENDPOINT environment variable.
oauthRedirectUrl java.lang.String Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_REDIRECT_URL environment variable.
oauthRefreshToken java.lang.String Token for use with OAuth.
ocspFailOpen java.lang.String True represents OCSP fail open mode.
oktaUrl java.lang.String The URL of the Okta server.
organizationName java.lang.String Specifies your Snowflake organization name assigned by Snowflake.
params java.util.Map<java.lang.String, java.lang.String> Sets other connection (i.e. session) parameters. Parameters. This field can not be set with environmental variables.
passcode java.lang.String Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login.
passcodeInPassword java.lang.Boolean OR com.hashicorp.cdktf.IResolvable False by default.
password java.lang.String Password for user + password auth.
port java.lang.Number Specifies a custom port value used by the driver for privatelink connections.
privateKey java.lang.String Private Key for username+private-key auth.
privateKeyPassphrase java.lang.String 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.
privateKeyPath java.lang.String Path to a private key for using keypair authentication.
profile java.lang.String Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the SNOWFLAKE_PROFILE environment variable.
protocol java.lang.String A protocol used in the connection.
region java.lang.String Snowflake region, such as "eu-central-1", with this parameter.
requestTimeout java.lang.Number request retry timeout in seconds EXCLUDING network roundtrip and read out http response.
role java.lang.String Specifies the role to use by default for accessing Snowflake objects in the client session.
sessionParams java.util.Map<java.lang.String, java.lang.String> Sets session parameters. Parameters.
tmpDirectoryPath java.lang.String Sets temporary directory used by the driver for operations like encrypting, compressing etc.
token java.lang.String Token to use for OAuth and other forms of token based auth.
tokenAccessor SnowflakeProviderTokenAccessor token_accessor block.
user java.lang.String Username. Required unless using profile. Can also be sourced from the SNOWFLAKE_USER environment variable.
username java.lang.String Username for user + password authentication. Required unless using profile. Can also be sourced from the SNOWFLAKE_USERNAME environment variable.
validateDefaultParameters java.lang.String True by default.
warehouse java.lang.String Specifies the virtual warehouse to use by default for queries, loading, etc.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

accountOptional
  • Type: java.lang.String

Use account_name and organization_name instead.

Specifies your Snowflake account identifier assigned, by Snowflake. The account locator format is not supported. For information about account identifiers, see the Snowflake documentation. Required unless using profile. Can also be sourced from the SNOWFLAKE_ACCOUNT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#account SnowflakeProvider#account}

accountNameOptional
  • Type: java.lang.String

Specifies your Snowflake account name assigned by Snowflake.

For information about account identifiers, see the Snowflake documentation. Required unless using profile. Can also be sourced from the SNOWFLAKE_ACCOUNT_NAME environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#account_name SnowflakeProvider#account_name}

aliasOptional
  • Type: java.lang.String

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#alias SnowflakeProvider#alias}

authenticatorOptional
  • Type: java.lang.String

Specifies the authentication type to use when connecting to Snowflake. Valid options are: SNOWFLAKE | OAUTH | EXTERNALBROWSER | OKTA | JWT | SNOWFLAKE_JWT | TOKENACCESSOR | USERNAMEPASSWORDMFA. Value JWT is deprecated and will be removed in future releases. Can also be sourced from the SNOWFLAKE_AUTHENTICATOR environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#authenticator SnowflakeProvider#authenticator}

browserAuthOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_USE_BROWSER_AUTH environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#browser_auth SnowflakeProvider#browser_auth}

clientIpOptional
  • Type: java.lang.String

IP address for network checks. Can also be sourced from the SNOWFLAKE_CLIENT_IP environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#client_ip SnowflakeProvider#client_ip}

clientRequestMfaTokenOptional
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#client_request_mfa_token SnowflakeProvider#client_request_mfa_token}

clientStoreTemporaryCredentialOptional
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#client_store_temporary_credential SnowflakeProvider#client_store_temporary_credential}

clientTimeoutOptional
  • Type: java.lang.Number

The timeout in seconds for the client to complete the authentication.

Can also be sourced from the SNOWFLAKE_CLIENT_TIMEOUT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#client_timeout SnowflakeProvider#client_timeout}

disableConsoleLoginOptional
  • Type: java.lang.String

Indicates whether console login should be disabled in the driver. Can also be sourced from the SNOWFLAKE_DISABLE_CONSOLE_LOGIN environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#disable_console_login SnowflakeProvider#disable_console_login}

disableQueryContextCacheOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Disables HTAP query context cache in the driver. Can also be sourced from the SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#disable_query_context_cache SnowflakeProvider#disable_query_context_cache}

disableTelemetryOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Disables telemetry in the driver. Can also be sourced from the DISABLE_TELEMETRY environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#disable_telemetry SnowflakeProvider#disable_telemetry}

driverTracingOptional
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#driver_tracing SnowflakeProvider#driver_tracing}

externalBrowserTimeoutOptional
  • Type: java.lang.Number

The timeout in seconds for the external browser to complete the authentication.

Can also be sourced from the SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#external_browser_timeout SnowflakeProvider#external_browser_timeout}

hostOptional
  • Type: java.lang.String

Specifies a custom host value used by the driver for privatelink connections.

Can also be sourced from the SNOWFLAKE_HOST environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#host SnowflakeProvider#host}

includeRetryReasonOptional
  • Type: java.lang.String

Should retried request contain retry reason. Can also be sourced from the SNOWFLAKE_INCLUDE_RETRY_REASON environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#include_retry_reason SnowflakeProvider#include_retry_reason}

insecureModeOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#insecure_mode SnowflakeProvider#insecure_mode}

jwtClientTimeoutOptional
  • Type: java.lang.Number

The timeout in seconds for the JWT client to complete the authentication.

Can also be sourced from the SNOWFLAKE_JWT_CLIENT_TIMEOUT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#jwt_client_timeout SnowflakeProvider#jwt_client_timeout}

jwtExpireTimeoutOptional
  • Type: java.lang.Number

JWT expire after timeout in seconds. Can also be sourced from the SNOWFLAKE_JWT_EXPIRE_TIMEOUT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#jwt_expire_timeout SnowflakeProvider#jwt_expire_timeout}

keepSessionAliveOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Enables the session to persist even after the connection is closed.

Can also be sourced from the SNOWFLAKE_KEEP_SESSION_ALIVE environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#keep_session_alive SnowflakeProvider#keep_session_alive}

loginTimeoutOptional
  • Type: java.lang.Number

Login retry timeout in seconds EXCLUDING network roundtrip and read out http response.

Can also be sourced from the SNOWFLAKE_LOGIN_TIMEOUT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#login_timeout SnowflakeProvider#login_timeout}

maxRetryCountOptional
  • Type: java.lang.Number

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#max_retry_count SnowflakeProvider#max_retry_count}

oauthAccessTokenOptional
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#oauth_access_token SnowflakeProvider#oauth_access_token}

oauthClientIdOptional
  • Type: java.lang.String

Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_CLIENT_ID environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#oauth_client_id SnowflakeProvider#oauth_client_id}

oauthClientSecretOptional
  • Type: java.lang.String

Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_CLIENT_SECRET environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#oauth_client_secret SnowflakeProvider#oauth_client_secret}

oauthEndpointOptional
  • Type: java.lang.String

Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_ENDPOINT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#oauth_endpoint SnowflakeProvider#oauth_endpoint}

oauthRedirectUrlOptional
  • Type: java.lang.String

Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_REDIRECT_URL environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#oauth_redirect_url SnowflakeProvider#oauth_redirect_url}

oauthRefreshTokenOptional
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#oauth_refresh_token SnowflakeProvider#oauth_refresh_token}

ocspFailOpenOptional
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#ocsp_fail_open SnowflakeProvider#ocsp_fail_open}

oktaUrlOptional
  • Type: java.lang.String

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. Can also be sourced from the SNOWFLAKE_OKTA_URL environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#okta_url SnowflakeProvider#okta_url}

organizationNameOptional
  • Type: java.lang.String

Specifies your Snowflake organization name assigned by Snowflake.

For information about account identifiers, see the Snowflake documentation. Required unless using profile. Can also be sourced from the SNOWFLAKE_ORGANIZATION_NAME environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#organization_name SnowflakeProvider#organization_name}

paramsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Sets other connection (i.e. session) parameters. Parameters. This field can not be set with environmental variables.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#params SnowflakeProvider#params}

passcodeOptional
  • Type: java.lang.String

Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login.

Can also be sourced from the SNOWFLAKE_PASSCODE environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#passcode SnowflakeProvider#passcode}

passcodeInPasswordOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#passcode_in_password SnowflakeProvider#passcode_in_password}

passwordOptional
  • Type: java.lang.String

Password for user + password auth.

Cannot be used with browser_auth or private_key_path. Can also be sourced from the SNOWFLAKE_PASSWORD environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#password SnowflakeProvider#password}

portOptional
  • Type: java.lang.Number

Specifies a custom port value used by the driver for privatelink connections.

Can also be sourced from the SNOWFLAKE_PORT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#port SnowflakeProvider#port}

privateKeyOptional
  • Type: java.lang.String

Private Key for username+private-key auth.

Cannot be used with browser_auth or password. Can also be sourced from the SNOWFLAKE_PRIVATE_KEY environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#private_key SnowflakeProvider#private_key}

privateKeyPassphraseOptional
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#private_key_passphrase SnowflakeProvider#private_key_passphrase}

privateKeyPathOptional
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#private_key_path SnowflakeProvider#private_key_path}

profileOptional
  • Type: java.lang.String

Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the SNOWFLAKE_PROFILE environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#profile SnowflakeProvider#profile}

protocolOptional
  • Type: java.lang.String

A protocol used in the connection.

Valid options are: http | https. Can also be sourced from the SNOWFLAKE_PROTOCOL environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#protocol SnowflakeProvider#protocol}

regionOptional
  • Type: java.lang.String

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 to use. Required if using the legacy format for the account identifier in the form of <cloud_region_id>.<cloud>. Can also be sourced from the SNOWFLAKE_REGION environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#region SnowflakeProvider#region}

requestTimeoutOptional
  • Type: java.lang.Number

request retry timeout in seconds EXCLUDING network roundtrip and read out http response.

Can also be sourced from the SNOWFLAKE_REQUEST_TIMEOUT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#request_timeout SnowflakeProvider#request_timeout}

roleOptional
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#role SnowflakeProvider#role}

sessionParamsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Sets session parameters. Parameters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#session_params SnowflakeProvider#session_params}

tmpDirectoryPathOptional
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#tmp_directory_path SnowflakeProvider#tmp_directory_path}

tokenOptional
  • Type: java.lang.String

Token to use for OAuth and other forms of token based auth.

Can also be sourced from the SNOWFLAKE_TOKEN environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#token SnowflakeProvider#token}

tokenAccessorOptional

token_accessor block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#token_accessor SnowflakeProvider#token_accessor}

userOptional
  • Type: java.lang.String

Username. Required unless using profile. Can also be sourced from the SNOWFLAKE_USER environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#user SnowflakeProvider#user}

usernameOptional
  • Type: java.lang.String

Username for user + password authentication. Required unless using profile. Can also be sourced from the SNOWFLAKE_USERNAME environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#username SnowflakeProvider#username}

validateDefaultParametersOptional
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#validate_default_parameters SnowflakeProvider#validate_default_parameters}

warehouseOptional
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#warehouse SnowflakeProvider#warehouse}

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
resetAccount No description.
resetAccountName No description.
resetAlias No description.
resetAuthenticator No description.
resetBrowserAuth No description.
resetClientIp No description.
resetClientRequestMfaToken No description.
resetClientStoreTemporaryCredential No description.
resetClientTimeout No description.
resetDisableConsoleLogin No description.
resetDisableQueryContextCache No description.
resetDisableTelemetry No description.
resetDriverTracing No description.
resetExternalBrowserTimeout No description.
resetHost No description.
resetIncludeRetryReason No description.
resetInsecureMode No description.
resetJwtClientTimeout No description.
resetJwtExpireTimeout No description.
resetKeepSessionAlive No description.
resetLoginTimeout No description.
resetMaxRetryCount No description.
resetOauthAccessToken No description.
resetOauthClientId No description.
resetOauthClientSecret No description.
resetOauthEndpoint No description.
resetOauthRedirectUrl No description.
resetOauthRefreshToken No description.
resetOcspFailOpen No description.
resetOktaUrl No description.
resetOrganizationName No description.
resetParams No description.
resetPasscode No description.
resetPasscodeInPassword No description.
resetPassword No description.
resetPort No description.
resetPrivateKey No description.
resetPrivateKeyPassphrase No description.
resetPrivateKeyPath No description.
resetProfile No description.
resetProtocol No description.
resetRegion No description.
resetRequestTimeout No description.
resetRole No description.
resetSessionParams No description.
resetTmpDirectoryPath No description.
resetToken No description.
resetTokenAccessor No description.
resetUser No description.
resetUsername No description.
resetValidateDefaultParameters No description.
resetWarehouse No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

resetAccount 
public void resetAccount()
resetAccountName 
public void resetAccountName()
resetAlias 
public void resetAlias()
resetAuthenticator 
public void resetAuthenticator()
resetBrowserAuth 
public void resetBrowserAuth()
resetClientIp 
public void resetClientIp()
resetClientRequestMfaToken 
public void resetClientRequestMfaToken()
resetClientStoreTemporaryCredential 
public void resetClientStoreTemporaryCredential()
resetClientTimeout 
public void resetClientTimeout()
resetDisableConsoleLogin 
public void resetDisableConsoleLogin()
resetDisableQueryContextCache 
public void resetDisableQueryContextCache()
resetDisableTelemetry 
public void resetDisableTelemetry()
resetDriverTracing 
public void resetDriverTracing()
resetExternalBrowserTimeout 
public void resetExternalBrowserTimeout()
resetHost 
public void resetHost()
resetIncludeRetryReason 
public void resetIncludeRetryReason()
resetInsecureMode 
public void resetInsecureMode()
resetJwtClientTimeout 
public void resetJwtClientTimeout()
resetJwtExpireTimeout 
public void resetJwtExpireTimeout()
resetKeepSessionAlive 
public void resetKeepSessionAlive()
resetLoginTimeout 
public void resetLoginTimeout()
resetMaxRetryCount 
public void resetMaxRetryCount()
resetOauthAccessToken 
public void resetOauthAccessToken()
resetOauthClientId 
public void resetOauthClientId()
resetOauthClientSecret 
public void resetOauthClientSecret()
resetOauthEndpoint 
public void resetOauthEndpoint()
resetOauthRedirectUrl 
public void resetOauthRedirectUrl()
resetOauthRefreshToken 
public void resetOauthRefreshToken()
resetOcspFailOpen 
public void resetOcspFailOpen()
resetOktaUrl 
public void resetOktaUrl()
resetOrganizationName 
public void resetOrganizationName()
resetParams 
public void resetParams()
resetPasscode 
public void resetPasscode()
resetPasscodeInPassword 
public void resetPasscodeInPassword()
resetPassword 
public void resetPassword()
resetPort 
public void resetPort()
resetPrivateKey 
public void resetPrivateKey()
resetPrivateKeyPassphrase 
public void resetPrivateKeyPassphrase()
resetPrivateKeyPath 
public void resetPrivateKeyPath()
resetProfile 
public void resetProfile()
resetProtocol 
public void resetProtocol()
resetRegion 
public void resetRegion()
resetRequestTimeout 
public void resetRequestTimeout()
resetRole 
public void resetRole()
resetSessionParams 
public void resetSessionParams()
resetTmpDirectoryPath 
public void resetTmpDirectoryPath()
resetToken 
public void resetToken()
resetTokenAccessor 
public void resetTokenAccessor()
resetUser 
public void resetUser()
resetUsername 
public void resetUsername()
resetValidateDefaultParameters 
public void resetValidateDefaultParameters()
resetWarehouse 
public void resetWarehouse()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformProvider No description.
generateConfigForImport Generates CDKTF code for importing a SnowflakeProvider resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.snowflake.provider.SnowflakeProvider;

SnowflakeProvider.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.snowflake.provider.SnowflakeProvider;

SnowflakeProvider.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformProvider 
import com.hashicorp.cdktf.providers.snowflake.provider.SnowflakeProvider;

SnowflakeProvider.isTerraformProvider(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.snowflake.provider.SnowflakeProvider;

SnowflakeProvider.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),SnowflakeProvider.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTF code for importing a SnowflakeProvider resource upon running "cdktf plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the SnowflakeProvider to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing SnowflakeProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the SnowflakeProvider to import is found.

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
metaAttributes java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
terraformProviderSource java.lang.String No description.
alias java.lang.String No description.
accountInput java.lang.String No description.
accountNameInput java.lang.String No description.
aliasInput java.lang.String No description.
authenticatorInput java.lang.String No description.
browserAuthInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
clientIpInput java.lang.String No description.
clientRequestMfaTokenInput java.lang.String No description.
clientStoreTemporaryCredentialInput java.lang.String No description.
clientTimeoutInput java.lang.Number No description.
disableConsoleLoginInput java.lang.String No description.
disableQueryContextCacheInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
disableTelemetryInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
driverTracingInput java.lang.String No description.
externalBrowserTimeoutInput java.lang.Number No description.
hostInput java.lang.String No description.
includeRetryReasonInput java.lang.String No description.
insecureModeInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
jwtClientTimeoutInput java.lang.Number No description.
jwtExpireTimeoutInput java.lang.Number No description.
keepSessionAliveInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
loginTimeoutInput java.lang.Number No description.
maxRetryCountInput java.lang.Number No description.
oauthAccessTokenInput java.lang.String No description.
oauthClientIdInput java.lang.String No description.
oauthClientSecretInput java.lang.String No description.
oauthEndpointInput java.lang.String No description.
oauthRedirectUrlInput java.lang.String No description.
oauthRefreshTokenInput java.lang.String No description.
ocspFailOpenInput java.lang.String No description.
oktaUrlInput java.lang.String No description.
organizationNameInput java.lang.String No description.
paramsInput java.util.Map<java.lang.String, java.lang.String> No description.
passcodeInPasswordInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
passcodeInput java.lang.String No description.
passwordInput java.lang.String No description.
portInput java.lang.Number No description.
privateKeyInput java.lang.String No description.
privateKeyPassphraseInput java.lang.String No description.
privateKeyPathInput java.lang.String No description.
profileInput java.lang.String No description.
protocolInput java.lang.String No description.
regionInput java.lang.String No description.
requestTimeoutInput java.lang.Number No description.
roleInput java.lang.String No description.
sessionParamsInput java.util.Map<java.lang.String, java.lang.String> No description.
tmpDirectoryPathInput java.lang.String No description.
tokenAccessorInput SnowflakeProviderTokenAccessor No description.
tokenInput java.lang.String No description.
userInput java.lang.String No description.
usernameInput java.lang.String No description.
validateDefaultParametersInput java.lang.String No description.
warehouseInput java.lang.String No description.
account java.lang.String No description.
accountName java.lang.String No description.
authenticator java.lang.String No description.
browserAuth java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
clientIp java.lang.String No description.
clientRequestMfaToken java.lang.String No description.
clientStoreTemporaryCredential java.lang.String No description.
clientTimeout java.lang.Number No description.
disableConsoleLogin java.lang.String No description.
disableQueryContextCache java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
disableTelemetry java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
driverTracing java.lang.String No description.
externalBrowserTimeout java.lang.Number No description.
host java.lang.String No description.
includeRetryReason java.lang.String No description.
insecureMode java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
jwtClientTimeout java.lang.Number No description.
jwtExpireTimeout java.lang.Number No description.
keepSessionAlive java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
loginTimeout java.lang.Number No description.
maxRetryCount java.lang.Number No description.
oauthAccessToken java.lang.String No description.
oauthClientId java.lang.String No description.
oauthClientSecret java.lang.String No description.
oauthEndpoint java.lang.String No description.
oauthRedirectUrl java.lang.String No description.
oauthRefreshToken java.lang.String No description.
ocspFailOpen java.lang.String No description.
oktaUrl java.lang.String No description.
organizationName java.lang.String No description.
params java.util.Map<java.lang.String, java.lang.String> No description.
passcode java.lang.String No description.
passcodeInPassword java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
password java.lang.String No description.
port java.lang.Number No description.
privateKey java.lang.String No description.
privateKeyPassphrase java.lang.String No description.
privateKeyPath java.lang.String No description.
profile java.lang.String No description.
protocol java.lang.String No description.
region java.lang.String No description.
requestTimeout java.lang.Number No description.
role java.lang.String No description.
sessionParams java.util.Map<java.lang.String, java.lang.String> No description.
tmpDirectoryPath java.lang.String No description.
token java.lang.String No description.
tokenAccessor SnowflakeProviderTokenAccessor No description.
user java.lang.String No description.
username java.lang.String No description.
validateDefaultParameters java.lang.String No description.
warehouse java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
metaAttributesRequired 
public java.util.Map<java.lang.String, java.lang.Object> getMetaAttributes();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
terraformProviderSourceOptional 
public java.lang.String getTerraformProviderSource();
  • Type: java.lang.String
aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String
accountInputOptional 
public java.lang.String getAccountInput();
  • Type: java.lang.String
accountNameInputOptional 
public java.lang.String getAccountNameInput();
  • Type: java.lang.String
aliasInputOptional 
public java.lang.String getAliasInput();
  • Type: java.lang.String
authenticatorInputOptional 
public java.lang.String getAuthenticatorInput();
  • Type: java.lang.String
browserAuthInputOptional 
public java.lang.Object getBrowserAuthInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
clientIpInputOptional 
public java.lang.String getClientIpInput();
  • Type: java.lang.String
clientRequestMfaTokenInputOptional 
public java.lang.String getClientRequestMfaTokenInput();
  • Type: java.lang.String
clientStoreTemporaryCredentialInputOptional 
public java.lang.String getClientStoreTemporaryCredentialInput();
  • Type: java.lang.String
clientTimeoutInputOptional 
public java.lang.Number getClientTimeoutInput();
  • Type: java.lang.Number
disableConsoleLoginInputOptional 
public java.lang.String getDisableConsoleLoginInput();
  • Type: java.lang.String
disableQueryContextCacheInputOptional 
public java.lang.Object getDisableQueryContextCacheInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
disableTelemetryInputOptional 
public java.lang.Object getDisableTelemetryInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
driverTracingInputOptional 
public java.lang.String getDriverTracingInput();
  • Type: java.lang.String
externalBrowserTimeoutInputOptional 
public java.lang.Number getExternalBrowserTimeoutInput();
  • Type: java.lang.Number
hostInputOptional 
public java.lang.String getHostInput();
  • Type: java.lang.String
includeRetryReasonInputOptional 
public java.lang.String getIncludeRetryReasonInput();
  • Type: java.lang.String
insecureModeInputOptional 
public java.lang.Object getInsecureModeInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
jwtClientTimeoutInputOptional 
public java.lang.Number getJwtClientTimeoutInput();
  • Type: java.lang.Number
jwtExpireTimeoutInputOptional 
public java.lang.Number getJwtExpireTimeoutInput();
  • Type: java.lang.Number
keepSessionAliveInputOptional 
public java.lang.Object getKeepSessionAliveInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
loginTimeoutInputOptional 
public java.lang.Number getLoginTimeoutInput();
  • Type: java.lang.Number
maxRetryCountInputOptional 
public java.lang.Number getMaxRetryCountInput();
  • Type: java.lang.Number
oauthAccessTokenInputOptional 
public java.lang.String getOauthAccessTokenInput();
  • Type: java.lang.String
oauthClientIdInputOptional 
public java.lang.String getOauthClientIdInput();
  • Type: java.lang.String
oauthClientSecretInputOptional 
public java.lang.String getOauthClientSecretInput();
  • Type: java.lang.String
oauthEndpointInputOptional 
public java.lang.String getOauthEndpointInput();
  • Type: java.lang.String
oauthRedirectUrlInputOptional 
public java.lang.String getOauthRedirectUrlInput();
  • Type: java.lang.String
oauthRefreshTokenInputOptional 
public java.lang.String getOauthRefreshTokenInput();
  • Type: java.lang.String
ocspFailOpenInputOptional 
public java.lang.String getOcspFailOpenInput();
  • Type: java.lang.String
oktaUrlInputOptional 
public java.lang.String getOktaUrlInput();
  • Type: java.lang.String
organizationNameInputOptional 
public java.lang.String getOrganizationNameInput();
  • Type: java.lang.String
paramsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getParamsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
passcodeInPasswordInputOptional 
public java.lang.Object getPasscodeInPasswordInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
passcodeInputOptional 
public java.lang.String getPasscodeInput();
  • Type: java.lang.String
passwordInputOptional 
public java.lang.String getPasswordInput();
  • Type: java.lang.String
portInputOptional 
public java.lang.Number getPortInput();
  • Type: java.lang.Number
privateKeyInputOptional 
public java.lang.String getPrivateKeyInput();
  • Type: java.lang.String
privateKeyPassphraseInputOptional 
public java.lang.String getPrivateKeyPassphraseInput();
  • Type: java.lang.String
privateKeyPathInputOptional 
public java.lang.String getPrivateKeyPathInput();
  • Type: java.lang.String
profileInputOptional 
public java.lang.String getProfileInput();
  • Type: java.lang.String
protocolInputOptional 
public java.lang.String getProtocolInput();
  • Type: java.lang.String
regionInputOptional 
public java.lang.String getRegionInput();
  • Type: java.lang.String
requestTimeoutInputOptional 
public java.lang.Number getRequestTimeoutInput();
  • Type: java.lang.Number
roleInputOptional 
public java.lang.String getRoleInput();
  • Type: java.lang.String
sessionParamsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getSessionParamsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tmpDirectoryPathInputOptional 
public java.lang.String getTmpDirectoryPathInput();
  • Type: java.lang.String
tokenAccessorInputOptional 
public SnowflakeProviderTokenAccessor getTokenAccessorInput();
tokenInputOptional 
public java.lang.String getTokenInput();
  • Type: java.lang.String
userInputOptional 
public java.lang.String getUserInput();
  • Type: java.lang.String
usernameInputOptional 
public java.lang.String getUsernameInput();
  • Type: java.lang.String
validateDefaultParametersInputOptional 
public java.lang.String getValidateDefaultParametersInput();
  • Type: java.lang.String
warehouseInputOptional 
public java.lang.String getWarehouseInput();
  • Type: java.lang.String
accountOptional 
public java.lang.String getAccount();
  • Type: java.lang.String
accountNameOptional 
public java.lang.String getAccountName();
  • Type: java.lang.String
authenticatorOptional 
public java.lang.String getAuthenticator();
  • Type: java.lang.String
browserAuthOptional 
public java.lang.Object getBrowserAuth();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
clientIpOptional 
public java.lang.String getClientIp();
  • Type: java.lang.String
clientRequestMfaTokenOptional 
public java.lang.String getClientRequestMfaToken();
  • Type: java.lang.String
clientStoreTemporaryCredentialOptional 
public java.lang.String getClientStoreTemporaryCredential();
  • Type: java.lang.String
clientTimeoutOptional 
public java.lang.Number getClientTimeout();
  • Type: java.lang.Number
disableConsoleLoginOptional 
public java.lang.String getDisableConsoleLogin();
  • Type: java.lang.String
disableQueryContextCacheOptional 
public java.lang.Object getDisableQueryContextCache();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
disableTelemetryOptional 
public java.lang.Object getDisableTelemetry();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
driverTracingOptional 
public java.lang.String getDriverTracing();
  • Type: java.lang.String
externalBrowserTimeoutOptional 
public java.lang.Number getExternalBrowserTimeout();
  • Type: java.lang.Number
hostOptional 
public java.lang.String getHost();
  • Type: java.lang.String
includeRetryReasonOptional 
public java.lang.String getIncludeRetryReason();
  • Type: java.lang.String
insecureModeOptional 
public java.lang.Object getInsecureMode();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
jwtClientTimeoutOptional 
public java.lang.Number getJwtClientTimeout();
  • Type: java.lang.Number
jwtExpireTimeoutOptional 
public java.lang.Number getJwtExpireTimeout();
  • Type: java.lang.Number
keepSessionAliveOptional 
public java.lang.Object getKeepSessionAlive();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
loginTimeoutOptional 
public java.lang.Number getLoginTimeout();
  • Type: java.lang.Number
maxRetryCountOptional 
public java.lang.Number getMaxRetryCount();
  • Type: java.lang.Number
oauthAccessTokenOptional 
public java.lang.String getOauthAccessToken();
  • Type: java.lang.String
oauthClientIdOptional 
public java.lang.String getOauthClientId();
  • Type: java.lang.String
oauthClientSecretOptional 
public java.lang.String getOauthClientSecret();
  • Type: java.lang.String
oauthEndpointOptional 
public java.lang.String getOauthEndpoint();
  • Type: java.lang.String
oauthRedirectUrlOptional 
public java.lang.String getOauthRedirectUrl();
  • Type: java.lang.String
oauthRefreshTokenOptional 
public java.lang.String getOauthRefreshToken();
  • Type: java.lang.String
ocspFailOpenOptional 
public java.lang.String getOcspFailOpen();
  • Type: java.lang.String
oktaUrlOptional 
public java.lang.String getOktaUrl();
  • Type: java.lang.String
organizationNameOptional 
public java.lang.String getOrganizationName();
  • Type: java.lang.String
paramsOptional 
public java.util.Map<java.lang.String, java.lang.String> getParams();
  • Type: java.util.Map<java.lang.String, java.lang.String>
passcodeOptional 
public java.lang.String getPasscode();
  • Type: java.lang.String
passcodeInPasswordOptional 
public java.lang.Object getPasscodeInPassword();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
passwordOptional 
public java.lang.String getPassword();
  • Type: java.lang.String
portOptional 
public java.lang.Number getPort();
  • Type: java.lang.Number
privateKeyOptional 
public java.lang.String getPrivateKey();
  • Type: java.lang.String
privateKeyPassphraseOptional 
public java.lang.String getPrivateKeyPassphrase();
  • Type: java.lang.String
privateKeyPathOptional 
public java.lang.String getPrivateKeyPath();
  • Type: java.lang.String
profileOptional 
public java.lang.String getProfile();
  • Type: java.lang.String
protocolOptional 
public java.lang.String getProtocol();
  • Type: java.lang.String
regionOptional 
public java.lang.String getRegion();
  • Type: java.lang.String
requestTimeoutOptional 
public java.lang.Number getRequestTimeout();
  • Type: java.lang.Number
roleOptional 
public java.lang.String getRole();
  • Type: java.lang.String
sessionParamsOptional 
public java.util.Map<java.lang.String, java.lang.String> getSessionParams();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tmpDirectoryPathOptional 
public java.lang.String getTmpDirectoryPath();
  • Type: java.lang.String
tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String
tokenAccessorOptional 
public SnowflakeProviderTokenAccessor getTokenAccessor();
userOptional 
public java.lang.String getUser();
  • Type: java.lang.String
usernameOptional 
public java.lang.String getUsername();
  • Type: java.lang.String
validateDefaultParametersOptional 
public java.lang.String getValidateDefaultParameters();
  • Type: java.lang.String
warehouseOptional 
public java.lang.String getWarehouse();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

SnowflakeProviderConfig

Initializer 

import com.hashicorp.cdktf.providers.snowflake.provider.SnowflakeProviderConfig;

SnowflakeProviderConfig.builder()
//  .account(java.lang.String)
//  .accountName(java.lang.String)
//  .alias(java.lang.String)
//  .authenticator(java.lang.String)
//  .browserAuth(java.lang.Boolean)
//  .browserAuth(IResolvable)
//  .clientIp(java.lang.String)
//  .clientRequestMfaToken(java.lang.String)
//  .clientStoreTemporaryCredential(java.lang.String)
//  .clientTimeout(java.lang.Number)
//  .disableConsoleLogin(java.lang.String)
//  .disableQueryContextCache(java.lang.Boolean)
//  .disableQueryContextCache(IResolvable)
//  .disableTelemetry(java.lang.Boolean)
//  .disableTelemetry(IResolvable)
//  .driverTracing(java.lang.String)
//  .externalBrowserTimeout(java.lang.Number)
//  .host(java.lang.String)
//  .includeRetryReason(java.lang.String)
//  .insecureMode(java.lang.Boolean)
//  .insecureMode(IResolvable)
//  .jwtClientTimeout(java.lang.Number)
//  .jwtExpireTimeout(java.lang.Number)
//  .keepSessionAlive(java.lang.Boolean)
//  .keepSessionAlive(IResolvable)
//  .loginTimeout(java.lang.Number)
//  .maxRetryCount(java.lang.Number)
//  .oauthAccessToken(java.lang.String)
//  .oauthClientId(java.lang.String)
//  .oauthClientSecret(java.lang.String)
//  .oauthEndpoint(java.lang.String)
//  .oauthRedirectUrl(java.lang.String)
//  .oauthRefreshToken(java.lang.String)
//  .ocspFailOpen(java.lang.String)
//  .oktaUrl(java.lang.String)
//  .organizationName(java.lang.String)
//  .params(java.util.Map<java.lang.String, java.lang.String>)
//  .passcode(java.lang.String)
//  .passcodeInPassword(java.lang.Boolean)
//  .passcodeInPassword(IResolvable)
//  .password(java.lang.String)
//  .port(java.lang.Number)
//  .privateKey(java.lang.String)
//  .privateKeyPassphrase(java.lang.String)
//  .privateKeyPath(java.lang.String)
//  .profile(java.lang.String)
//  .protocol(java.lang.String)
//  .region(java.lang.String)
//  .requestTimeout(java.lang.Number)
//  .role(java.lang.String)
//  .sessionParams(java.util.Map<java.lang.String, java.lang.String>)
//  .tmpDirectoryPath(java.lang.String)
//  .token(java.lang.String)
//  .tokenAccessor(SnowflakeProviderTokenAccessor)
//  .user(java.lang.String)
//  .username(java.lang.String)
//  .validateDefaultParameters(java.lang.String)
//  .warehouse(java.lang.String)
    .build();

Properties

Name Type Description
account java.lang.String Use account_name and organization_name instead.
accountName java.lang.String Specifies your Snowflake account name assigned by Snowflake.
alias java.lang.String Alias name.
authenticator java.lang.String Specifies the authentication type to use when connecting to Snowflake. Valid options are: SNOWFLAKE | OAUTH | EXTERNALBROWSER | OKTA | JWT | SNOWFLAKE_JWT | TOKENACCESSOR | USERNAMEPASSWORDMFA. Value JWT is deprecated and will be removed in future releases. Can also be sourced from the SNOWFLAKE_AUTHENTICATOR environment variable.
browserAuth java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_USE_BROWSER_AUTH environment variable.
clientIp java.lang.String IP address for network checks. Can also be sourced from the SNOWFLAKE_CLIENT_IP environment variable.
clientRequestMfaToken java.lang.String When true the MFA token is cached in the credential manager.
clientStoreTemporaryCredential java.lang.String When true the ID token is cached in the credential manager.
clientTimeout java.lang.Number The timeout in seconds for the client to complete the authentication.
disableConsoleLogin java.lang.String Indicates whether console login should be disabled in the driver. Can also be sourced from the SNOWFLAKE_DISABLE_CONSOLE_LOGIN environment variable.
disableQueryContextCache java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Disables HTAP query context cache in the driver. Can also be sourced from the SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE environment variable.
disableTelemetry java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Disables telemetry in the driver. Can also be sourced from the DISABLE_TELEMETRY environment variable.
driverTracing java.lang.String Specifies the logging level to be used by the driver.
externalBrowserTimeout java.lang.Number The timeout in seconds for the external browser to complete the authentication.
host java.lang.String Specifies a custom host value used by the driver for privatelink connections.
includeRetryReason java.lang.String Should retried request contain retry reason. Can also be sourced from the SNOWFLAKE_INCLUDE_RETRY_REASON environment variable.
insecureMode java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check.
jwtClientTimeout java.lang.Number The timeout in seconds for the JWT client to complete the authentication.
jwtExpireTimeout java.lang.Number JWT expire after timeout in seconds. Can also be sourced from the SNOWFLAKE_JWT_EXPIRE_TIMEOUT environment variable.
keepSessionAlive java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enables the session to persist even after the connection is closed.
loginTimeout java.lang.Number Login retry timeout in seconds EXCLUDING network roundtrip and read out http response.
maxRetryCount java.lang.Number Specifies how many times non-periodic HTTP request can be retried by the driver.
oauthAccessToken java.lang.String Token for use with OAuth.
oauthClientId java.lang.String Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_CLIENT_ID environment variable.
oauthClientSecret java.lang.String Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_CLIENT_SECRET environment variable.
oauthEndpoint java.lang.String Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_ENDPOINT environment variable.
oauthRedirectUrl java.lang.String Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_REDIRECT_URL environment variable.
oauthRefreshToken java.lang.String Token for use with OAuth.
ocspFailOpen java.lang.String True represents OCSP fail open mode.
oktaUrl java.lang.String The URL of the Okta server.
organizationName java.lang.String Specifies your Snowflake organization name assigned by Snowflake.
params java.util.Map<java.lang.String, java.lang.String> Sets other connection (i.e. session) parameters. Parameters. This field can not be set with environmental variables.
passcode java.lang.String Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login.
passcodeInPassword java.lang.Boolean OR com.hashicorp.cdktf.IResolvable False by default.
password java.lang.String Password for user + password auth.
port java.lang.Number Specifies a custom port value used by the driver for privatelink connections.
privateKey java.lang.String Private Key for username+private-key auth.
privateKeyPassphrase java.lang.String 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.
privateKeyPath java.lang.String Path to a private key for using keypair authentication.
profile java.lang.String Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the SNOWFLAKE_PROFILE environment variable.
protocol java.lang.String A protocol used in the connection.
region java.lang.String Snowflake region, such as "eu-central-1", with this parameter.
requestTimeout java.lang.Number request retry timeout in seconds EXCLUDING network roundtrip and read out http response.
role java.lang.String Specifies the role to use by default for accessing Snowflake objects in the client session.
sessionParams java.util.Map<java.lang.String, java.lang.String> Sets session parameters. Parameters.
tmpDirectoryPath java.lang.String Sets temporary directory used by the driver for operations like encrypting, compressing etc.
token java.lang.String Token to use for OAuth and other forms of token based auth.
tokenAccessor SnowflakeProviderTokenAccessor token_accessor block.
user java.lang.String Username. Required unless using profile. Can also be sourced from the SNOWFLAKE_USER environment variable.
username java.lang.String Username for user + password authentication. Required unless using profile. Can also be sourced from the SNOWFLAKE_USERNAME environment variable.
validateDefaultParameters java.lang.String True by default.
warehouse java.lang.String Specifies the virtual warehouse to use by default for queries, loading, etc.
accountOptional 
public java.lang.String getAccount();
  • Type: java.lang.String

Use account_name and organization_name instead.

Specifies your Snowflake account identifier assigned, by Snowflake. The account locator format is not supported. For information about account identifiers, see the Snowflake documentation. Required unless using profile. Can also be sourced from the SNOWFLAKE_ACCOUNT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#account SnowflakeProvider#account}

accountNameOptional 
public java.lang.String getAccountName();
  • Type: java.lang.String

Specifies your Snowflake account name assigned by Snowflake.

For information about account identifiers, see the Snowflake documentation. Required unless using profile. Can also be sourced from the SNOWFLAKE_ACCOUNT_NAME environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#account_name SnowflakeProvider#account_name}

aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#alias SnowflakeProvider#alias}

authenticatorOptional 
public java.lang.String getAuthenticator();
  • Type: java.lang.String

Specifies the authentication type to use when connecting to Snowflake. Valid options are: SNOWFLAKE | OAUTH | EXTERNALBROWSER | OKTA | JWT | SNOWFLAKE_JWT | TOKENACCESSOR | USERNAMEPASSWORDMFA. Value JWT is deprecated and will be removed in future releases. Can also be sourced from the SNOWFLAKE_AUTHENTICATOR environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#authenticator SnowflakeProvider#authenticator}

browserAuthOptional 
public java.lang.Object getBrowserAuth();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_USE_BROWSER_AUTH environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#browser_auth SnowflakeProvider#browser_auth}

clientIpOptional 
public java.lang.String getClientIp();
  • Type: java.lang.String

IP address for network checks. Can also be sourced from the SNOWFLAKE_CLIENT_IP environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#client_ip SnowflakeProvider#client_ip}

clientRequestMfaTokenOptional 
public java.lang.String getClientRequestMfaToken();
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#client_request_mfa_token SnowflakeProvider#client_request_mfa_token}

clientStoreTemporaryCredentialOptional 
public java.lang.String getClientStoreTemporaryCredential();
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#client_store_temporary_credential SnowflakeProvider#client_store_temporary_credential}

clientTimeoutOptional 
public java.lang.Number getClientTimeout();
  • Type: java.lang.Number

The timeout in seconds for the client to complete the authentication.

Can also be sourced from the SNOWFLAKE_CLIENT_TIMEOUT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#client_timeout SnowflakeProvider#client_timeout}

disableConsoleLoginOptional 
public java.lang.String getDisableConsoleLogin();
  • Type: java.lang.String

Indicates whether console login should be disabled in the driver. Can also be sourced from the SNOWFLAKE_DISABLE_CONSOLE_LOGIN environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#disable_console_login SnowflakeProvider#disable_console_login}

disableQueryContextCacheOptional 
public java.lang.Object getDisableQueryContextCache();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Disables HTAP query context cache in the driver. Can also be sourced from the SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#disable_query_context_cache SnowflakeProvider#disable_query_context_cache}

disableTelemetryOptional 
public java.lang.Object getDisableTelemetry();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Disables telemetry in the driver. Can also be sourced from the DISABLE_TELEMETRY environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#disable_telemetry SnowflakeProvider#disable_telemetry}

driverTracingOptional 
public java.lang.String getDriverTracing();
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#driver_tracing SnowflakeProvider#driver_tracing}

externalBrowserTimeoutOptional 
public java.lang.Number getExternalBrowserTimeout();
  • Type: java.lang.Number

The timeout in seconds for the external browser to complete the authentication.

Can also be sourced from the SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#external_browser_timeout SnowflakeProvider#external_browser_timeout}

hostOptional 
public java.lang.String getHost();
  • Type: java.lang.String

Specifies a custom host value used by the driver for privatelink connections.

Can also be sourced from the SNOWFLAKE_HOST environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#host SnowflakeProvider#host}

includeRetryReasonOptional 
public java.lang.String getIncludeRetryReason();
  • Type: java.lang.String

Should retried request contain retry reason. Can also be sourced from the SNOWFLAKE_INCLUDE_RETRY_REASON environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#include_retry_reason SnowflakeProvider#include_retry_reason}

insecureModeOptional 
public java.lang.Object getInsecureMode();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#insecure_mode SnowflakeProvider#insecure_mode}

jwtClientTimeoutOptional 
public java.lang.Number getJwtClientTimeout();
  • Type: java.lang.Number

The timeout in seconds for the JWT client to complete the authentication.

Can also be sourced from the SNOWFLAKE_JWT_CLIENT_TIMEOUT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#jwt_client_timeout SnowflakeProvider#jwt_client_timeout}

jwtExpireTimeoutOptional 
public java.lang.Number getJwtExpireTimeout();
  • Type: java.lang.Number

JWT expire after timeout in seconds. Can also be sourced from the SNOWFLAKE_JWT_EXPIRE_TIMEOUT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#jwt_expire_timeout SnowflakeProvider#jwt_expire_timeout}

keepSessionAliveOptional 
public java.lang.Object getKeepSessionAlive();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Enables the session to persist even after the connection is closed.

Can also be sourced from the SNOWFLAKE_KEEP_SESSION_ALIVE environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#keep_session_alive SnowflakeProvider#keep_session_alive}

loginTimeoutOptional 
public java.lang.Number getLoginTimeout();
  • Type: java.lang.Number

Login retry timeout in seconds EXCLUDING network roundtrip and read out http response.

Can also be sourced from the SNOWFLAKE_LOGIN_TIMEOUT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#login_timeout SnowflakeProvider#login_timeout}

maxRetryCountOptional 
public java.lang.Number getMaxRetryCount();
  • Type: java.lang.Number

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#max_retry_count SnowflakeProvider#max_retry_count}

oauthAccessTokenOptional 
public java.lang.String getOauthAccessToken();
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#oauth_access_token SnowflakeProvider#oauth_access_token}

oauthClientIdOptional 
public java.lang.String getOauthClientId();
  • Type: java.lang.String

Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_CLIENT_ID environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#oauth_client_id SnowflakeProvider#oauth_client_id}

oauthClientSecretOptional 
public java.lang.String getOauthClientSecret();
  • Type: java.lang.String

Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_CLIENT_SECRET environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#oauth_client_secret SnowflakeProvider#oauth_client_secret}

oauthEndpointOptional 
public java.lang.String getOauthEndpoint();
  • Type: java.lang.String

Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_ENDPOINT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#oauth_endpoint SnowflakeProvider#oauth_endpoint}

oauthRedirectUrlOptional 
public java.lang.String getOauthRedirectUrl();
  • Type: java.lang.String

Required when oauth_refresh_token is used. Can also be sourced from SNOWFLAKE_OAUTH_REDIRECT_URL environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#oauth_redirect_url SnowflakeProvider#oauth_redirect_url}

oauthRefreshTokenOptional 
public java.lang.String getOauthRefreshToken();
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#oauth_refresh_token SnowflakeProvider#oauth_refresh_token}

ocspFailOpenOptional 
public java.lang.String getOcspFailOpen();
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#ocsp_fail_open SnowflakeProvider#ocsp_fail_open}

oktaUrlOptional 
public java.lang.String getOktaUrl();
  • Type: java.lang.String

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. Can also be sourced from the SNOWFLAKE_OKTA_URL environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#okta_url SnowflakeProvider#okta_url}

organizationNameOptional 
public java.lang.String getOrganizationName();
  • Type: java.lang.String

Specifies your Snowflake organization name assigned by Snowflake.

For information about account identifiers, see the Snowflake documentation. Required unless using profile. Can also be sourced from the SNOWFLAKE_ORGANIZATION_NAME environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#organization_name SnowflakeProvider#organization_name}

paramsOptional 
public java.util.Map<java.lang.String, java.lang.String> getParams();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Sets other connection (i.e. session) parameters. Parameters. This field can not be set with environmental variables.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#params SnowflakeProvider#params}

passcodeOptional 
public java.lang.String getPasscode();
  • Type: java.lang.String

Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login.

Can also be sourced from the SNOWFLAKE_PASSCODE environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#passcode SnowflakeProvider#passcode}

passcodeInPasswordOptional 
public java.lang.Object getPasscodeInPassword();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#passcode_in_password SnowflakeProvider#passcode_in_password}

passwordOptional 
public java.lang.String getPassword();
  • Type: java.lang.String

Password for user + password auth.

Cannot be used with browser_auth or private_key_path. Can also be sourced from the SNOWFLAKE_PASSWORD environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#password SnowflakeProvider#password}

portOptional 
public java.lang.Number getPort();
  • Type: java.lang.Number

Specifies a custom port value used by the driver for privatelink connections.

Can also be sourced from the SNOWFLAKE_PORT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#port SnowflakeProvider#port}

privateKeyOptional 
public java.lang.String getPrivateKey();
  • Type: java.lang.String

Private Key for username+private-key auth.

Cannot be used with browser_auth or password. Can also be sourced from the SNOWFLAKE_PRIVATE_KEY environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#private_key SnowflakeProvider#private_key}

privateKeyPassphraseOptional 
public java.lang.String getPrivateKeyPassphrase();
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#private_key_passphrase SnowflakeProvider#private_key_passphrase}

privateKeyPathOptional 
public java.lang.String getPrivateKeyPath();
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#private_key_path SnowflakeProvider#private_key_path}

profileOptional 
public java.lang.String getProfile();
  • Type: java.lang.String

Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the SNOWFLAKE_PROFILE environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#profile SnowflakeProvider#profile}

protocolOptional 
public java.lang.String getProtocol();
  • Type: java.lang.String

A protocol used in the connection.

Valid options are: http | https. Can also be sourced from the SNOWFLAKE_PROTOCOL environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#protocol SnowflakeProvider#protocol}

regionOptional 
public java.lang.String getRegion();
  • Type: java.lang.String

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 to use. Required if using the legacy format for the account identifier in the form of <cloud_region_id>.<cloud>. Can also be sourced from the SNOWFLAKE_REGION environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#region SnowflakeProvider#region}

requestTimeoutOptional 
public java.lang.Number getRequestTimeout();
  • Type: java.lang.Number

request retry timeout in seconds EXCLUDING network roundtrip and read out http response.

Can also be sourced from the SNOWFLAKE_REQUEST_TIMEOUT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#request_timeout SnowflakeProvider#request_timeout}

roleOptional 
public java.lang.String getRole();
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#role SnowflakeProvider#role}

sessionParamsOptional 
public java.util.Map<java.lang.String, java.lang.String> getSessionParams();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Sets session parameters. Parameters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#session_params SnowflakeProvider#session_params}

tmpDirectoryPathOptional 
public java.lang.String getTmpDirectoryPath();
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#tmp_directory_path SnowflakeProvider#tmp_directory_path}

tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String

Token to use for OAuth and other forms of token based auth.

Can also be sourced from the SNOWFLAKE_TOKEN environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#token SnowflakeProvider#token}

tokenAccessorOptional 
public SnowflakeProviderTokenAccessor getTokenAccessor();

token_accessor block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#token_accessor SnowflakeProvider#token_accessor}

userOptional 
public java.lang.String getUser();
  • Type: java.lang.String

Username. Required unless using profile. Can also be sourced from the SNOWFLAKE_USER environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#user SnowflakeProvider#user}

usernameOptional 
public java.lang.String getUsername();
  • Type: java.lang.String

Username for user + password authentication. Required unless using profile. Can also be sourced from the SNOWFLAKE_USERNAME environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#username SnowflakeProvider#username}

validateDefaultParametersOptional 
public java.lang.String getValidateDefaultParameters();
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#validate_default_parameters SnowflakeProvider#validate_default_parameters}

warehouseOptional 
public java.lang.String getWarehouse();
  • Type: java.lang.String

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#warehouse SnowflakeProvider#warehouse}

SnowflakeProviderTokenAccessor

Initializer 

import com.hashicorp.cdktf.providers.snowflake.provider.SnowflakeProviderTokenAccessor;

SnowflakeProviderTokenAccessor.builder()
    .clientId(java.lang.String)
    .clientSecret(java.lang.String)
    .redirectUri(java.lang.String)
    .refreshToken(java.lang.String)
    .tokenEndpoint(java.lang.String)
    .build();

Properties

Name Type Description
clientId java.lang.String The client ID for the OAuth provider when using a refresh token to renew access token.
clientSecret java.lang.String The client secret for the OAuth provider when using a refresh token to renew access token.
redirectUri java.lang.String The redirect URI for the OAuth provider when using a refresh token to renew access token.
refreshToken java.lang.String The refresh token for the OAuth provider when using a refresh token to renew access token.
tokenEndpoint java.lang.String The token endpoint for the OAuth provider e.g. https://{yourDomain}/oauth/token when using a refresh token to renew access token. Can also be sourced from the SNOWFLAKE_TOKEN_ACCESSOR_TOKEN_ENDPOINT environment variable.
clientIdRequired 
public java.lang.String getClientId();
  • Type: java.lang.String

The client ID for the OAuth provider when using a refresh token to renew access token.

Can also be sourced from the SNOWFLAKE_TOKEN_ACCESSOR_CLIENT_ID environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#client_id SnowflakeProvider#client_id}

clientSecretRequired 
public java.lang.String getClientSecret();
  • Type: java.lang.String

The client secret for the OAuth provider when using a refresh token to renew access token.

Can also be sourced from the SNOWFLAKE_TOKEN_ACCESSOR_CLIENT_SECRET environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#client_secret SnowflakeProvider#client_secret}

redirectUriRequired 
public java.lang.String getRedirectUri();
  • Type: java.lang.String

The redirect URI for the OAuth provider when using a refresh token to renew access token.

Can also be sourced from the SNOWFLAKE_TOKEN_ACCESSOR_REDIRECT_URI environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#redirect_uri SnowflakeProvider#redirect_uri}

refreshTokenRequired 
public java.lang.String getRefreshToken();
  • Type: java.lang.String

The refresh token for the OAuth provider when using a refresh token to renew access token.

Can also be sourced from the SNOWFLAKE_TOKEN_ACCESSOR_REFRESH_TOKEN environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#refresh_token SnowflakeProvider#refresh_token}

tokenEndpointRequired 
public java.lang.String getTokenEndpoint();
  • Type: java.lang.String

The token endpoint for the OAuth provider e.g. https://{yourDomain}/oauth/token when using a refresh token to renew access token. Can also be sourced from the SNOWFLAKE_TOKEN_ACCESSOR_TOKEN_ENDPOINT environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.98.0/docs#token_endpoint SnowflakeProvider#token_endpoint}