You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/resources/template.md
+22-2
Original file line number
Diff line number
Diff line change
@@ -23,12 +23,22 @@ A Coder template
23
23
### Optional
24
24
25
25
-`acl` (Attributes) Access control list for the template. Requires an enterprise Coder deployment. If null, ACL policies will not be added or removed by Terraform. (see [below for nested schema](#nestedatt--acl))
26
-
-`allow_user_auto_start` (Boolean)
27
-
-`allow_user_auto_stop` (Boolean)
26
+
-`activity_bump_ms` (Number) The activity bump duration for all workspaces created from this template, in milliseconds. Defaults to one hour.
27
+
-`allow_user_auto_start` (Boolean) Whether users can auto-start workspaces created from this template. Defaults to true.
28
+
-`allow_user_auto_stop` (Boolean) Whether users can auto-start workspaces created from this template. Defaults to true.
29
+
-`allow_user_cancel_workspace_jobs` (Boolean) Whether users can cancel in-progress workspace jobs using this template. Defaults to true.
30
+
-`auto_start_permitted_days_of_week` (Set of String) List of days of the week in which autostart is allowed to happen, for all workspaces created from this template. Defaults to all days. If no days are specified, autostart is not allowed. Requires an enterprise Coder deployment.
31
+
-`auto_stop_requirement` (Attributes) The auto-stop requirement for all workspaces created from this template. Requires an enterprise Coder deployment. (see [below for nested schema](#nestedatt--auto_stop_requirement))
32
+
-`default_ttl_ms` (Number) The default time-to-live for all workspaces created from this template, in milliseconds.
33
+
-`deprecation_message` (String) If set, the template will be marked as deprecated and users will be blocked from creating new workspaces from it.
28
34
-`description` (String) A description of the template.
29
35
-`display_name` (String) The display name of the template. Defaults to the template name.
36
+
-`failure_ttl_ms` (Number) The max lifetime before Coder stops all resources for failed workspaces created from this template, in milliseconds.
30
37
-`icon` (String) Relative path or external URL that specifes an icon to be displayed in the dashboard.
31
38
-`organization_id` (String) The ID of the organization. Defaults to the provider's default organization
39
+
-`require_active_version` (Boolean) Whether workspaces must be created from the active version of this template. Defaults to false.
40
+
-`time_til_dormant_autodelete_ms` (Number) The max lifetime before Coder permanently deletes dormant workspaces created from this template.
41
+
-`time_til_dormant_ms` (Number) The max lifetime before Coder locks inactive workspaces created from this template, in milliseconds.
32
42
33
43
### Read-Only
34
44
@@ -97,3 +107,13 @@ Required:
97
107
98
108
-`id` (String)
99
109
-`role` (String)
110
+
111
+
112
+
113
+
<aid="nestedatt--auto_stop_requirement"></a>
114
+
### Nested Schema for `auto_stop_requirement`
115
+
116
+
Optional:
117
+
118
+
-`days_of_week` (Set of String) List of days of the week on which restarts are required. Restarts happen within the user's quiet hours (in their configured timezone). If no days are specified, restarts are not required.
119
+
-`weeks` (Number) Weeks is the number of weeks between required restarts. Weeks are synced across all workspaces (and Coder deployments) using modulo math on a hardcoded epoch week of January 2nd, 2023 (the first Monday of 2023). Values of 0 or 1 indicate weekly restarts. Values of 2 indicate fortnightly restarts, etc.
0 commit comments