Skip to content

GenericSecret

Snowflake Documentation | Snowcap CLI label: generic_secret

A Secret defines a set of sensitive data that can be used for authentication or other purposes. This class defines a generic secret.

Examples

YAML

For sensitive values, use environment variables to avoid storing secrets in your repository. Set environment variables prefixed with SNOWCAP_VAR_ and reference them using {{ var.variable_name }} syntax.

# Set in your environment or .env file (loaded before running snowcap)
export SNOWCAP_VAR_API_KEY="your-secret-api-key"

secrets:
  - name: some_secret
    secret_type: GENERIC_STRING
    secret_string: "{{ var.api_key }}"
    comment: API key for external service
    owner: SYSADMIN

Python

import os

secret = GenericSecret(
    name="some_secret",
    secret_string=os.environ.get("API_KEY"),
    comment="API key for external service",
    owner="SYSADMIN",
)

Fields

  • name (string, required) - The name of the secret.
  • secret_string (string) - The secret string.
  • comment (string) - A comment for the secret.
  • owner (string or Role) - The owner of the secret. Defaults to SYSADMIN.