Skip to main content
Version: 1.0-beta

WorkspaceModuleSetting

API reference

A constructor-backed module setting.

Implements Node

defaultValue: String!

The constructor argument's declared default, formatted like value, or empty when the argument has no default.

description: String!

The constructor argument description.

id: ID!

A unique identifier for this WorkspaceModuleSetting.

isList: Boolean!

Whether the setting accepts a list of values.

isObject: Boolean!

Whether the setting is an object type resolved from an address string (Container, Directory, File, Secret, Service, ...), which may be a module reference.

isString: Boolean!

Whether the setting is a string argument, stored as a TOML string even when the value reads as a number or boolean.

key: String!

The setting key.

value: String!

The value stored in workspace config after applying the selected workspace environment, or empty when unset.

References

Returned by