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.

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

Update documentation #13

Merged
merged 1 commit into from
Jul 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions docs/data-sources/connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,5 @@ Use an `cloudconnexa_connector` data source to read an existing CloudConnexa con
- `ip_v6_address` (String) The IPV6 address of the connector.
- `network_item_id` (String) The id of the network or host with which the connector is associated.
- `network_item_type` (String) The network object type of the connector. This typically will be set to either `NETWORK` or `HOST`.
- `profile` (String) OpenVPN profile
- `vpn_region_id` (String) The id of the region where the connector is deployed.


50 changes: 50 additions & 0 deletions docs/data-sources/ip_service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "cloudconnexa_ip_service Data Source - terraform-provider-cloudconnexa"
subcategory: ""
description: |-

---

# cloudconnexa_ip_service (Data Source)





<!-- schema generated by tfplugindocs -->
## Schema

### Read-Only

- `config` (List of Object) (see [below for nested schema](#nestedatt--config))
- `description` (String)
- `id` (String) The ID of this resource.
- `name` (String)
- `network_item_id` (String)
- `network_item_type` (String)
- `routes` (List of String)
- `type` (String)

<a id="nestedatt--config"></a>
### Nested Schema for `config`

Read-Only:

- `custom_service_types` (List of Object) (see [below for nested schema](#nestedobjatt--config--custom_service_types))
- `service_types` (List of String)

<a id="nestedobjatt--config--custom_service_types"></a>
### Nested Schema for `config.custom_service_types`

Read-Only:

- `icmp_type` (List of Object) (see [below for nested schema](#nestedobjatt--config--custom_service_types--icmp_type))

<a id="nestedobjatt--config--custom_service_types--icmp_type"></a>
### Nested Schema for `config.custom_service_types.icmp_type`

Read-Only:

- `lower_value` (Number)
- `upper_value` (Number)
2 changes: 0 additions & 2 deletions docs/data-sources/user_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,3 @@ Use an `cloudconnexa_user_group` data source to read an CloudConnexa user group.
- `system_subnets` (List of String) The IPV4 and IPV6 addresses of the subnets associated with this user group.
- `user_group_id` (String) The user group ID.
- `vpn_region_ids` (List of String) The list of VPN region IDs this user group is associated with.


2 changes: 0 additions & 2 deletions docs/data-sources/vpn_region.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,3 @@ Use a `cloudconnexa_vpn_region` data source to read an CloudConnexa VPN region.
- `country_iso` (String) The ISO code of the country of the region.
- `id` (String) The ID of this resource.
- `region_name` (String) The name of the region.


56 changes: 56 additions & 0 deletions docs/resources/ip_service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "cloudconnexa_ip_service Resource - terraform-provider-cloudconnexa"
subcategory: ""
description: |-

---

# cloudconnexa_ip_service (Resource)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String)
- `network_item_id` (String)
- `network_item_type` (String)
- `routes` (List of String)
- `type` (String)

### Optional

- `config` (Block List, Max: 1) (see [below for nested schema](#nestedblock--config))
- `description` (String)

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--config"></a>
### Nested Schema for `config`

Optional:

- `custom_service_types` (Block List) (see [below for nested schema](#nestedblock--config--custom_service_types))
- `service_types` (List of String)

<a id="nestedblock--config--custom_service_types"></a>
### Nested Schema for `config.custom_service_types`

Required:

- `icmp_type` (Block List, Min: 1) (see [below for nested schema](#nestedblock--config--custom_service_types--icmp_type))

<a id="nestedblock--config--custom_service_types--icmp_type"></a>
### Nested Schema for `config.custom_service_types.icmp_type`

Required:

- `lower_value` (Number)
- `upper_value` (Number)
32 changes: 32 additions & 0 deletions docs/resources/user_group.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "cloudconnexa_user_group Resource - terraform-provider-cloudconnexa"
subcategory: ""
description: |-
Use cloudconnexa_user_group to create an CloudConnexa user group.
---

# cloudconnexa_user_group (Resource)

Use `cloudconnexa_user_group` to create an CloudConnexa user group.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String) The name of the user group.
- `vpn_region_ids` (List of String) A list of VPN regions that are accessible to the user group.

### Optional

- `connect_auth` (String)
- `internet_access` (String)
- `max_device` (Number) The maximum number of devices that can be connected to the user group.
- `system_subnets` (List of String) A list of subnets that are accessible to the user group.

### Read-Only

- `id` (String) The ID of the user group.
2 changes: 1 addition & 1 deletion templates/index.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Use this provider to interact with the [CloudConnexa API](https://openvpn.net/cl

### Required

- **base_url** (String) The base url of your CloudConnexa accout.
- **base_url** (String) The base url of your CloudConnexa account.

### Optional

Expand Down