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

TerraformModuleSubmodule describes a submodule (modules//) shipped alongside the root module, with its HCL parsed into the same shape as the root module.

Properties

• 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.
• ↳ 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.
• outputs array[TerraformModuleOutput] required
  The outputs declared by the submodule.
• ↳ 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 submodule.
• ↳ 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.