Skip to content

Commit 293fad8

Browse files
author
GitHub Actions
committed
Update Terraform Provider docs for version refs/tags/v0.0.4
1 parent 18804b8 commit 293fad8

File tree

4 files changed

+183
-0
lines changed

4 files changed

+183
-0
lines changed

‎docs/index.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "dfcloud Provider"
4+
subcategory: ""
5+
description: |-
6+
The Dragonfly Cloud provider is used to interact with resources supported by Dragonfly Cloud.
7+
The provider needs to be configured with the proper credentials before it can be used.
8+
---
9+
10+
# dfcloud Provider
11+
12+
The Dragonfly Cloud provider is used to interact with resources supported by Dragonfly Cloud.
13+
14+
The provider needs to be configured with the proper credentials before it can be used.
15+
16+
17+
18+
<!-- schema generated by tfplugindocs -->
19+
## Schema
20+
21+
### Optional
22+
23+
- `api_host` (String) The URL of the Dragonfly Cloud API.
24+
- `api_key` (String, Sensitive) Dragonfly Cloud API key. This can also be set via the DFCLOUD_API_KEY environment variable.

‎docs/resources/connection.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "dfcloud_connection Resource - dfcloud"
4+
subcategory: ""
5+
description: |-
6+
Manages a Dragonfly network connection.
7+
---
8+
9+
# dfcloud_connection (Resource)
10+
11+
Manages a Dragonfly network connection.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) The name of the connection.
21+
- `network_id` (String) The ID of the network to connect to.
22+
- `peer` (Attributes) The VPC to connect to. (see [below for nested schema](#nestedatt--peer))
23+
24+
### Read-Only
25+
26+
- `connection_id` (String) The ID of the connection.
27+
- `peer_connection_id` (String) The underlying cloud provider connection ID.
28+
- `status` (String) The status of the connection.
29+
- `status_detail` (String) Additional details about the connection status.
30+
31+
<a id="nestedatt--peer"></a>
32+
### Nested Schema for `peer`
33+
34+
Required:
35+
36+
- `account_id` (String) The account ID of the target VPC.
37+
- `vpc_id` (String) The ID of the target VPC.
38+
39+
Optional:
40+
41+
- `region` (String) The region of the target VPC.

‎docs/resources/datastore.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "dfcloud_datastore Resource - dfcloud"
4+
subcategory: ""
5+
description: |-
6+
Manages a Dragonfly datastore.
7+
---
8+
9+
# dfcloud_datastore (Resource)
10+
11+
Manages a Dragonfly datastore.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `location` (Attributes) The location configuration for the datastore. (see [below for nested schema](#nestedatt--location))
21+
- `name` (String) The name of the datastore.
22+
- `tier` (Attributes) The tier configuration for the datastore. (see [below for nested schema](#nestedatt--tier))
23+
24+
### Optional
25+
26+
- `dragonfly` (Attributes) Dragonfly-specific configuration. (see [below for nested schema](#nestedatt--dragonfly))
27+
- `network_id` (String) The ID of the network the datastore should be placed into.
28+
29+
### Read-Only
30+
31+
- `addr` (String) The address of the datastore.
32+
- `created_at` (Number) The timestamp when the datastore was created.
33+
- `datastore_id` (String) The ID of the datastore.
34+
- `password` (String, Sensitive) The password for the datastore.
35+
36+
<a id="nestedatt--location"></a>
37+
### Nested Schema for `location`
38+
39+
Required:
40+
41+
- `provider` (String) The provider for the datastore location.
42+
- `region` (String) The region for the datastore location.
43+
44+
Optional:
45+
46+
- `availability_zones` (List of String) The availability zones for the datastore location.
47+
48+
49+
<a id="nestedatt--tier"></a>
50+
### Nested Schema for `tier`
51+
52+
Required:
53+
54+
- `max_memory_bytes` (Number) The maximum memory (in bytes) for the datastore.
55+
- `performance_tier` (String) The performance tier for the datastore.
56+
57+
Optional:
58+
59+
- `replicas` (Number) The number of replicas for the datastore.
60+
61+
62+
<a id="nestedatt--dragonfly"></a>
63+
### Nested Schema for `dragonfly`
64+
65+
Optional:
66+
67+
- `acl_rules` (List of String) List of ACL rules.
68+
- `bullmq` (Boolean) Enable BullMQ compatibility.
69+
- `cache_mode` (Boolean) Enable cache mode for memory management.
70+
- `memcached` (Boolean) Enable Memcached protocol.
71+
- `sidekiq` (Boolean) Enable Sidekiq compatibility.
72+
- `tls` (Boolean) Enable TLS.

‎docs/resources/network.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "dfcloud_network Resource - dfcloud"
4+
subcategory: ""
5+
description: |-
6+
Manages a Dragonfly network.
7+
---
8+
9+
# dfcloud_network (Resource)
10+
11+
Manages a Dragonfly network.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `cidr_block` (String) The CIDR block for the network.
21+
- `location` (Attributes) The location configuration for the network. (see [below for nested schema](#nestedatt--location))
22+
- `name` (String) The name of the network.
23+
24+
### Read-Only
25+
26+
- `created_at` (Number) The timestamp when the network was created.
27+
- `id` (String) The ID of the network.
28+
- `status` (String) The status of the network.
29+
- `vpc` (Object) The VPC information for the network. (see [below for nested schema](#nestedatt--vpc))
30+
31+
<a id="nestedatt--location"></a>
32+
### Nested Schema for `location`
33+
34+
Required:
35+
36+
- `provider` (String) The provider for the network location.
37+
- `region` (String) The region for the network location.
38+
39+
40+
<a id="nestedatt--vpc"></a>
41+
### Nested Schema for `vpc`
42+
43+
Read-Only:
44+
45+
- `account_id` (String)
46+
- `resource_id` (String)

0 commit comments

Comments
 (0)