================
CODE SNIPPETS
================
TITLE: Sample Request: List Terraform Provider Installation Packages
DESCRIPTION: Example `curl` command to query download packages for version `2.0.0` of the `hashicorp/random` provider.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/provider-network-mirror-protocol.mdx#_snippet_6

LANGUAGE: shell
CODE:
```
curl 'https://terraform.example.com/providers/registry.terraform.io/hashicorp/random/2.0.0.json'
```

--------------------------------

TITLE: Example JSON for Provision Start Message
DESCRIPTION: This JSON snippet demonstrates the structure of a `provision_start` message from Terraform UI. It signifies the beginning of a resource provisioning operation, including the resource details and the type of provisioner being used.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/machine-readable-ui.mdx#_snippet_18

LANGUAGE: json
CODE:
```
{
  "@level": "info",
  "@message": "null_resource.none[0]: Provisioning with 'local-exec'...",
  "@module": "terraform.ui",
  "@timestamp": "2021-03-26T16:38:43.997431-04:00",
  "hook": {
    "resource": {
      "addr": "null_resource.none[0]",
      "module": "",
      "resource": "null_resource.none[0]",
      "implied_provider": "null",
      "resource_type": "null_resource",
      "resource_name": "none",
      "resource_key": 0
    },
    "provisioner": "local-exec"
  },
  "type": "provision_start"
}
```

--------------------------------

TITLE: Terraform UI Message: Ephemeral Operation Start Example
DESCRIPTION: This JSON example shows the `ephemeral_op_start` message, indicating the beginning of an ephemeral resource operation. It includes the resource details and the specific action being performed (e.g., "open").

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/machine-readable-ui.mdx#_snippet_26

LANGUAGE: json
CODE:
```
{
  "@level": "info",
  "@message": "ephemeral.random_password.example: Opening...",
  "@module": "terraform.ui",
  "@timestamp": "2024-10-30T10:34:26.222465-00:00",
  "hook": {
    "resource": {
      "addr": "ephemeral.random_password.example",
      "module": "",
      "resource": "ephemeral.random_password.example",
      "implied_provider": "random",
      "resource_type": "random_password",
      "resource_name": "example",
      "resource_key": null
    },
    "action": "open"
  },
  "type": "ephemeral_op_start"
}
```

--------------------------------

TITLE: Execute Credentials Helper for 'get' Operation
DESCRIPTION: Command-line execution example for the 'credstore' helper to retrieve credentials for a specific host using the 'get' verb. The helper prints a JSON object to stdout on success or an empty JSON object if no credentials are found.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/credentials-helpers.mdx#_snippet_2

LANGUAGE: Shell
CODE:
```
terraform-credentials-credstore --host=credstore.example.com get app.terraform.io
```

--------------------------------

TITLE: Example input for network and subnet variables
DESCRIPTION: Provides example HCL input values for the `networks` and `subnets` variables, demonstrating the expected structure and data for the `setproduct` example. This input will generate specific combinations for resource creation.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/setproduct.mdx#_snippet_8

LANGUAGE: HCL
CODE:
```
networks = {
  a = {
    base_cidr_block = "10.1.0.0/16"
  }
  b = {
    base_cidr_block = "10.2.0.0/16"
  }
}
subnets = {
  a = {
    number = 1
  }
  b = {
    number = 2
  }
  c = {
    number = 3
  }
}
```

--------------------------------

TITLE: Terraform Init: Provider Plugin Installation Options
DESCRIPTION: Describes how `terraform init` automatically finds, downloads, and installs necessary provider plugins from registries. It also explains how the dependency lock file is used to ensure consistent provider versions and options to override this.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/commands/init.mdx#_snippet_4

LANGUAGE: APIDOC
CODE:
```
-upgrade: Upgrades all previously-selected plugins to the newest version that complies with the configuration's version constraints, ignoring the dependency lock file.
-get-plugins=false: Skips plugin installation. (Superseded by `provider_installation` and `plugin_cache_dir` settings in Terraform 0.13+, removed in 0.15).
-plugin-dir=PATH: Forces plugin installation to read plugins only from the specified directory, acting as a one-time override for testing local builds.
-lockfile=MODE: Sets a dependency lockfile mode. Valid modes include:
  readonly: Suppresses lockfile changes but verifies checksums against recorded information. Conflicts with -upgrade.
```

--------------------------------

TITLE: HCL Deployment Block Example with Inputs
DESCRIPTION: An example of a deployment block named "production" that accepts 'aws_region' and 'instance_count' as input variables, demonstrating practical usage.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/stacks/reference/tfdeploy.mdx#_snippet_2

LANGUAGE: HCL
CODE:
```
deployment "production" {
    inputs = {
        aws_region     = "us-west-1"
        instance_count = 2
    }
}
```

--------------------------------

TITLE: Example of Generated Terraform HCL Configuration File
DESCRIPTION: A simplified example of the HCL configuration content that Terraform generates for an imported resource. This output serves as a starting template for further refinement and integration into the main configuration.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/import/generating-configuration.mdx#_snippet_3

LANGUAGE: hcl
CODE:
```
resource "aws_iot_thing" "bar" {
  name = "foo"
}
```

--------------------------------

TITLE: Terraform Provider Installation Method: direct
DESCRIPTION: Documentation for the `direct` provider installation method. This method instructs Terraform to request provider information directly from its origin registry and download it over the network. It does not require any additional arguments.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/config/config-file.mdx#_snippet_4

LANGUAGE: APIDOC
CODE:
```
direct:
  description: Requests information about the provider directly from its origin registry and downloads over the network from the location that registry indicates.
  arguments: None
```

--------------------------------

TITLE: HCL `range` Function Output Examples
DESCRIPTION: Provides several examples demonstrating the output of the `range` function with different combinations of `max`, `start`, `limit`, and `step` values, including positive, negative, and fractional steps.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/range.mdx#_snippet_2

LANGUAGE: HCL
CODE:
```
> range(3)
[
  0,
  1,
  2,
]

> range(1, 4)
[
  1,
  2,
  3,
]

> range(1, 8, 2)
[
  1,
  3,
  5,
  7,
]

> range(1, 4, 0.5)
[
  1,
  1.5,
  2,
  2.5,
  3,
  3.5,
]

> range(4, 1)
[
  4,
  3,
  2,
]

> range(10, 5, -2)
[
  10,
  8,
  6,
]
```

--------------------------------

TITLE: Initialize Terraform Working Directory
DESCRIPTION: Explains how `terraform init` installs required providers, noting default network access and options to limit it for air-gapped environments.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/plugins/index.mdx#_snippet_0

LANGUAGE: APIDOC
CODE:
```
terraform init
  Purpose: Initializes a working directory by installing any required providers.
  Details:
    - Requires network access by default to download providers.
    - Can be configured to limit or skip network access, or use local/HTTPS mirrors.
```

--------------------------------

TITLE: Install Terraform Stacks CLI on Debian or Ubuntu
DESCRIPTION: Commands to add the HashiCorp GPG key and repository, then install the terraform-stacks-cli package using apt on Debian or Ubuntu systems.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/stacks/reference/tfstacks-cli.mdx#_snippet_1

LANGUAGE: shell-session
CODE:
```
$ wget -O- https://apt.releases.hashicorp.com/gpg | sudo gpg --dearmor -o /usr/share/keyrings/hashicorp-archive-keyring.gpg
$ echo "deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] https://apt.releases.hashicorp.com $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/hashicorp.list
$ sudo apt update && sudo apt install terraform-stacks-cli
```

--------------------------------

TITLE: Install Terraform Stacks CLI with Homebrew
DESCRIPTION: Commands to add the HashiCorp tap and install the tfstacks CLI using Homebrew on macOS or Linux.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/stacks/reference/tfstacks-cli.mdx#_snippet_0

LANGUAGE: shell-session
CODE:
```
$ brew tap hashicorp/tap
$ brew install hashicorp/tap/tfstacks
```

--------------------------------

TITLE: Example Terraform Configuration for Console Testing
DESCRIPTION: A sample `main.tf` configuration defining a map variable `apps` and a `random_pet` resource using `for_each`. This configuration serves as the context for subsequent `terraform console` examples, allowing users to test interpolations against defined variables and resources.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/commands/console.mdx#_snippet_1

LANGUAGE: hcl
CODE:
```
variable "apps" {
  type = map(any)
  default = {
    "foo" = {
      "region" = "us-east-1"
    },
    "bar" = {
      "region" = "eu-west-1"
    },
    "baz" = {
      "region" = "ap-south-1"
    }
  }
}

resource "random_pet" "example" {
  for_each = var.apps
}
```

--------------------------------

TITLE: Terraform Test File Progress and Status Example
DESCRIPTION: This snippet shows a `test_file` message, providing progress updates for each test file during `terraform test` execution. It includes `path`, `progress` (starting, teardown, complete), and `status` (pass, error, fail, skip) upon completion.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/machine-readable-ui.mdx#_snippet_35

LANGUAGE: json
CODE:
```
{
  "@level": "info",
  "@message": "main.tftest.hcl... pass",
  "@module": "terraform.ui",
  "@testfile": "validation.tftest.hcl",
  "@timestamp": "2023-08-09T16:12:30.724368+02:00",
  "test_file": {
    "path": "validation.tftest.hcl",
    "progress": "complete",
    "status": "pass"
  },
  "type": "test_file"
}
```

--------------------------------

TITLE: Example JSON for Refresh Start Message
DESCRIPTION: This JSON snippet shows the structure of a `refresh_start` message from Terraform UI. It indicates the initiation of a state refresh operation for a resource, providing the resource details and its identifier.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/machine-readable-ui.mdx#_snippet_22

LANGUAGE: json
CODE:
```
{
  "@level": "info",
  "@message": "null_resource.none[0]: Refreshing state... [id=1971614370559474622]",
  "@module": "terraform.ui",
  "@timestamp": "2021-03-26T14:18:06.508915-04:00",
  "hook": {
    "resource": {
      "addr": "null_resource.none[0]",
      "module": "",
      "resource": "null_resource.none[0]",
      "implied_provider": "null",
      "resource_type": "null_resource",
      "resource_name": "none",
      "resource_key": 0
    },
    "id_key": "id",
    "id_value": "1971614370559474622"
  },
  "type": "refresh_start"
}
```

--------------------------------

TITLE: Install Terraform Stacks CLI on Fedora
DESCRIPTION: Commands to enable dnf-plugins-core, add the HashiCorp repository, and install the terraform-stacks-cli package using dnf on Fedora systems.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/stacks/reference/tfstacks-cli.mdx#_snippet_3

LANGUAGE: shell-session
CODE:
```
$ sudo dnf install -y dnf-plugins-core
$ sudo dnf config-manager addrepo --from-repofile=https://rpm.releases.hashicorp.com/fedora/hashicorp.repo
$ sudo dnf -y install terraform-stacks-cli
```

--------------------------------

TITLE: Initialize a new Terraform project and Git repository
DESCRIPTION: This snippet demonstrates the initial setup for a Terraform project, including creating a Git repository, an empty main.tf configuration file, and running 'terraform init' to download necessary provider plugins.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/intro/core-workflow.mdx#_snippet_0

LANGUAGE: sh
CODE:
```
# Create repository
$ git init my-infra && cd my-infra

Initialized empty Git repository in /.../my-infra/.git/

# Write initial config
$ vim main.tf

# Initialize Terraform
$ terraform init

Initializing provider plugins...
# ...
Terraform has been successfully initialized!
```

--------------------------------

TITLE: Terraform Provider Installation Method: filesystem_mirror
DESCRIPTION: Documentation for the `filesystem_mirror` provider installation method. This method allows Terraform to consult a local directory for provider copies. It requires the `path` argument and supports both packed and unpacked directory layouts for provider distribution files.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/config/config-file.mdx#_snippet_5

LANGUAGE: APIDOC
CODE:
```
filesystem_mirror:
  description: Consults a directory on the local disk for copies of providers.
  arguments:
    path: string (required)
      description: The directory to look in for provider copies.
  supported_layouts:
    Packed layout: HOSTNAME/NAMESPACE/TYPE/terraform-provider-TYPE_VERSION_TARGET.zip
    Unpacked layout: HOSTNAME/NAMESPACE/TYPE/VERSION/TARGET
      Note: Unpacked layout attempts symbolic linking.
```

--------------------------------

TITLE: Example Usage of base64sha256 Function
DESCRIPTION: This snippet demonstrates the direct application of the `base64sha256` function within a console-like environment, showing the input string 'hello world' and its corresponding Base64-encoded SHA256 hash output.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/base64sha256.mdx#_snippet_0

LANGUAGE: Console
CODE:
```
> base64sha256("hello world")
uU0nuZNNPgilLlLX2n2r+sSE7+N6U4DukIj3rOLvzek=
```

--------------------------------

TITLE: Sample Request: List Terraform Provider Versions
DESCRIPTION: Example `curl` command to query available versions for the `hashicorp/random` provider.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/provider-network-mirror-protocol.mdx#_snippet_3

LANGUAGE: shell
CODE:
```
curl 'https://terraform.example.com/providers/registry.terraform.io/hashicorp/random/index.json'
```

--------------------------------

TITLE: Terraform Init with Source Module Copy
DESCRIPTION: Demonstrates how to use `terraform init` to copy a module from a source into the current working directory before any other initialization steps are run. This is useful for checking out configurations or using example configurations.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/commands/init.mdx#_snippet_1

LANGUAGE: Shell
CODE:
```
terraform init -from-module=MODULE-SOURCE
```

--------------------------------

TITLE: Configure Terraform Provider Installation Block
DESCRIPTION: This HCL snippet demonstrates the basic structure of a `provider_installation` block in Terraform's CLI configuration. It shows how to define a `filesystem_mirror` for specific providers (e.g., `example.com/*/*`) and a `direct` method for all others, using `include` and `exclude` patterns to control which installation method applies to which providers.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/config/config-file.mdx#_snippet_3

LANGUAGE: HCL
CODE:
```
provider_installation {
  filesystem_mirror {
    path    = "/usr/share/terraform/providers"
    include = ["example.com/*/*"]
  }
  direct {
    exclude = ["example.com/*/*"]
  }
}
```

--------------------------------

TITLE: Illustrate chunklist function usage with HCL examples
DESCRIPTION: These examples demonstrate the practical application of the `chunklist` function in HCL. They show how a single list is divided into fixed-size sub-lists based on the `chunk_size` parameter, and how the function handles remaining elements. The output clearly displays the resulting list of lists.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/chunklist.mdx#_snippet_1

LANGUAGE: HCL
CODE:
```
> chunklist(["a", "b", "c", "d", "e"], 2)
[
  [
    "a",
    "b",
  ],
  [
    "c",
    "d",
  ],
  [
    "e",
  ],
]
> chunklist(["a", "b", "c", "d", "e"], 1)
[
  [
    "a",
  ],
  [
    "b",
  ],
  [
    "c",
  ],
  [
    "d",
  ],
  [
    "e",
  ],
]
```

--------------------------------

TITLE: Terraform Provider Service Discovery Document Example
DESCRIPTION: An example of a service discovery document for a host that only implements the provider registry protocol, showing the base URL for the `providers.v1` service.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/provider-registry-protocol.mdx#_snippet_0

LANGUAGE: json
CODE:
```
{
  "providers.v1": "/terraform/providers/v1/"
}
```

--------------------------------

TITLE: HCL Example: Configuring Provisioner Connection Blocks
DESCRIPTION: This HCL code demonstrates how to define `connection` blocks within Terraform provisioners. It includes two examples: one for an SSH connection to copy a file as the root user, and another for a WinRM connection to copy a file as the Administrator user. Both examples specify connection type, user, password, and host.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/resources/provisioners/connection.mdx#_snippet_0

LANGUAGE: hcl
CODE:
```
# Copies the file as the root user using SSH
provisioner "file" {
  source      = "conf/myapp.conf"
  destination = "/etc/myapp.conf"

  connection {
    type     = "ssh"
    user     = "root"
    password = var.root_password
    host     = var.host
  }
}

# Copies the file as the Administrator user using WinRM
provisioner "file" {
  source      = "conf/myapp.conf"
  destination = "C:/App/myapp.conf"

  connection {
    type     = "winrm"
    user     = "Administrator"
    password = var.admin_password
    host     = var.host
  }
}
```

--------------------------------

TITLE: Install Terraform Stacks CLI on CentOS or RHEL
DESCRIPTION: Commands to enable yum-utils, add the HashiCorp repository, and install the terraform-stacks-cli package using yum on CentOS or RHEL systems.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/stacks/reference/tfstacks-cli.mdx#_snippet_2

LANGUAGE: shell-session
CODE:
```
$ sudo yum install -y yum-utils
$ sudo yum-config-manager --add-repo https://rpm.releases.hashicorp.com/RHEL/hashicorp.repo
$ sudo yum -y install terraform-stacks-cli
```

--------------------------------

TITLE: Terraform `terraform` block complete configuration example
DESCRIPTION: Illustrates all supported built-in arguments for the `terraform` block, including `required_version`, `required_providers`, `provider_meta`, `backend`, `cloud`, and `experiments`.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/terraform.mdx#_snippet_1

LANGUAGE: hcl
CODE:
```
terraform {
  required_version = "<version>"
  required_providers {
    <PROVIDER> {
      version = "<version-constraint>"
      source = "<provider-address>"
    }
  }
  provider_meta "<LABEL>" { 
    # Shown for completeness but only used for specific cases     
  }
  backend "<TYPE>" {        
    # `backend` is mutually exclusive with `cloud` 
    "<ARGUMENTS>"
  }
  cloud {                   
    # `cloud` is mutually exclusive with `backend` 
    organization = "<organization-name>"
    workspaces {
      tags = [ "<tag>" ]
      name = "<workspace-name>"
      project = "<project-name>"
    }
    hostname = "app.terraform.io"
    token - "<TOKEN>"
  }
  experiments = [ "<feature-name>" ]
}
```

--------------------------------

TITLE: Sample Request: Download Module Source Code
DESCRIPTION: A `curl` command example demonstrating how to make a request to download a specific module version (`0.0.1`) for `hashicorp/consul/aws`.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/module-registry-protocol.mdx#_snippet_6

LANGUAGE: text
CODE:
```
$ curl -i 'https://registry.terraform.io/v1/modules/hashicorp/consul/aws/0.0.1/download'
```

--------------------------------

TITLE: Sample Response: List Terraform Provider Installation Packages
DESCRIPTION: Expected JSON response showing download URLs and hashes for distribution packages of a specific Terraform provider version across different operating systems and architectures.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/provider-network-mirror-protocol.mdx#_snippet_7

LANGUAGE: json
CODE:
```
{
  "archives": {
    "darwin_amd64": {
      "url": "terraform-provider-random_2.0.0_darwin_amd64.zip",
      "hashes": [
        "h1:4A07+ZFc2wgJwo8YNlQpr1rVlgUDlxXHhPJciaPY5gs="
      ]
    },
    "linux_amd64": {
      "url": "terraform-provider-random_2.0.0_linux_amd64.zip",
      "hashes": [
        "h1:lCJCxf/LIowc2IGS9TPjWDyXY4nOmdGdfcwwDQCOURQ="
      ]
    }
  }
}
```

--------------------------------

TITLE: HCL: Basic log function usage examples
DESCRIPTION: Illustrates basic usage of the `log` function with different numbers and bases, demonstrating its output for common logarithmic calculations.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/log.mdx#_snippet_1

LANGUAGE: HCL
CODE:
```
> log(50, 10)
1.6989700043360185
> log(16, 2)
4
```

--------------------------------

TITLE: Terraform CLI: Get Command Usage
DESCRIPTION: Illustrates the basic syntax for the `terraform get` command, which downloads and updates modules into a `.terraform` subdirectory.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/commands/get.mdx#_snippet_0

LANGUAGE: APIDOC
CODE:
```
Usage: terraform get [options]
```

--------------------------------

TITLE: Terraform Provider Installation Method: network_mirror
DESCRIPTION: Documentation for the `network_mirror` provider installation method. This method enables Terraform to consult a specific HTTPS server for provider copies, regardless of their origin registry. It requires a `url` argument pointing to a base URL implementing the provider network mirror protocol.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/config/config-file.mdx#_snippet_6

LANGUAGE: APIDOC
CODE:
```
network_mirror:
  description: Consults a particular HTTPS server for copies of providers, regardless of which registry host they belong to.
  arguments:
    url: string (required)
      description: The mirror base URL, which should use the `https:` scheme and end with a trailing slash.
      protocol: Provider network mirror protocol
```

--------------------------------

TITLE: Illustrate Terraform lookup function usage with examples
DESCRIPTION: Examples demonstrating how the `lookup` function retrieves values from a map or returns a default value if the specified key does not exist.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/lookup.mdx#_snippet_1

LANGUAGE: hcl
CODE:
```
> lookup({a="ay", b="bee"}, "a", "what?")
ay
> lookup({a="ay", b="bee"}, "c", "what?")
what?
```

--------------------------------

TITLE: Example JSON for Terraform `change_summary` Message
DESCRIPTION: Provides a JSON example of a `change_summary` message, indicating the outcome of an 'apply' operation where one resource was added and none were changed or destroyed.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/machine-readable-ui.mdx#_snippet_10

LANGUAGE: json
CODE:
```
{
  "@level": "info",
  "@message": "Apply complete! Resources: 1 added, 0 changed, 0 destroyed.",
  "@module": "terraform.ui",
  "@timestamp": "2021-05-25T13:32:41.869168-04:00",
  "changes": {
    "add": 1,
    "change": 0,
    "remove": 0,
    "operation": "apply"
  },
  "type": "change_summary"
}
```

--------------------------------

TITLE: Terraform Setup Module: S3 Bucket Creation (Partial)
DESCRIPTION: This snippet introduces a setup module designed to create an S3 bucket, making it available for the main configuration under test. The provided code block is incomplete, but its purpose is to provision prerequisite infrastructure for testing.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/tests/index.mdx#_snippet_17

LANGUAGE: hcl
CODE:
```

```

--------------------------------

TITLE: CLI example of filesha512 function
DESCRIPTION: Demonstrates executing a file hashing function from the command line, showing the expected output for a given file. Although the context is `filesha256`, this specific example uses `filesha512`.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/filesha256.mdx#_snippet_1

LANGUAGE: shell
CODE:
```
$ filesha512("example.txt")
a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b0b571d0f6a26f2bb
```

--------------------------------

TITLE: Complete Terraform Module Directory Structure with Nested Modules and Examples
DESCRIPTION: This snippet demonstrates a comprehensive Terraform module structure, showcasing all optional elements. It includes standard module files, a 'modules/' directory for nested modules, and an 'examples/' directory for usage examples, representing the most complex possible module layout.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/modules/develop/structure.mdx#_snippet_1

LANGUAGE: sh
CODE:
```
$ tree complete-module/
.
├── README.md
├── main.tf
├── variables.tf
├── outputs.tf
├── ...
├── modules/
│   ├── nestedA/
│   │   ├── README.md
│   │   ├── variables.tf
│   │   ├── main.tf
│   │   ├── outputs.tf
│   ├── nestedB/
│   ├── .../
├── examples/
│   ├── exampleA/
│   │   ├── main.tf
│   ├── exampleB/
│   ├── .../
```

--------------------------------

TITLE: Install Terraform Stacks CLI on Amazon Linux
DESCRIPTION: Commands to enable yum-utils and shadow-utils, add the HashiCorp repository, and install the terraform-stacks-cli package using yum on Amazon Linux systems.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/stacks/reference/tfstacks-cli.mdx#_snippet_4

LANGUAGE: shell-session
CODE:
```
$ sudo yum install -y yum-utils shadow-utils
$ sudo yum-config-manager --add-repo https://rpm.releases.hashicorp.com/AmazonLinux/hashicorp.repo
$ sudo yum -y install terraform-stacks-cli
```

--------------------------------

TITLE: HCL strcontains Function Examples
DESCRIPTION: Illustrates the usage of the `strcontains` function in HCL, showing its signature and practical examples of checking for substring existence.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/strcontains.mdx#_snippet_0

LANGUAGE: hcl
CODE:
```
strcontains(string, substr)
```

LANGUAGE: hcl
CODE:
```
> strcontains("hello world", "wor")
true
```

LANGUAGE: hcl
CODE:
```
> strcontains("hello world", "wod")
false
```

--------------------------------

TITLE: Example JSON Output from Template
DESCRIPTION: The resulting JSON string generated by the `jsonencode` template when provided with the same input as the list example.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/templatefile.mdx#_snippet_7

LANGUAGE: JSON
CODE:
```
{"backends":["10.0.0.1:8080","10.0.0.2:8080"]}
```

--------------------------------

TITLE: Illustrate HCL slice function example
DESCRIPTION: Provides a practical example of using the `slice` function in HCL to extract a sub-list from an array, demonstrating the input arguments and the resulting output.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/slice.mdx#_snippet_1

LANGUAGE: HCL
CODE:
```
> slice(["a", "b", "c", "d"], 1, 3)
[
  "b",
  "c",
]
```

--------------------------------

TITLE: Show Installed Provider Versions with Terraform CLI
DESCRIPTION: Explains how `terraform version` (or `terraform -version`) displays the specific provider versions installed.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/plugins/index.mdx#_snippet_2

LANGUAGE: APIDOC
CODE:
```
terraform version | terraform -version
  Purpose: Shows the specific provider versions installed for the current working directory.
```

--------------------------------

TITLE: Terraform HCL: Example `filebase64` Usage
DESCRIPTION: This example demonstrates how to use the `filebase64` function within a Terraform configuration. It shows reading a file relative to the module path (`hello.txt`) and the resulting base64-encoded string output, which represents 'Hello World'.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/filebase64.mdx#_snippet_1

LANGUAGE: HCL
CODE:
```
> filebase64("${path.module}/hello.txt")
SGVsbG8gV29ybGQ=
```

--------------------------------

TITLE: Example path for an in-house provider executable on Windows
DESCRIPTION: This example shows the full file path for an in-house provider plugin executable within the local filesystem mirror. It includes the placeholder hostname, namespace, type, version, and platform-specific subdirectory (e.g., "windows_amd64"), leading to the executable file.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/providers/requirements.mdx#_snippet_7

LANGUAGE: plaintext
CODE:
```
terraform.example.com/examplecorp/ourcloud/1.0.0/windows_amd64/terraform-provider-ourcloud.exe
```

--------------------------------

TITLE: Example Usage of Terraform `keys` Function
DESCRIPTION: Illustrates the `keys` function's behavior when applied to a map, showing the lexicographically ordered list of keys returned in a console output.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/keys.mdx#_snippet_0

LANGUAGE: console
CODE:
```
> keys({a=1, c=2, d=3})
[
  "a",
  "c",
  "d",
]
```

--------------------------------

TITLE: Terraform Test Run Progress and Status Examples
DESCRIPTION: These snippets illustrate `test_run` messages, which provide status updates for individual `run` blocks within a test file. They show `progress` (starting, running, teardown, complete), `elapsed` time, and `status` (pass, error, fail, skip) upon completion, detailing the execution flow.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/machine-readable-ui.mdx#_snippet_36

LANGUAGE: json
CODE:
```
{
  "@level": "info",
  "@message": "  \"successful_validation\"... pass",
  "@module": "terraform.ui",
  "@testfile": "validation.tftest.hcl",
  "@testrun": "successful_validation",
  "@timestamp": "2023-08-09T16:12:30.724407+02:00",
  "test_run": {
    "path": "main.tftest.hcl",
    "run": "successful_validation",
    "progress": "complete",
    "status": "pass"
  },
  "type": "test_run"
}
```

LANGUAGE: json
CODE:
```
{
  "@level": "info",
  "@message": "  \"successful_validation\"... in progress",
  "@module": "terraform.ui",
  "@testfile": "validation.tftest.hcl",
  "@testrun": "successful_validation",
  "@timestamp": "2023-08-09T16:12:30.724407+02:00",
  "test_run": {
    "path": "main.tftest.hcl",
    "run": "successful_validation",
    "progress": "running",
    "elapsed": 2024
  },
  "type": "test_run"
}
```

--------------------------------

TITLE: Update Terraform Lock File with New AzureRM Provider
DESCRIPTION: This diff illustrates the changes made to the `.terraform.lock.hcl` file when a new provider, specifically `hashicorp/azurerm`, is introduced. It shows the addition of a new `provider` block, including the selected `version`, the `constraints` that guided the selection, and a list of `hashes` for package integrity verification.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/files/dependency-lock.mdx#_snippet_2

LANGUAGE: Diff
CODE:
```
--- .terraform.lock.hcl	2020-10-07 16:12:07.539570634 -0700
+++ .terraform.lock.hcl	2020-10-07 16:12:15.267487237 -0700
@@ -6,6 +6,26 @@
   ]
 }
 
+provider "registry.terraform.io/hashicorp/azurerm" {
+  version     = "2.30.0"
+  constraints = "~> 2.12"
+  hashes = [
+    "h1:FJwsuowaG5CIdZ0WQyFZH9r6kIJeRKts9+GcRsTz1+Y=",
+    "h1:c/ntSXrDYM1mUir2KufijYebPcwKqS9CRGd2duDSGfY=",
+    "h1:yre4Ph76g9H84MbuhZ2z5MuldjSA4FsrX6538O7PCcY=",
+    "zh:04f0a50bb2ba92f3bea6f0a9e549ace5a4c13ef0cbb6975494cac0ef7d4acb43",
+    "zh:2082e12548ebcdd6fd73580e83f626ed4ed13f8cdfd51205d8696ffe54f30734",
+    "zh:246bcc449e9a92679fb30f3c0a77f05513886565e2dcc66b16c4486f51533064",
+    "zh:24de3930625ac9014594d79bfa42d600eca65e9022b9668b54bfd0d924e21d14",
+    "zh:2a22893a576ff6f268d9bf81cf4a56406f7ba79f77826f6df51ee787f6d2840a",
+    "zh:2b27485e19c2aaa9f15f29c4cff46154a9720647610171e30fc6c18ddc42ec28",
+    "zh:435f24ce1fb2b63f7f02aa3c84ac29c5757cd29ec4d297ed0618423387fe7bd4",
+    "zh:7d99725923de5240ff8b34b5510569aa4ebdc0bdb27b7bac2aa911a8037a3893",
+    "zh:7e3b5d0af3b7411dd9dc65ec9ab6caee8c191aee0fa7f20fc4f51716e67f50c0",
+    "zh:da0af4552bef5a29b88f6a0718253f3bf71ce471c959816eb7602b0dadb469ca",
+  ]
+}
 
 provider "registry.terraform.io/newrelic/newrelic" {
   version     = "2.1.2"
```

--------------------------------

TITLE: Terraform S3 Backend Configuration Example
DESCRIPTION: Demonstrates a basic Terraform configuration block to set up the S3 backend, specifying the bucket, key, and region for state storage.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/backend/s3.mdx#_snippet_0

LANGUAGE: hcl
CODE:
```
terraform {
  backend "s3" {
    bucket = "mybucket"
    key    = "path/to/my/key"
    region = "us-east-1"
  }
}
```

--------------------------------

TITLE: Example Service Discovery Document
DESCRIPTION: Illustrates the structure of a service discovery document for a host implementing only the module registry protocol, showing the "modules.v1" service identifier and its base URL.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/module-registry-protocol.mdx#_snippet_1

LANGUAGE: json
CODE:
```
{
  "modules.v1": "/terraform/modules/v1/"
}
```

--------------------------------

TITLE: Command Line: `alltrue` Function Examples
DESCRIPTION: Provides examples of the `alltrue` function's behavior when executed via the Terraform command line, demonstrating its output for collections containing all true values and mixed values.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/alltrue.mdx#_snippet_1

LANGUAGE: command
CODE:
```
> alltrue(["true", true])
true
> alltrue([true, false])
false
```

--------------------------------

TITLE: Configure Terraform Credentials Helper
DESCRIPTION: Example HCL configuration for a 'credstore' credentials helper, specifying arguments to be passed to the helper program.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/credentials-helpers.mdx#_snippet_0

LANGUAGE: HCL
CODE:
```
credentials_helper "credstore" {
  args = ["--host=credstore.example.com"]
}
```

--------------------------------

TITLE: Build Terraform Documentation Website Locally
DESCRIPTION: Executes the `make website` command from the Terraform top-level directory to build the entire documentation site locally. This command compiles content from both the `terraform` and `terraform-website` repositories, enabling a full preview of the documentation.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/README.md#_snippet_2

LANGUAGE: Makefile
CODE:
```
make website
```

--------------------------------

TITLE: Example Usage of abspath Function
DESCRIPTION: This example demonstrates how the `abspath` function converts a relative path (represented by `path.root`) into its absolute equivalent, showing the console output of the function call.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/abspath.mdx#_snippet_0

LANGUAGE: Console
CODE:
```
> abspath(path.root)
/home/user/some/terraform/root
```

--------------------------------

TITLE: HCL: Get element by positive index
DESCRIPTION: Example demonstrating how to retrieve an element from a list using a positive, zero-based index.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/element.mdx#_snippet_1

LANGUAGE: hcl
CODE:
```
> element(["a", "b", "c"], 1)
"b"
```

--------------------------------

TITLE: Example JSON for Terraform `outputs` Message
DESCRIPTION: Presents a JSON example of an `outputs` message, showing a non-sensitive string output named 'pets' with its value 'smart-lizard'.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/machine-readable-ui.mdx#_snippet_12

LANGUAGE: json
CODE:
```
{
  "@level": "info",
  "@message": "Outputs: 1",
  "@module": "terraform.ui",
  "@timestamp": "2021-05-25T13:32:41.869280-04:00",
  "outputs": {
    "pets": {
      "sensitive": false,
      "type": "string",
      "value": "smart-lizard"
    }
  },
  "type": "outputs"
}
```

--------------------------------

TITLE: HCL: Get last element using negative index
DESCRIPTION: Example demonstrating how to retrieve the last element of a list using a negative index (`-1`).

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/element.mdx#_snippet_3

LANGUAGE: hcl
CODE:
```
> element(["a", "b", "c"], -1)
"c"
```

--------------------------------

TITLE: Sample Request: List Module Versions
DESCRIPTION: A `curl` command example demonstrating how to make a request to the module versions API endpoint for `hashicorp/consul/aws`.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/module-registry-protocol.mdx#_snippet_3

LANGUAGE: text
CODE:
```
$ curl 'https://registry.terraform.io/v1/modules/hashicorp/consul/aws/versions'
```

--------------------------------

TITLE: Example JSON for Terraform `planned_change` Message
DESCRIPTION: Illustrates a sample `planned_change` message in JSON format, showing the creation of a `random_pet` resource. This example demonstrates the `resource` object details and the `action` field indicating a 'create' operation.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/machine-readable-ui.mdx#_snippet_8

LANGUAGE: json
CODE:
```
{
  "@level": "info",
  "@message": "random_pet.animal: Plan to create",
  "@module": "terraform.ui",
  "@timestamp": "2021-05-25T13:32:41.705503-04:00",
  "change": {
    "resource": {
      "addr": "random_pet.animal",
      "module": "",
      "resource": "random_pet.animal",
      "implied_provider": "random",
      "resource_type": "random_pet",
      "resource_name": "animal",
      "resource_key": null
    },
    "action": "create"
  },
  "type": "planned_change"
}
```

--------------------------------

TITLE: Example Output of Object Transformation
DESCRIPTION: An example of the object structure produced by transforming a list into an object using a `for` expression, showing original list elements as keys and their uppercase versions as values.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/expressions/for.mdx#_snippet_4

LANGUAGE: HCL
CODE:
```
{
  foo = "FOO"
  bar = "BAR"
  baz = "BAZ"
}
```

--------------------------------

TITLE: Example output of combined network and subnet data
DESCRIPTION: Shows the expected JSON structure of the `network_subnets` local variable after `setproduct` has processed the example input. This output illustrates the generated combinations, including derived CIDR blocks and associated network IDs.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/setproduct.mdx#_snippet_9

LANGUAGE: JSON
CODE:
```
[
  {
    "cidr_block": "10.1.16.0/20",
    "network_id": "vpc-0bfb00ca6173ea5aa",
    "network_key": "a",
    "subnet_key": "a"
  },
  {
    "cidr_block": "10.1.32.0/20",
    "network_id": "vpc-0bfb00ca6173ea5aa",
    "network_key": "a",
    "subnet_key": "b"
  },
  {
    "cidr_block": "10.1.48.0/20",
    "network_id": "vpc-0bfb00ca6173ea5aa",
    "network_key": "a",
    "subnet_key": "c"
  },
  {
    "cidr_block": "10.2.16.0/20",
    "network_id": "vpc-0d193e011f6211a7d",
    "network_key": "b",
    "subnet_key": "a"
  },
  {
    "cidr_block": "10.2.32.0/20",
    "network_id": "vpc-0d193e011f6211a7d",
    "network_key": "b",
    "subnet_key": "b"
  },
  {
    "cidr_block": "10.2.48.0/20",
    "network_id": "vpc-0d193e011f6211a7d",
    "network_key": "b",
    "subnet_key": "c"
  }
]
```

--------------------------------

TITLE: HCL: Get element with wrap-around index
DESCRIPTION: Example showing the `element` function's wrap-around behavior when the index exceeds the list length, using modulo arithmetic.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/element.mdx#_snippet_2

LANGUAGE: hcl
CODE:
```
> element(["a", "b", "c"], 3)
"a"
```

--------------------------------

TITLE: HCL: Basic `format` function usage
DESCRIPTION: Examples demonstrating simple string and integer formatting using `%s` and `%d` verbs.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/format.mdx#_snippet_1

LANGUAGE: HCL
CODE:
```
> format("Hello, %s!", "Ander")
Hello, Ander!
> format("There are %d lights", 4)
There are 4 lights
```

--------------------------------

TITLE: JSON Example for Terraform Version Message
DESCRIPTION: Illustrates the structure of the `version` message, which always begins a machine-readable UI command output. It includes the Terraform version and the UI schema version.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/machine-readable-ui.mdx#_snippet_4

LANGUAGE: json
CODE:
```
{
  "@level": "info",
  "@message": "Terraform 0.15.4",
  "@module": "terraform.ui",
  "@timestamp": "2021-05-25T13:32:41.275359-04:00",
  "terraform": "0.15.4",
  "type": "version",
  "ui": "0.1.0"
}
```

--------------------------------

TITLE: Get Maximum of Individual Numbers in Terraform
DESCRIPTION: Demonstrates how to use the `max` function with individual numeric arguments to find the greatest number. The example shows the function call and its resulting output.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/max.mdx#_snippet_0

LANGUAGE: Terraform
CODE:
```
> max(12, 54, 3)
54
```

--------------------------------

TITLE: Terraform Init Backend Configuration Options
DESCRIPTION: Illustrates various options for configuring the backend during `terraform init`, including reconfiguring, migrating state, forcing copy, disabling backend, and providing partial backend configuration.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/commands/init.mdx#_snippet_2

LANGUAGE: Shell
CODE:
```
terraform init -reconfigure
```

LANGUAGE: Shell
CODE:
```
terraform init -migrate-state
```

LANGUAGE: Shell
CODE:
```
terraform init -force-copy
```

LANGUAGE: Shell
CODE:
```
terraform init -backend=false
```

LANGUAGE: Shell
CODE:
```
terraform init -backend-config="KEY=VALUE"
```

--------------------------------

TITLE: Terraform CLI: Get Command Options Reference
DESCRIPTION: Details the available options for the `terraform get` command, including `-update` for checking for module updates and `-no-color` for disabling output coloring.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/commands/get.mdx#_snippet_1

LANGUAGE: APIDOC
CODE:
```
terraform get command options:
  -update:
    description: If specified, modules that are already downloaded will be checked for updates and the updates will be downloaded if present.
  -no-color:
    description: Disable text coloring in the output.
```

--------------------------------

TITLE: HCL: zipmap Function Example Usage
DESCRIPTION: This example demonstrates how to use the `zipmap` function with a list of string keys and a list of integer values. It illustrates the resulting map where keys are mapped to their corresponding values based on their index.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/zipmap.mdx#_snippet_1

LANGUAGE: HCL
CODE:
```
> zipmap(["a", "b"], [1, 2])
{
  "a" = 1
  "b" = 2
}
```

--------------------------------

TITLE: Terraform Init: Child Module Installation Options
DESCRIPTION: Explains how `terraform init` retrieves child module source code. By default, it installs new modules but doesn't change existing ones. Options allow overriding this behavior.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/commands/init.mdx#_snippet_3

LANGUAGE: APIDOC
CODE:
```
-upgrade: Updates all modules to the latest available source code, ignoring previously installed versions.
-get=false: Skips child module installation during init. Note that some other init steps require a complete module tree.
```

--------------------------------

TITLE: Initialize Terraform Backend with Partial Configuration File
DESCRIPTION: This command initializes the Terraform backend, providing the remaining configuration arguments from a specified file. The -backend-config option points to the file containing the backend settings.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/backend/index.mdx#_snippet_2

LANGUAGE: Shell
CODE:
```
$ `terraform init -backend-config="./state.config"`
```

--------------------------------

TITLE: Compile Terraform with Debug Flags and Start Delve Server
DESCRIPTION: This set of commands compiles the Terraform binary with specific Go compiler flags (-N -l) to disable optimizations and inlining, making it suitable for debugging. Subsequently, it launches the compiled Terraform binary via Delve, starting a headless debug server on port 2345. This setup enables remote debugging of Terraform operations.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/docs/debugging.md#_snippet_0

LANGUAGE: Shell
CODE:
```
go install -gcflags="all=-N -l"
```

LANGUAGE: Shell
CODE:
```
dlv exec $HOME/go/bin/terraform --headless --listen :2345 --log -- apply
```

--------------------------------

TITLE: Terraform Nested Module Path Example
DESCRIPTION: An example demonstrating how to address deeply nested modules with multiple instances using the module path syntax. This shows how multiple `module` keywords delineate nested structures and how indices select specific instances.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/state/resource-addressing.mdx#_snippet_2

LANGUAGE: Terraform HCL
CODE:
```
module.foo[0].module.bar["a"]
```

--------------------------------

TITLE: Terraform File Provisioner Example Usage with AWS Instance
DESCRIPTION: This HCL code block demonstrates various ways to use the `file` provisioner within an `aws_instance` resource. It shows examples of copying a single file, writing inline content to a file, copying an entire directory, and copying contents of a directory to a destination.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/resources/provisioners/file.mdx#_snippet_0

LANGUAGE: hcl
CODE:
```
resource "aws_instance" "web" {
  # ...

  # Copies the myapp.conf file to /etc/myapp.conf
  provisioner "file" {
    source      = "conf/myapp.conf"
    destination = "/etc/myapp.conf"
  }

  # Copies the string in content into /tmp/file.log
  provisioner "file" {
    content     = "ami used: ${self.ami}"
    destination = "/tmp/file.log"
  }

  # Copies the configs.d folder to /etc/configs.d
  provisioner "file" {
    source      = "conf/configs.d"
    destination = "/etc"
  }

  # Copies all files and folders in apps/app1 to D:/IIS/webapp1
  provisioner "file" {
    source      = "apps/app1/"
    destination = "D:/IIS/webapp1"
  }
}
```

--------------------------------

TITLE: Terraform Configuration Examples: JSON vs. Native HCL
DESCRIPTION: Demonstrates how `variable` and `resource` blocks are defined in Terraform's JSON-compatible syntax, showing the mapping of block types, labels, and arguments. The equivalent configuration in native HCL syntax is also provided for comparison.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/syntax/json.mdx#_snippet_0

LANGUAGE: json
CODE:
```
{
  "variable": {
    "example": {
      "default": "hello"
    }
  }
}
```

LANGUAGE: json
CODE:
```
{
  "resource": {
    "aws_instance": {
      "example": {
        "instance_type": "t2.micro",
        "ami": "ami-abc123"
      }
    }
  }
}
```

LANGUAGE: hcl
CODE:
```
variable "example" {
  default = "hello"
}

resource "aws_instance" "example" {
  instance_type = "t2.micro"
  ami           = "ami-abc123"
}
```

--------------------------------

TITLE: Terraform Init Command Basic Usage
DESCRIPTION: Shows the basic syntax for the `terraform init` command, which initializes a Terraform working directory.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/commands/init.mdx#_snippet_0

LANGUAGE: Shell
CODE:
```
terraform init [options]
```

--------------------------------

TITLE: Example: Select Terraform Workspace
DESCRIPTION: This example demonstrates how to list existing Terraform workspaces and then switch to a specific one using the `terraform workspace select` command. It shows the output of listing workspaces and the confirmation message after a successful selection. The command supports selecting an existing workspace by `NAME` and an optional `DIR`, and can create a new workspace if the `-or-create` flag is used.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/commands/workspace/select.mdx#_snippet_0

LANGUAGE: shell
CODE:
```
$ terraform workspace list
  default
* development
  jsmith-test

$ terraform workspace select default
Switched to workspace "default".
```

--------------------------------

TITLE: Import AWS Instance into For_Each-Configured Terraform Resource
DESCRIPTION: This snippet provides platform-specific examples for importing an AWS EC2 instance into a resource configured with the `for_each` meta-argument. It targets the instance identified by the key `"example"`, showing necessary quoting and escaping variations for different shells.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/commands/import.mdx#_snippet_6

LANGUAGE: shell
CODE:
```
$ terraform import 'aws_instance.baz["example"]' i-abcd1234
```

LANGUAGE: shell
CODE:
```
$ terraform import 'aws_instance.baz[\"example\"]' i-abcd1234
```

LANGUAGE: shell
CODE:
```
$ terraform import aws_instance.baz[\"example\"] i-abcd1234
```

--------------------------------

TITLE: Get Maximum from a List or Set in Terraform
DESCRIPTION: Illustrates how to apply the `max` function to a list or set of numbers by expanding the collection using the `...` operator. The example includes the function call and its resulting output.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/max.mdx#_snippet_1

LANGUAGE: Terraform
CODE:
```
> max([12, 54, 3]...)
54
```

--------------------------------

TITLE: Sample Response: List Module Versions
DESCRIPTION: An example JSON response structure for the module versions API, showing an array of modules, each with an array of available versions. Notes that Terraform only uses the first element and that a `404 Not Found` indicates no module.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/module-registry-protocol.mdx#_snippet_4

LANGUAGE: json
CODE:
```
{
   "modules": [
      {
         "versions": [
            {"version": "1.0.0"},
            {"version": "1.1.0"},
            {"version": "2.0.0"}
         ]
      }
   ]
}
```

--------------------------------

TITLE: API Documentation: Ephemeral Operation Start Message Hook Object
DESCRIPTION: Describes the `hook` object structure for the `ephemeral_op_start` message. It specifies the `resource` object and the `action` key, which can be `open`, `renew`, or `close`.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/internals/machine-readable-ui.mdx#_snippet_25

LANGUAGE: APIDOC
CODE:
```
ephemeral_op_start message hook object keys:
- resource: a [resource object](#resource-object) identifying the resource
- action: the action the ephemeral resource is going through. Values: open, renew, close
```

--------------------------------

TITLE: Terraform Apply Command General Usage
DESCRIPTION: Illustrates the general syntax for the `terraform apply` command, including optional arguments for options and a plan file.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/cli/commands/apply.mdx#_snippet_0

LANGUAGE: CLI
CODE:
```
terraform apply [options] [plan file]
```

--------------------------------

TITLE: Get Current UTC Timestamp in Terraform Console
DESCRIPTION: Demonstrates how to call the `timestamp()` function in the Terraform console to retrieve the current UTC date and time in RFC 3339 format. The example shows the function call and a sample output.

SOURCE: https://github.com/hashicorp/terraform/blob/v1.12.2/website/docs/language/functions/timestamp.mdx#_snippet_0

LANGUAGE: Terraform
CODE:
```
> timestamp()
2018-05-13T07:44:12Z
```