Bool Function Parameter

Bool function parameters expect a boolean true or false value from a practitioner configuration. Values are accessible in function logic by the Go built-in bool type, Go built-in *bool type, or the framework bool type.

In this Terraform configuration example, a bool parameter is set to the value true:

provider::example::example(true)

Function Definition

Use the function.BoolParameter type in the function definition to accept a bool value.

In this example, a function definition includes a first position bool parameter:

func (f ExampleFunction) Definition(ctx context.Context, req function.DefinitionRequest, resp *function.DefinitionResponse) {
    resp.Definition = function.Definition{
        // ... other Definition fields ...
        Parameters: []function.Parameter{
            function.BoolParameter{
                Name: "example",
                // ... potentially other BoolParameter fields ...
            },
        },
    }
}

If the bool value should be the element type of a collection parameter type, set the ElementType field according to the framework bool type. Refer to the collection parameter type documentation for additional details.

If the bool value should be a value type of an object parameter type, set the AttributeTypes map value according to the framework bool type. Refer to the object parameter type documentation for additional details.

Allow Null Values

By default, Terraform will not pass null values to the function logic. Use the AllowNullValue field to explicitly allow null values, if there is a meaningful distinction that should occur in function logic. Enabling AllowNullValue requires using a Go pointer type or framework bool type when reading argument data.

Allow Unknown Values

By default, Terraform will not pass unknown values to the function logic. Use the AllowUnknownValues field to explicitly allow unknown values, if there is a meaningful distinction that should occur in function logic. Enabling AllowUnknownValues requires using a framework bool type when reading argument data.

Custom Types

You may want to build your own data value and type implementations to allow your provider to combine validation and other behaviors into a reusable bundle. This helps avoid duplication and ensures consistency. These implementations use the CustomType field in the parameter type.

Refer to Custom Types for further details on creating provider-defined types and values.

Documentation

Refer to function documentation for information about the Name, Description, and MarkdownDescription fields available.

Reading Argument Data

The function implementation documentation covers the general methods for reading function argument data in function logic.

When retrieving the argument value for this parameter:

• If CustomType is set, use its associated value type.
• If AllowUnknownValues is enabled, you must use the framework bool type.
• If AllowNullValue is enabled, you must use the Go built-in *bool type or framework bool type.
• Otherwise, use the Go built-in bool type, Go built-in *bool type, or framework bool type.

In this example, a function defines a single bool parameter and accesses its argument value:

func (f ExampleFunction) Definition(ctx context.Context, req function.DefinitionRequest, resp *function.DefinitionResponse) {
    resp.Definition = function.Definition{
        // ... other Definition fields ...
        Parameters: []function.Parameter{
            function.BoolParameter{
                Name: "bool_param",
            },
        },
    }
}

func (f ExampleFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse) {
    var boolArg bool
    // var boolArg *bool // e.g. with AllowNullValue, where Go nil equals Terraform null
    // var boolArg types.Bool // e.g. with AllowUnknownValues or AllowNullValue

    resp.Error = function.ConcatFuncErrors(resp.Error, req.Arguments.Get(ctx, &boolArg))

    // boolArg is now populated
    // ... other logic ...
}