Skip to content

Latest commit

 

History

History
2343 lines (1467 loc) · 103 KB

provider.typescript.md

File metadata and controls

2343 lines (1467 loc) · 103 KB
Raw

provider Submodule

Constructs

SnowflakeProvider

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

Initializers 

import { provider } from '@cdktf/provider-snowflake'

new provider.SnowflakeProvider(scope: Construct, id: string, config?: SnowflakeProviderConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config SnowflakeProviderConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configOptional

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.
resetAccountName No description.
resetAlias No description.
resetAuthenticator 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.
resetOcspFailOpen No description.
resetOktaUrl No description.
resetOrganizationName No description.
resetParams No description.
resetPasscode No description.
resetPasscodeInPassword No description.
resetPassword No description.
resetPort No description.
resetPreviewFeaturesEnabled No description.
resetPrivateKey No description.
resetPrivateKeyPassphrase No description.
resetProfile No description.
resetProtocol No description.
resetRequestTimeout No description.
resetRole No description.
resetTmpDirectoryPath No description.
resetToken No description.
resetTokenAccessor No description.
resetUser No description.
resetValidateDefaultParameters No description.
resetWarehouse No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

toHclTerraform 
public toHclTerraform(): any
toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

resetAccountName 
public resetAccountName(): void
resetAlias 
public resetAlias(): void
resetAuthenticator 
public resetAuthenticator(): void
resetClientIp 
public resetClientIp(): void
resetClientRequestMfaToken 
public resetClientRequestMfaToken(): void
resetClientStoreTemporaryCredential 
public resetClientStoreTemporaryCredential(): void
resetClientTimeout 
public resetClientTimeout(): void
resetDisableConsoleLogin 
public resetDisableConsoleLogin(): void
resetDisableQueryContextCache 
public resetDisableQueryContextCache(): void
resetDisableTelemetry 
public resetDisableTelemetry(): void
resetDriverTracing 
public resetDriverTracing(): void
resetExternalBrowserTimeout 
public resetExternalBrowserTimeout(): void
resetHost 
public resetHost(): void
resetIncludeRetryReason 
public resetIncludeRetryReason(): void
resetInsecureMode 
public resetInsecureMode(): void
resetJwtClientTimeout 
public resetJwtClientTimeout(): void
resetJwtExpireTimeout 
public resetJwtExpireTimeout(): void
resetKeepSessionAlive 
public resetKeepSessionAlive(): void
resetLoginTimeout 
public resetLoginTimeout(): void
resetMaxRetryCount 
public resetMaxRetryCount(): void
resetOcspFailOpen 
public resetOcspFailOpen(): void
resetOktaUrl 
public resetOktaUrl(): void
resetOrganizationName 
public resetOrganizationName(): void
resetParams 
public resetParams(): void
resetPasscode 
public resetPasscode(): void
resetPasscodeInPassword 
public resetPasscodeInPassword(): void
resetPassword 
public resetPassword(): void
resetPort 
public resetPort(): void
resetPreviewFeaturesEnabled 
public resetPreviewFeaturesEnabled(): void
resetPrivateKey 
public resetPrivateKey(): void
resetPrivateKeyPassphrase 
public resetPrivateKeyPassphrase(): void
resetProfile 
public resetProfile(): void
resetProtocol 
public resetProtocol(): void
resetRequestTimeout 
public resetRequestTimeout(): void
resetRole 
public resetRole(): void
resetTmpDirectoryPath 
public resetTmpDirectoryPath(): void
resetToken 
public resetToken(): void
resetTokenAccessor 
public resetTokenAccessor(): void
resetUser 
public resetUser(): void
resetValidateDefaultParameters 
public resetValidateDefaultParameters(): void
resetWarehouse 
public resetWarehouse(): void

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 { provider } from '@cdktf/provider-snowflake'

provider.SnowflakeProvider.isConstruct(x: any)

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: any

Any object.

isTerraformElement 
import { provider } from '@cdktf/provider-snowflake'

provider.SnowflakeProvider.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformProvider 
import { provider } from '@cdktf/provider-snowflake'

provider.SnowflakeProvider.isTerraformProvider(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { provider } from '@cdktf/provider-snowflake'

provider.SnowflakeProvider.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

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

importFromIdRequired
  • Type: string

The id of the existing SnowflakeProvider that should be imported.

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

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
metaAttributes {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
terraformProviderSource string No description.
alias string No description.
accountNameInput string No description.
aliasInput string No description.
authenticatorInput string No description.
clientIpInput string No description.
clientRequestMfaTokenInput string No description.
clientStoreTemporaryCredentialInput string No description.
clientTimeoutInput number No description.
disableConsoleLoginInput string No description.
disableQueryContextCacheInput boolean | cdktf.IResolvable No description.
disableTelemetryInput boolean | cdktf.IResolvable No description.
driverTracingInput string No description.
externalBrowserTimeoutInput number No description.
hostInput string No description.
includeRetryReasonInput string No description.
insecureModeInput boolean | cdktf.IResolvable No description.
jwtClientTimeoutInput number No description.
jwtExpireTimeoutInput number No description.
keepSessionAliveInput boolean | cdktf.IResolvable No description.
loginTimeoutInput number No description.
maxRetryCountInput number No description.
ocspFailOpenInput string No description.
oktaUrlInput string No description.
organizationNameInput string No description.
paramsInput {[ key: string ]: string} No description.
passcodeInPasswordInput boolean | cdktf.IResolvable No description.
passcodeInput string No description.
passwordInput string No description.
portInput number No description.
previewFeaturesEnabledInput string[] No description.
privateKeyInput string No description.
privateKeyPassphraseInput string No description.
profileInput string No description.
protocolInput string No description.
requestTimeoutInput number No description.
roleInput string No description.
tmpDirectoryPathInput string No description.
tokenAccessorInput SnowflakeProviderTokenAccessor No description.
tokenInput string No description.
userInput string No description.
validateDefaultParametersInput string No description.
warehouseInput string No description.
accountName string No description.
authenticator string No description.
clientIp string No description.
clientRequestMfaToken string No description.
clientStoreTemporaryCredential string No description.
clientTimeout number No description.
disableConsoleLogin string No description.
disableQueryContextCache boolean | cdktf.IResolvable No description.
disableTelemetry boolean | cdktf.IResolvable No description.
driverTracing string No description.
externalBrowserTimeout number No description.
host string No description.
includeRetryReason string No description.
insecureMode boolean | cdktf.IResolvable No description.
jwtClientTimeout number No description.
jwtExpireTimeout number No description.
keepSessionAlive boolean | cdktf.IResolvable No description.
loginTimeout number No description.
maxRetryCount number No description.
ocspFailOpen string No description.
oktaUrl string No description.
organizationName string No description.
params {[ key: string ]: string} No description.
passcode string No description.
passcodeInPassword boolean | cdktf.IResolvable No description.
password string No description.
port number No description.
previewFeaturesEnabled string[] No description.
privateKey string No description.
privateKeyPassphrase string No description.
profile string No description.
protocol string No description.
requestTimeout number No description.
role string No description.
tmpDirectoryPath string No description.
token string No description.
tokenAccessor SnowflakeProviderTokenAccessor No description.
user string No description.
validateDefaultParameters string No description.
warehouse string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
metaAttributesRequired 
public readonly metaAttributes: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
terraformProviderSourceOptional 
public readonly terraformProviderSource: string;
  • Type: string
aliasOptional 
public readonly alias: string;
  • Type: string
accountNameInputOptional 
public readonly accountNameInput: string;
  • Type: string
aliasInputOptional 
public readonly aliasInput: string;
  • Type: string
authenticatorInputOptional 
public readonly authenticatorInput: string;
  • Type: string
clientIpInputOptional 
public readonly clientIpInput: string;
  • Type: string
clientRequestMfaTokenInputOptional 
public readonly clientRequestMfaTokenInput: string;
  • Type: string
clientStoreTemporaryCredentialInputOptional 
public readonly clientStoreTemporaryCredentialInput: string;
  • Type: string
clientTimeoutInputOptional 
public readonly clientTimeoutInput: number;
  • Type: number
disableConsoleLoginInputOptional 
public readonly disableConsoleLoginInput: string;
  • Type: string
disableQueryContextCacheInputOptional 
public readonly disableQueryContextCacheInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
disableTelemetryInputOptional 
public readonly disableTelemetryInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
driverTracingInputOptional 
public readonly driverTracingInput: string;
  • Type: string
externalBrowserTimeoutInputOptional 
public readonly externalBrowserTimeoutInput: number;
  • Type: number
hostInputOptional 
public readonly hostInput: string;
  • Type: string
includeRetryReasonInputOptional 
public readonly includeRetryReasonInput: string;
  • Type: string
insecureModeInputOptional 
public readonly insecureModeInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
jwtClientTimeoutInputOptional 
public readonly jwtClientTimeoutInput: number;
  • Type: number
jwtExpireTimeoutInputOptional 
public readonly jwtExpireTimeoutInput: number;
  • Type: number
keepSessionAliveInputOptional 
public readonly keepSessionAliveInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
loginTimeoutInputOptional 
public readonly loginTimeoutInput: number;
  • Type: number
maxRetryCountInputOptional 
public readonly maxRetryCountInput: number;
  • Type: number
ocspFailOpenInputOptional 
public readonly ocspFailOpenInput: string;
  • Type: string
oktaUrlInputOptional 
public readonly oktaUrlInput: string;
  • Type: string
organizationNameInputOptional 
public readonly organizationNameInput: string;
  • Type: string
paramsInputOptional 
public readonly paramsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
passcodeInPasswordInputOptional 
public readonly passcodeInPasswordInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
passcodeInputOptional 
public readonly passcodeInput: string;
  • Type: string
passwordInputOptional 
public readonly passwordInput: string;
  • Type: string
portInputOptional 
public readonly portInput: number;
  • Type: number
previewFeaturesEnabledInputOptional 
public readonly previewFeaturesEnabledInput: string[];
  • Type: string[]
privateKeyInputOptional 
public readonly privateKeyInput: string;
  • Type: string
privateKeyPassphraseInputOptional 
public readonly privateKeyPassphraseInput: string;
  • Type: string
profileInputOptional 
public readonly profileInput: string;
  • Type: string
protocolInputOptional 
public readonly protocolInput: string;
  • Type: string
requestTimeoutInputOptional 
public readonly requestTimeoutInput: number;
  • Type: number
roleInputOptional 
public readonly roleInput: string;
  • Type: string
tmpDirectoryPathInputOptional 
public readonly tmpDirectoryPathInput: string;
  • Type: string
tokenAccessorInputOptional 
public readonly tokenAccessorInput: SnowflakeProviderTokenAccessor;
tokenInputOptional 
public readonly tokenInput: string;
  • Type: string
userInputOptional 
public readonly userInput: string;
  • Type: string
validateDefaultParametersInputOptional 
public readonly validateDefaultParametersInput: string;
  • Type: string
warehouseInputOptional 
public readonly warehouseInput: string;
  • Type: string
accountNameOptional 
public readonly accountName: string;
  • Type: string
authenticatorOptional 
public readonly authenticator: string;
  • Type: string
clientIpOptional 
public readonly clientIp: string;
  • Type: string
clientRequestMfaTokenOptional 
public readonly clientRequestMfaToken: string;
  • Type: string
clientStoreTemporaryCredentialOptional 
public readonly clientStoreTemporaryCredential: string;
  • Type: string
clientTimeoutOptional 
public readonly clientTimeout: number;
  • Type: number
disableConsoleLoginOptional 
public readonly disableConsoleLogin: string;
  • Type: string
disableQueryContextCacheOptional 
public readonly disableQueryContextCache: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
disableTelemetryOptional 
public readonly disableTelemetry: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
driverTracingOptional 
public readonly driverTracing: string;
  • Type: string
externalBrowserTimeoutOptional 
public readonly externalBrowserTimeout: number;
  • Type: number
hostOptional 
public readonly host: string;
  • Type: string
includeRetryReasonOptional 
public readonly includeRetryReason: string;
  • Type: string
insecureModeOptional 
public readonly insecureMode: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
jwtClientTimeoutOptional 
public readonly jwtClientTimeout: number;
  • Type: number
jwtExpireTimeoutOptional 
public readonly jwtExpireTimeout: number;
  • Type: number
keepSessionAliveOptional 
public readonly keepSessionAlive: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
loginTimeoutOptional 
public readonly loginTimeout: number;
  • Type: number
maxRetryCountOptional 
public readonly maxRetryCount: number;
  • Type: number
ocspFailOpenOptional 
public readonly ocspFailOpen: string;
  • Type: string
oktaUrlOptional 
public readonly oktaUrl: string;
  • Type: string
organizationNameOptional 
public readonly organizationName: string;
  • Type: string
paramsOptional 
public readonly params: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
passcodeOptional 
public readonly passcode: string;
  • Type: string
passcodeInPasswordOptional 
public readonly passcodeInPassword: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
passwordOptional 
public readonly password: string;
  • Type: string
portOptional 
public readonly port: number;
  • Type: number
previewFeaturesEnabledOptional 
public readonly previewFeaturesEnabled: string[];
  • Type: string[]
privateKeyOptional 
public readonly privateKey: string;
  • Type: string
privateKeyPassphraseOptional 
public readonly privateKeyPassphrase: string;
  • Type: string
profileOptional 
public readonly profile: string;
  • Type: string
protocolOptional 
public readonly protocol: string;
  • Type: string
requestTimeoutOptional 
public readonly requestTimeout: number;
  • Type: number
roleOptional 
public readonly role: string;
  • Type: string
tmpDirectoryPathOptional 
public readonly tmpDirectoryPath: string;
  • Type: string
tokenOptional 
public readonly token: string;
  • Type: string
tokenAccessorOptional 
public readonly tokenAccessor: SnowflakeProviderTokenAccessor;
userOptional 
public readonly user: string;
  • Type: string
validateDefaultParametersOptional 
public readonly validateDefaultParameters: string;
  • Type: string
warehouseOptional 
public readonly warehouse: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

SnowflakeProviderConfig

Initializer 

import { provider } from '@cdktf/provider-snowflake'

const snowflakeProviderConfig: provider.SnowflakeProviderConfig = { ... }

Properties

Name Type Description
accountName string Specifies your Snowflake account name assigned by Snowflake.
alias string Alias name.
authenticator string Specifies the authentication type to use when connecting to Snowflake. Valid options are: SNOWFLAKE | OAUTH | EXTERNALBROWSER | OKTA | SNOWFLAKE_JWT | TOKENACCESSOR | USERNAMEPASSWORDMFA. Can also be sourced from the SNOWFLAKE_AUTHENTICATOR environment variable.
clientIp string IP address for network checks. Can also be sourced from the SNOWFLAKE_CLIENT_IP environment variable.
clientRequestMfaToken string When true the MFA token is cached in the credential manager.
clientStoreTemporaryCredential string When true the ID token is cached in the credential manager.
clientTimeout number The timeout in seconds for the client to complete the authentication.
disableConsoleLogin string Indicates whether console login should be disabled in the driver. Can also be sourced from the SNOWFLAKE_DISABLE_CONSOLE_LOGIN environment variable.
disableQueryContextCache boolean | cdktf.IResolvable Disables HTAP query context cache in the driver. Can also be sourced from the SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE environment variable.
disableTelemetry boolean | cdktf.IResolvable Disables telemetry in the driver. Can also be sourced from the DISABLE_TELEMETRY environment variable.
driverTracing string Specifies the logging level to be used by the driver.
externalBrowserTimeout number The timeout in seconds for the external browser to complete the authentication.
host string Specifies a custom host value used by the driver for privatelink connections.
includeRetryReason string Should retried request contain retry reason. Can also be sourced from the SNOWFLAKE_INCLUDE_RETRY_REASON environment variable.
insecureMode boolean | cdktf.IResolvable If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check.
jwtClientTimeout number The timeout in seconds for the JWT client to complete the authentication.
jwtExpireTimeout number JWT expire after timeout in seconds. Can also be sourced from the SNOWFLAKE_JWT_EXPIRE_TIMEOUT environment variable.
keepSessionAlive boolean | cdktf.IResolvable Enables the session to persist even after the connection is closed.
loginTimeout number Login retry timeout in seconds EXCLUDING network roundtrip and read out http response.
maxRetryCount number Specifies how many times non-periodic HTTP request can be retried by the driver.
ocspFailOpen string True represents OCSP fail open mode.
oktaUrl string The URL of the Okta server.
organizationName string Specifies your Snowflake organization name assigned by Snowflake.
params {[ key: string ]: string} Sets other connection (i.e. session) parameters. Parameters. This field can not be set with environmental variables.
passcode string Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login.
passcodeInPassword boolean | cdktf.IResolvable False by default.
password string Password for user + password auth.
port number Specifies a custom port value used by the driver for privatelink connections.
previewFeaturesEnabled string[] A list of preview features that are handled by the provider.
privateKey string Private Key for username+private-key auth. Cannot be used with password. Can also be sourced from the SNOWFLAKE_PRIVATE_KEY environment variable.
privateKeyPassphrase 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.
profile string Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the SNOWFLAKE_PROFILE environment variable.
protocol string A protocol used in the connection.
requestTimeout number request retry timeout in seconds EXCLUDING network roundtrip and read out http response.
role string Specifies the role to use by default for accessing Snowflake objects in the client session.
tmpDirectoryPath string Sets temporary directory used by the driver for operations like encrypting, compressing etc.
token string Token to use for OAuth and other forms of token based auth.
tokenAccessor SnowflakeProviderTokenAccessor token_accessor block.
user string Username. Required unless using profile. Can also be sourced from the SNOWFLAKE_USER environment variable.
validateDefaultParameters string True by default.
warehouse string Specifies the virtual warehouse to use by default for queries, loading, etc.
accountNameOptional 
public readonly accountName: string;
  • Type: 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/1.0.1/docs#account_name SnowflakeProvider#account_name}

aliasOptional 
public readonly alias: string;
  • Type: string

Alias name.

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

authenticatorOptional 
public readonly authenticator: string;
  • Type: string

Specifies the authentication type to use when connecting to Snowflake. Valid options are: SNOWFLAKE | OAUTH | EXTERNALBROWSER | OKTA | SNOWFLAKE_JWT | TOKENACCESSOR | USERNAMEPASSWORDMFA. Can also be sourced from the SNOWFLAKE_AUTHENTICATOR environment variable.

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

clientIpOptional 
public readonly clientIp: string;
  • Type: 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/1.0.1/docs#client_ip SnowflakeProvider#client_ip}

clientRequestMfaTokenOptional 
public readonly clientRequestMfaToken: string;
  • Type: 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/1.0.1/docs#client_request_mfa_token SnowflakeProvider#client_request_mfa_token}

clientStoreTemporaryCredentialOptional 
public readonly clientStoreTemporaryCredential: string;
  • Type: 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/1.0.1/docs#client_store_temporary_credential SnowflakeProvider#client_store_temporary_credential}

clientTimeoutOptional 
public readonly clientTimeout: number;
  • Type: 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/1.0.1/docs#client_timeout SnowflakeProvider#client_timeout}

disableConsoleLoginOptional 
public readonly disableConsoleLogin: string;
  • Type: 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/1.0.1/docs#disable_console_login SnowflakeProvider#disable_console_login}

disableQueryContextCacheOptional 
public readonly disableQueryContextCache: boolean | IResolvable;
  • Type: boolean | 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/1.0.1/docs#disable_query_context_cache SnowflakeProvider#disable_query_context_cache}

disableTelemetryOptional 
public readonly disableTelemetry: boolean | IResolvable;
  • Type: boolean | 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/1.0.1/docs#disable_telemetry SnowflakeProvider#disable_telemetry}

driverTracingOptional 
public readonly driverTracing: string;
  • Type: 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/1.0.1/docs#driver_tracing SnowflakeProvider#driver_tracing}

externalBrowserTimeoutOptional 
public readonly externalBrowserTimeout: number;
  • Type: 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/1.0.1/docs#external_browser_timeout SnowflakeProvider#external_browser_timeout}

hostOptional 
public readonly host: string;
  • Type: 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/1.0.1/docs#host SnowflakeProvider#host}

includeRetryReasonOptional 
public readonly includeRetryReason: string;
  • Type: 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/1.0.1/docs#include_retry_reason SnowflakeProvider#include_retry_reason}

insecureModeOptional 
public readonly insecureMode: boolean | IResolvable;
  • Type: boolean | 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/1.0.1/docs#insecure_mode SnowflakeProvider#insecure_mode}

jwtClientTimeoutOptional 
public readonly jwtClientTimeout: number;
  • Type: 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/1.0.1/docs#jwt_client_timeout SnowflakeProvider#jwt_client_timeout}

jwtExpireTimeoutOptional 
public readonly jwtExpireTimeout: number;
  • Type: 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/1.0.1/docs#jwt_expire_timeout SnowflakeProvider#jwt_expire_timeout}

keepSessionAliveOptional 
public readonly keepSessionAlive: boolean | IResolvable;
  • Type: boolean | 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/1.0.1/docs#keep_session_alive SnowflakeProvider#keep_session_alive}

loginTimeoutOptional 
public readonly loginTimeout: number;
  • Type: 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/1.0.1/docs#login_timeout SnowflakeProvider#login_timeout}

maxRetryCountOptional 
public readonly maxRetryCount: number;
  • Type: 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/1.0.1/docs#max_retry_count SnowflakeProvider#max_retry_count}

ocspFailOpenOptional 
public readonly ocspFailOpen: string;
  • Type: 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/1.0.1/docs#ocsp_fail_open SnowflakeProvider#ocsp_fail_open}

oktaUrlOptional 
public readonly oktaUrl: string;
  • Type: 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/1.0.1/docs#okta_url SnowflakeProvider#okta_url}

organizationNameOptional 
public readonly organizationName: string;
  • Type: 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/1.0.1/docs#organization_name SnowflakeProvider#organization_name}

paramsOptional 
public readonly params: {[ key: string ]: string};
  • Type: {[ key: string ]: 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/1.0.1/docs#params SnowflakeProvider#params}

passcodeOptional 
public readonly passcode: string;
  • Type: 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/1.0.1/docs#passcode SnowflakeProvider#passcode}

passcodeInPasswordOptional 
public readonly passcodeInPassword: boolean | IResolvable;
  • Type: boolean | 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/1.0.1/docs#passcode_in_password SnowflakeProvider#passcode_in_password}

passwordOptional 
public readonly password: string;
  • Type: string

Password for user + password auth.

Cannot be used with private_key and private_key_passphrase. Can also be sourced from the SNOWFLAKE_PASSWORD environment variable.

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

portOptional 
public readonly port: number;
  • Type: 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/1.0.1/docs#port SnowflakeProvider#port}

previewFeaturesEnabledOptional 
public readonly previewFeaturesEnabled: string[];
  • Type: string[]

A list of preview features that are handled by the provider.

See preview features list. Preview features may have breaking changes in future releases, even without raising the major version. This field can not be set with environmental variables. Valid options are: snowflake_current_account_datasource | snowflake_account_authentication_policy_attachment_resource | snowflake_account_password_policy_attachment_resource | snowflake_alert_resource | snowflake_alerts_datasource | snowflake_api_integration_resource | snowflake_authentication_policy_resource | snowflake_cortex_search_service_resource | snowflake_cortex_search_services_datasource | snowflake_database_datasource | snowflake_database_role_datasource | snowflake_dynamic_table_resource | snowflake_dynamic_tables_datasource | snowflake_external_function_resource | snowflake_external_functions_datasource | snowflake_external_table_resource | snowflake_external_tables_datasource | snowflake_external_volume_resource | snowflake_failover_group_resource | snowflake_failover_groups_datasource | snowflake_file_format_resource | snowflake_file_formats_datasource | snowflake_function_java_resource | snowflake_function_javascript_resource | snowflake_function_python_resource | snowflake_function_scala_resource | snowflake_function_sql_resource | snowflake_functions_datasource | snowflake_managed_account_resource | snowflake_materialized_view_resource | snowflake_materialized_views_datasource | snowflake_network_policy_attachment_resource | snowflake_network_rule_resource | snowflake_email_notification_integration_resource | snowflake_notification_integration_resource | snowflake_object_parameter_resource | snowflake_password_policy_resource | snowflake_pipe_resource | snowflake_pipes_datasource | snowflake_current_role_datasource | snowflake_sequence_resource | snowflake_sequences_datasource | snowflake_share_resource | snowflake_shares_datasource | snowflake_parameters_datasource | snowflake_procedure_java_resource | snowflake_procedure_javascript_resource | snowflake_procedure_python_resource | snowflake_procedure_scala_resource | snowflake_procedure_sql_resource | snowflake_procedures_datasource | snowflake_stage_resource | snowflake_stages_datasource | snowflake_storage_integration_resource | snowflake_storage_integrations_datasource | snowflake_system_generate_scim_access_token_datasource | snowflake_system_get_aws_sns_iam_policy_datasource | snowflake_system_get_privatelink_config_datasource | snowflake_system_get_snowflake_platform_info_datasource | snowflake_table_column_masking_policy_application_resource | snowflake_table_constraint_resource | snowflake_table_resource | snowflake_tables_datasource | snowflake_user_authentication_policy_attachment_resource | snowflake_user_public_keys_resource | snowflake_user_password_policy_attachment_resource.

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

privateKeyOptional 
public readonly privateKey: string;
  • Type: string

Private Key for username+private-key auth. Cannot be used with 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/1.0.1/docs#private_key SnowflakeProvider#private_key}

privateKeyPassphraseOptional 
public readonly privateKeyPassphrase: string;
  • Type: 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/1.0.1/docs#private_key_passphrase SnowflakeProvider#private_key_passphrase}

profileOptional 
public readonly profile: string;
  • Type: 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/1.0.1/docs#profile SnowflakeProvider#profile}

protocolOptional 
public readonly protocol: string;
  • Type: 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/1.0.1/docs#protocol SnowflakeProvider#protocol}

requestTimeoutOptional 
public readonly requestTimeout: number;
  • Type: 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/1.0.1/docs#request_timeout SnowflakeProvider#request_timeout}

roleOptional 
public readonly role: string;
  • Type: 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/1.0.1/docs#role SnowflakeProvider#role}

tmpDirectoryPathOptional 
public readonly tmpDirectoryPath: string;
  • Type: 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/1.0.1/docs#tmp_directory_path SnowflakeProvider#tmp_directory_path}

tokenOptional 
public readonly token: string;
  • Type: 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/1.0.1/docs#token SnowflakeProvider#token}

tokenAccessorOptional 
public readonly tokenAccessor: SnowflakeProviderTokenAccessor;

token_accessor block.

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

userOptional 
public readonly user: string;
  • Type: 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/1.0.1/docs#user SnowflakeProvider#user}

validateDefaultParametersOptional 
public readonly validateDefaultParameters: string;
  • Type: 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/1.0.1/docs#validate_default_parameters SnowflakeProvider#validate_default_parameters}

warehouseOptional 
public readonly warehouse: string;
  • Type: 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/1.0.1/docs#warehouse SnowflakeProvider#warehouse}

SnowflakeProviderTokenAccessor

Initializer 

import { provider } from '@cdktf/provider-snowflake'

const snowflakeProviderTokenAccessor: provider.SnowflakeProviderTokenAccessor = { ... }

Properties

Name Type Description
clientId string The client ID for the OAuth provider when using a refresh token to renew access token.
clientSecret string The client secret for the OAuth provider when using a refresh token to renew access token.
redirectUri string The redirect URI for the OAuth provider when using a refresh token to renew access token.
refreshToken string The refresh token for the OAuth provider when using a refresh token to renew access token.
tokenEndpoint 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 readonly clientId: string;
  • Type: 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/1.0.1/docs#client_id SnowflakeProvider#client_id}

clientSecretRequired 
public readonly clientSecret: string;
  • Type: 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/1.0.1/docs#client_secret SnowflakeProvider#client_secret}

redirectUriRequired 
public readonly redirectUri: string;
  • Type: 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/1.0.1/docs#redirect_uri SnowflakeProvider#redirect_uri}

refreshTokenRequired 
public readonly refreshToken: string;
  • Type: 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/1.0.1/docs#refresh_token SnowflakeProvider#refresh_token}

tokenEndpointRequired 
public readonly tokenEndpoint: string;
  • Type: 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/1.0.1/docs#token_endpoint SnowflakeProvider#token_endpoint}