# Terraform CLI

> For AI agents: the complete documentation index is at https://buddy.works/llms.txt

Execute Terraform CLI commands with integration-based authentication.

## YAML parameters for Terraform CLI

```typescript
interface YAMLParameters {
  type: "TERRAFORM";
  /** Unique identifier for the action within the pipeline. */
  action: string;
  /** Terraform integration (GOOGLE_SERVICE_ACCOUNT|AMAZON). It refers to an integration in the workspace by its identifier, not by its display name. */
  integration?: string;
  /** The cloud provider region for Terraform resources */
  region?: string;
  /** The version of Terraform to use. Defaults to `latest`. */
  version?: string;
  /** The Terraform backend configuration. Required when `integration` is set. Defaults to `CUSTOM` when no integration */
  backend?: "CUSTOM" | "AMAZON" | "GOOGLE" | "ARTIFACT";
  /** The artifact identifier used as the Terraform backend. Required when `backend` is `ARTIFACT` */
  artifact?: string;
  /** The version of the artifact used as the Terraform backend */
  artifact_version?: string;
  /** The directory in which the Terraform commands are executed. Available when `backend` is `ARTIFACT` */
  working_directory?: string;
  /** The name of the Terraform state stored in the backend */
  state_name?: string;
  /** The shell used to execute commands. Default: BASH. */
  shell?: "SH" | "BASH" | "POWERSHELL";
  /** Commands to run before the main commands (e.g., for installing dependencies). Several commands go in one multi-line string (a `|` block), one per line - not a YAML list. */
  setup_commands?: string;
  /** List of shell commands to execute. Several commands go in one multi-line string (a `|` block), one per line - not a YAML list. */
  commands?: string;
  /** Specifies when the action should be executed. ON_SUCCESS actions run after every successful run, also one ended by an EARLY_EXIT action. */
  trigger_time?: "ON_EVERY_EXECUTION" | "ON_SUCCESS" | "ON_FAILURE" | "ON_BACK_TO_SUCCESS" | "ON_WARNING" | "ON_WAIT_FOR_APPROVE" | "ON_TERMINATE";
  /** The list of variables for dynamic action execution. The action runs once for each value. */
  loop?: string[];
  /** When true, the action runs only on the first failure instead of on each failure. Used only when trigger_time is ON_FAILURE. */
  run_only_on_first_failure?: boolean;
  /** When set to true the action is disabled. By default it is set to false. */
  disabled?: boolean;
  /** The timeout in seconds. It cannot exceed the action time limit of the workspace plan; a higher value is rejected. */
  timeout?: number;
  /** If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions. */
  ignore_errors?: boolean;
  /** Delay time between auto retries in seconds. */
  retry_interval?: number;
  /** Number of retries if the action fails. */
  retry_count?: number;
  /** Defines whether the action should run in parallel with the next one. */
  run_next?: "WAIT_ON_SUCCESS" | "IN_SOFT_PARALLEL" | "IN_HARD_PARALLEL";
  /** The list of trigger conditions to meet so that the action can be triggered. */
  trigger_conditions?: TriggerConditionYaml[];
  /** The list of variables you can use in the action. */
  variables?: VariableYaml[];
}
```

## Type Definitions

```typescript
interface TriggerConditionYaml {
  /** The type of trigger condition. `ACTION_STATUS_IS` and `ACTION_STATUS_IS_NOT` are allowed only in an action's `trigger_conditions`. */
  trigger_condition: "ALWAYS" | "ON_CHANGE" | "ON_CHANGE_AT_PATH" | "VAR_IS" | "VAR_IS_NOT" | "VAR_CONTAINS" | "VAR_NOT_CONTAINS" | "DATETIME" | "SUCCESS_PIPELINE" | "DAY" | "HOUR" | "OR" | "VAR_LESS_THAN" | "VAR_LESS_THAN_OR_EQUAL" | "VAR_GREATER_THAN" | "VAR_GREATER_THAN_OR_EQUAL" | "ACTION_STATUS_IS" | "ACTION_STATUS_IS_NOT" | "TRIGGERING_USER_IS" | "TRIGGERING_USER_IS_NOT" | "TRIGGERING_USER_IS_IN_GROUP" | "TRIGGERING_USER_IS_NOT_IN_GROUP" | "ON_PAYLOAD" | "ON_PAYLOAD_AT_PATH";
  /** The value to compare the trigger variable against */
  trigger_variable_value?: string;
  /** The name of the variable to check in the trigger condition - an environment variable or a run variable (BUDDY_RUN_*), e.g. BUDDY_RUN_PR_DRAFT */
  trigger_variable_key?: string;
  /** The timezone for datetime trigger conditions (e.g., 'UTC', 'Europe/Warsaw') */
  timezone?: string;
  /** The hours when the datetime trigger should activate (0-23) */
  trigger_hours?: number[];
  /** The days when the datetime trigger should activate (1-7, where 1 is Monday) */
  trigger_days?: number[];
  /** The project name for cross-project pipeline triggers */
  project?: string;
  /** The pipeline name for cross-pipeline triggers */
  pipeline?: string;
  /** The username or email of the workspace member who can trigger the pipeline. The user must exist. */
  trigger_user?: string;
  /** The name of the workspace group that can trigger the pipeline. The group must exist. */
  trigger_group?: string;
  /** Paths for trigger_condition ON_CHANGE_AT_PATH (files that must change) and ON_PAYLOAD_AT_PATH (paths in the webhook payload); required for these two conditions and ignored by the others. */
  trigger_condition_paths?: string[];
  /** The action status to check for action status triggers */
  trigger_status?: "SUCCESSFUL" | "FAILED" | "SKIPPED" | "SUPPRESSED";
  /** The name of the action to check status for */
  trigger_action_name?: string;
  /** The list of nested trigger conditions combined with the OR operator. */
  trigger_operands?: TriggerConditionYaml[];
}

interface VariableYaml {
  /** The name of the variable */
  key: string;
  /** The value of the variable. With `encrypted: true` give the plain value - it is encrypted on import; an already encrypted value (`secure!...`, `!encrypted ...`) is accepted only in the workspace that encrypted it. For SSH_KEY give the whole private key - its format is validated and a variable reference is not accepted. For P12 give the base64-encoded PKCS12 keystore - it is opened with `password` on import. Masked to bare !encrypted without manage rights */
  value?: string;
  /** The type of the added variable */
  type?: "VAR" | "FILE" | "SSH_KEY" | "IOS_KEYCHAIN" | "IOS_PROVISION_PROFILES" | "SSH_PUBLIC_KEY" | "GPG_KEY" | "P12";
  /** If set to true the variable value will be encrypted and hidden */
  encrypted?: boolean;
  /** Initial path for the variable */
  init_path?: string;
  /** Default value for the variable */
  defaults?: string;
  /** Specifies where to copy the file on each run. Set if type is FILE, SSH_KEY, IOS_KEYCHAIN, or IOS_PROVISION_PROFILES. */
  file_path?: string;
  /** File permission set on copy to a container on each run. Set if type is FILE, SSH_KEY, IOS_KEYCHAIN, or IOS_PROVISION_PROFILES. */
  file_chmod?: string;
  /** Set if type is FILE, SSH_KEY, IOS_KEYCHAIN, or IOS_PROVISION_PROFILES. If it's NONE, the variable can be used as a parameter in an action. For CONTAINER, the given key is additionally copied to an action container on each run */
  file_place?: "NONE" | "CONTAINER";
  /** Password for certificates. Follows the same masking rules as value */
  password?: string;
  /** Passphrase for encrypted SSH keys. Follows the same masking rules as value */
  passphrase?: string;
  /** Key identifier for iOS certificates, provisioning profiles, or GPG keys */
  key_identifier?: string;
  /** Whether Buddy actions can set the variable value: DISABLED (default), ENABLED (the new value is kept for later runs) or RUN_ONLY (the new value applies to the current run only; not allowed for file, SSH key and SSH public key variables). Boolean `true` (unquoted) means ENABLED. */
  settable?: string;
  /** If set to true the variable is disabled and will not be injected anywhere */
  disabled?: boolean;
  /** Encoding of the variable value. Use `b64` for binary files (certificates, images, compiled blobs) where the value is already base64-encoded. Omit or set to `text` for plain text files (JSON, XML, config) — the system will handle encoding automatically. Only applies to non-encrypted asset variables (FILE, SSH_KEY, SSH_PUBLIC_KEY, IOS_KEYCHAIN, IOS_PROVISION_PROFILES). */
  encoding?: "text" | "b64";
  /** Note for this resource */
  note?: string;
  /** YAML note for AI agents operating on this resource */
  agent_note?: string;
}

```

## YAML examples for Terraform CLI

### Terraform infrastructure commands

```yaml
- action: "terraform plan -input=false"
  type: "TERRAFORM"
  version: "latest"
  commands: |-
    terraform init -input=false
    terraform plan -input=false
    #terraform apply -auto-approve -input=false
  backend: "CUSTOM"

```

### Terraform with AWS backend

```yaml
- action: "terraform plan -input=false"
  type: "TERRAFORM"
  commands: |-
    terraform init -input=false
    terraform plan -input=false
    #terraform apply -auto-approve -input=false
  version: "latest"
  integration: "amazon-web-services"
  backend: "AMAZON"

```

### Terraform with artifact state backend

```yaml
- action: "terraform plan -input=false"
  type: "TERRAFORM"
  commands: |-
    terraform init -input=false
    terraform plan -input=false
    #terraform apply -auto-approve -input=false
  version: "latest"
  backend: "ARTIFACT"
  artifact: "terraform-state"
  artifact_version: "1.0.0"
  working_directory: "/buddy/terraform"
  state_name: "production"

```


---
Original source: https://buddy.works/docs/yaml/yaml-actions/terraform