Authenticate the Terraform Provider

The VeloDB Terraform provider uses a VeloDB Cloud API key to call the Management API. Configure authentication before you define or manage VeloDB Cloud resources.

Authentication requirements

• Create an API key with an organization role that can manage every resource in your Terraform configuration. The key inherits the permissions of that role.
• Store the key in the VELODB_API_KEY environment variable. Do not put it in Terraform configuration, variable files, or source control.
• Set VELODB_HOST only when VeloDB Cloud Support provides a Management API host other than api.velodb.cloud. Use a bare hostname without https://.

Initialization downloads the provider but does not validate the API key. Terraform validates the credentials when a plan or apply operation calls the Management API.

Provider documentation

See the following references for installation, configuration, and all supported authentication arguments:

• VeloDB provider documentation
• Install Terraform
• Configure Terraform providers

Next steps

• Create a SaaS warehouse with Terraform.
• Create an AWS BYOC warehouse with Terraform.