Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update primary ip arguments requirements #1017

Merged
merged 2 commits into from
Oct 25, 2024
Merged

docs: update primary ip arguments requirements #1017

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27b5b39
docs: add note on primary ip about arg requirements
ghostdevv Oct 25, 2024
ef03ecf
docs: further improve the primary ip docs
jooola Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions website/docs/r/primary_ip.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,22 +50,23 @@ resource "hcloud_server" "server_test" {
- `auto_delete` - (bool) Whether auto delete is enabled.
`Important note:`It is recommended to set `auto_delete` to `false`, because if a server assigned to the managed ip is getting deleted, it will also delete the primary IP which will break the TF state.
- `labels` - (map, optional) User-defined labels (key-value pairs).
- `assignee_id` - (int) ID of the assigned resource
- `assignee_id` - (int, optional) ID of the assigned resource.
- `assignee_type` - (string) The type of the assigned resource. Currently supported: `server`
- `delete_protection` - (bool) Whether delete protection is enabled. See ["Delete Protection"](../index.html.markdown#delete-protection) in the Provider Docs for details.
- `delete_protection` - (bool, optional) Whether delete protection is enabled. See ["Delete Protection"](../index.html.markdown#delete-protection) in the Provider Docs for details.

Note: At least one of `datacenter` or `assignee_id` is required.

## Attributes Reference

- `id` - (int) Unique ID of the Primary IP.
- `type` - (string) Type of the Primary IP.
- `datacenter` - (string, optional) The datacenter name to create the resource in.
- `datacenter` - (string) The datacenter of the Primary IP.
- `name` - (string) Name of the Primary IP.
- `auto_delete` - (bool) Whether auto delete is enabled.
`Important note:`It is recommended to set `auto_delete` to `false`, because if a server assigned to a managed ip is getting deleted, it will also delete the primary IP which will break the TF state.
- `labels` - (map) User-defined labels (key-value pairs).
- `ip_address` - (string) IP Address of the Primary IP.
- `ip_network` - (string) IPv6 subnet of the Primary IP for IPv6 addresses. (Only set if `type` is `ipv6`)
- `assignee_id` - (int) ID of the assigned resource
- `assignee_id` - (int) ID of the assigned resource.
- `assignee_type` - (string) The type of the assigned resource.
- `delete_protection` - (bool) Whether delete protection is enabled.

Expand Down
Loading