generated from hashicorp/terraform-provider-scaffolding
-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add project resource documentation (#22)
- Loading branch information
Showing
1 changed file
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
layout: "boundary" | ||
page_title: "Boundary: project_resource" | ||
sidebar_current: "docs-boundary-project-resource" | ||
description: |- | ||
Project resource for the Boundary Terraform provider. | ||
--- | ||
|
||
# boundary_project_resource | ||
The project resource allows you to configure a Boundary project. | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
resource "boundary_project" "foo" { | ||
name = "foo_project" | ||
description = "My first project!" | ||
} | ||
``` | ||
|
||
Usage for project-specific resources: | ||
|
||
```hcl | ||
resource "boundary_project" "foo" { | ||
name = "foo_project" | ||
} | ||
resource "boundary_user" "foo" { | ||
description = "foo user" | ||
} | ||
resource "boundary_group" "example" { | ||
name = "My group" | ||
description = "My first group!" | ||
member_ids = [boundary_user.foo.id] | ||
scope_id = boundary_project.foo.id | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are optional: | ||
* `description` - The project description. | ||
* `name` - The project name. Defaults to the resource name. |