1. Docs
2. Reference
3. REST API Docs
4. Schema
5. GetTerraformModuleResponse

TerraformModule describes a Terraform module hosted in the Pulumi Cloud registry.

Properties

• name string required
  The module name.
• terraformSourceAddress string optional
  The Terraform/OpenTofu source address ("///") used to consume the module from a module block or pulumi package add terraform-module. Empty when the registry host is not configured.
• version string required
  The semantic version of this module version.
• publisher string required
  The organization or user that published the module (the Terraform namespace).
• sha256 string required
  The SHA-256 checksum of the module tarball.
• sizeBytes integer required
  The size of the module tarball in bytes.
• source string required
  The source identifier indicating where the module originates from (e.g. ‘private’).
• readme string optional
  The module README, rendered client-side. Absent when the module ships no README.
• system string required
  The Terraform provider system the module targets (e.g. ‘aws’, ‘azurerm’, ‘google’).
• description string optional
  A free-form text description of the module’s purpose.
• inputs array[TerraformModuleInput] required
  The input variables declared by the root module.
• ↳ name string required
  The variable name.
• ↳ type string optional
  The declared Terraform type of the variable, if any.
• ↳ description string optional
  The variable description, if any.
• ↳ defaultValue string optional
  The default value rendered as a string, if the variable declares one.
• ↳ required boolean required
  Whether the variable is required (declares no default).
• ↳ sensitive boolean required
  Whether the variable is marked sensitive.
• latestVersion string required
  The latest published semantic version of the module.
• outputs array[TerraformModuleOutput] required
  The outputs declared by the root module.
• ↳ name string required
  The output name.
• ↳ description string optional
  The output description, if any.
• ↳ sensitive boolean required
  Whether the output is marked sensitive.
• providerRequirements array[TerraformModuleProviderRequirement] required
  The provider requirements declared by the root module.
• ↳ name string required
  The local provider name (e.g. ‘aws’).
• ↳ source string optional
  The provider source address (e.g. ‘hashicorp/aws’), if declared.
• ↳ versionConstraint string optional
  The version constraint declared for the provider, if any.
• updatedAt string required
  The timestamp when the module was last updated.
• submodules array[TerraformModuleSubmodule] optional
  The submodules (modules//) shipped alongside the root module.
• ↳ name string required
  The submodule name (its directory under modules/).
• ↳ readme string optional
  The submodule README, rendered client-side. Absent when the submodule ships no README.
• ↳ inputs array[TerraformModuleInput] required
  The input variables declared by the submodule.
• ↳ outputs array[TerraformModuleOutput] required
  The outputs declared by the submodule.
• ↳ providerRequirements array[TerraformModuleProviderRequirement] required
  The provider requirements declared by the submodule.
• url string required
  The canonical registry:// URL identifying the module.
• examples array[TerraformModuleExample] optional
  The examples (examples//) shipped alongside the root module.
• ↳ name string required
  The example name (its directory under examples/).
• ↳ files map[string]string required
  The example files, keyed by path relative to the example directory.
• packageConversion TerraformModulePackageConversion optional
  The package conversion status for this version. Absent for versions published before conversion was enabled (not backfilled).
• ↳ status string required
  The conversion status: converting, converted, failed, or unsupported. A failed conversion may succeed on a retry; an unsupported one cannot, because the module uses Terraform features the bridge cannot express.
• ↳ failureReason string optional
  A fault code classifying why the conversion produced no package, not prose: unknown, transient, misconfigured, timed_out, missing_provider, unsupported_feature, invalid_version or module_error. Every code other than unknown is a positive classification; unknown means the conversion failed and nothing recognised why, so a retry has no established reason to succeed. Clients render their own wording from it. Present when the status is failed or unsupported.
• ↳ failureDetail string optional
  The conversion bridge’s own description of the module’s problem, safe to show verbatim. Present only when the module itself is at fault.
• ↳ packageVersionId string optional
  The Pulumi package version this conversion produced. Present when the status is converted.