Amit Kotagi
f059618167
* feat(proj-alias): support project scoped alias via suffixes * fix: generate resouce docs using make gen * fix: address review comments * chore: make gen changes * fix(proja-alias): validate scope id before calling remove alias suffix * fix: filter unknown scopes in validation
68 lines
1.9 KiB
Markdown
68 lines
1.9 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "boundary_scope_alias_suffix Resource - terraform-provider-boundary"
|
|
subcategory: ""
|
|
description: |-
|
|
The scope alias suffix resource allows you to set an alias suffix for an org or project scope. Global scopes are not valid for alias suffix operations.
|
|
---
|
|
|
|
# boundary_scope_alias_suffix (Resource)
|
|
|
|
The scope alias suffix resource allows you to set an alias suffix for an org or project scope. Global scopes are not valid for alias suffix operations.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
resource "boundary_scope" "global" {
|
|
global_scope = true
|
|
scope_id = "global"
|
|
}
|
|
|
|
resource "boundary_scope" "org" {
|
|
name = "organization_one"
|
|
description = "My first scope!"
|
|
scope_id = boundary_scope.global.id
|
|
auto_create_admin_role = true
|
|
auto_create_default_role = true
|
|
}
|
|
|
|
resource "boundary_scope" "project" {
|
|
name = "project_one"
|
|
description = "My first project"
|
|
scope_id = boundary_scope.org.id
|
|
auto_create_admin_role = true
|
|
}
|
|
|
|
resource "boundary_scope_alias_suffix" "org_suffix" {
|
|
scope_id = boundary_scope.org.id
|
|
alias_suffix = "org"
|
|
}
|
|
|
|
resource "boundary_scope_alias_suffix" "project_suffix" {
|
|
scope_id = boundary_scope.project.id
|
|
alias_suffix = "projectone"
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `alias_suffix` (String) The alias suffix value for this scope.
|
|
- `scope_id` (String) The scope ID. Alias suffixes are supported for org and project scopes.
|
|
|
|
### Read-Only
|
|
|
|
- `id` (String) The ID of this resource.
|
|
|
|
## Import
|
|
|
|
Import is supported using the following syntax:
|
|
|
|
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
|
|
|
|
```shell
|
|
terraform import boundary_scope_alias_suffix.org_suffix <scope-id>
|
|
```
|