Skip to Content
DocumentationSpeakeasyGeneration ConfigTerraform Configuration

Terraform configuration options

This section details the available configuration options for Terraform Provider generation. All configuration is managed in the gen.yaml file under the terraform section.

Version and general configuration

terraform:
  version: 1.2.3
  author: "examplecorp"
  packageName: "examplecloud"
Name
version
Required
true
Description
Current version of the Terraform Provider.
Default Value
0.0.1
packageName
Required
true
Description
Terraform Provider name. Prefixes all resource names. For providers published in the public Terraform Registry, this typically matches the suffix after terraform-provider- in the GitHub Repository name.
Default Value
terraform
author
Required
true
Description
Terraform Provider namespace. For providers published in the public Terraform Registry, this typically matches the GitHub Organization name.
Default Value
speakeasy

Additions

terraform:
  additionalDependencies: {}
  additionalResources: []
  additionalDataSources: []
  additionalEphemeralResources: []
Name
additionalDependencies
Required
false
Description
Add additional dependencies to include in the generated
.
Default Value
{}
additionalResources
Required
false
Description
A list of
objects to insert into the provider resource list.
Default Value
[]
additionalDataSources
Required
false
Description
A list of
objects to insert into the provider data source list.
Default Value
[]
additionalEphemeralResources
Required
false
Description
A list of
objects to insert into the provider ephemeral resource list.
Default Value
[]

Environment variables

terraform:
  environmentVariables:
    - env: EXAMPLECLOUD_TOKEN
      providerAttribute: token
Name
environmentVariables
Required
false
Description
A list of objects with
keys/values to associate environment variables with a provider attribute.
Default Value
[]

Last updated on