coder.getWorkspacePreset
Explore with Pulumi AI
Use this data source to predefine common configurations for coder workspaces. Users will have the option to select a defined preset, which will automatically apply the selected configuration. Any parameters defined in the preset will be applied to the workspace. Parameters that are defined by the template but not defined by the preset will still be configurable when creating a workspace.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as coder from "@pulumi/coder";
const example = coder.getWorkspacePreset({
name: "example",
description: "Example description of what this preset does.",
icon: "/icon/example.svg",
parameters: {
[data.coder_parameter.example.name]: "us-central1-a",
[data.coder_parameter.ami.name]: "ami-xxxxxxxx",
},
});
const standard = coder.getWorkspacePreset({
name: "Standard",
description: "A workspace preset with medium compute in the US West region.",
icon: "/icon/standard.svg",
"default": true,
parameters: {
[data.coder_parameter.instance_type.name]: "t3.medium",
[data.coder_parameter.region.name]: "us-west-2",
},
});
import pulumi
import pulumi_coder as coder
example = coder.get_workspace_preset(name="example",
description="Example description of what this preset does.",
icon="/icon/example.svg",
parameters={
data["coder_parameter"]["example"]["name"]: "us-central1-a",
data["coder_parameter"]["ami"]["name"]: "ami-xxxxxxxx",
})
standard = coder.get_workspace_preset(name="Standard",
description="A workspace preset with medium compute in the US West region.",
icon="/icon/standard.svg",
default=True,
parameters={
data["coder_parameter"]["instance_type"]["name"]: "t3.medium",
data["coder_parameter"]["region"]["name"]: "us-west-2",
})
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/coder/v2/coder"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := coder.GetWorkspacePreset(ctx, &coder.GetWorkspacePresetArgs{
Name: "example",
Description: pulumi.StringRef("Example description of what this preset does."),
Icon: pulumi.StringRef("/icon/example.svg"),
Parameters: map[string]string{
data.Coder_parameter.Example.Name: "us-central1-a",
data.Coder_parameter.Ami.Name: "ami-xxxxxxxx",
},
}, nil)
if err != nil {
return err
}
_, err = coder.GetWorkspacePreset(ctx, &coder.GetWorkspacePresetArgs{
Name: "Standard",
Description: pulumi.StringRef("A workspace preset with medium compute in the US West region."),
Icon: pulumi.StringRef("/icon/standard.svg"),
Default: pulumi.BoolRef(true),
Parameters: map[string]string{
data.Coder_parameter.Instance_type.Name: "t3.medium",
data.Coder_parameter.Region.Name: "us-west-2",
},
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Coder = Pulumi.Coder;
return await Deployment.RunAsync(() =>
{
var example = Coder.GetWorkspacePreset.Invoke(new()
{
Name = "example",
Description = "Example description of what this preset does.",
Icon = "/icon/example.svg",
Parameters =
{
{ data.Coder_parameter.Example.Name, "us-central1-a" },
{ data.Coder_parameter.Ami.Name, "ami-xxxxxxxx" },
},
});
var standard = Coder.GetWorkspacePreset.Invoke(new()
{
Name = "Standard",
Description = "A workspace preset with medium compute in the US West region.",
Icon = "/icon/standard.svg",
Default = true,
Parameters =
{
{ data.Coder_parameter.Instance_type.Name, "t3.medium" },
{ data.Coder_parameter.Region.Name, "us-west-2" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.coder.CoderFunctions;
import com.pulumi.coder.inputs.GetWorkspacePresetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = CoderFunctions.getWorkspacePreset(GetWorkspacePresetArgs.builder()
.name("example")
.description("Example description of what this preset does.")
.icon("/icon/example.svg")
.parameters(Map.ofEntries(
Map.entry(data.coder_parameter().example().name(), "us-central1-a"),
Map.entry(data.coder_parameter().ami().name(), "ami-xxxxxxxx")
))
.build());
final var standard = CoderFunctions.getWorkspacePreset(GetWorkspacePresetArgs.builder()
.name("Standard")
.description("A workspace preset with medium compute in the US West region.")
.icon("/icon/standard.svg")
.default_(true)
.parameters(Map.ofEntries(
Map.entry(data.coder_parameter().instance_type().name(), "t3.medium"),
Map.entry(data.coder_parameter().region().name(), "us-west-2")
))
.build());
}
}
variables:
example:
fn::invoke:
function: coder:getWorkspacePreset
arguments:
name: example
description: Example description of what this preset does.
icon: /icon/example.svg
parameters:
${data.coder_parameter.example.name}: us-central1-a
${data.coder_parameter.ami.name}: ami-xxxxxxxx
standard:
fn::invoke:
function: coder:getWorkspacePreset
arguments:
name: Standard
description: A workspace preset with medium compute in the US West region.
icon: /icon/standard.svg
default: true
parameters:
${data.coder_parameter.instance_type.name}: t3.medium
${data.coder_parameter.region.name}: us-west-2
Using getWorkspacePreset
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 getWorkspacePreset(args: GetWorkspacePresetArgs, opts?: InvokeOptions): Promise<GetWorkspacePresetResult>
function getWorkspacePresetOutput(args: GetWorkspacePresetOutputArgs, opts?: InvokeOptions): Output<GetWorkspacePresetResult>
def get_workspace_preset(default: Optional[bool] = None,
description: Optional[str] = None,
icon: Optional[str] = None,
name: Optional[str] = None,
parameters: Optional[Mapping[str, str]] = None,
prebuilds: Optional[GetWorkspacePresetPrebuilds] = None,
opts: Optional[InvokeOptions] = None) -> GetWorkspacePresetResult
def get_workspace_preset_output(default: Optional[pulumi.Input[bool]] = None,
description: Optional[pulumi.Input[str]] = None,
icon: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
parameters: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
prebuilds: Optional[pulumi.Input[GetWorkspacePresetPrebuildsArgs]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetWorkspacePresetResult]
func GetWorkspacePreset(ctx *Context, args *GetWorkspacePresetArgs, opts ...InvokeOption) (*GetWorkspacePresetResult, error)
func GetWorkspacePresetOutput(ctx *Context, args *GetWorkspacePresetOutputArgs, opts ...InvokeOption) GetWorkspacePresetResultOutput
> Note: This function is named GetWorkspacePreset
in the Go SDK.
public static class GetWorkspacePreset
{
public static Task<GetWorkspacePresetResult> InvokeAsync(GetWorkspacePresetArgs args, InvokeOptions? opts = null)
public static Output<GetWorkspacePresetResult> Invoke(GetWorkspacePresetInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetWorkspacePresetResult> getWorkspacePreset(GetWorkspacePresetArgs args, InvokeOptions options)
public static Output<GetWorkspacePresetResult> getWorkspacePreset(GetWorkspacePresetArgs args, InvokeOptions options)
fn::invoke:
function: coder:index/getWorkspacePreset:getWorkspacePreset
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- The name of the workspace preset.
- Default bool
- Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.
- Description string
- Describe what this preset 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>"
. - Parameters Dictionary<string, string>
- Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.
- Prebuilds
Get
Workspace Preset Prebuilds - Configuration for prebuilt workspaces associated with this preset. Coder will maintain a pool of standby workspaces based on this configuration. When a user creates a workspace using this preset, they are assigned a prebuilt workspace instead of waiting for a new one to build. See prebuilt workspace documentation here
- Name string
- The name of the workspace preset.
- Default bool
- Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.
- Description string
- Describe what this preset 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>"
. - Parameters map[string]string
- Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.
- Prebuilds
Get
Workspace Preset Prebuilds - Configuration for prebuilt workspaces associated with this preset. Coder will maintain a pool of standby workspaces based on this configuration. When a user creates a workspace using this preset, they are assigned a prebuilt workspace instead of waiting for a new one to build. See prebuilt workspace documentation here
- name String
- The name of the workspace preset.
- default_ Boolean
- Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.
- description String
- Describe what this preset 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>"
. - parameters Map<String,String>
- Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.
- prebuilds
Get
Workspace Preset Prebuilds - Configuration for prebuilt workspaces associated with this preset. Coder will maintain a pool of standby workspaces based on this configuration. When a user creates a workspace using this preset, they are assigned a prebuilt workspace instead of waiting for a new one to build. See prebuilt workspace documentation here
- name string
- The name of the workspace preset.
- default boolean
- Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.
- description string
- Describe what this preset 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>"
. - parameters {[key: string]: string}
- Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.
- prebuilds
Get
Workspace Preset Prebuilds - Configuration for prebuilt workspaces associated with this preset. Coder will maintain a pool of standby workspaces based on this configuration. When a user creates a workspace using this preset, they are assigned a prebuilt workspace instead of waiting for a new one to build. See prebuilt workspace documentation here
- name str
- The name of the workspace preset.
- default bool
- Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.
- description str
- Describe what this preset 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>"
. - parameters Mapping[str, str]
- Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.
- prebuilds
Get
Workspace Preset Prebuilds - Configuration for prebuilt workspaces associated with this preset. Coder will maintain a pool of standby workspaces based on this configuration. When a user creates a workspace using this preset, they are assigned a prebuilt workspace instead of waiting for a new one to build. See prebuilt workspace documentation here
- name String
- The name of the workspace preset.
- default Boolean
- Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.
- description String
- Describe what this preset 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>"
. - parameters Map<String>
- Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.
- prebuilds Property Map
- Configuration for prebuilt workspaces associated with this preset. Coder will maintain a pool of standby workspaces based on this configuration. When a user creates a workspace using this preset, they are assigned a prebuilt workspace instead of waiting for a new one to build. See prebuilt workspace documentation here
getWorkspacePreset Result
The following output properties are available:
- Id string
- The preset ID is automatically generated and may change between runs. It is recommended to use the
name
attribute to identify the preset. - Name string
- The name of the workspace preset.
- Default bool
- Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.
- Description string
- Describe what this preset 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>"
. - Parameters Dictionary<string, string>
- Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.
- Prebuilds
Get
Workspace Preset Prebuilds - Configuration for prebuilt workspaces associated with this preset. Coder will maintain a pool of standby workspaces based on this configuration. When a user creates a workspace using this preset, they are assigned a prebuilt workspace instead of waiting for a new one to build. See prebuilt workspace documentation here
- Id string
- The preset ID is automatically generated and may change between runs. It is recommended to use the
name
attribute to identify the preset. - Name string
- The name of the workspace preset.
- Default bool
- Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.
- Description string
- Describe what this preset 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>"
. - Parameters map[string]string
- Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.
- Prebuilds
Get
Workspace Preset Prebuilds - Configuration for prebuilt workspaces associated with this preset. Coder will maintain a pool of standby workspaces based on this configuration. When a user creates a workspace using this preset, they are assigned a prebuilt workspace instead of waiting for a new one to build. See prebuilt workspace documentation here
- id String
- The preset ID is automatically generated and may change between runs. It is recommended to use the
name
attribute to identify the preset. - name String
- The name of the workspace preset.
- default_ Boolean
- Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.
- description String
- Describe what this preset 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>"
. - parameters Map<String,String>
- Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.
- prebuilds
Get
Workspace Preset Prebuilds - Configuration for prebuilt workspaces associated with this preset. Coder will maintain a pool of standby workspaces based on this configuration. When a user creates a workspace using this preset, they are assigned a prebuilt workspace instead of waiting for a new one to build. See prebuilt workspace documentation here
- id string
- The preset ID is automatically generated and may change between runs. It is recommended to use the
name
attribute to identify the preset. - name string
- The name of the workspace preset.
- default boolean
- Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.
- description string
- Describe what this preset 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>"
. - parameters {[key: string]: string}
- Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.
- prebuilds
Get
Workspace Preset Prebuilds - Configuration for prebuilt workspaces associated with this preset. Coder will maintain a pool of standby workspaces based on this configuration. When a user creates a workspace using this preset, they are assigned a prebuilt workspace instead of waiting for a new one to build. See prebuilt workspace documentation here
- id str
- The preset ID is automatically generated and may change between runs. It is recommended to use the
name
attribute to identify the preset. - name str
- The name of the workspace preset.
- default bool
- Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.
- description str
- Describe what this preset 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>"
. - parameters Mapping[str, str]
- Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.
- prebuilds
Get
Workspace Preset Prebuilds - Configuration for prebuilt workspaces associated with this preset. Coder will maintain a pool of standby workspaces based on this configuration. When a user creates a workspace using this preset, they are assigned a prebuilt workspace instead of waiting for a new one to build. See prebuilt workspace documentation here
- id String
- The preset ID is automatically generated and may change between runs. It is recommended to use the
name
attribute to identify the preset. - name String
- The name of the workspace preset.
- default Boolean
- Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.
- description String
- Describe what this preset 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>"
. - parameters Map<String>
- Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.
- prebuilds Property Map
- Configuration for prebuilt workspaces associated with this preset. Coder will maintain a pool of standby workspaces based on this configuration. When a user creates a workspace using this preset, they are assigned a prebuilt workspace instead of waiting for a new one to build. See prebuilt workspace documentation here
Supporting Types
GetWorkspacePresetPrebuilds
- Instances double
- The number of workspaces to keep in reserve for this preset.
- Expiration
Policy GetWorkspace Preset Prebuilds Expiration Policy - Configuration block that defines TTL (time-to-live) behavior for prebuilds. Use this to automatically invalidate and delete prebuilds after a certain period, ensuring they stay up-to-date.
- Scheduling
Get
Workspace Preset Prebuilds Scheduling - Configuration block that defines scheduling behavior for prebuilds. Use this to automatically adjust the number of prebuild instances based on a schedule.
- Instances float64
- The number of workspaces to keep in reserve for this preset.
- Expiration
Policy GetWorkspace Preset Prebuilds Expiration Policy - Configuration block that defines TTL (time-to-live) behavior for prebuilds. Use this to automatically invalidate and delete prebuilds after a certain period, ensuring they stay up-to-date.
- Scheduling
Get
Workspace Preset Prebuilds Scheduling - Configuration block that defines scheduling behavior for prebuilds. Use this to automatically adjust the number of prebuild instances based on a schedule.
- instances Double
- The number of workspaces to keep in reserve for this preset.
- expiration
Policy GetWorkspace Preset Prebuilds Expiration Policy - Configuration block that defines TTL (time-to-live) behavior for prebuilds. Use this to automatically invalidate and delete prebuilds after a certain period, ensuring they stay up-to-date.
- scheduling
Get
Workspace Preset Prebuilds Scheduling - Configuration block that defines scheduling behavior for prebuilds. Use this to automatically adjust the number of prebuild instances based on a schedule.
- instances number
- The number of workspaces to keep in reserve for this preset.
- expiration
Policy GetWorkspace Preset Prebuilds Expiration Policy - Configuration block that defines TTL (time-to-live) behavior for prebuilds. Use this to automatically invalidate and delete prebuilds after a certain period, ensuring they stay up-to-date.
- scheduling
Get
Workspace Preset Prebuilds Scheduling - Configuration block that defines scheduling behavior for prebuilds. Use this to automatically adjust the number of prebuild instances based on a schedule.
- instances float
- The number of workspaces to keep in reserve for this preset.
- expiration_
policy GetWorkspace Preset Prebuilds Expiration Policy - Configuration block that defines TTL (time-to-live) behavior for prebuilds. Use this to automatically invalidate and delete prebuilds after a certain period, ensuring they stay up-to-date.
- scheduling
Get
Workspace Preset Prebuilds Scheduling - Configuration block that defines scheduling behavior for prebuilds. Use this to automatically adjust the number of prebuild instances based on a schedule.
- instances Number
- The number of workspaces to keep in reserve for this preset.
- expiration
Policy Property Map - Configuration block that defines TTL (time-to-live) behavior for prebuilds. Use this to automatically invalidate and delete prebuilds after a certain period, ensuring they stay up-to-date.
- scheduling Property Map
- Configuration block that defines scheduling behavior for prebuilds. Use this to automatically adjust the number of prebuild instances based on a schedule.
GetWorkspacePresetPrebuildsExpirationPolicy
- Ttl double
- Time in seconds after which an unclaimed prebuild is considered expired and eligible for cleanup.
- Ttl float64
- Time in seconds after which an unclaimed prebuild is considered expired and eligible for cleanup.
- ttl Double
- Time in seconds after which an unclaimed prebuild is considered expired and eligible for cleanup.
- ttl number
- Time in seconds after which an unclaimed prebuild is considered expired and eligible for cleanup.
- ttl float
- Time in seconds after which an unclaimed prebuild is considered expired and eligible for cleanup.
- ttl Number
- Time in seconds after which an unclaimed prebuild is considered expired and eligible for cleanup.
GetWorkspacePresetPrebuildsScheduling
- Schedules
List<Get
Workspace Preset Prebuilds Scheduling Schedule> - One or more schedule blocks that define when to scale the number of prebuild instances.
- Timezone string
- The timezone to use for the prebuild schedules (e.g., "UTC", "America/NewYork"). Timezone must be a valid timezone in the IANA timezone database. See https://en.wikipedia.org/wiki/Listoftzdatabasetimezones for a complete list of valid timezone identifiers and https://www.iana.org/time-zones for the official IANA timezone database.
- Schedules
[]Get
Workspace Preset Prebuilds Scheduling Schedule - One or more schedule blocks that define when to scale the number of prebuild instances.
- Timezone string
- The timezone to use for the prebuild schedules (e.g., "UTC", "America/NewYork"). Timezone must be a valid timezone in the IANA timezone database. See https://en.wikipedia.org/wiki/Listoftzdatabasetimezones for a complete list of valid timezone identifiers and https://www.iana.org/time-zones for the official IANA timezone database.
- schedules
List<Get
Workspace Preset Prebuilds Scheduling Schedule> - One or more schedule blocks that define when to scale the number of prebuild instances.
- timezone String
- The timezone to use for the prebuild schedules (e.g., "UTC", "America/NewYork"). Timezone must be a valid timezone in the IANA timezone database. See https://en.wikipedia.org/wiki/Listoftzdatabasetimezones for a complete list of valid timezone identifiers and https://www.iana.org/time-zones for the official IANA timezone database.
- schedules
Get
Workspace Preset Prebuilds Scheduling Schedule[] - One or more schedule blocks that define when to scale the number of prebuild instances.
- timezone string
- The timezone to use for the prebuild schedules (e.g., "UTC", "America/NewYork"). Timezone must be a valid timezone in the IANA timezone database. See https://en.wikipedia.org/wiki/Listoftzdatabasetimezones for a complete list of valid timezone identifiers and https://www.iana.org/time-zones for the official IANA timezone database.
- schedules
Sequence[Get
Workspace Preset Prebuilds Scheduling Schedule] - One or more schedule blocks that define when to scale the number of prebuild instances.
- timezone str
- The timezone to use for the prebuild schedules (e.g., "UTC", "America/NewYork"). Timezone must be a valid timezone in the IANA timezone database. See https://en.wikipedia.org/wiki/Listoftzdatabasetimezones for a complete list of valid timezone identifiers and https://www.iana.org/time-zones for the official IANA timezone database.
- schedules List<Property Map>
- One or more schedule blocks that define when to scale the number of prebuild instances.
- timezone String
- The timezone to use for the prebuild schedules (e.g., "UTC", "America/NewYork"). Timezone must be a valid timezone in the IANA timezone database. See https://en.wikipedia.org/wiki/Listoftzdatabasetimezones for a complete list of valid timezone identifiers and https://www.iana.org/time-zones for the official IANA timezone database.
GetWorkspacePresetPrebuildsSchedulingSchedule
- Cron string
- A cron expression that defines when this schedule should be active. The cron expression must be in the format "* HOUR DOM MONTH DAY-OF-WEEK" where HOUR is 0-23, DOM (day-of-month) is 1-31, MONTH is 1-12, and DAY-OF-WEEK is 0-6 (Sunday-Saturday). The minute field must be "*" to ensure the schedule covers entire hours rather than specific minute intervals.
- Instances double
- The number of prebuild instances to maintain during this schedule period.
- Cron string
- A cron expression that defines when this schedule should be active. The cron expression must be in the format "* HOUR DOM MONTH DAY-OF-WEEK" where HOUR is 0-23, DOM (day-of-month) is 1-31, MONTH is 1-12, and DAY-OF-WEEK is 0-6 (Sunday-Saturday). The minute field must be "*" to ensure the schedule covers entire hours rather than specific minute intervals.
- Instances float64
- The number of prebuild instances to maintain during this schedule period.
- cron String
- A cron expression that defines when this schedule should be active. The cron expression must be in the format "* HOUR DOM MONTH DAY-OF-WEEK" where HOUR is 0-23, DOM (day-of-month) is 1-31, MONTH is 1-12, and DAY-OF-WEEK is 0-6 (Sunday-Saturday). The minute field must be "*" to ensure the schedule covers entire hours rather than specific minute intervals.
- instances Double
- The number of prebuild instances to maintain during this schedule period.
- cron string
- A cron expression that defines when this schedule should be active. The cron expression must be in the format "* HOUR DOM MONTH DAY-OF-WEEK" where HOUR is 0-23, DOM (day-of-month) is 1-31, MONTH is 1-12, and DAY-OF-WEEK is 0-6 (Sunday-Saturday). The minute field must be "*" to ensure the schedule covers entire hours rather than specific minute intervals.
- instances number
- The number of prebuild instances to maintain during this schedule period.
- cron str
- A cron expression that defines when this schedule should be active. The cron expression must be in the format "* HOUR DOM MONTH DAY-OF-WEEK" where HOUR is 0-23, DOM (day-of-month) is 1-31, MONTH is 1-12, and DAY-OF-WEEK is 0-6 (Sunday-Saturday). The minute field must be "*" to ensure the schedule covers entire hours rather than specific minute intervals.
- instances float
- The number of prebuild instances to maintain during this schedule period.
- cron String
- A cron expression that defines when this schedule should be active. The cron expression must be in the format "* HOUR DOM MONTH DAY-OF-WEEK" where HOUR is 0-23, DOM (day-of-month) is 1-31, MONTH is 1-12, and DAY-OF-WEEK is 0-6 (Sunday-Saturday). The minute field must be "*" to ensure the schedule covers entire hours rather than specific minute intervals.
- instances Number
- The number of prebuild instances to maintain during this schedule period.
Package Details
- Repository
- coder coder/terraform-provider-coder
- License
- Notes
- This Pulumi package is based on the
coder
Terraform Provider.