provider

package
v11.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 5, 2024 License: MPL-2.0 Imports: 7 Imported by: 0

README

provider

Refer to the Terraform Registry for docs: snowflake.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewSnowflakeProvider_Override 

func NewSnowflakeProvider_Override(s SnowflakeProvider, scope constructs.Construct, id *string, config *SnowflakeProviderConfig)

Create a new {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs snowflake} Resource.

func SnowflakeProvider_GenerateConfigForImport 

func SnowflakeProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a SnowflakeProvider resource upon running "cdktf plan <stack-name>".

func SnowflakeProvider_IsConstruct 

func SnowflakeProvider_IsConstruct(x interface{}) *bool

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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func SnowflakeProvider_IsTerraformElement 

func SnowflakeProvider_IsTerraformElement(x interface{}) *bool

Experimental.

func SnowflakeProvider_IsTerraformProvider 

func SnowflakeProvider_IsTerraformProvider(x interface{}) *bool

Experimental.

func SnowflakeProvider_TfResourceType 

func SnowflakeProvider_TfResourceType() *string

Types

type SnowflakeProvider 

type SnowflakeProvider interface {
	cdktf.TerraformProvider
	Account() *string
	SetAccount(val *string)
	AccountInput() *string
	Alias() *string
	SetAlias(val *string)
	AliasInput() *string
	Authenticator() *string
	SetAuthenticator(val *string)
	AuthenticatorInput() *string
	BrowserAuth() interface{}
	SetBrowserAuth(val interface{})
	BrowserAuthInput() interface{}
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	ClientIp() *string
	SetClientIp(val *string)
	ClientIpInput() *string
	ClientRequestMfaToken() interface{}
	SetClientRequestMfaToken(val interface{})
	ClientRequestMfaTokenInput() interface{}
	ClientStoreTemporaryCredential() interface{}
	SetClientStoreTemporaryCredential(val interface{})
	ClientStoreTemporaryCredentialInput() interface{}
	ClientTimeout() *float64
	SetClientTimeout(val *float64)
	ClientTimeoutInput() *float64
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	DisableQueryContextCache() interface{}
	SetDisableQueryContextCache(val interface{})
	DisableQueryContextCacheInput() interface{}
	DisableTelemetry() interface{}
	SetDisableTelemetry(val interface{})
	DisableTelemetryInput() interface{}
	ExternalBrowserTimeout() *float64
	SetExternalBrowserTimeout(val *float64)
	ExternalBrowserTimeoutInput() *float64
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Host() *string
	SetHost(val *string)
	HostInput() *string
	InsecureMode() interface{}
	SetInsecureMode(val interface{})
	InsecureModeInput() interface{}
	JwtClientTimeout() *float64
	SetJwtClientTimeout(val *float64)
	JwtClientTimeoutInput() *float64
	JwtExpireTimeout() *float64
	SetJwtExpireTimeout(val *float64)
	JwtExpireTimeoutInput() *float64
	KeepSessionAlive() interface{}
	SetKeepSessionAlive(val interface{})
	KeepSessionAliveInput() interface{}
	LoginTimeout() *float64
	SetLoginTimeout(val *float64)
	LoginTimeoutInput() *float64
	// Experimental.
	MetaAttributes() *map[string]interface{}
	// The tree node.
	Node() constructs.Node
	OauthAccessToken() *string
	SetOauthAccessToken(val *string)
	OauthAccessTokenInput() *string
	OauthClientId() *string
	SetOauthClientId(val *string)
	OauthClientIdInput() *string
	OauthClientSecret() *string
	SetOauthClientSecret(val *string)
	OauthClientSecretInput() *string
	OauthEndpoint() *string
	SetOauthEndpoint(val *string)
	OauthEndpointInput() *string
	OauthRedirectUrl() *string
	SetOauthRedirectUrl(val *string)
	OauthRedirectUrlInput() *string
	OauthRefreshToken() *string
	SetOauthRefreshToken(val *string)
	OauthRefreshTokenInput() *string
	OcspFailOpen() interface{}
	SetOcspFailOpen(val interface{})
	OcspFailOpenInput() interface{}
	OktaUrl() *string
	SetOktaUrl(val *string)
	OktaUrlInput() *string
	Params() *map[string]*string
	SetParams(val *map[string]*string)
	ParamsInput() *map[string]*string
	Passcode() *string
	SetPasscode(val *string)
	PasscodeInPassword() interface{}
	SetPasscodeInPassword(val interface{})
	PasscodeInPasswordInput() interface{}
	PasscodeInput() *string
	Password() *string
	SetPassword(val *string)
	PasswordInput() *string
	Port() *float64
	SetPort(val *float64)
	PortInput() *float64
	PrivateKey() *string
	SetPrivateKey(val *string)
	PrivateKeyInput() *string
	PrivateKeyPassphrase() *string
	SetPrivateKeyPassphrase(val *string)
	PrivateKeyPassphraseInput() *string
	PrivateKeyPath() *string
	SetPrivateKeyPath(val *string)
	PrivateKeyPathInput() *string
	Profile() *string
	SetProfile(val *string)
	ProfileInput() *string
	Protocol() *string
	SetProtocol(val *string)
	ProtocolInput() *string
	// Experimental.
	RawOverrides() interface{}
	Region() *string
	SetRegion(val *string)
	RegionInput() *string
	RequestTimeout() *float64
	SetRequestTimeout(val *float64)
	RequestTimeoutInput() *float64
	Role() *string
	SetRole(val *string)
	RoleInput() *string
	SessionParams() *map[string]*string
	SetSessionParams(val *map[string]*string)
	SessionParamsInput() *map[string]*string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformProviderSource() *string
	// Experimental.
	TerraformResourceType() *string
	Token() *string
	SetToken(val *string)
	TokenAccessor() *SnowflakeProviderTokenAccessor
	SetTokenAccessor(val *SnowflakeProviderTokenAccessor)
	TokenAccessorInput() *SnowflakeProviderTokenAccessor
	TokenInput() *string
	User() *string
	SetUser(val *string)
	UserInput() *string
	Username() *string
	SetUsername(val *string)
	UsernameInput() *string
	ValidateDefaultParameters() interface{}
	SetValidateDefaultParameters(val interface{})
	ValidateDefaultParametersInput() interface{}
	Warehouse() *string
	SetWarehouse(val *string)
	WarehouseInput() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAccount()
	ResetAlias()
	ResetAuthenticator()
	ResetBrowserAuth()
	ResetClientIp()
	ResetClientRequestMfaToken()
	ResetClientStoreTemporaryCredential()
	ResetClientTimeout()
	ResetDisableQueryContextCache()
	ResetDisableTelemetry()
	ResetExternalBrowserTimeout()
	ResetHost()
	ResetInsecureMode()
	ResetJwtClientTimeout()
	ResetJwtExpireTimeout()
	ResetKeepSessionAlive()
	ResetLoginTimeout()
	ResetOauthAccessToken()
	ResetOauthClientId()
	ResetOauthClientSecret()
	ResetOauthEndpoint()
	ResetOauthRedirectUrl()
	ResetOauthRefreshToken()
	ResetOcspFailOpen()
	ResetOktaUrl()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetParams()
	ResetPasscode()
	ResetPasscodeInPassword()
	ResetPassword()
	ResetPort()
	ResetPrivateKey()
	ResetPrivateKeyPassphrase()
	ResetPrivateKeyPath()
	ResetProfile()
	ResetProtocol()
	ResetRegion()
	ResetRequestTimeout()
	ResetRole()
	ResetSessionParams()
	ResetToken()
	ResetTokenAccessor()
	ResetUser()
	ResetUsername()
	ResetValidateDefaultParameters()
	ResetWarehouse()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

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

func NewSnowflakeProvider 

func NewSnowflakeProvider(scope constructs.Construct, id *string, config *SnowflakeProviderConfig) SnowflakeProvider

Create a new {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs snowflake} Resource.

type SnowflakeProviderConfig 

type SnowflakeProviderConfig struct {
	// Specifies your Snowflake account identifier assigned, by Snowflake.
	//
	// For information about account identifiers, see the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html). Can also be sourced from the `SNOWFLAKE_ACCOUNT` environment variable. Required unless using `profile`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#account SnowflakeProvider#account}
	Account *string `field:"optional" json:"account" yaml:"account"`
	// Alias name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#alias SnowflakeProvider#alias}
	Alias *string `field:"optional" json:"alias" yaml:"alias"`
	// Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when connecting to Snowflake. Valid values include: Snowflake, OAuth, ExternalBrowser, Okta, JWT, TokenAccessor, UsernamePasswordMFA. Can also be sourced from the `SNOWFLAKE_AUTHENTICATOR` environment variable. It has to be set explicitly to JWT for private key authentication.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#authenticator SnowflakeProvider#authenticator}
	Authenticator *string `field:"optional" json:"authenticator" yaml:"authenticator"`
	// 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.95.0/docs#browser_auth SnowflakeProvider#browser_auth}
	BrowserAuth interface{} `field:"optional" json:"browserAuth" yaml:"browserAuth"`
	// 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.95.0/docs#client_ip SnowflakeProvider#client_ip}
	ClientIp *string `field:"optional" json:"clientIp" yaml:"clientIp"`
	// 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.95.0/docs#client_request_mfa_token SnowflakeProvider#client_request_mfa_token}
	ClientRequestMfaToken interface{} `field:"optional" json:"clientRequestMfaToken" yaml:"clientRequestMfaToken"`
	// 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.95.0/docs#client_store_temporary_credential SnowflakeProvider#client_store_temporary_credential}
	ClientStoreTemporaryCredential interface{} `field:"optional" json:"clientStoreTemporaryCredential" yaml:"clientStoreTemporaryCredential"`
	// The timeout in seconds for the client to complete the authentication.
	//
	// Default is 900 seconds. Can also be sourced from the `SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#client_timeout SnowflakeProvider#client_timeout}
	ClientTimeout *float64 `field:"optional" json:"clientTimeout" yaml:"clientTimeout"`
	// Should HTAP query context cache be disabled. 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.95.0/docs#disable_query_context_cache SnowflakeProvider#disable_query_context_cache}
	DisableQueryContextCache interface{} `field:"optional" json:"disableQueryContextCache" yaml:"disableQueryContextCache"`
	// Indicates whether to disable telemetry. Can also be sourced from the `SNOWFLAKE_DISABLE_TELEMETRY` environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#disable_telemetry SnowflakeProvider#disable_telemetry}
	DisableTelemetry interface{} `field:"optional" json:"disableTelemetry" yaml:"disableTelemetry"`
	// The timeout in seconds for the external browser to complete the authentication.
	//
	// Default is 120 seconds. Can also be sourced from the `SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT` environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#external_browser_timeout SnowflakeProvider#external_browser_timeout}
	ExternalBrowserTimeout *float64 `field:"optional" json:"externalBrowserTimeout" yaml:"externalBrowserTimeout"`
	// Supports passing in a custom host value to the snowflake go driver for use with privatelink.
	//
	// Can also be sourced from the `SNOWFLAKE_HOST` environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#host SnowflakeProvider#host}
	Host *string `field:"optional" json:"host" yaml:"host"`
	// 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.95.0/docs#insecure_mode SnowflakeProvider#insecure_mode}
	InsecureMode interface{} `field:"optional" json:"insecureMode" yaml:"insecureMode"`
	// The timeout in seconds for the JWT client to complete the authentication.
	//
	// Default is 10 seconds. Can also be sourced from the `SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#jwt_client_timeout SnowflakeProvider#jwt_client_timeout}
	JwtClientTimeout *float64 `field:"optional" json:"jwtClientTimeout" yaml:"jwtClientTimeout"`
	// 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.95.0/docs#jwt_expire_timeout SnowflakeProvider#jwt_expire_timeout}
	JwtExpireTimeout *float64 `field:"optional" json:"jwtExpireTimeout" yaml:"jwtExpireTimeout"`
	// 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.95.0/docs#keep_session_alive SnowflakeProvider#keep_session_alive}
	KeepSessionAlive interface{} `field:"optional" json:"keepSessionAlive" yaml:"keepSessionAlive"`
	// Login retry timeout 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.95.0/docs#login_timeout SnowflakeProvider#login_timeout}
	LoginTimeout *float64 `field:"optional" json:"loginTimeout" yaml:"loginTimeout"`
	// 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.95.0/docs#oauth_access_token SnowflakeProvider#oauth_access_token}
	OauthAccessToken *string `field:"optional" json:"oauthAccessToken" yaml:"oauthAccessToken"`
	// 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.95.0/docs#oauth_client_id SnowflakeProvider#oauth_client_id}
	OauthClientId *string `field:"optional" json:"oauthClientId" yaml:"oauthClientId"`
	// 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.95.0/docs#oauth_client_secret SnowflakeProvider#oauth_client_secret}
	OauthClientSecret *string `field:"optional" json:"oauthClientSecret" yaml:"oauthClientSecret"`
	// 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.95.0/docs#oauth_endpoint SnowflakeProvider#oauth_endpoint}
	OauthEndpoint *string `field:"optional" json:"oauthEndpoint" yaml:"oauthEndpoint"`
	// 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.95.0/docs#oauth_redirect_url SnowflakeProvider#oauth_redirect_url}
	OauthRedirectUrl *string `field:"optional" json:"oauthRedirectUrl" yaml:"oauthRedirectUrl"`
	// 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.95.0/docs#oauth_refresh_token SnowflakeProvider#oauth_refresh_token}
	OauthRefreshToken *string `field:"optional" json:"oauthRefreshToken" yaml:"oauthRefreshToken"`
	// 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.95.0/docs#ocsp_fail_open SnowflakeProvider#ocsp_fail_open}
	OcspFailOpen interface{} `field:"optional" json:"ocspFailOpen" yaml:"ocspFailOpen"`
	// The URL of the Okta server. e.g. https://example.okta.com. 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.95.0/docs#okta_url SnowflakeProvider#okta_url}
	OktaUrl *string `field:"optional" json:"oktaUrl" yaml:"oktaUrl"`
	// Sets other connection (i.e. session) parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#params SnowflakeProvider#params}
	Params *map[string]*string `field:"optional" json:"params" yaml:"params"`
	// 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.95.0/docs#passcode SnowflakeProvider#passcode}
	Passcode *string `field:"optional" json:"passcode" yaml:"passcode"`
	// False by default.
	//
	// Set to true if the MFA passcode is embedded in the login password. Appends the MFA passcode to the end of the password. Can also be sourced from the `SNOWFLAKE_PASSCODE_IN_PASSWORD` environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#passcode_in_password SnowflakeProvider#passcode_in_password}
	PasscodeInPassword interface{} `field:"optional" json:"passcodeInPassword" yaml:"passcodeInPassword"`
	// Password for username+password auth.
	//
	// Cannot be used with `browser_auth` or `private_key_path`. Can also be sourced from the `SNOWFLAKE_PASSWORD` environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#password SnowflakeProvider#password}
	Password *string `field:"optional" json:"password" yaml:"password"`
	// Support custom port values to snowflake go driver for use with privatelink.
	//
	// Can also be sourced from the `SNOWFLAKE_PORT` environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#port SnowflakeProvider#port}
	Port *float64 `field:"optional" json:"port" yaml:"port"`
	// Private Key for username+private-key auth.
	//
	// Cannot be used with `browser_auth` or `password`. Can also be sourced from `SNOWFLAKE_PRIVATE_KEY` environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#private_key SnowflakeProvider#private_key}
	PrivateKey *string `field:"optional" json:"privateKey" yaml:"privateKey"`
	// Supports the encryption ciphers aes-128-cbc, aes-128-gcm, aes-192-cbc, aes-192-gcm, aes-256-cbc, aes-256-gcm, and des-ede3-cbc.
	//
	// Can also be sourced from `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#private_key_passphrase SnowflakeProvider#private_key_passphrase}
	PrivateKeyPassphrase *string `field:"optional" json:"privateKeyPassphrase" yaml:"privateKeyPassphrase"`
	// 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.95.0/docs#private_key_path SnowflakeProvider#private_key_path}
	PrivateKeyPath *string `field:"optional" json:"privateKeyPath" yaml:"privateKeyPath"`
	// 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.95.0/docs#profile SnowflakeProvider#profile}
	Profile *string `field:"optional" json:"profile" yaml:"profile"`
	// Either http or https, defaults to 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.95.0/docs#protocol SnowflakeProvider#protocol}
	Protocol *string `field:"optional" json:"protocol" yaml:"protocol"`
	// Snowflake region, such as "eu-central-1", with this parameter.
	//
	// However, since this parameter is deprecated, it is best to specify the region as part of the account parameter. For details, see the description of the account parameter. [Snowflake region](https://docs.snowflake.com/en/user-guide/intro-regions.html) to use.  Required if using the [legacy format for the `account` identifier](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html#format-2-legacy-account-locator-in-a-region) in the form of `<cloud_region_id>.<cloud>`. Can also be sourced from the `SNOWFLAKE_REGION` environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#region SnowflakeProvider#region}
	Region *string `field:"optional" json:"region" yaml:"region"`
	// request retry timeout 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.95.0/docs#request_timeout SnowflakeProvider#request_timeout}
	RequestTimeout *float64 `field:"optional" json:"requestTimeout" yaml:"requestTimeout"`
	// 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.95.0/docs#role SnowflakeProvider#role}
	Role *string `field:"optional" json:"role" yaml:"role"`
	// Sets session parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#session_params SnowflakeProvider#session_params}
	SessionParams *map[string]*string `field:"optional" json:"sessionParams" yaml:"sessionParams"`
	// 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.95.0/docs#token SnowflakeProvider#token}
	Token *string `field:"optional" json:"token" yaml:"token"`
	// token_accessor block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#token_accessor SnowflakeProvider#token_accessor}
	TokenAccessor *SnowflakeProviderTokenAccessor `field:"optional" json:"tokenAccessor" yaml:"tokenAccessor"`
	// Username. Can also be sourced from the `SNOWFLAKE_USER` environment variable. Required unless using `profile`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#user SnowflakeProvider#user}
	User *string `field:"optional" json:"user" yaml:"user"`
	// Username for username+password authentication. Can also be sourced from the `SNOWFLAKE_USERNAME` environment variable. Required unless using `profile`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.95.0/docs#username SnowflakeProvider#username}
	Username *string `field:"optional" json:"username" yaml:"username"`
	// 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.95.0/docs#validate_default_parameters SnowflakeProvider#validate_default_parameters}
	ValidateDefaultParameters interface{} `field:"optional" json:"validateDefaultParameters" yaml:"validateDefaultParameters"`
	// 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.95.0/docs#warehouse SnowflakeProvider#warehouse}
	Warehouse *string `field:"optional" json:"warehouse" yaml:"warehouse"`
}

type SnowflakeProviderTokenAccessor 

type SnowflakeProviderTokenAccessor struct {
	// 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.95.0/docs#client_id SnowflakeProvider#client_id}
	ClientId *string `field:"required" json:"clientId" yaml:"clientId"`
	// 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.95.0/docs#client_secret SnowflakeProvider#client_secret}
	ClientSecret *string `field:"required" json:"clientSecret" yaml:"clientSecret"`
	// 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.95.0/docs#redirect_uri SnowflakeProvider#redirect_uri}
	RedirectUri *string `field:"required" json:"redirectUri" yaml:"redirectUri"`
	// 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.95.0/docs#refresh_token SnowflakeProvider#refresh_token}
	RefreshToken *string `field:"required" json:"refreshToken" yaml:"refreshToken"`
	// 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.95.0/docs#token_endpoint SnowflakeProvider#token_endpoint}
	TokenEndpoint *string `field:"required" json:"tokenEndpoint" yaml:"tokenEndpoint"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.