91 lines
2.1 KiB
Markdown
91 lines
2.1 KiB
Markdown
---
|
|
page_title: "boundary_group Resource - terraform-provider-boundary"
|
|
subcategory: ""
|
|
description: |-
|
|
The group resource allows you to configure a Boundary group.
|
|
---
|
|
|
|
# Resource `boundary_group`
|
|
|
|
The group resource allows you to configure a Boundary group.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
resource "boundary_scope" "org" {
|
|
name = "organization_one"
|
|
description = "My first scope!"
|
|
scope_id = "global"
|
|
auto_create_admin_role = true
|
|
auto_create_default_role = true
|
|
}
|
|
|
|
resource "boundary_user" "foo" {
|
|
description = "foo user"
|
|
scope_id = boundary_scope.org.id
|
|
}
|
|
|
|
resource "boundary_group" "example" {
|
|
name = "My group"
|
|
description = "My first group!"
|
|
member_ids = [boundary_user.foo.id]
|
|
scope_id = boundary_scope.org.id
|
|
}
|
|
```
|
|
|
|
Usage for project-specific group:
|
|
|
|
```terraform
|
|
resource "boundary_scope" "org" {
|
|
name = "organization_one"
|
|
description = "My first scope!"
|
|
scope_id = "global"
|
|
auto_create_admin_role = true
|
|
auto_create_default_role = true
|
|
}
|
|
|
|
resource "boundary_scope" "project" {
|
|
name = "project_one"
|
|
description = "My first scope!"
|
|
scope_id = boundary_scope.org.id
|
|
auto_create_admin_role = true
|
|
}
|
|
|
|
resource "boundary_user" "foo" {
|
|
description = "foo user"
|
|
scope_id = boundary_scope.org.id
|
|
}
|
|
|
|
resource "boundary_group" "example" {
|
|
name = "My group"
|
|
description = "My first group!"
|
|
member_ids = [boundary_user.foo.id]
|
|
scope_id = boundary_scope.project.id
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `scope_id` (String) The scope ID in which the resource is created. Defaults to the provider's `default_scope` if unset.
|
|
|
|
### Optional
|
|
|
|
- `description` (String) The group description.
|
|
- `member_ids` (Set of String) Resource IDs for group members, these are most likely boundary users.
|
|
- `name` (String) The group name. Defaults to the resource name.
|
|
|
|
### Read-Only
|
|
|
|
- `id` (String) The ID of the group.
|
|
|
|
## Import
|
|
|
|
Import is supported using the following syntax:
|
|
|
|
```shell
|
|
terraform import boundary_group.foo <my-id>
|
|
```
|