coder 2.4.0-pre1, Apr 15 25

coder 2.4.0-pre1 published on Tuesday, Apr 15, 2025 by coder

coder.getParameter

Explore with Pulumi AI

coder 2.4.0-pre1 published on Tuesday, Apr 15, 2025 by coder

Using getParameter

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getParameter(args: GetParameterArgs, opts?: InvokeOptions): Promise<GetParameterResult>
function getParameterOutput(args: GetParameterOutputArgs, opts?: InvokeOptions): Output<GetParameterResult>

def get_parameter(default: Optional[str] = None,
                  description: Optional[str] = None,
                  display_name: Optional[str] = None,
                  ephemeral: Optional[bool] = None,
                  form_type: Optional[str] = None,
                  icon: Optional[str] = None,
                  id: Optional[str] = None,
                  mutable: Optional[bool] = None,
                  name: Optional[str] = None,
                  options: Optional[Sequence[GetParameterOption]] = None,
                  order: Optional[float] = None,
                  styling: Optional[str] = None,
                  type: Optional[str] = None,
                  validation: Optional[GetParameterValidation] = None,
                  opts: Optional[InvokeOptions] = None) -> GetParameterResult
def get_parameter_output(default: Optional[pulumi.Input[str]] = None,
                  description: Optional[pulumi.Input[str]] = None,
                  display_name: Optional[pulumi.Input[str]] = None,
                  ephemeral: Optional[pulumi.Input[bool]] = None,
                  form_type: Optional[pulumi.Input[str]] = None,
                  icon: Optional[pulumi.Input[str]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  mutable: Optional[pulumi.Input[bool]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  options: Optional[pulumi.Input[Sequence[pulumi.Input[GetParameterOptionArgs]]]] = None,
                  order: Optional[pulumi.Input[float]] = None,
                  styling: Optional[pulumi.Input[str]] = None,
                  type: Optional[pulumi.Input[str]] = None,
                  validation: Optional[pulumi.Input[GetParameterValidationArgs]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetParameterResult]

func GetParameter(ctx *Context, args *GetParameterArgs, opts ...InvokeOption) (*GetParameterResult, error)
func GetParameterOutput(ctx *Context, args *GetParameterOutputArgs, opts ...InvokeOption) GetParameterResultOutput

> Note: This function is named GetParameter in the Go SDK.

public static class GetParameter 
{
    public static Task<GetParameterResult> InvokeAsync(GetParameterArgs args, InvokeOptions? opts = null)
    public static Output<GetParameterResult> Invoke(GetParameterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetParameterResult> getParameter(GetParameterArgs args, InvokeOptions options)
public static Output<GetParameterResult> getParameter(GetParameterArgs args, InvokeOptions options)

fn::invoke:
  function: coder:index/getParameter:getParameter
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the parameter. If this is changed, developers will be re-prompted for a new value.
Default string: A default value for the parameter.
Description string: Describe what this parameter does.
DisplayName string: The displayed name of the parameter as it will appear in the interface.
Ephemeral bool: The value of an ephemeral parameter will not be preserved between consecutive workspace builds.
FormType string: The type of this parameter. Must be one of: [radio, slider, input, dropdown, checkbox, switch, multi-select, tag-select, textarea, error].
Icon string: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
Id string: The ID of this resource.
Mutable bool: Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
Options List<GetParameterOption>: Each option block defines a value for a user to select from.
Order double: The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
Styling string
Type string: The type of this parameter. Must be one of: "number", "string", "bool", or "list(string)".
Validation GetParameterValidation: Validate the input of a parameter.

Name string: The name of the parameter. If this is changed, developers will be re-prompted for a new value.
Default string: A default value for the parameter.
Description string: Describe what this parameter does.
DisplayName string: The displayed name of the parameter as it will appear in the interface.
Ephemeral bool: The value of an ephemeral parameter will not be preserved between consecutive workspace builds.
FormType string: The type of this parameter. Must be one of: [radio, slider, input, dropdown, checkbox, switch, multi-select, tag-select, textarea, error].
Icon string: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
Id string: The ID of this resource.
Mutable bool: Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
Options []GetParameterOption: Each option block defines a value for a user to select from.
Order float64: The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
Styling string
Type string: The type of this parameter. Must be one of: "number", "string", "bool", or "list(string)".
Validation GetParameterValidation: Validate the input of a parameter.

name String: The name of the parameter. If this is changed, developers will be re-prompted for a new value.
default_ String: A default value for the parameter.
description String: Describe what this parameter does.
displayName String: The displayed name of the parameter as it will appear in the interface.
ephemeral Boolean: The value of an ephemeral parameter will not be preserved between consecutive workspace builds.
formType String: The type of this parameter. Must be one of: [radio, slider, input, dropdown, checkbox, switch, multi-select, tag-select, textarea, error].
icon String: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
id String: The ID of this resource.
mutable Boolean: Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
options List<GetParameterOption>: Each option block defines a value for a user to select from.
order Double: The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
styling String
type String: The type of this parameter. Must be one of: "number", "string", "bool", or "list(string)".
validation GetParameterValidation: Validate the input of a parameter.

name string: The name of the parameter. If this is changed, developers will be re-prompted for a new value.
default string: A default value for the parameter.
description string: Describe what this parameter does.
displayName string: The displayed name of the parameter as it will appear in the interface.
ephemeral boolean: The value of an ephemeral parameter will not be preserved between consecutive workspace builds.
formType string: The type of this parameter. Must be one of: [radio, slider, input, dropdown, checkbox, switch, multi-select, tag-select, textarea, error].
icon string: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
id string: The ID of this resource.
mutable boolean: Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
options GetParameterOption[]: Each option block defines a value for a user to select from.
order number: The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
styling string
type string: The type of this parameter. Must be one of: "number", "string", "bool", or "list(string)".
validation GetParameterValidation: Validate the input of a parameter.

name str: The name of the parameter. If this is changed, developers will be re-prompted for a new value.
default str: A default value for the parameter.
description str: Describe what this parameter does.
display_name str: The displayed name of the parameter as it will appear in the interface.
ephemeral bool: The value of an ephemeral parameter will not be preserved between consecutive workspace builds.
form_type str: The type of this parameter. Must be one of: [radio, slider, input, dropdown, checkbox, switch, multi-select, tag-select, textarea, error].
icon str: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
id str: The ID of this resource.
mutable bool: Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
options Sequence[GetParameterOption]: Each option block defines a value for a user to select from.
order float: The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
styling str
type str: The type of this parameter. Must be one of: "number", "string", "bool", or "list(string)".
validation GetParameterValidation: Validate the input of a parameter.

name String: The name of the parameter. If this is changed, developers will be re-prompted for a new value.
default String: A default value for the parameter.
description String: Describe what this parameter does.
displayName String: The displayed name of the parameter as it will appear in the interface.
ephemeral Boolean: The value of an ephemeral parameter will not be preserved between consecutive workspace builds.
formType String: The type of this parameter. Must be one of: [radio, slider, input, dropdown, checkbox, switch, multi-select, tag-select, textarea, error].
icon String: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
id String: The ID of this resource.
mutable Boolean: Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
options List<Property Map>: Each option block defines a value for a user to select from.
order Number: The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
styling String
type String: The type of this parameter. Must be one of: "number", "string", "bool", or "list(string)".
validation Property Map: Validate the input of a parameter.

getParameter Result

The following output properties are available:

Id string: The ID of this resource.
Name string: The name of the parameter. If this is changed, developers will be re-prompted for a new value.
Optional bool: Whether this value is optional.
Value string: The output value of the parameter.
Default string: A default value for the parameter.
Description string: Describe what this parameter does.
DisplayName string: The displayed name of the parameter as it will appear in the interface.
Ephemeral bool: The value of an ephemeral parameter will not be preserved between consecutive workspace builds.
FormType string: The type of this parameter. Must be one of: [radio, slider, input, dropdown, checkbox, switch, multi-select, tag-select, textarea, error].
Icon string: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
Mutable bool: Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
Options List<GetParameterOption>: Each option block defines a value for a user to select from.
Order double: The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
Styling string
Type string: The type of this parameter. Must be one of: "number", "string", "bool", or "list(string)".
Validation GetParameterValidation: Validate the input of a parameter.

Id string: The ID of this resource.
Name string: The name of the parameter. If this is changed, developers will be re-prompted for a new value.
Optional bool: Whether this value is optional.
Value string: The output value of the parameter.
Default string: A default value for the parameter.
Description string: Describe what this parameter does.
DisplayName string: The displayed name of the parameter as it will appear in the interface.
Ephemeral bool: The value of an ephemeral parameter will not be preserved between consecutive workspace builds.
FormType string: The type of this parameter. Must be one of: [radio, slider, input, dropdown, checkbox, switch, multi-select, tag-select, textarea, error].
Icon string: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
Mutable bool: Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
Options []GetParameterOption: Each option block defines a value for a user to select from.
Order float64: The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
Styling string
Type string: The type of this parameter. Must be one of: "number", "string", "bool", or "list(string)".
Validation GetParameterValidation: Validate the input of a parameter.

id String: The ID of this resource.
name String: The name of the parameter. If this is changed, developers will be re-prompted for a new value.
optional Boolean: Whether this value is optional.
value String: The output value of the parameter.
default_ String: A default value for the parameter.
description String: Describe what this parameter does.
displayName String: The displayed name of the parameter as it will appear in the interface.
ephemeral Boolean: The value of an ephemeral parameter will not be preserved between consecutive workspace builds.
formType String: The type of this parameter. Must be one of: [radio, slider, input, dropdown, checkbox, switch, multi-select, tag-select, textarea, error].
icon String: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
mutable Boolean: Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
options List<GetParameterOption>: Each option block defines a value for a user to select from.
order Double: The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
styling String
type String: The type of this parameter. Must be one of: "number", "string", "bool", or "list(string)".
validation GetParameterValidation: Validate the input of a parameter.

id string: The ID of this resource.
name string: The name of the parameter. If this is changed, developers will be re-prompted for a new value.
optional boolean: Whether this value is optional.
value string: The output value of the parameter.
default string: A default value for the parameter.
description string: Describe what this parameter does.
displayName string: The displayed name of the parameter as it will appear in the interface.
ephemeral boolean: The value of an ephemeral parameter will not be preserved between consecutive workspace builds.
formType string: The type of this parameter. Must be one of: [radio, slider, input, dropdown, checkbox, switch, multi-select, tag-select, textarea, error].
icon string: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
mutable boolean: Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
options GetParameterOption[]: Each option block defines a value for a user to select from.
order number: The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
styling string
type string: The type of this parameter. Must be one of: "number", "string", "bool", or "list(string)".
validation GetParameterValidation: Validate the input of a parameter.

id str: The ID of this resource.
name str: The name of the parameter. If this is changed, developers will be re-prompted for a new value.
optional bool: Whether this value is optional.
value str: The output value of the parameter.
default str: A default value for the parameter.
description str: Describe what this parameter does.
display_name str: The displayed name of the parameter as it will appear in the interface.
ephemeral bool: The value of an ephemeral parameter will not be preserved between consecutive workspace builds.
form_type str: The type of this parameter. Must be one of: [radio, slider, input, dropdown, checkbox, switch, multi-select, tag-select, textarea, error].
icon str: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
mutable bool: Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
options Sequence[GetParameterOption]: Each option block defines a value for a user to select from.
order float: The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
styling str
type str: The type of this parameter. Must be one of: "number", "string", "bool", or "list(string)".
validation GetParameterValidation: Validate the input of a parameter.

id String: The ID of this resource.
name String: The name of the parameter. If this is changed, developers will be re-prompted for a new value.
optional Boolean: Whether this value is optional.
value String: The output value of the parameter.
default String: A default value for the parameter.
description String: Describe what this parameter does.
displayName String: The displayed name of the parameter as it will appear in the interface.
ephemeral Boolean: The value of an ephemeral parameter will not be preserved between consecutive workspace builds.
formType String: The type of this parameter. Must be one of: [radio, slider, input, dropdown, checkbox, switch, multi-select, tag-select, textarea, error].
icon String: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
mutable Boolean: Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
options List<Property Map>: Each option block defines a value for a user to select from.
order Number: The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
styling String
type String: The type of this parameter. Must be one of: "number", "string", "bool", or "list(string)".
validation Property Map: Validate the input of a parameter.

Supporting Types

GetParameterOption

Name string: The display name of this value in the UI.
Value string: The value of this option set on the parameter if selected.
Description string: Describe what selecting this value does.
Icon string: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".

Name string: The display name of this value in the UI.
Value string: The value of this option set on the parameter if selected.
Description string: Describe what selecting this value does.
Icon string: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".

name String: The display name of this value in the UI.
value String: The value of this option set on the parameter if selected.
description String: Describe what selecting this value does.
icon String: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".

name string: The display name of this value in the UI.
value string: The value of this option set on the parameter if selected.
description string: Describe what selecting this value does.
icon string: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".

name str: The display name of this value in the UI.
value str: The value of this option set on the parameter if selected.
description str: Describe what selecting this value does.
icon str: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".

name String: The display name of this value in the UI.
value String: The value of this option set on the parameter if selected.
description String: Describe what selecting this value does.
icon String: A URL to an icon that will display in the dashboard. View built-in icons here. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".

GetParameterValidation

MaxDisabled bool: Helper field to check if max is present
MinDisabled bool: Helper field to check if min is present
Error string: An error message to display if the value breaks the validation rules. The following placeholders are supported: {max}, {min}, and {value}.
Max double: The maximum of a number parameter.
Min double: The minimum of a number parameter.
Monotonic string: Number monotonicity, either increasing or decreasing.
Regex string: A regex for the input parameter to match against.

MaxDisabled bool: Helper field to check if max is present
MinDisabled bool: Helper field to check if min is present
Error string: An error message to display if the value breaks the validation rules. The following placeholders are supported: {max}, {min}, and {value}.
Max float64: The maximum of a number parameter.
Min float64: The minimum of a number parameter.
Monotonic string: Number monotonicity, either increasing or decreasing.
Regex string: A regex for the input parameter to match against.

maxDisabled Boolean: Helper field to check if max is present
minDisabled Boolean: Helper field to check if min is present
error String: An error message to display if the value breaks the validation rules. The following placeholders are supported: {max}, {min}, and {value}.
max Double: The maximum of a number parameter.
min Double: The minimum of a number parameter.
monotonic String: Number monotonicity, either increasing or decreasing.
regex String: A regex for the input parameter to match against.

maxDisabled boolean: Helper field to check if max is present
minDisabled boolean: Helper field to check if min is present
error string: An error message to display if the value breaks the validation rules. The following placeholders are supported: {max}, {min}, and {value}.
max number: The maximum of a number parameter.
min number: The minimum of a number parameter.
monotonic string: Number monotonicity, either increasing or decreasing.
regex string: A regex for the input parameter to match against.

max_disabled bool: Helper field to check if max is present
min_disabled bool: Helper field to check if min is present
error str: An error message to display if the value breaks the validation rules. The following placeholders are supported: {max}, {min}, and {value}.
max float: The maximum of a number parameter.
min float: The minimum of a number parameter.
monotonic str: Number monotonicity, either increasing or decreasing.
regex str: A regex for the input parameter to match against.

maxDisabled Boolean: Helper field to check if max is present
minDisabled Boolean: Helper field to check if min is present
error String: An error message to display if the value breaks the validation rules. The following placeholders are supported: {max}, {min}, and {value}.
max Number: The maximum of a number parameter.
min Number: The minimum of a number parameter.
monotonic String: Number monotonicity, either increasing or decreasing.
regex String: A regex for the input parameter to match against.

Package Details

Repository: coder coder/terraform-provider-coder
License
Notes: This Pulumi package is based on the coder Terraform Provider.

coder 2.4.0-pre1 published on Tuesday, Apr 15, 2025 by coder

coder/terraform-provider-coder

coder.getParameter

On this page

On this page

Using getParameter

getParameter Result

Supporting Types

GetParameterOption

GetParameterValidation

Package Details

On this page

On this page