published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a Snowflake connector and its configuration in a Descope project. Stream authentication audit logs to your Snowflake data warehouse with the Snowflake connector.
Create SnowflakeConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SnowflakeConnector(name: string, args: SnowflakeConnectorArgs, opts?: CustomResourceOptions);@overload
def SnowflakeConnector(resource_name: str,
args: SnowflakeConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SnowflakeConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
database: Optional[str] = None,
warehouse: Optional[str] = None,
site: Optional[str] = None,
schema: Optional[str] = None,
project_id: Optional[str] = None,
auth_type: Optional[str] = None,
private_key: Optional[str] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
mask_pii: Optional[bool] = None,
min_flush_interval_minutes: Optional[float] = None,
name: Optional[str] = None,
account_identifier: Optional[str] = None,
private_key_passphrase: Optional[str] = None,
audit_table: Optional[str] = None,
audit_filters: Optional[Sequence[SnowflakeConnectorAuditFilterArgs]] = None,
self_provision: Optional[bool] = None,
audit_enabled: Optional[bool] = None,
snowflake_user: Optional[str] = None,
troubleshoot_log_enabled: Optional[bool] = None,
api_key: Optional[str] = None)func NewSnowflakeConnector(ctx *Context, name string, args SnowflakeConnectorArgs, opts ...ResourceOption) (*SnowflakeConnector, error)public SnowflakeConnector(string name, SnowflakeConnectorArgs args, CustomResourceOptions? opts = null)
public SnowflakeConnector(String name, SnowflakeConnectorArgs args)
public SnowflakeConnector(String name, SnowflakeConnectorArgs args, CustomResourceOptions options)
type: descope:SnowflakeConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_snowflake_connector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args SnowflakeConnectorArgs
- 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 SnowflakeConnectorArgs
- 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 SnowflakeConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SnowflakeConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SnowflakeConnectorArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var snowflakeConnectorResource = new Descope.SnowflakeConnector("snowflakeConnectorResource", new()
{
Database = "string",
Warehouse = "string",
Site = "string",
Schema = "string",
ProjectId = "string",
AuthType = "string",
PrivateKey = "string",
Description = "string",
Disabled = false,
MaskPii = false,
MinFlushIntervalMinutes = 0.0,
Name = "string",
AccountIdentifier = "string",
PrivateKeyPassphrase = "string",
AuditTable = "string",
AuditFilters = new[]
{
new Descope.Inputs.SnowflakeConnectorAuditFilterArgs
{
Key = "string",
Operator = "string",
Values = new[]
{
"string",
},
},
},
SelfProvision = false,
AuditEnabled = false,
SnowflakeUser = "string",
TroubleshootLogEnabled = false,
ApiKey = "string",
});
example, err := descope.NewSnowflakeConnector(ctx, "snowflakeConnectorResource", &descope.SnowflakeConnectorArgs{
Database: pulumi.String("string"),
Warehouse: pulumi.String("string"),
Site: pulumi.String("string"),
Schema: pulumi.String("string"),
ProjectId: pulumi.String("string"),
AuthType: pulumi.String("string"),
PrivateKey: pulumi.String("string"),
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
MaskPii: pulumi.Bool(false),
MinFlushIntervalMinutes: pulumi.Float64(0),
Name: pulumi.String("string"),
AccountIdentifier: pulumi.String("string"),
PrivateKeyPassphrase: pulumi.String("string"),
AuditTable: pulumi.String("string"),
AuditFilters: descope.SnowflakeConnectorAuditFilterArray{
&descope.SnowflakeConnectorAuditFilterArgs{
Key: pulumi.String("string"),
Operator: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
SelfProvision: pulumi.Bool(false),
AuditEnabled: pulumi.Bool(false),
SnowflakeUser: pulumi.String("string"),
TroubleshootLogEnabled: pulumi.Bool(false),
ApiKey: pulumi.String("string"),
})
resource "descope_snowflake_connector" "snowflakeConnectorResource" {
lifecycle {
create_before_destroy = true
}
database = "string"
warehouse = "string"
site = "string"
schema = "string"
project_id = "string"
auth_type = "string"
private_key = "string"
description = "string"
disabled = false
mask_pii = false
min_flush_interval_minutes = 0
name = "string"
account_identifier = "string"
private_key_passphrase = "string"
audit_table = "string"
audit_filters {
key = "string"
operator = "string"
values = ["string"]
}
self_provision = false
audit_enabled = false
snowflake_user = "string"
troubleshoot_log_enabled = false
api_key = "string"
}
var snowflakeConnectorResource = new SnowflakeConnector("snowflakeConnectorResource", SnowflakeConnectorArgs.builder()
.database("string")
.warehouse("string")
.site("string")
.schema("string")
.projectId("string")
.authType("string")
.privateKey("string")
.description("string")
.disabled(false)
.maskPii(false)
.minFlushIntervalMinutes(0.0)
.name("string")
.accountIdentifier("string")
.privateKeyPassphrase("string")
.auditTable("string")
.auditFilters(SnowflakeConnectorAuditFilterArgs.builder()
.key("string")
.operator("string")
.values("string")
.build())
.selfProvision(false)
.auditEnabled(false)
.snowflakeUser("string")
.troubleshootLogEnabled(false)
.apiKey("string")
.build());
snowflake_connector_resource = descope.SnowflakeConnector("snowflakeConnectorResource",
database="string",
warehouse="string",
site="string",
schema="string",
project_id="string",
auth_type="string",
private_key="string",
description="string",
disabled=False,
mask_pii=False,
min_flush_interval_minutes=float(0),
name="string",
account_identifier="string",
private_key_passphrase="string",
audit_table="string",
audit_filters=[{
"key": "string",
"operator": "string",
"values": ["string"],
}],
self_provision=False,
audit_enabled=False,
snowflake_user="string",
troubleshoot_log_enabled=False,
api_key="string")
const snowflakeConnectorResource = new descope.SnowflakeConnector("snowflakeConnectorResource", {
database: "string",
warehouse: "string",
site: "string",
schema: "string",
projectId: "string",
authType: "string",
privateKey: "string",
description: "string",
disabled: false,
maskPii: false,
minFlushIntervalMinutes: 0,
name: "string",
accountIdentifier: "string",
privateKeyPassphrase: "string",
auditTable: "string",
auditFilters: [{
key: "string",
operator: "string",
values: ["string"],
}],
selfProvision: false,
auditEnabled: false,
snowflakeUser: "string",
troubleshootLogEnabled: false,
apiKey: "string",
});
type: descope:SnowflakeConnector
properties:
accountIdentifier: string
apiKey: string
auditEnabled: false
auditFilters:
- key: string
operator: string
values:
- string
auditTable: string
authType: string
database: string
description: string
disabled: false
maskPii: false
minFlushIntervalMinutes: 0
name: string
privateKey: string
privateKeyPassphrase: string
projectId: string
schema: string
selfProvision: false
site: string
snowflakeUser: string
troubleshootLogEnabled: false
warehouse: string
SnowflakeConnector Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SnowflakeConnector resource accepts the following input properties:
- Database string
- The Snowflake database, exactly as stored (unquoted names are uppercased: descopedb->DESCOPEDB). Run SHOW DATABASES to check. Defaults to
DESCOPE_EXPORT_DB. - Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Schema string
- The schema within the database, exactly as stored (unquoted names are uppercased: public->PUBLIC). Run SHOW SCHEMAS to check. Defaults to
PUBLIC. - Site string
- Your Snowflake account URL, e.g.
https://<org>-<account>.snowflakecomputing.com. - Warehouse string
- The Snowflake warehouse, exactly as stored (unquoted names are uppercased: descopewh->DESCOPEWH). Run SHOW WAREHOUSES to check. Defaults to
COMPUTE_WH. - Account
Identifier string - Overrides the account identifier derived from the Account URL. Only needed for PrivateLink or legacy region locators.
- Api
Key string - A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges, unless Self Provision is enabled - in which case it only needs write access to the table you created.
- Audit
Enabled bool - Whether to enable streaming of audit events.
- Audit
Filters List<Descope.Snowflake Connector Audit Filter> - Specify which events will be sent to the external audit service (including tenant selection).
- Audit
Table string - The table to write audit events to, exactly as stored (unquoted names are uppercased: auditlogs->AUDITLOGS). Run SHOW TABLES to check. Defaults to
DESCOPE_AUDIT_LOGS. - Auth
Type string - How Descope authenticates to the Snowflake SQL API. See the connector documentation for the setup steps of each method.
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Mask
Pii bool - Whether to mask personally identifiable information in the logs.
- Min
Flush doubleInterval Minutes - The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
- Name string
- A custom name for your connector.
- Private
Key string - The private key in PEM format, RSA 2048-bit or stronger. Descope reads PKCS#8 encrypted with PBES2, or unencrypted PKCS#8 or PKCS#1. For Snowflake's own key-pair requirements see https://docs.snowflake.com/en/user-guide/key-pair-auth.
- Private
Key stringPassphrase - Required only if the private key is passphrase-protected. Leave empty for an unencrypted key.
- Self
Provision bool - Create the database, table and schema in Snowflake manually instead of allowing the connector to create them. Useful when the Snowflake user Descope authenticates as is restricted to minimal or write-only privileges.
- Snowflake
User string - The Snowflake user Descope authenticates as. The public key must be registered on this user with
ALTER USER ... SET RSA_PUBLIC_KEY. - Troubleshoot
Log boolEnabled - Whether to send troubleshooting events.
- Database string
- The Snowflake database, exactly as stored (unquoted names are uppercased: descopedb->DESCOPEDB). Run SHOW DATABASES to check. Defaults to
DESCOPE_EXPORT_DB. - Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Schema string
- The schema within the database, exactly as stored (unquoted names are uppercased: public->PUBLIC). Run SHOW SCHEMAS to check. Defaults to
PUBLIC. - Site string
- Your Snowflake account URL, e.g.
https://<org>-<account>.snowflakecomputing.com. - Warehouse string
- The Snowflake warehouse, exactly as stored (unquoted names are uppercased: descopewh->DESCOPEWH). Run SHOW WAREHOUSES to check. Defaults to
COMPUTE_WH. - Account
Identifier string - Overrides the account identifier derived from the Account URL. Only needed for PrivateLink or legacy region locators.
- Api
Key string - A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges, unless Self Provision is enabled - in which case it only needs write access to the table you created.
- Audit
Enabled bool - Whether to enable streaming of audit events.
- Audit
Filters []SnowflakeConnector Audit Filter Args - Specify which events will be sent to the external audit service (including tenant selection).
- Audit
Table string - The table to write audit events to, exactly as stored (unquoted names are uppercased: auditlogs->AUDITLOGS). Run SHOW TABLES to check. Defaults to
DESCOPE_AUDIT_LOGS. - Auth
Type string - How Descope authenticates to the Snowflake SQL API. See the connector documentation for the setup steps of each method.
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Mask
Pii bool - Whether to mask personally identifiable information in the logs.
- Min
Flush float64Interval Minutes - The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
- Name string
- A custom name for your connector.
- Private
Key string - The private key in PEM format, RSA 2048-bit or stronger. Descope reads PKCS#8 encrypted with PBES2, or unencrypted PKCS#8 or PKCS#1. For Snowflake's own key-pair requirements see https://docs.snowflake.com/en/user-guide/key-pair-auth.
- Private
Key stringPassphrase - Required only if the private key is passphrase-protected. Leave empty for an unencrypted key.
- Self
Provision bool - Create the database, table and schema in Snowflake manually instead of allowing the connector to create them. Useful when the Snowflake user Descope authenticates as is restricted to minimal or write-only privileges.
- Snowflake
User string - The Snowflake user Descope authenticates as. The public key must be registered on this user with
ALTER USER ... SET RSA_PUBLIC_KEY. - Troubleshoot
Log boolEnabled - Whether to send troubleshooting events.
- database string
- The Snowflake database, exactly as stored (unquoted names are uppercased: descopedb->DESCOPEDB). Run SHOW DATABASES to check. Defaults to
DESCOPE_EXPORT_DB. - project_
id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- schema string
- The schema within the database, exactly as stored (unquoted names are uppercased: public->PUBLIC). Run SHOW SCHEMAS to check. Defaults to
PUBLIC. - site string
- Your Snowflake account URL, e.g.
https://<org>-<account>.snowflakecomputing.com. - warehouse string
- The Snowflake warehouse, exactly as stored (unquoted names are uppercased: descopewh->DESCOPEWH). Run SHOW WAREHOUSES to check. Defaults to
COMPUTE_WH. - account_
identifier string - Overrides the account identifier derived from the Account URL. Only needed for PrivateLink or legacy region locators.
- api_
key string - A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges, unless Self Provision is enabled - in which case it only needs write access to the table you created.
- audit_
enabled bool - Whether to enable streaming of audit events.
- audit_
filters list(object) - Specify which events will be sent to the external audit service (including tenant selection).
- audit_
table string - The table to write audit events to, exactly as stored (unquoted names are uppercased: auditlogs->AUDITLOGS). Run SHOW TABLES to check. Defaults to
DESCOPE_AUDIT_LOGS. - auth_
type string - How Descope authenticates to the Snowflake SQL API. See the connector documentation for the setup steps of each method.
- description string
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask_
pii bool - Whether to mask personally identifiable information in the logs.
- min_
flush_ numberinterval_ minutes - The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
- name string
- A custom name for your connector.
- private_
key string - The private key in PEM format, RSA 2048-bit or stronger. Descope reads PKCS#8 encrypted with PBES2, or unencrypted PKCS#8 or PKCS#1. For Snowflake's own key-pair requirements see https://docs.snowflake.com/en/user-guide/key-pair-auth.
- private_
key_ stringpassphrase - Required only if the private key is passphrase-protected. Leave empty for an unencrypted key.
- self_
provision bool - Create the database, table and schema in Snowflake manually instead of allowing the connector to create them. Useful when the Snowflake user Descope authenticates as is restricted to minimal or write-only privileges.
- snowflake_
user string - The Snowflake user Descope authenticates as. The public key must be registered on this user with
ALTER USER ... SET RSA_PUBLIC_KEY. - troubleshoot_
log_ boolenabled - Whether to send troubleshooting events.
- database String
- The Snowflake database, exactly as stored (unquoted names are uppercased: descopedb->DESCOPEDB). Run SHOW DATABASES to check. Defaults to
DESCOPE_EXPORT_DB. - project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- schema String
- The schema within the database, exactly as stored (unquoted names are uppercased: public->PUBLIC). Run SHOW SCHEMAS to check. Defaults to
PUBLIC. - site String
- Your Snowflake account URL, e.g.
https://<org>-<account>.snowflakecomputing.com. - warehouse String
- The Snowflake warehouse, exactly as stored (unquoted names are uppercased: descopewh->DESCOPEWH). Run SHOW WAREHOUSES to check. Defaults to
COMPUTE_WH. - account
Identifier String - Overrides the account identifier derived from the Account URL. Only needed for PrivateLink or legacy region locators.
- api
Key String - A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges, unless Self Provision is enabled - in which case it only needs write access to the table you created.
- audit
Enabled Boolean - Whether to enable streaming of audit events.
- audit
Filters List<SnowflakeConnector Audit Filter> - Specify which events will be sent to the external audit service (including tenant selection).
- audit
Table String - The table to write audit events to, exactly as stored (unquoted names are uppercased: auditlogs->AUDITLOGS). Run SHOW TABLES to check. Defaults to
DESCOPE_AUDIT_LOGS. - auth
Type String - How Descope authenticates to the Snowflake SQL API. See the connector documentation for the setup steps of each method.
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask
Pii Boolean - Whether to mask personally identifiable information in the logs.
- min
Flush DoubleInterval Minutes - The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
- name String
- A custom name for your connector.
- private
Key String - The private key in PEM format, RSA 2048-bit or stronger. Descope reads PKCS#8 encrypted with PBES2, or unencrypted PKCS#8 or PKCS#1. For Snowflake's own key-pair requirements see https://docs.snowflake.com/en/user-guide/key-pair-auth.
- private
Key StringPassphrase - Required only if the private key is passphrase-protected. Leave empty for an unencrypted key.
- self
Provision Boolean - Create the database, table and schema in Snowflake manually instead of allowing the connector to create them. Useful when the Snowflake user Descope authenticates as is restricted to minimal or write-only privileges.
- snowflake
User String - The Snowflake user Descope authenticates as. The public key must be registered on this user with
ALTER USER ... SET RSA_PUBLIC_KEY. - troubleshoot
Log BooleanEnabled - Whether to send troubleshooting events.
- database string
- The Snowflake database, exactly as stored (unquoted names are uppercased: descopedb->DESCOPEDB). Run SHOW DATABASES to check. Defaults to
DESCOPE_EXPORT_DB. - project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- schema string
- The schema within the database, exactly as stored (unquoted names are uppercased: public->PUBLIC). Run SHOW SCHEMAS to check. Defaults to
PUBLIC. - site string
- Your Snowflake account URL, e.g.
https://<org>-<account>.snowflakecomputing.com. - warehouse string
- The Snowflake warehouse, exactly as stored (unquoted names are uppercased: descopewh->DESCOPEWH). Run SHOW WAREHOUSES to check. Defaults to
COMPUTE_WH. - account
Identifier string - Overrides the account identifier derived from the Account URL. Only needed for PrivateLink or legacy region locators.
- api
Key string - A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges, unless Self Provision is enabled - in which case it only needs write access to the table you created.
- audit
Enabled boolean - Whether to enable streaming of audit events.
- audit
Filters SnowflakeConnector Audit Filter[] - Specify which events will be sent to the external audit service (including tenant selection).
- audit
Table string - The table to write audit events to, exactly as stored (unquoted names are uppercased: auditlogs->AUDITLOGS). Run SHOW TABLES to check. Defaults to
DESCOPE_AUDIT_LOGS. - auth
Type string - How Descope authenticates to the Snowflake SQL API. See the connector documentation for the setup steps of each method.
- description string
- A description of what your connector is used for.
- disabled boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask
Pii boolean - Whether to mask personally identifiable information in the logs.
- min
Flush numberInterval Minutes - The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
- name string
- A custom name for your connector.
- private
Key string - The private key in PEM format, RSA 2048-bit or stronger. Descope reads PKCS#8 encrypted with PBES2, or unencrypted PKCS#8 or PKCS#1. For Snowflake's own key-pair requirements see https://docs.snowflake.com/en/user-guide/key-pair-auth.
- private
Key stringPassphrase - Required only if the private key is passphrase-protected. Leave empty for an unencrypted key.
- self
Provision boolean - Create the database, table and schema in Snowflake manually instead of allowing the connector to create them. Useful when the Snowflake user Descope authenticates as is restricted to minimal or write-only privileges.
- snowflake
User string - The Snowflake user Descope authenticates as. The public key must be registered on this user with
ALTER USER ... SET RSA_PUBLIC_KEY. - troubleshoot
Log booleanEnabled - Whether to send troubleshooting events.
- database str
- The Snowflake database, exactly as stored (unquoted names are uppercased: descopedb->DESCOPEDB). Run SHOW DATABASES to check. Defaults to
DESCOPE_EXPORT_DB. - project_
id str - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- schema str
- The schema within the database, exactly as stored (unquoted names are uppercased: public->PUBLIC). Run SHOW SCHEMAS to check. Defaults to
PUBLIC. - site str
- Your Snowflake account URL, e.g.
https://<org>-<account>.snowflakecomputing.com. - warehouse str
- The Snowflake warehouse, exactly as stored (unquoted names are uppercased: descopewh->DESCOPEWH). Run SHOW WAREHOUSES to check. Defaults to
COMPUTE_WH. - account_
identifier str - Overrides the account identifier derived from the Account URL. Only needed for PrivateLink or legacy region locators.
- api_
key str - A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges, unless Self Provision is enabled - in which case it only needs write access to the table you created.
- audit_
enabled bool - Whether to enable streaming of audit events.
- audit_
filters Sequence[SnowflakeConnector Audit Filter Args] - Specify which events will be sent to the external audit service (including tenant selection).
- audit_
table str - The table to write audit events to, exactly as stored (unquoted names are uppercased: auditlogs->AUDITLOGS). Run SHOW TABLES to check. Defaults to
DESCOPE_AUDIT_LOGS. - auth_
type str - How Descope authenticates to the Snowflake SQL API. See the connector documentation for the setup steps of each method.
- description str
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask_
pii bool - Whether to mask personally identifiable information in the logs.
- min_
flush_ floatinterval_ minutes - The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
- name str
- A custom name for your connector.
- private_
key str - The private key in PEM format, RSA 2048-bit or stronger. Descope reads PKCS#8 encrypted with PBES2, or unencrypted PKCS#8 or PKCS#1. For Snowflake's own key-pair requirements see https://docs.snowflake.com/en/user-guide/key-pair-auth.
- private_
key_ strpassphrase - Required only if the private key is passphrase-protected. Leave empty for an unencrypted key.
- self_
provision bool - Create the database, table and schema in Snowflake manually instead of allowing the connector to create them. Useful when the Snowflake user Descope authenticates as is restricted to minimal or write-only privileges.
- snowflake_
user str - The Snowflake user Descope authenticates as. The public key must be registered on this user with
ALTER USER ... SET RSA_PUBLIC_KEY. - troubleshoot_
log_ boolenabled - Whether to send troubleshooting events.
- database String
- The Snowflake database, exactly as stored (unquoted names are uppercased: descopedb->DESCOPEDB). Run SHOW DATABASES to check. Defaults to
DESCOPE_EXPORT_DB. - project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- schema String
- The schema within the database, exactly as stored (unquoted names are uppercased: public->PUBLIC). Run SHOW SCHEMAS to check. Defaults to
PUBLIC. - site String
- Your Snowflake account URL, e.g.
https://<org>-<account>.snowflakecomputing.com. - warehouse String
- The Snowflake warehouse, exactly as stored (unquoted names are uppercased: descopewh->DESCOPEWH). Run SHOW WAREHOUSES to check. Defaults to
COMPUTE_WH. - account
Identifier String - Overrides the account identifier derived from the Account URL. Only needed for PrivateLink or legacy region locators.
- api
Key String - A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges, unless Self Provision is enabled - in which case it only needs write access to the table you created.
- audit
Enabled Boolean - Whether to enable streaming of audit events.
- audit
Filters List<Property Map> - Specify which events will be sent to the external audit service (including tenant selection).
- audit
Table String - The table to write audit events to, exactly as stored (unquoted names are uppercased: auditlogs->AUDITLOGS). Run SHOW TABLES to check. Defaults to
DESCOPE_AUDIT_LOGS. - auth
Type String - How Descope authenticates to the Snowflake SQL API. See the connector documentation for the setup steps of each method.
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask
Pii Boolean - Whether to mask personally identifiable information in the logs.
- min
Flush NumberInterval Minutes - The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
- name String
- A custom name for your connector.
- private
Key String - The private key in PEM format, RSA 2048-bit or stronger. Descope reads PKCS#8 encrypted with PBES2, or unencrypted PKCS#8 or PKCS#1. For Snowflake's own key-pair requirements see https://docs.snowflake.com/en/user-guide/key-pair-auth.
- private
Key StringPassphrase - Required only if the private key is passphrase-protected. Leave empty for an unencrypted key.
- self
Provision Boolean - Create the database, table and schema in Snowflake manually instead of allowing the connector to create them. Useful when the Snowflake user Descope authenticates as is restricted to minimal or write-only privileges.
- snowflake
User String - The Snowflake user Descope authenticates as. The public key must be registered on this user with
ALTER USER ... SET RSA_PUBLIC_KEY. - troubleshoot
Log BooleanEnabled - Whether to send troubleshooting events.
Outputs
All input properties are implicitly available as output properties. Additionally, the SnowflakeConnector 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 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.
Look up Existing SnowflakeConnector Resource
Get an existing SnowflakeConnector resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SnowflakeConnectorState, opts?: CustomResourceOptions): SnowflakeConnector@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_identifier: Optional[str] = None,
api_key: Optional[str] = None,
audit_enabled: Optional[bool] = None,
audit_filters: Optional[Sequence[SnowflakeConnectorAuditFilterArgs]] = None,
audit_table: Optional[str] = None,
auth_type: Optional[str] = None,
database: Optional[str] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
mask_pii: Optional[bool] = None,
min_flush_interval_minutes: Optional[float] = None,
name: Optional[str] = None,
private_key: Optional[str] = None,
private_key_passphrase: Optional[str] = None,
project_id: Optional[str] = None,
schema: Optional[str] = None,
self_provision: Optional[bool] = None,
site: Optional[str] = None,
snowflake_user: Optional[str] = None,
troubleshoot_log_enabled: Optional[bool] = None,
warehouse: Optional[str] = None) -> SnowflakeConnectorfunc GetSnowflakeConnector(ctx *Context, name string, id IDInput, state *SnowflakeConnectorState, opts ...ResourceOption) (*SnowflakeConnector, error)public static SnowflakeConnector Get(string name, Input<string> id, SnowflakeConnectorState? state, CustomResourceOptions? opts = null)public static SnowflakeConnector get(String name, Output<String> id, SnowflakeConnectorState state, CustomResourceOptions options)resources: existingSnowflakeConnector: type: descope:SnowflakeConnector get: id: ${id}import {
to = descope_snowflake_connector.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state SnowflakeConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state SnowflakeConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state SnowflakeConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state SnowflakeConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Account
Identifier string - Overrides the account identifier derived from the Account URL. Only needed for PrivateLink or legacy region locators.
- Api
Key string - A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges, unless Self Provision is enabled - in which case it only needs write access to the table you created.
- Audit
Enabled bool - Whether to enable streaming of audit events.
- Audit
Filters List<Descope.Snowflake Connector Audit Filter> - Specify which events will be sent to the external audit service (including tenant selection).
- Audit
Table string - The table to write audit events to, exactly as stored (unquoted names are uppercased: auditlogs->AUDITLOGS). Run SHOW TABLES to check. Defaults to
DESCOPE_AUDIT_LOGS. - Auth
Type string - How Descope authenticates to the Snowflake SQL API. See the connector documentation for the setup steps of each method.
- Database string
- The Snowflake database, exactly as stored (unquoted names are uppercased: descopedb->DESCOPEDB). Run SHOW DATABASES to check. Defaults to
DESCOPE_EXPORT_DB. - Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Mask
Pii bool - Whether to mask personally identifiable information in the logs.
- Min
Flush doubleInterval Minutes - The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
- Name string
- A custom name for your connector.
- Private
Key string - The private key in PEM format, RSA 2048-bit or stronger. Descope reads PKCS#8 encrypted with PBES2, or unencrypted PKCS#8 or PKCS#1. For Snowflake's own key-pair requirements see https://docs.snowflake.com/en/user-guide/key-pair-auth.
- Private
Key stringPassphrase - Required only if the private key is passphrase-protected. Leave empty for an unencrypted key.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Schema string
- The schema within the database, exactly as stored (unquoted names are uppercased: public->PUBLIC). Run SHOW SCHEMAS to check. Defaults to
PUBLIC. - Self
Provision bool - Create the database, table and schema in Snowflake manually instead of allowing the connector to create them. Useful when the Snowflake user Descope authenticates as is restricted to minimal or write-only privileges.
- Site string
- Your Snowflake account URL, e.g.
https://<org>-<account>.snowflakecomputing.com. - Snowflake
User string - The Snowflake user Descope authenticates as. The public key must be registered on this user with
ALTER USER ... SET RSA_PUBLIC_KEY. - Troubleshoot
Log boolEnabled - Whether to send troubleshooting events.
- Warehouse string
- The Snowflake warehouse, exactly as stored (unquoted names are uppercased: descopewh->DESCOPEWH). Run SHOW WAREHOUSES to check. Defaults to
COMPUTE_WH.
- Account
Identifier string - Overrides the account identifier derived from the Account URL. Only needed for PrivateLink or legacy region locators.
- Api
Key string - A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges, unless Self Provision is enabled - in which case it only needs write access to the table you created.
- Audit
Enabled bool - Whether to enable streaming of audit events.
- Audit
Filters []SnowflakeConnector Audit Filter Args - Specify which events will be sent to the external audit service (including tenant selection).
- Audit
Table string - The table to write audit events to, exactly as stored (unquoted names are uppercased: auditlogs->AUDITLOGS). Run SHOW TABLES to check. Defaults to
DESCOPE_AUDIT_LOGS. - Auth
Type string - How Descope authenticates to the Snowflake SQL API. See the connector documentation for the setup steps of each method.
- Database string
- The Snowflake database, exactly as stored (unquoted names are uppercased: descopedb->DESCOPEDB). Run SHOW DATABASES to check. Defaults to
DESCOPE_EXPORT_DB. - Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Mask
Pii bool - Whether to mask personally identifiable information in the logs.
- Min
Flush float64Interval Minutes - The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
- Name string
- A custom name for your connector.
- Private
Key string - The private key in PEM format, RSA 2048-bit or stronger. Descope reads PKCS#8 encrypted with PBES2, or unencrypted PKCS#8 or PKCS#1. For Snowflake's own key-pair requirements see https://docs.snowflake.com/en/user-guide/key-pair-auth.
- Private
Key stringPassphrase - Required only if the private key is passphrase-protected. Leave empty for an unencrypted key.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Schema string
- The schema within the database, exactly as stored (unquoted names are uppercased: public->PUBLIC). Run SHOW SCHEMAS to check. Defaults to
PUBLIC. - Self
Provision bool - Create the database, table and schema in Snowflake manually instead of allowing the connector to create them. Useful when the Snowflake user Descope authenticates as is restricted to minimal or write-only privileges.
- Site string
- Your Snowflake account URL, e.g.
https://<org>-<account>.snowflakecomputing.com. - Snowflake
User string - The Snowflake user Descope authenticates as. The public key must be registered on this user with
ALTER USER ... SET RSA_PUBLIC_KEY. - Troubleshoot
Log boolEnabled - Whether to send troubleshooting events.
- Warehouse string
- The Snowflake warehouse, exactly as stored (unquoted names are uppercased: descopewh->DESCOPEWH). Run SHOW WAREHOUSES to check. Defaults to
COMPUTE_WH.
- account_
identifier string - Overrides the account identifier derived from the Account URL. Only needed for PrivateLink or legacy region locators.
- api_
key string - A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges, unless Self Provision is enabled - in which case it only needs write access to the table you created.
- audit_
enabled bool - Whether to enable streaming of audit events.
- audit_
filters list(object) - Specify which events will be sent to the external audit service (including tenant selection).
- audit_
table string - The table to write audit events to, exactly as stored (unquoted names are uppercased: auditlogs->AUDITLOGS). Run SHOW TABLES to check. Defaults to
DESCOPE_AUDIT_LOGS. - auth_
type string - How Descope authenticates to the Snowflake SQL API. See the connector documentation for the setup steps of each method.
- database string
- The Snowflake database, exactly as stored (unquoted names are uppercased: descopedb->DESCOPEDB). Run SHOW DATABASES to check. Defaults to
DESCOPE_EXPORT_DB. - description string
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask_
pii bool - Whether to mask personally identifiable information in the logs.
- min_
flush_ numberinterval_ minutes - The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
- name string
- A custom name for your connector.
- private_
key string - The private key in PEM format, RSA 2048-bit or stronger. Descope reads PKCS#8 encrypted with PBES2, or unencrypted PKCS#8 or PKCS#1. For Snowflake's own key-pair requirements see https://docs.snowflake.com/en/user-guide/key-pair-auth.
- private_
key_ stringpassphrase - Required only if the private key is passphrase-protected. Leave empty for an unencrypted key.
- project_
id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- schema string
- The schema within the database, exactly as stored (unquoted names are uppercased: public->PUBLIC). Run SHOW SCHEMAS to check. Defaults to
PUBLIC. - self_
provision bool - Create the database, table and schema in Snowflake manually instead of allowing the connector to create them. Useful when the Snowflake user Descope authenticates as is restricted to minimal or write-only privileges.
- site string
- Your Snowflake account URL, e.g.
https://<org>-<account>.snowflakecomputing.com. - snowflake_
user string - The Snowflake user Descope authenticates as. The public key must be registered on this user with
ALTER USER ... SET RSA_PUBLIC_KEY. - troubleshoot_
log_ boolenabled - Whether to send troubleshooting events.
- warehouse string
- The Snowflake warehouse, exactly as stored (unquoted names are uppercased: descopewh->DESCOPEWH). Run SHOW WAREHOUSES to check. Defaults to
COMPUTE_WH.
- account
Identifier String - Overrides the account identifier derived from the Account URL. Only needed for PrivateLink or legacy region locators.
- api
Key String - A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges, unless Self Provision is enabled - in which case it only needs write access to the table you created.
- audit
Enabled Boolean - Whether to enable streaming of audit events.
- audit
Filters List<SnowflakeConnector Audit Filter> - Specify which events will be sent to the external audit service (including tenant selection).
- audit
Table String - The table to write audit events to, exactly as stored (unquoted names are uppercased: auditlogs->AUDITLOGS). Run SHOW TABLES to check. Defaults to
DESCOPE_AUDIT_LOGS. - auth
Type String - How Descope authenticates to the Snowflake SQL API. See the connector documentation for the setup steps of each method.
- database String
- The Snowflake database, exactly as stored (unquoted names are uppercased: descopedb->DESCOPEDB). Run SHOW DATABASES to check. Defaults to
DESCOPE_EXPORT_DB. - description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask
Pii Boolean - Whether to mask personally identifiable information in the logs.
- min
Flush DoubleInterval Minutes - The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
- name String
- A custom name for your connector.
- private
Key String - The private key in PEM format, RSA 2048-bit or stronger. Descope reads PKCS#8 encrypted with PBES2, or unencrypted PKCS#8 or PKCS#1. For Snowflake's own key-pair requirements see https://docs.snowflake.com/en/user-guide/key-pair-auth.
- private
Key StringPassphrase - Required only if the private key is passphrase-protected. Leave empty for an unencrypted key.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- schema String
- The schema within the database, exactly as stored (unquoted names are uppercased: public->PUBLIC). Run SHOW SCHEMAS to check. Defaults to
PUBLIC. - self
Provision Boolean - Create the database, table and schema in Snowflake manually instead of allowing the connector to create them. Useful when the Snowflake user Descope authenticates as is restricted to minimal or write-only privileges.
- site String
- Your Snowflake account URL, e.g.
https://<org>-<account>.snowflakecomputing.com. - snowflake
User String - The Snowflake user Descope authenticates as. The public key must be registered on this user with
ALTER USER ... SET RSA_PUBLIC_KEY. - troubleshoot
Log BooleanEnabled - Whether to send troubleshooting events.
- warehouse String
- The Snowflake warehouse, exactly as stored (unquoted names are uppercased: descopewh->DESCOPEWH). Run SHOW WAREHOUSES to check. Defaults to
COMPUTE_WH.
- account
Identifier string - Overrides the account identifier derived from the Account URL. Only needed for PrivateLink or legacy region locators.
- api
Key string - A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges, unless Self Provision is enabled - in which case it only needs write access to the table you created.
- audit
Enabled boolean - Whether to enable streaming of audit events.
- audit
Filters SnowflakeConnector Audit Filter[] - Specify which events will be sent to the external audit service (including tenant selection).
- audit
Table string - The table to write audit events to, exactly as stored (unquoted names are uppercased: auditlogs->AUDITLOGS). Run SHOW TABLES to check. Defaults to
DESCOPE_AUDIT_LOGS. - auth
Type string - How Descope authenticates to the Snowflake SQL API. See the connector documentation for the setup steps of each method.
- database string
- The Snowflake database, exactly as stored (unquoted names are uppercased: descopedb->DESCOPEDB). Run SHOW DATABASES to check. Defaults to
DESCOPE_EXPORT_DB. - description string
- A description of what your connector is used for.
- disabled boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask
Pii boolean - Whether to mask personally identifiable information in the logs.
- min
Flush numberInterval Minutes - The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
- name string
- A custom name for your connector.
- private
Key string - The private key in PEM format, RSA 2048-bit or stronger. Descope reads PKCS#8 encrypted with PBES2, or unencrypted PKCS#8 or PKCS#1. For Snowflake's own key-pair requirements see https://docs.snowflake.com/en/user-guide/key-pair-auth.
- private
Key stringPassphrase - Required only if the private key is passphrase-protected. Leave empty for an unencrypted key.
- project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- schema string
- The schema within the database, exactly as stored (unquoted names are uppercased: public->PUBLIC). Run SHOW SCHEMAS to check. Defaults to
PUBLIC. - self
Provision boolean - Create the database, table and schema in Snowflake manually instead of allowing the connector to create them. Useful when the Snowflake user Descope authenticates as is restricted to minimal or write-only privileges.
- site string
- Your Snowflake account URL, e.g.
https://<org>-<account>.snowflakecomputing.com. - snowflake
User string - The Snowflake user Descope authenticates as. The public key must be registered on this user with
ALTER USER ... SET RSA_PUBLIC_KEY. - troubleshoot
Log booleanEnabled - Whether to send troubleshooting events.
- warehouse string
- The Snowflake warehouse, exactly as stored (unquoted names are uppercased: descopewh->DESCOPEWH). Run SHOW WAREHOUSES to check. Defaults to
COMPUTE_WH.
- account_
identifier str - Overrides the account identifier derived from the Account URL. Only needed for PrivateLink or legacy region locators.
- api_
key str - A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges, unless Self Provision is enabled - in which case it only needs write access to the table you created.
- audit_
enabled bool - Whether to enable streaming of audit events.
- audit_
filters Sequence[SnowflakeConnector Audit Filter Args] - Specify which events will be sent to the external audit service (including tenant selection).
- audit_
table str - The table to write audit events to, exactly as stored (unquoted names are uppercased: auditlogs->AUDITLOGS). Run SHOW TABLES to check. Defaults to
DESCOPE_AUDIT_LOGS. - auth_
type str - How Descope authenticates to the Snowflake SQL API. See the connector documentation for the setup steps of each method.
- database str
- The Snowflake database, exactly as stored (unquoted names are uppercased: descopedb->DESCOPEDB). Run SHOW DATABASES to check. Defaults to
DESCOPE_EXPORT_DB. - description str
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask_
pii bool - Whether to mask personally identifiable information in the logs.
- min_
flush_ floatinterval_ minutes - The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
- name str
- A custom name for your connector.
- private_
key str - The private key in PEM format, RSA 2048-bit or stronger. Descope reads PKCS#8 encrypted with PBES2, or unencrypted PKCS#8 or PKCS#1. For Snowflake's own key-pair requirements see https://docs.snowflake.com/en/user-guide/key-pair-auth.
- private_
key_ strpassphrase - Required only if the private key is passphrase-protected. Leave empty for an unencrypted key.
- project_
id str - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- schema str
- The schema within the database, exactly as stored (unquoted names are uppercased: public->PUBLIC). Run SHOW SCHEMAS to check. Defaults to
PUBLIC. - self_
provision bool - Create the database, table and schema in Snowflake manually instead of allowing the connector to create them. Useful when the Snowflake user Descope authenticates as is restricted to minimal or write-only privileges.
- site str
- Your Snowflake account URL, e.g.
https://<org>-<account>.snowflakecomputing.com. - snowflake_
user str - The Snowflake user Descope authenticates as. The public key must be registered on this user with
ALTER USER ... SET RSA_PUBLIC_KEY. - troubleshoot_
log_ boolenabled - Whether to send troubleshooting events.
- warehouse str
- The Snowflake warehouse, exactly as stored (unquoted names are uppercased: descopewh->DESCOPEWH). Run SHOW WAREHOUSES to check. Defaults to
COMPUTE_WH.
- account
Identifier String - Overrides the account identifier derived from the Account URL. Only needed for PrivateLink or legacy region locators.
- api
Key String - A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges, unless Self Provision is enabled - in which case it only needs write access to the table you created.
- audit
Enabled Boolean - Whether to enable streaming of audit events.
- audit
Filters List<Property Map> - Specify which events will be sent to the external audit service (including tenant selection).
- audit
Table String - The table to write audit events to, exactly as stored (unquoted names are uppercased: auditlogs->AUDITLOGS). Run SHOW TABLES to check. Defaults to
DESCOPE_AUDIT_LOGS. - auth
Type String - How Descope authenticates to the Snowflake SQL API. See the connector documentation for the setup steps of each method.
- database String
- The Snowflake database, exactly as stored (unquoted names are uppercased: descopedb->DESCOPEDB). Run SHOW DATABASES to check. Defaults to
DESCOPE_EXPORT_DB. - description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask
Pii Boolean - Whether to mask personally identifiable information in the logs.
- min
Flush NumberInterval Minutes - The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
- name String
- A custom name for your connector.
- private
Key String - The private key in PEM format, RSA 2048-bit or stronger. Descope reads PKCS#8 encrypted with PBES2, or unencrypted PKCS#8 or PKCS#1. For Snowflake's own key-pair requirements see https://docs.snowflake.com/en/user-guide/key-pair-auth.
- private
Key StringPassphrase - Required only if the private key is passphrase-protected. Leave empty for an unencrypted key.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- schema String
- The schema within the database, exactly as stored (unquoted names are uppercased: public->PUBLIC). Run SHOW SCHEMAS to check. Defaults to
PUBLIC. - self
Provision Boolean - Create the database, table and schema in Snowflake manually instead of allowing the connector to create them. Useful when the Snowflake user Descope authenticates as is restricted to minimal or write-only privileges.
- site String
- Your Snowflake account URL, e.g.
https://<org>-<account>.snowflakecomputing.com. - snowflake
User String - The Snowflake user Descope authenticates as. The public key must be registered on this user with
ALTER USER ... SET RSA_PUBLIC_KEY. - troubleshoot
Log BooleanEnabled - Whether to send troubleshooting events.
- warehouse String
- The Snowflake warehouse, exactly as stored (unquoted names are uppercased: descopewh->DESCOPEWH). Run SHOW WAREHOUSES to check. Defaults to
COMPUTE_WH.
Supporting Types
SnowflakeConnectorAuditFilter, SnowflakeConnectorAuditFilterArgs
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope