Files
terraform-provider-threshold/docs/resources/worker.md
T

59 lines
1.8 KiB
Markdown
Raw Normal View History

---
page_title: "boundary_worker Resource - terraform-provider-boundary"
subcategory: ""
description: |-
The resource allows you to create a self-managed worker object.
---
# boundary_worker (Resource)
The resource allows you to create a self-managed worker object.
2023-02-18 07:35:00 +11:00
## Example Usage
### Controller-led worker
2023-02-18 07:35:00 +11:00
```terraform
resource "boundary_worker" "controller_led" {
2023-03-21 20:38:03 -07:00
scope_id = "global"
name = "controller-led-worker-1"
2023-03-21 20:38:03 -07:00
description = "self managed worker with controller led auth"
2023-02-18 07:35:00 +11:00
}
```
2023-02-18 07:35:00 +11:00
### Worker-led worker
```terraform
resource "boundary_worker" "worker_led" {
2023-03-21 20:38:03 -07:00
scope_id = "global"
name = "worker-led-worker-1"
2023-03-21 20:38:03 -07:00
description = "self managed worker with worker led auth"
worker_generated_auth_token = var.worker_generated_auth_token
2023-02-18 07:35:00 +11:00
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Optional
- `description` (String) The description for the worker.
- `name` (String) The name for the worker.
- `scope_id` (String) The scope for the worker. Defaults to `global`.
- `worker_generated_auth_token` (String) The worker authentication token required to register the worker for the worker-led authentication flow. Leaving this blank will result in a controller generated token.
### Read-Only
- `address` (String) The accessible address of the self managed worker.
- `authorized_actions` (List of String) A list of actions that the worker is entitled to perform.
- `controller_generated_activation_token` (String) A single use token generated by the controller to be passed to the self-managed worker.
- `id` (String) The ID of the worker.
- `release_version` (Number) The version of the Boundary binary running on the self managed worker.
2022-11-29 14:03:43 -08:00
## Import
2022-11-29 14:03:43 -08:00
Import is supported using the following syntax:
```shell
terraform import boundary_worker.foo <my-id>
```