Docs Packages
  1. Packages
  2. Snowflake
  3. API Docs
  4. Provider
Snowflake v0.32.0 published on Tuesday, Aug 22, 2023 by Pulumi
pulumi/pulumi-snowflake

snowflake.Provider

Explore with Pulumi AI

snowflake logo
Snowflake v0.32.0 published on Tuesday, Aug 22, 2023 by Pulumi
pulumi/pulumi-snowflake

    The provider type for the snowflake package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             account: Optional[str] = None,
             browser_auth: Optional[bool] = None,
             host: Optional[str] = None,
             insecure_mode: Optional[bool] = None,
             oauth_access_token: Optional[str] = None,
             oauth_client_id: Optional[str] = None,
             oauth_client_secret: Optional[str] = None,
             oauth_endpoint: Optional[str] = None,
             oauth_redirect_url: Optional[str] = None,
             oauth_refresh_token: Optional[str] = None,
             password: Optional[str] = None,
             port: Optional[int] = None,
             private_key: Optional[str] = None,
             private_key_passphrase: Optional[str] = None,
             private_key_path: Optional[str] = None,
             profile: Optional[str] = None,
             protocol: Optional[str] = None,
             region: Optional[str] = None,
             role: Optional[str] = None,
             session_params: Optional[Mapping[str, Any]] = None,
             username: Optional[str] = None,
             warehouse: Optional[str] = None)
@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

    type: pulumi:providers:snowflake
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Provider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Provider resource accepts the following input properties:

    Account string

    The name of the Snowflake account. Can also come from the SNOWFLAKE_ACCOUNT environment variable. Required unless using profile. It can also be sourced from the following environment variable: SNOWFLAKE_ACCOUNT

    BrowserAuth bool

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_USE_BROWSER_AUTH environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_USE_BROWSER_AUTH

    Host string

    Supports passing in a custom host value to the snowflake go driver for use with privatelink. It can also be sourced from the following environment variable: SNOWFLAKE_HOST

    InsecureMode bool

    If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the default value for testing or emergency situations only.

    OauthAccessToken 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 be sourced from SNOWFLAKE_OAUTH_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_ACCESS_TOKEN

    OauthClientId string

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_CLIENT_ID environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_CLIENT_ID

    OauthClientSecret string

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_CLIENT_SECRET environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_CLIENT_SECRET

    OauthEndpoint string

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_ENDPOINT environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_ENDPOINT

    OauthRedirectUrl string

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_REDIRECT_URL environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_REDIRECT_URL

    OauthRefreshToken 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 be sourced from SNOWFLAKE_OAUTH_REFRESH_TOKEN environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_REFRESH_TOKEN

    Password string

    Password for username+password auth. Cannot be used with browser_auth or private_key_path. Can be sourced from SNOWFLAKE_PASSWORD environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PASSWORD

    Port int

    Support custom port values to snowflake go driver for use with privatelink. Can be sourced from SNOWFLAKE_PORT environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PORT

    PrivateKey string

    Private Key for username+private-key auth. Cannot be used with browser_auth or password. Can be sourced from 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 It can also be sourced from the following environment variable: SNOWFLAKE_PRIVATE_KEY_PASSPHRASE

    PrivateKeyPath string

    Path to a private key for using keypair authentication. Cannot be used with browser_auth, oauth_access_token or password. Can be sourced from SNOWFLAKE_PRIVATE_KEY_PATH environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PRIVATE_KEY_PATH

    Profile string

    Sets the profile to read from ~/.snowflake/config file.

    Protocol string

    Support custom protocols to snowflake go driver. Can be sourced from SNOWFLAKE_PROTOCOL environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PROTOCOL

    Region string

    Snowflake region to use. Required if using the legacy format for the account identifier in the form of <cloud_region_id>.<cloud>. Can be sourced from the SNOWFLAKE_REGION environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_REGION

    Role string

    Snowflake role to use for operations. If left unset, default role for user will be used. Can be sourced from the SNOWFLAKE_ROLE environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_ROLE

    SessionParams Dictionary<string, object>

    Sets session parameters. Parameters

    Username string

    Username for username+password authentication. Can come from the SNOWFLAKE_USER environment variable. Required unless using profile. It can also be sourced from the following environment variable: SNOWFLAKE_USER

    Warehouse string

    Sets the default warehouse. Optional. Can be sourced from SNOWFLAKE_WAREHOUSE environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_WAREHOUSE

    Account string

    The name of the Snowflake account. Can also come from the SNOWFLAKE_ACCOUNT environment variable. Required unless using profile. It can also be sourced from the following environment variable: SNOWFLAKE_ACCOUNT

    BrowserAuth bool

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_USE_BROWSER_AUTH environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_USE_BROWSER_AUTH

    Host string

    Supports passing in a custom host value to the snowflake go driver for use with privatelink. It can also be sourced from the following environment variable: SNOWFLAKE_HOST

    InsecureMode bool

    If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the default value for testing or emergency situations only.

    OauthAccessToken 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 be sourced from SNOWFLAKE_OAUTH_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_ACCESS_TOKEN

    OauthClientId string

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_CLIENT_ID environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_CLIENT_ID

    OauthClientSecret string

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_CLIENT_SECRET environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_CLIENT_SECRET

    OauthEndpoint string

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_ENDPOINT environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_ENDPOINT

    OauthRedirectUrl string

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_REDIRECT_URL environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_REDIRECT_URL

    OauthRefreshToken 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 be sourced from SNOWFLAKE_OAUTH_REFRESH_TOKEN environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_REFRESH_TOKEN

    Password string

    Password for username+password auth. Cannot be used with browser_auth or private_key_path. Can be sourced from SNOWFLAKE_PASSWORD environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PASSWORD

    Port int

    Support custom port values to snowflake go driver for use with privatelink. Can be sourced from SNOWFLAKE_PORT environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PORT

    PrivateKey string

    Private Key for username+private-key auth. Cannot be used with browser_auth or password. Can be sourced from 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 It can also be sourced from the following environment variable: SNOWFLAKE_PRIVATE_KEY_PASSPHRASE

    PrivateKeyPath string

    Path to a private key for using keypair authentication. Cannot be used with browser_auth, oauth_access_token or password. Can be sourced from SNOWFLAKE_PRIVATE_KEY_PATH environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PRIVATE_KEY_PATH

    Profile string

    Sets the profile to read from ~/.snowflake/config file.

    Protocol string

    Support custom protocols to snowflake go driver. Can be sourced from SNOWFLAKE_PROTOCOL environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PROTOCOL

    Region string

    Snowflake region to use. Required if using the legacy format for the account identifier in the form of <cloud_region_id>.<cloud>. Can be sourced from the SNOWFLAKE_REGION environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_REGION

    Role string

    Snowflake role to use for operations. If left unset, default role for user will be used. Can be sourced from the SNOWFLAKE_ROLE environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_ROLE

    SessionParams map[string]interface{}

    Sets session parameters. Parameters

    Username string

    Username for username+password authentication. Can come from the SNOWFLAKE_USER environment variable. Required unless using profile. It can also be sourced from the following environment variable: SNOWFLAKE_USER

    Warehouse string

    Sets the default warehouse. Optional. Can be sourced from SNOWFLAKE_WAREHOUSE environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_WAREHOUSE

    account String

    The name of the Snowflake account. Can also come from the SNOWFLAKE_ACCOUNT environment variable. Required unless using profile. It can also be sourced from the following environment variable: SNOWFLAKE_ACCOUNT

    browserAuth Boolean

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_USE_BROWSER_AUTH environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_USE_BROWSER_AUTH

    host String

    Supports passing in a custom host value to the snowflake go driver for use with privatelink. It can also be sourced from the following environment variable: SNOWFLAKE_HOST

    insecureMode Boolean

    If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the default value for testing or emergency situations only.

    oauthAccessToken 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 be sourced from SNOWFLAKE_OAUTH_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_ACCESS_TOKEN

    oauthClientId String

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_CLIENT_ID environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_CLIENT_ID

    oauthClientSecret String

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_CLIENT_SECRET environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_CLIENT_SECRET

    oauthEndpoint String

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_ENDPOINT environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_ENDPOINT

    oauthRedirectUrl String

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_REDIRECT_URL environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_REDIRECT_URL

    oauthRefreshToken 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 be sourced from SNOWFLAKE_OAUTH_REFRESH_TOKEN environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_REFRESH_TOKEN

    password String

    Password for username+password auth. Cannot be used with browser_auth or private_key_path. Can be sourced from SNOWFLAKE_PASSWORD environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PASSWORD

    port Integer

    Support custom port values to snowflake go driver for use with privatelink. Can be sourced from SNOWFLAKE_PORT environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PORT

    privateKey String

    Private Key for username+private-key auth. Cannot be used with browser_auth or password. Can be sourced from 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 It can also be sourced from the following environment variable: SNOWFLAKE_PRIVATE_KEY_PASSPHRASE

    privateKeyPath String

    Path to a private key for using keypair authentication. Cannot be used with browser_auth, oauth_access_token or password. Can be sourced from SNOWFLAKE_PRIVATE_KEY_PATH environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PRIVATE_KEY_PATH

    profile String

    Sets the profile to read from ~/.snowflake/config file.

    protocol String

    Support custom protocols to snowflake go driver. Can be sourced from SNOWFLAKE_PROTOCOL environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PROTOCOL

    region String

    Snowflake region to use. Required if using the legacy format for the account identifier in the form of <cloud_region_id>.<cloud>. Can be sourced from the SNOWFLAKE_REGION environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_REGION

    role String

    Snowflake role to use for operations. If left unset, default role for user will be used. Can be sourced from the SNOWFLAKE_ROLE environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_ROLE

    sessionParams Map<String,Object>

    Sets session parameters. Parameters

    username String

    Username for username+password authentication. Can come from the SNOWFLAKE_USER environment variable. Required unless using profile. It can also be sourced from the following environment variable: SNOWFLAKE_USER

    warehouse String

    Sets the default warehouse. Optional. Can be sourced from SNOWFLAKE_WAREHOUSE environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_WAREHOUSE

    account string

    The name of the Snowflake account. Can also come from the SNOWFLAKE_ACCOUNT environment variable. Required unless using profile. It can also be sourced from the following environment variable: SNOWFLAKE_ACCOUNT

    browserAuth boolean

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_USE_BROWSER_AUTH environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_USE_BROWSER_AUTH

    host string

    Supports passing in a custom host value to the snowflake go driver for use with privatelink. It can also be sourced from the following environment variable: SNOWFLAKE_HOST

    insecureMode boolean

    If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the default value for testing or emergency situations only.

    oauthAccessToken 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 be sourced from SNOWFLAKE_OAUTH_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_ACCESS_TOKEN

    oauthClientId string

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_CLIENT_ID environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_CLIENT_ID

    oauthClientSecret string

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_CLIENT_SECRET environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_CLIENT_SECRET

    oauthEndpoint string

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_ENDPOINT environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_ENDPOINT

    oauthRedirectUrl string

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_REDIRECT_URL environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_REDIRECT_URL

    oauthRefreshToken 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 be sourced from SNOWFLAKE_OAUTH_REFRESH_TOKEN environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_REFRESH_TOKEN

    password string

    Password for username+password auth. Cannot be used with browser_auth or private_key_path. Can be sourced from SNOWFLAKE_PASSWORD environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PASSWORD

    port number

    Support custom port values to snowflake go driver for use with privatelink. Can be sourced from SNOWFLAKE_PORT environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PORT

    privateKey string

    Private Key for username+private-key auth. Cannot be used with browser_auth or password. Can be sourced from 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 It can also be sourced from the following environment variable: SNOWFLAKE_PRIVATE_KEY_PASSPHRASE

    privateKeyPath string

    Path to a private key for using keypair authentication. Cannot be used with browser_auth, oauth_access_token or password. Can be sourced from SNOWFLAKE_PRIVATE_KEY_PATH environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PRIVATE_KEY_PATH

    profile string

    Sets the profile to read from ~/.snowflake/config file.

    protocol string

    Support custom protocols to snowflake go driver. Can be sourced from SNOWFLAKE_PROTOCOL environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PROTOCOL

    region string

    Snowflake region to use. Required if using the legacy format for the account identifier in the form of <cloud_region_id>.<cloud>. Can be sourced from the SNOWFLAKE_REGION environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_REGION

    role string

    Snowflake role to use for operations. If left unset, default role for user will be used. Can be sourced from the SNOWFLAKE_ROLE environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_ROLE

    sessionParams {[key: string]: any}

    Sets session parameters. Parameters

    username string

    Username for username+password authentication. Can come from the SNOWFLAKE_USER environment variable. Required unless using profile. It can also be sourced from the following environment variable: SNOWFLAKE_USER

    warehouse string

    Sets the default warehouse. Optional. Can be sourced from SNOWFLAKE_WAREHOUSE environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_WAREHOUSE

    account str

    The name of the Snowflake account. Can also come from the SNOWFLAKE_ACCOUNT environment variable. Required unless using profile. It can also be sourced from the following environment variable: SNOWFLAKE_ACCOUNT

    browser_auth bool

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_USE_BROWSER_AUTH environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_USE_BROWSER_AUTH

    host str

    Supports passing in a custom host value to the snowflake go driver for use with privatelink. It can also be sourced from the following environment variable: SNOWFLAKE_HOST

    insecure_mode bool

    If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the default value for testing or emergency situations only.

    oauth_access_token str

    Token for use with OAuth. Generating the token is left to other tools. Cannot be used with browser_auth, private_key_path, oauth_refresh_token or password. Can be sourced from SNOWFLAKE_OAUTH_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_ACCESS_TOKEN

    oauth_client_id str

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_CLIENT_ID environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_CLIENT_ID

    oauth_client_secret str

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_CLIENT_SECRET environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_CLIENT_SECRET

    oauth_endpoint str

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_ENDPOINT environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_ENDPOINT

    oauth_redirect_url str

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_REDIRECT_URL environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_REDIRECT_URL

    oauth_refresh_token str

    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 be sourced from SNOWFLAKE_OAUTH_REFRESH_TOKEN environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_REFRESH_TOKEN

    password str

    Password for username+password auth. Cannot be used with browser_auth or private_key_path. Can be sourced from SNOWFLAKE_PASSWORD environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PASSWORD

    port int

    Support custom port values to snowflake go driver for use with privatelink. Can be sourced from SNOWFLAKE_PORT environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PORT

    private_key str

    Private Key for username+private-key auth. Cannot be used with browser_auth or password. Can be sourced from SNOWFLAKE_PRIVATE_KEY environment variable.

    private_key_passphrase str

    Supports the encryption ciphers aes-128-cbc, aes-128-gcm, aes-192-cbc, aes-192-gcm, aes-256-cbc, aes-256-gcm, and des-ede3-cbc It can also be sourced from the following environment variable: SNOWFLAKE_PRIVATE_KEY_PASSPHRASE

    private_key_path str

    Path to a private key for using keypair authentication. Cannot be used with browser_auth, oauth_access_token or password. Can be sourced from SNOWFLAKE_PRIVATE_KEY_PATH environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PRIVATE_KEY_PATH

    profile str

    Sets the profile to read from ~/.snowflake/config file.

    protocol str

    Support custom protocols to snowflake go driver. Can be sourced from SNOWFLAKE_PROTOCOL environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PROTOCOL

    region str

    Snowflake region to use. Required if using the legacy format for the account identifier in the form of <cloud_region_id>.<cloud>. Can be sourced from the SNOWFLAKE_REGION environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_REGION

    role str

    Snowflake role to use for operations. If left unset, default role for user will be used. Can be sourced from the SNOWFLAKE_ROLE environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_ROLE

    session_params Mapping[str, Any]

    Sets session parameters. Parameters

    username str

    Username for username+password authentication. Can come from the SNOWFLAKE_USER environment variable. Required unless using profile. It can also be sourced from the following environment variable: SNOWFLAKE_USER

    warehouse str

    Sets the default warehouse. Optional. Can be sourced from SNOWFLAKE_WAREHOUSE environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_WAREHOUSE

    account String

    The name of the Snowflake account. Can also come from the SNOWFLAKE_ACCOUNT environment variable. Required unless using profile. It can also be sourced from the following environment variable: SNOWFLAKE_ACCOUNT

    browserAuth Boolean

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_USE_BROWSER_AUTH environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_USE_BROWSER_AUTH

    host String

    Supports passing in a custom host value to the snowflake go driver for use with privatelink. It can also be sourced from the following environment variable: SNOWFLAKE_HOST

    insecureMode Boolean

    If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the default value for testing or emergency situations only.

    oauthAccessToken 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 be sourced from SNOWFLAKE_OAUTH_ACCESS_TOKEN environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_ACCESS_TOKEN

    oauthClientId String

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_CLIENT_ID environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_CLIENT_ID

    oauthClientSecret String

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_CLIENT_SECRET environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_CLIENT_SECRET

    oauthEndpoint String

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_ENDPOINT environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_ENDPOINT

    oauthRedirectUrl String

    Required when oauth_refresh_token is used. Can be sourced from SNOWFLAKE_OAUTH_REDIRECT_URL environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_REDIRECT_URL

    oauthRefreshToken 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 be sourced from SNOWFLAKE_OAUTH_REFRESH_TOKEN environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_OAUTH_REFRESH_TOKEN

    password String

    Password for username+password auth. Cannot be used with browser_auth or private_key_path. Can be sourced from SNOWFLAKE_PASSWORD environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PASSWORD

    port Number

    Support custom port values to snowflake go driver for use with privatelink. Can be sourced from SNOWFLAKE_PORT environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PORT

    privateKey String

    Private Key for username+private-key auth. Cannot be used with browser_auth or password. Can be sourced from 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 It can also be sourced from the following environment variable: SNOWFLAKE_PRIVATE_KEY_PASSPHRASE

    privateKeyPath String

    Path to a private key for using keypair authentication. Cannot be used with browser_auth, oauth_access_token or password. Can be sourced from SNOWFLAKE_PRIVATE_KEY_PATH environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PRIVATE_KEY_PATH

    profile String

    Sets the profile to read from ~/.snowflake/config file.

    protocol String

    Support custom protocols to snowflake go driver. Can be sourced from SNOWFLAKE_PROTOCOL environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_PROTOCOL

    region String

    Snowflake region to use. Required if using the legacy format for the account identifier in the form of <cloud_region_id>.<cloud>. Can be sourced from the SNOWFLAKE_REGION environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_REGION

    role String

    Snowflake role to use for operations. If left unset, default role for user will be used. Can be sourced from the SNOWFLAKE_ROLE environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_ROLE

    sessionParams Map<Any>

    Sets session parameters. Parameters

    username String

    Username for username+password authentication. Can come from the SNOWFLAKE_USER environment variable. Required unless using profile. It can also be sourced from the following environment variable: SNOWFLAKE_USER

    warehouse String

    Sets the default warehouse. Optional. Can be sourced from SNOWFLAKE_WAREHOUSE environment variable. It can also be sourced from the following environment variable: SNOWFLAKE_WAREHOUSE

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    Id string

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    id string

    The provider-assigned unique ID for this managed resource.

    id str

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the snowflake Terraform Provider.

    snowflake logo
    Snowflake v0.32.0 published on Tuesday, Aug 22, 2023 by Pulumi
    pulumi/pulumi-snowflake