Skip to content

Commit 6f134b4

Browse files
feat: Updated OpenAPI file for cloud gateway-addon. (#187)
* feat: Updated OpenAPI file for cloud gateway-addon. * feat: added .go files, .speakeasy and docs directory * feat: added test for cloud gateway add-on * fix: resolved review comments on test
1 parent 430b76d commit 6f134b4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+4339
-24
lines changed

.speakeasy/gen.lock

Lines changed: 203 additions & 12 deletions
Large diffs are not rendered by default.
Lines changed: 226 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,226 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "konnect_cloud_gateway_add_on Resource - terraform-provider-konnect-beta"
4+
subcategory: ""
5+
description: |-
6+
CloudGatewayAddOn Resource
7+
---
8+
9+
# konnect_cloud_gateway_add_on (Resource)
10+
11+
CloudGatewayAddOn Resource
12+
13+
## Example Usage
14+
15+
```terraform
16+
resource "konnect_cloud_gateway_add_on" "my_cloudgatewayaddon" {
17+
provider = konnect-beta
18+
config = {
19+
managed_cache = {
20+
capacity_config = {
21+
tiered = {
22+
tier = "micro"
23+
}
24+
}
25+
}
26+
}
27+
name = "my-add-on"
28+
owner = {
29+
control_plane_group = {
30+
control_plane_group_geo = "sg"
31+
control_plane_group_id = "123e4567-e89b-12d3-a456-426614174000"
32+
}
33+
}
34+
}
35+
```
36+
37+
<!-- schema generated by tfplugindocs -->
38+
## Schema
39+
40+
### Required
41+
42+
- `config` (Attributes) Configuration for creating different types of add-ons. Requires replacement if changed. (see [below for nested schema](#nestedatt--config))
43+
- `name` (String) Unique human-readable name of the add-on. Requires replacement if changed.
44+
- `owner` (Attributes) Owner for the add-on. Requires replacement if changed. (see [below for nested schema](#nestedatt--owner))
45+
46+
### Read-Only
47+
48+
- `created_at` (String) RFC-3339 timestamp representation of add-on creation date.
49+
- `entity_version` (Number) Monotonically-increasing version count of the add-on, to indicate the order of updates to the add-on.
50+
- `id` (String) The ID of this resource.
51+
- `state` (String) The current state of the add-on. Possible values:
52+
- `initializing` - The add-on is in the process of being initialized/updated.
53+
- `ready` - The add-on is fully operational.
54+
- `terminating` - The add-on is in the process of being deleted.
55+
- `updated_at` (String) RFC-3339 timestamp representation of add-on update date.
56+
57+
<a id="nestedatt--config"></a>
58+
### Nested Schema for `config`
59+
60+
Optional:
61+
62+
- `managed_cache` (Attributes) Configuration for creating a managed cache add-on. Requires replacement if changed. (see [below for nested schema](#nestedatt--config--managed_cache))
63+
64+
Read-Only:
65+
66+
- `managed_cache_add_on_config_response` (Attributes) Configuration for managed cache add-on. (see [below for nested schema](#nestedatt--config--managed_cache_add_on_config_response))
67+
68+
<a id="nestedatt--config--managed_cache"></a>
69+
### Nested Schema for `config.managed_cache`
70+
71+
Required:
72+
73+
- `capacity_config` (Attributes) Configuration for managed cache capacity and performance characteristics. Requires replacement if changed. (see [below for nested schema](#nestedatt--config--managed_cache--capacity_config))
74+
75+
<a id="nestedatt--config--managed_cache--capacity_config"></a>
76+
### Nested Schema for `config.managed_cache.capacity_config`
77+
78+
Optional:
79+
80+
- `tiered` (Attributes) Capacity tiers with pre-configured size and performance characteristics. Requires replacement if changed. (see [below for nested schema](#nestedatt--config--managed_cache--capacity_config--tiered))
81+
82+
<a id="nestedatt--config--managed_cache--capacity_config--tiered"></a>
83+
### Nested Schema for `config.managed_cache.capacity_config.tiered`
84+
85+
Required:
86+
87+
- `tier` (String) Capacity tier that determines both cache size and performance characteristics:
88+
- micro: ~0.5 GiB capacity
89+
- small: ~1 GiB capacity
90+
- medium: ~3 GiB capacity
91+
- large: ~6 GiB capacity
92+
- xlarge: ~12 GiB capacity
93+
- 2xlarge: ~25 GiB capacity
94+
- 4xlarge: ~52 GiB capacity
95+
must be one of ["micro", "small", "medium", "large", "xlarge", "2xlarge", "4xlarge"]; Requires replacement if changed.
96+
97+
98+
99+
100+
<a id="nestedatt--config--managed_cache_add_on_config_response"></a>
101+
### Nested Schema for `config.managed_cache_add_on_config_response`
102+
103+
Read-Only:
104+
105+
- `capacity_config` (Attributes) Configuration for managed cache capacity and performance characteristics. (see [below for nested schema](#nestedatt--config--managed_cache_add_on_config_response--capacity_config))
106+
- `data_plane_groups` (Attributes List) List of data-plane groups where the managed cache is deployed. (see [below for nested schema](#nestedatt--config--managed_cache_add_on_config_response--data_plane_groups))
107+
- `state_metadata` (Attributes) Metadata describing the state of the managed cache add-on. (see [below for nested schema](#nestedatt--config--managed_cache_add_on_config_response--state_metadata))
108+
109+
<a id="nestedatt--config--managed_cache_add_on_config_response--capacity_config"></a>
110+
### Nested Schema for `config.managed_cache_add_on_config_response.capacity_config`
111+
112+
Read-Only:
113+
114+
- `tiered` (Attributes) Capacity tiers with pre-configured size and performance characteristics. (see [below for nested schema](#nestedatt--config--managed_cache_add_on_config_response--capacity_config--tiered))
115+
116+
<a id="nestedatt--config--managed_cache_add_on_config_response--capacity_config--tiered"></a>
117+
### Nested Schema for `config.managed_cache_add_on_config_response.capacity_config.tiered`
118+
119+
Read-Only:
120+
121+
- `tier` (String) Capacity tier that determines both cache size and performance characteristics:
122+
- micro: ~0.5 GiB capacity
123+
- small: ~1 GiB capacity
124+
- medium: ~3 GiB capacity
125+
- large: ~6 GiB capacity
126+
- xlarge: ~12 GiB capacity
127+
- 2xlarge: ~25 GiB capacity
128+
- 4xlarge: ~52 GiB capacity
129+
130+
131+
132+
<a id="nestedatt--config--managed_cache_add_on_config_response--data_plane_groups"></a>
133+
### Nested Schema for `config.managed_cache_add_on_config_response.data_plane_groups`
134+
135+
Read-Only:
136+
137+
- `cloud_gateway_network_id` (String) Network ID this data-plane group is attached to.
138+
- `id` (String) ID of the data-plane group.
139+
- `provider` (String) Name of cloud provider.
140+
- `region` (String) Region of cloud provider the data-plane group is deployed to.
141+
- `state` (String) The current state of the managed cache add-on in the data-plane group. Possible values:
142+
- `initializing` - The add-on is in the process of being initialized/updated and is setting up necessary resources for this data-plane group.
143+
- `ready` - The add-on is fully operational for this data-plane group.
144+
- `error` - The add-on is in an error state, and is not operational for this data-plane group.
145+
- `terminating` - The add-on is in the process of being deleted for this data-plane group.
146+
- `state_metadata` (Attributes) Metadata describing the state of the managed cache add-on in the data-plane group. (see [below for nested schema](#nestedatt--config--managed_cache_add_on_config_response--data_plane_groups--state_metadata))
147+
148+
<a id="nestedatt--config--managed_cache_add_on_config_response--data_plane_groups--state_metadata"></a>
149+
### Nested Schema for `config.managed_cache_add_on_config_response.data_plane_groups.state_metadata`
150+
151+
Read-Only:
152+
153+
- `error_reason` (String) Reason why the managed cache add-on may be in an error state, reported from backing infrastructure.
154+
155+
156+
157+
<a id="nestedatt--config--managed_cache_add_on_config_response--state_metadata"></a>
158+
### Nested Schema for `config.managed_cache_add_on_config_response.state_metadata`
159+
160+
Read-Only:
161+
162+
- `cache_config_id` (String) Reference to cache configuration for this add-on.
163+
- `cache_host` (String) Env vault path to cache hostname.
164+
- `cache_port` (String) Env vault path to cache port.
165+
- `cache_server_name` (String) Env vault path to cache server name.
166+
- `cache_username` (String) Env vault path to cache username.
167+
- `cloud_authentication` (Attributes) Metadata describing the cloud authentication details for managed cache add-on. (see [below for nested schema](#nestedatt--config--managed_cache_add_on_config_response--state_metadata--cloud_authentication))
168+
169+
<a id="nestedatt--config--managed_cache_add_on_config_response--state_metadata--cloud_authentication"></a>
170+
### Nested Schema for `config.managed_cache_add_on_config_response.state_metadata.cloud_authentication`
171+
172+
Read-Only:
173+
174+
- `auth_provider` (String) Env vault path to cache auth provider.
175+
- `aws_assume_role_arn` (String) Env vault path to aws assume role arn.
176+
- `aws_cache_name` (String) Env vault path to aws cache name.
177+
- `aws_region` (String) Env vault path to aws region.
178+
- `azure_tenant_id` (String) Env vault path to azure tenant id.
179+
180+
181+
182+
183+
184+
<a id="nestedatt--owner"></a>
185+
### Nested Schema for `owner`
186+
187+
Optional:
188+
189+
- `control_plane` (Attributes) Control Plane is the owner for the add-on. Requires replacement if changed. (see [below for nested schema](#nestedatt--owner--control_plane))
190+
- `control_plane_group` (Attributes) Control Plane Group is the owner for the add-on. Requires replacement if changed. (see [below for nested schema](#nestedatt--owner--control_plane_group))
191+
192+
<a id="nestedatt--owner--control_plane"></a>
193+
### Nested Schema for `owner.control_plane`
194+
195+
Optional:
196+
197+
- `control_plane_geo` (String) Set of control-plane geos supported for deploying cloud-gateways configurations. Not Null; must be one of ["us", "eu", "au", "me", "in", "sg"]; Requires replacement if changed.
198+
- `control_plane_id` (String) ID of the control-plane that owns this add-on. Not Null; Requires replacement if changed.
199+
200+
201+
<a id="nestedatt--owner--control_plane_group"></a>
202+
### Nested Schema for `owner.control_plane_group`
203+
204+
Optional:
205+
206+
- `control_plane_group_geo` (String) Set of control-plane geos supported for deploying cloud-gateways configurations. Not Null; must be one of ["us", "eu", "au", "me", "in", "sg"]; Requires replacement if changed.
207+
- `control_plane_group_id` (String) ID of the control-plane group that owns this add-on. Not Null; Requires replacement if changed.
208+
209+
## Import
210+
211+
Import is supported using the following syntax:
212+
213+
In Terraform v1.5.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `id` attribute, for example:
214+
215+
```terraform
216+
import {
217+
to = konnect_cloud_gateway_add_on.my_konnect_cloud_gateway_add_on
218+
id = "550e8400-e29b-41d4-a716-446655440000"
219+
}
220+
```
221+
222+
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
223+
224+
```shell
225+
terraform import konnect_cloud_gateway_add_on.my_konnect_cloud_gateway_add_on "550e8400-e29b-41d4-a716-446655440000"
226+
```
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import {
2+
provider = konnect-beta
3+
to = konnect_cloud_gateway_add_on.my_konnect-beta_cloud_gateway_add_on
4+
id = "550e8400-e29b-41d4-a716-446655440000"
5+
}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
terraform import konnect_cloud_gateway_add_on.my_konnect_cloud_gateway_add_on "550e8400-e29b-41d4-a716-446655440000"
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
resource "konnect_cloud_gateway_add_on" "my_cloudgatewayaddon" {
2+
provider = konnect-beta
3+
config = {
4+
managed_cache = {
5+
capacity_config = {
6+
tiered = {
7+
tier = "micro"
8+
}
9+
}
10+
}
11+
}
12+
name = "my-add-on"
13+
owner = {
14+
control_plane_group = {
15+
control_plane_group_geo = "sg"
16+
control_plane_group_id = "123e4567-e89b-12d3-a456-426614174000"
17+
}
18+
}
19+
}

0 commit comments

Comments
 (0)