|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title:"coder_script Resource - terraform-provider-coder" |
| 4 | +subcategory:"" |
| 5 | +description:|- |
| 6 | + Use this resource to run a script from an agent. |
| 7 | +--- |
| 8 | + |
| 9 | +#coder_script (Resource) |
| 10 | + |
| 11 | +Use this resource to run a script from an agent. |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +<!-- schema generated by tfplugindocs--> |
| 16 | +##Schema |
| 17 | + |
| 18 | +###Required |
| 19 | + |
| 20 | +-`agent_id` (String) The "id" property of a "coder_agent" resource to associate with. |
| 21 | +-`script` (String) The script to run. |
| 22 | + |
| 23 | +###Optional |
| 24 | + |
| 25 | +-`login_before_ready` (Boolean) This option defines whether or not the user can (by default) login to the workspace before it is ready. Ready means that e.g. the script is done and has exited. When enabled, users may see an incomplete workspace when logging in. |
| 26 | +-`run_on_start` (Boolean) This option defines whether or not the script should run when the agent starts. |
| 27 | +-`run_on_stop` (Boolean) This option defines whether or not the script should run when the agent stops. |
| 28 | +-`schedule` (String) The schedule to run the script on. This is a cron expression. |
| 29 | +-`timeout` (Number) Time in seconds until the agent lifecycle status is marked as timed out, this happens when the script has not completed (exited) in the given time. |
| 30 | + |
| 31 | +###Read-Only |
| 32 | + |
| 33 | +-`id` (String) The ID of this resource. |