Versions in this module Expand all Collapse all v1 v1.0.1 Apr 27, 2026 Changes in this version + const DefaultTerragruntConfigPath + const DefaultTerragruntJsonConfigPath + const FoundInFile + const MaxIter + const MetadataDependencies + const MetadataDependency + const MetadataDependentModules + const MetadataDownloadDir + const MetadataGenerateConfigs + const MetadataIamAssumeRoleDuration + const MetadataIamAssumeRoleSessionName + const MetadataIamRole + const MetadataInputs + const MetadataLocals + const MetadataPreventDestroy + const MetadataRemoteState + const MetadataRetryMaxAttempts + const MetadataRetrySleepIntervalSec + const MetadataRetryableErrors + const MetadataSkip + const MetadataTerraform + const MetadataTerraformBinary + const MetadataTerraformVersionConstraint + const MetadataTerragruntVersionConstraint + var DefaultTerragruntConfigPaths = []string + var TERRAFORM_COMMANDS_NEED_INPUT = []string + var TERRAFORM_COMMANDS_NEED_LOCKING = []string + var TERRAFORM_COMMANDS_NEED_PARALLELISM = []string + var TERRAFORM_COMMANDS_NEED_VARS = []string + func ClearOutputCache() + func CreateTerragruntEvalContext(filename string, terragruntOptions *options.TerragruntOptions, ...) (*hcl.EvalContext, error) + func FindConfigFilesInPath(rootPath string, terragruntOptions *options.TerragruntOptions) ([]string, error) + func GetDefaultConfigPath(workingDir string) string + func GetTerraformSourceUrl(terragruntOptions *options.TerragruntOptions, ...) (string, error) + func GetTerragruntSourceForModule(sourcePath string, modulePath string, moduleTerragruntConfig *TerragruntConfig) (string, error) + func ParseAndDecodeVarFile(hclContents string, filename string, out interface{}) (err error) + func TerragruntConfigAsCty(config *TerragruntConfig) (cty.Value, error) + func TerragruntConfigAsCtyWithMetadata(config *TerragruntConfig) (cty.Value, error) + type CouldNotEvaluateAllLocalsError struct + func (err CouldNotEvaluateAllLocalsError) Error() string + type CouldNotResolveTerragruntConfigInFile string + func (err CouldNotResolveTerragruntConfigInFile) Error() string + type CtyJsonOutput struct + Type interface{} + Value map[string]interface{} + type Dependency struct + ConfigPath string + Enabled *bool + MockOutputs *cty.Value + MockOutputsAllowedTerraformCommands *[]string + MockOutputsMergeStrategyWithState *MergeStrategyType + MockOutputsMergeWithState *bool + Name string + RenderedOutputs *cty.Value + SkipOutputs *bool + func (dependencyConfig *Dependency) DeepMerge(sourceDepConfig Dependency) error + type DependencyConfigNotFound struct + Path string + func (err DependencyConfigNotFound) Error() string + type DependencyCycle []string + func (err DependencyCycle) Error() string + type DependencyDirNotFound struct + Dir []string + func (err DependencyDirNotFound) Error() string + type DuplicatedGenerateBlocks struct + BlockName []string + func (err DuplicatedGenerateBlocks) Error() string + type EmptyStringNotAllowed string + func (err EmptyStringNotAllowed) Error() string + type EnvVar struct + DefaultValue string + IsRequired bool + Name string + type EnvVarNotFound struct + EnvVar string + func (err EnvVarNotFound) Error() string + type ErrorHook struct + Commands []string + Execute []string + Name string + OnErrors []string + SuppressStdout *bool + WorkingDir *string + func (conf *ErrorHook) String() string + func (conf ErrorHook) GetName() string + type ErrorParsingModulePath struct + ModuleSourceUrl string + func (err ErrorParsingModulePath) Error() string + type ErrorParsingTerragruntConfig struct + ConfigPath string + Underlying error + func (err ErrorParsingTerragruntConfig) Error() string + type EvalContextExtensions struct + DecodedDependencies *cty.Value + Locals *cty.Value + PartialParseDecodeList []PartialDecodeSectionType + TrackInclude *TrackInclude + type Hook struct + Commands []string + Execute []string + Name string + RunOnError *bool + SuppressStdout *bool + WorkingDir *string + func (conf *Hook) String() string + func (conf Hook) GetName() string + type IAMRoleOptionsCache struct + Cache map[string]options.IAMRoleOptions + Mutex *sync.Mutex + func NewIAMRoleOptionsCache() *IAMRoleOptionsCache + func (cache *IAMRoleOptionsCache) Get(key string) (options.IAMRoleOptions, bool) + func (cache *IAMRoleOptionsCache) Put(key string, value options.IAMRoleOptions) + type IncludeConfig struct + Expose *bool + MergeStrategy *string + Name string + Path string + func (cfg *IncludeConfig) GetExpose() bool + func (cfg *IncludeConfig) GetMergeStrategy() (MergeStrategyType, error) + func (cfg *IncludeConfig) String() string + type IncludeConfigs map[string]IncludeConfig + func (cfgs IncludeConfigs) ContainsPath(path string) bool + type IncludeIsNotABlockErr struct + func (err IncludeIsNotABlockErr) Error() string + type IncludedConfigMissingPath string + func (err IncludedConfigMissingPath) Error() string + type InvalidArgError string + func (e InvalidArgError) Error() string + type InvalidBackendConfigType struct + ActualType string + ExpectedType string + func (err InvalidBackendConfigType) Error() string + type InvalidEnvParamName struct + EnvVarName string + func (err InvalidEnvParamName) Error() string + type InvalidGetEnvParams struct + ActualNumParams int + Example string + func (err InvalidGetEnvParams) Error() string + type InvalidIncludeKey struct + func (err InvalidIncludeKey) Error() string + type InvalidMergeStrategyType string + func (err InvalidMergeStrategyType) Error() string + type InvalidParameterType struct + Actual string + Expected string + func (err InvalidParameterType) Error() string + type InvalidPartialBlockName struct + func (err InvalidPartialBlockName) Error() string + type InvalidSopsFormat struct + SourceFilePath string + func (err InvalidSopsFormat) Error() string + type InvalidSourceUrl struct + ModulePath string + ModuleSourceUrl string + TerragruntSource string + func (err InvalidSourceUrl) Error() string + type InvalidSourceUrlWithMap struct + ModulePath string + ModuleSourceUrl string + func (err InvalidSourceUrlWithMap) Error() string + type Local struct + Expr hcl.Expression + Name string + type MaxIterError struct + func (err MaxIterError) Error() string + type MergeStrategyType string + const DeepMerge + const DeepMergeMapOnly + const NoMerge + const ShallowMerge + type ModuleDependencies struct + Paths []string + func (deps *ModuleDependencies) Merge(source *ModuleDependencies) + func (deps *ModuleDependencies) String() string + type MultipleBareIncludeBlocksErr struct + func (err MultipleBareIncludeBlocksErr) Error() string + type PanicWhileParsingConfig struct + ConfigFile string + RecoveredValue interface{} + func (err PanicWhileParsingConfig) Error() string + type ParentFileNotFound struct + Cause string + File string + Path string + func (err ParentFileNotFound) Error() string + type PartialDecodeSectionType int + const DependenciesBlock + const DependencyBlock + const RemoteStateBlock + const TerraformBlock + const TerraformSource + const TerragruntFlags + const TerragruntVersionConstraints + type StringCache struct + Cache map[string]string + Mutex *sync.Mutex + func NewStringCache() *StringCache + func (cache *StringCache) Get(key string) (string, bool) + func (cache *StringCache) Put(key string, value string) + type TerraformConfig struct + AfterHooks []Hook + BeforeHooks []Hook + ErrorHooks []ErrorHook + ExtraArgs []TerraformExtraArguments + IncludeInCopy *[]string + Source *string + func (conf *TerraformConfig) GetAfterHooks() []Hook + func (conf *TerraformConfig) GetBeforeHooks() []Hook + func (conf *TerraformConfig) GetErrorHooks() []ErrorHook + func (conf *TerraformConfig) String() string + func (conf *TerraformConfig) ValidateHooks() error + type TerraformExtraArguments struct + Arguments *[]string + Commands []string + EnvVars *map[string]string + Name string + OptionalVarFiles *[]string + RequiredVarFiles *[]string + func (conf *TerraformExtraArguments) GetVarFiles(logger *logrus.Entry) []string + func (conf *TerraformExtraArguments) String() string + func (conf TerraformExtraArguments) GetName() string + type TerragruntConfig struct + Dependencies *ModuleDependencies + DependentModulesPath []*string + DownloadDir string + FieldsMetadata map[string]map[string]interface{} + GenerateConfigs map[string]codegen.GenerateConfig + IamAssumeRoleDuration *int64 + IamAssumeRoleSessionName string + IamRole string + Inputs map[string]interface{} + IsPartial bool + Locals map[string]interface{} + PreventDestroy *bool + ProcessedIncludes IncludeConfigs + RemoteState *remote.RemoteState + RetryMaxAttempts *int + RetrySleepIntervalSec *int + RetryableErrors []string + Skip bool + Terraform *TerraformConfig + TerraformBinary string + TerraformVersionConstraint string + TerragruntDependencies []Dependency + TerragruntVersionConstraint string + func ParseConfigFile(filename string, terragruntOptions *options.TerragruntOptions, ...) (*TerragruntConfig, error) + func ParseConfigString(configString string, terragruntOptions *options.TerragruntOptions, ...) (*TerragruntConfig, error) + func PartialParseConfigFile(filename string, terragruntOptions *options.TerragruntOptions, ...) (*TerragruntConfig, error) + func PartialParseConfigString(configString string, terragruntOptions *options.TerragruntOptions, ...) (*TerragruntConfig, error) + func ReadTerragruntConfig(terragruntOptions *options.TerragruntOptions) (*TerragruntConfig, error) + func TerragruntConfigFromPartialConfigString(configString string, terragruntOptions *options.TerragruntOptions, ...) (*TerragruntConfig, error) + func (conf *TerragruntConfig) DeepMerge(sourceConfig *TerragruntConfig, terragruntOptions *options.TerragruntOptions) error + func (conf *TerragruntConfig) GetFieldMetadata(fieldName string) (map[string]string, bool) + func (conf *TerragruntConfig) GetIAMRoleOptions() options.IAMRoleOptions + func (conf *TerragruntConfig) GetMapFieldMetadata(fieldType, fieldName string) (map[string]string, bool) + func (conf *TerragruntConfig) Merge(sourceConfig *TerragruntConfig, terragruntOptions *options.TerragruntOptions) error + func (conf *TerragruntConfig) SetFieldMetadata(fieldName string, m map[string]interface{}) + func (conf *TerragruntConfig) SetFieldMetadataMap(field string, data map[string]interface{}, metadata map[string]interface{}) + func (conf *TerragruntConfig) SetFieldMetadataWithType(fieldType, fieldName string, m map[string]interface{}) + func (conf *TerragruntConfig) String() string + type TerragruntConfigCache struct + Cache map[string]*TerragruntConfig + Mutex *sync.Mutex + func NewTerragruntConfigCache() *TerragruntConfigCache + func (cache *TerragruntConfigCache) Get(key string) (*TerragruntConfig, bool) + func (cache *TerragruntConfigCache) Put(key string, value *TerragruntConfig) + type TerragruntConfigFile struct + Dependencies *ModuleDependencies + DownloadDir *string + GenerateAttrs *cty.Value + GenerateBlocks []terragruntGenerateBlock + IamAssumeRoleDuration *int64 + IamAssumeRoleSessionName *string + IamRole *string + Include []terragruntIncludeIgnore + Inputs *cty.Value + Locals *terragruntLocal + PreventDestroy *bool + RemoteState *remoteStateConfigFile + RemoteStateAttr *cty.Value + RetryMaxAttempts *int + RetrySleepIntervalSec *int + RetryableErrors []string + Skip *bool + Terraform *TerraformConfig + TerraformBinary *string + TerraformVersionConstraint *string + TerragruntDependencies []Dependency + TerragruntVersionConstraint *string + type TerragruntConfigNotFound struct + Path string + func (err TerragruntConfigNotFound) Error() string + type TerragruntOutputEncodingError struct + Err error + Path string + func (err TerragruntOutputEncodingError) Error() string + type TerragruntOutputListEncodingError struct + Err error + Paths []string + func (err TerragruntOutputListEncodingError) Error() string + type TerragruntOutputParsingError struct + Err error + Path string + func (err TerragruntOutputParsingError) Error() string + type TerragruntOutputTargetNoOutputs struct + func (err TerragruntOutputTargetNoOutputs) Error() string + type TooManyLevelsOfInheritance struct + ConfigPath string + FirstLevelIncludePath string + SecondLevelIncludePath string + func (err TooManyLevelsOfInheritance) Error() string + type TrackInclude struct + CurrentList []IncludeConfig + CurrentMap map[string]IncludeConfig + Original *IncludeConfig + func DecodeBaseBlocks(terragruntOptions *options.TerragruntOptions, parser *hclparse.Parser, ...) (*cty.Value, *TrackInclude, error) + type ValueWithMetadata struct + Metadata map[string]string + Value cty.Value + type WrongNumberOfParams struct + Actual int + Expected string + Func string + func (err WrongNumberOfParams) Error() string