Patterns
Define Project-Specific Helpers
Wrap attr, str, and raw in short functions. These helpers remove repetition in configuration definitions.
module MyProject =
open FsHcl.Hcl
let name value = attr "name" (str value)
let region value = attr "region" (str value)
let role value = attr "role" (raw value)
let function_name value = attr "function_name" (raw value)
Example with project-specific helpers:
open MyProject
open FsHcl.Hcl
open FsHcl.TerraformHcl
hcl {
resource "aws_iam_role" "deploy" {
name "github-actions-deploy"
role "data.aws_iam_policy_document.assume.json"
}
resource "aws_lambda_function_url" "api" {
function_name "data.aws_lambda_function.api.function_name"
attr "authorization_type" (str "NONE")
depends_on [ "aws_lambda_function.api" ]
}
}
|> document
// resource "aws_iam_role" "deploy" {
// name = "github-actions-deploy"
// role = data.aws_iam_policy_document.assume.json
// }
// resource "aws_lambda_function_url" "api" {
// function_name = data.aws_lambda_function.api.function_name
// authorization_type = "NONE"
// depends_on = [
// aws_lambda_function.api,
// ]
// }
Choose Between str and raw
Use str for literal string values. Use raw for Terraform references and expressions.
The helper function makes this distinction explicit. Callers do not need to decide which wrapper to use.
let bucket value = attr "bucket" (str value) // literal string
let role_arn value = attr "role_arn" (raw value) // Terraform reference
Wrap Repeated Nested Blocks
For nested blocks that appear in many resources, define a block wrapper. Do not hide the block body inside a function.
let statement = block "statement" []
Use the wrapper like a standard block:
resource "aws_iam_policy_document" "example" {
statement {
attr "effect" (str "Allow")
list_ "actions" [ str "s3:GetObject" ]
list_ "resources" [ str "*" ]
}
}
Complete Example
examples/HelloLambda is a full project that uses these patterns.