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

70 lines
2.1 KiB
Markdown
Raw Normal View History

2020-10-06 20:34:16 -04:00
---
2021-01-14 14:07:36 -08:00
# generated by https://github.com/hashicorp/terraform-plugin-docs
2020-10-06 20:34:16 -04:00
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.
---
2021-05-05 10:02:53 -07:00
# boundary_host (Resource)
2020-10-06 20:34:16 -04:00
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" {
2020-10-13 23:12:03 -04:00
name = "organization_one"
description = "My first scope!"
scope_id = "global"
auto_create_admin_role = true
auto_create_default_role = true
2020-10-06 20:34:16 -04:00
}
resource "boundary_scope" "project" {
2021-01-14 14:07:36 -08:00
name = "project_one"
description = "My first scope!"
scope_id = boundary_scope.org.id
auto_create_admin_role = true
2020-10-06 20:34:16 -04:00
}
2021-09-02 00:36:33 +03:00
resource "boundary_host_catalog" "static" {
name = "My catalog"
description = "My first host catalog!"
type = "static"
2020-10-06 20:34:16 -04:00
scope_id = boundary_scope.project.id
}
2021-09-02 00:36:33 +03:00
resource "boundary_host" "example" {
name = "example_host"
description = "My first host!"
address = "10.0.0.1"
host_catalog_id = boundary_host_catalog.static.id
}
2020-10-06 20:34:16 -04:00
```
2021-01-14 14:07:36 -08:00
<!-- schema generated by tfplugindocs -->
2020-10-06 20:34:16 -04:00
## Schema
### Required
2021-01-14 14:07:36 -08:00
- **host_catalog_id** (String)
- **type** (String)
2020-10-06 20:34:16 -04:00
### Optional
2021-01-14 14:07:36 -08:00
- **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.
2020-10-06 20:34:16 -04:00
2021-05-05 10:02:53 -07:00
### Read-Only
2021-01-14 14:07:36 -08:00
- **id** (String) The ID of the host.
2020-10-07 12:04:11 -04:00
## Import
2020-10-06 20:34:16 -04:00
2020-10-07 12:04:11 -04:00
Import is supported using the following syntax:
```shell
terraform import boundary_host.foo <my-id>
```