terragrunt plan
Show changes required by the current configuration
Options
| Name | Description |
|---|---|
-compact-warnings | If Terraform produces any warnings that are not accompanied by errors, show them in a more compact form that includes only the summary messages |
-destroy | If set, generates a plan to destroy all the known resources |
-detailed-exitcode | Return a detailed exit code when the command exits |
-out | The path to save the generated execution plan |
-parallelism <number> | Limit the number of concurrent operation as Terraform walks the graph. Defaults to 10 |
-refresh <true or false> | Update the state prior to checking for differences |
-state <arg> | Path to the state file. Defaults to 'terraform.tfstate'. Ignored when remote state is used |
-target |
|
-var <foo=bar> |
|
-var-file <arg> | Set variables in the Terraform configuration from a variable file |
-lock <true or false> | Lock the state file when locking is supported. Defaults to true |
-force <true or false> | Delete the workspace even if its state is not empty. Defaults to false |
-lock-timeout <seconds> | Duration to retry a state lock. Default 0s |
-input <true or false> | Ask for input for variables if not directly set |
-no-color | Disables output with coloring |
-h, --help | Show this help output, or the help for a specified subcommand |
-v, --version | Show the current Terragrunt version |
--terragrunt-config <arg> | Path to the Terragrunt config file. Default is terragrunt.hcl |
--terragrunt-tfpath <arg> | Path to the Terraform binary. Default is terraform (on PATH) |
--terragrunt-no-auto-init | Don't automatically run 'terraform init' during other terragrunt commands. You must run 'terragrunt init' manually |
--terragrunt-no-auto-retry | Don't automatically re-run command in case of transient errors |
--terragrunt-non-interactive | Assume 'yes' for all prompts |
--terragrunt-working-dir <arg> | The path to the Terraform templates. Default is current directory |
--terragrunt-download-dir <arg> | The path where to download Terraform code. Default is .terragrunt-cache in the working directory |
--terragrunt-source <arg> | Download Terraform configurations from the specified source into a temporary folder, and run Terraform in that temporary folder |
--terragrunt-source-map | Replaces any source URL (including the source URL of a config pulled in with dependency blocks) that has root source with dest |
--terragrunt-source-update | Delete the contents of the temporary folder to clear out any old, cached source code before downloading new source code into it |
--terragrunt-ignore-dependency-errors | *-all commands continue processing components even if a dependency fails |
--terragrunt-iam-role <IAM role ARN> | Assume the specified IAM role before executing Terraform. Can also be set via the TERRAGRUNT_IAM_ROLE environment variable |
--terragrunt-iam-assume-role-duration <Duration> | Session duration for IAM Assume Role session. Can also be set via the TERRAGRUNT_IAM_ASSUME_ROLE_DURATION environment variable |
--terragrunt-iam-assume-role-session-name <Session name> | Name for the IAM Assummed Role session. Can also be set via TERRAGRUNT_IAM_ASSUME_ROLE_SESSION_NAME environment variable |
--terragrunt-exclude-dir <arg> | Unix-style glob of directories to exclude when running *-all commands |
--terragrunt-include-dir <arg> | Unix-style glob of directories to include when running *-all commands |
--terragrunt-strict-include | Only modules under the directories passed in with –terragrunt-include-dir will be included. All dependencies of the included directories will be excluded if they are not in the included directories. If no –terragrunt-include-dir flags are included, terragrunt will not include any modules during the execution of the commands |
--terragrunt-strict-validate | Sets strict mode for the validate-inputs command. By default, strict mode is off. When this flag is passed, strict mode is turned on. When strict mode is turned off, the validate-inputs command will only return an error if required inputs are missing from all input sources (env vars, var files, etc). When strict mode is turned on, an error will be returned if required inputs are missing OR if unused variables are passed to Terragrunt |
--terragrunt-ignore-dependency-order | *-all commands will be run disregarding the dependencies |
--terragrunt-ignore-external-dependencies | *-all commands will not attempt to include external dependencies |
--terragrunt-include-external-dependencies | *-all commands will include external dependencies |
--terragrunt-parallelism <N> | *-all commands parallelism set to at most N modules |
--terragrunt-debug | Write terragrunt-debug.tfvars to working folder to help root-cause issues |
--terragrunt-log-level | Sets the logging level for Terragrunt. Supported levels: panic, fatal, error, warn (default), info, debug, trace |
--terragrunt-check | Enable check mode in the hclfmt command |
--terragrunt-hclfmt-file <hcl file> | The path to a single hcl file that the hclfmt command should run on |
--terragrunt-override-attr <arg> | A key=value attribute to override in a provider block as part of the aws-provider-patch command. May be specified multiple times |
--terragrunt-json-out <arg> | The file path that terragrunt should use when rendering the terragrunt.hcl config as json. Only used in the render-json command. Defaults to terragrunt_rendered.json |
--terragrunt-modules-that-include <arg> | When passed in, run-all will only run the command against Terragrunt modules that include the specified file |