71 lines
2.1 KiB
Markdown
71 lines
2.1 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "boundary_host Resource - terraform-provider-boundary"
|
|
subcategory: ""
|
|
description: |-
|
|
The host resource allows you to configure a Boundary static host. Hosts are always part of a project, so a project resource should be used inline or you should have the project ID in hand to successfully configure a host.
|
|
---
|
|
|
|
# boundary_host (Resource)
|
|
|
|
The host resource allows you to configure a Boundary static host. Hosts are always part of a project, so a project resource should be used inline or you should have the project ID in hand to successfully configure a host.
|
|
|
|
## 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_scope" "project" {
|
|
name = "project_one"
|
|
description = "My first scope!"
|
|
scope_id = boundary_scope.org.id
|
|
auto_create_admin_role = true
|
|
}
|
|
|
|
resource "boundary_host_catalog" "static" {
|
|
name = "My catalog"
|
|
description = "My first host catalog!"
|
|
type = "static"
|
|
scope_id = boundary_scope.project.id
|
|
}
|
|
|
|
resource "boundary_host" "example" {
|
|
name = "example_host"
|
|
description = "My first host!"
|
|
address = "10.0.0.1"
|
|
host_catalog_id = boundary_host_catalog.static.id
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- **host_catalog_id** (String)
|
|
- **type** (String)
|
|
|
|
### Optional
|
|
|
|
- **address** (String) The static address of the host resource as `<IP>` (note: port assignment occurs in the target resource definition, do not add :port here) or a domain name.
|
|
- **description** (String) The host description.
|
|
- **name** (String) The host name. Defaults to the resource name.
|
|
|
|
### Read-Only
|
|
|
|
- **id** (String) The ID of the host.
|
|
|
|
## Import
|
|
|
|
Import is supported using the following syntax:
|
|
|
|
```shell
|
|
terraform import boundary_host.foo <my-id>
|
|
```
|