-
Notifications
You must be signed in to change notification settings - Fork 47
/
example_provider_documentation_output.html
504 lines (430 loc) · 26.2 KB
/
example_provider_documentation_output.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
<p dir="ltr">
This guide lists the configuration for 'openapi' Terraform provider
resources that can be managed using
<a href="https://www.hashicorp.com/blog/announcing-terraform-0-12/" target="_self">Terraform v0.12</a>.
</p><ul>
<li>
<a href="#provider_installation" target="_self">Provider Installation</a>
</li>
<li>
<a href="#provider_configuration" target="_self">Provider Configuration</a>
<ul>
<li>
<a href="#provider_configuration_example_usage" target="_self">Example Usage</a>
</li>
<li>
<a href="#provider_configuration_arguments_reference" target="_self">Arguments Reference</a>
</li>
</ul>
</li>
<li>
<a href="#provider_resources" target="_self">Provider Resources</a>
<ul>
<li><a href="#cdn_v1" target="_self">openapi_cdn_v1</a></li>
<li><a href="#cdn_v1_firewalls_v1" target="_self">openapi_cdn_v1_firewalls_v1</a></li>
<li><a href="#lbs_v1" target="_self">openapi_lbs_v1</a></li>
<li><a href="#monitors_v1_dub1" target="_self">openapi_monitors_v1_dub1</a></li>
<li><a href="#monitors_v1_rst1" target="_self">openapi_monitors_v1_rst1</a></li>
<li><a href="#multiregionmonitors_v1" target="_self">openapi_multiregionmonitors_v1</a></li>
</ul>
</li>
<li>
<a href="#provider_datasources" target="_self">Data Sources (using resource id)</a>
<ul>
<li><a href="#cdn_v1_firewalls_v1_instance" target="_self">openapi_cdn_v1_firewalls_v1_instance</a></li>
<li><a href="#cdn_v1_instance" target="_self">openapi_cdn_v1_instance</a></li>
<li><a href="#lbs_v1_instance" target="_self">openapi_lbs_v1_instance</a></li>
<li><a href="#monitors_v1_dub1_instance" target="_self">openapi_monitors_v1_dub1_instance</a></li>
<li><a href="#monitors_v1_rst1_instance" target="_self">openapi_monitors_v1_rst1_instance</a></li>
<li><a href="#multiregionmonitors_v1_instance" target="_self">openapi_multiregionmonitors_v1_instance</a></li>
</ul>
</li>
<li>
<a href="#provider_datasources_filters" target="_self">Data Sources (using filters)</a>
<ul>
</ul>
</li>
</ul><h2 id="provider_installation">Provider Installation</h2>
<p>
In order to provision 'openapi' Terraform resources, you need to first install the 'openapi'
Terraform plugin by running the following command (you must be running Terraform >= 0.12):
</p>
<pre>$ export PROVIDER_NAME=openapi && curl -fsSL https://raw.githubusercontent.com/dikhan/terraform-provider-openapi/master/scripts/install.sh | bash -s -- --provider-name $PROVIDER_NAME<br>[INFO] Downloading https://github.com/dikhan/terraform-provider-openapi/v3/releases/download/v3.0.0/terraform-provider-openapi_3.0.0_darwin_amd64.tar.gz in temporally folder /var/folders/n_/1lrwb99s7f50xmn9jpmfnddh0000gp/T/tmp.Xv1AkIZh...<br>[INFO] Extracting terraform-provider-openapi from terraform-provider-openapi_3.0.0_darwin_amd64.tar.gz...<br>[INFO] Cleaning up tmp dir created for installation purposes: /var/folders/n_/1lrwb99s7f50xmn9jpmfnddh0000gp/T/tmp.Xv1AkIZh<br>[INFO] Terraform provider 'terraform-provider-openapi' successfully installed at: '~/.terraform.d/plugins'!</pre>
<p>
<span>You can then start running the Terraform provider:</span>
</p>
<pre dir="ltr">$ export OTF_VAR_openapi_PLUGIN_CONFIGURATION_FILE="https://api.service.com/openapi.yaml"<br>
➜ ~ terraform init && terraform plan
</pre>
<p>
<b>Note:</b> As of Terraform >= 0.13 each Terraform module must declare which providers it requires, so that Terraform can install and use them. If you are using Terraform >= 0.13, copy into your .tf file the
following snippet already populated with the provider configuration:
<pre dir="ltr">
terraform {
required_providers {
openapi = {
source = "terraform.example.com/examplecorp/openapi"
version = ">= 2.0.1"
}
}
}
</pre>
</p>
<h2 id="provider_configuration">Provider Configuration</h2>
<h4 id="provider_configuration_example_usage" dir="ltr">Example Usage</h4>
<pre>
<span>provider </span><span>"openapi" </span>{
<span> apikey_auth </span>= <span>"..."</span>
<span> x_request_id </span>= <span>"..."</span>
<span>}</span>
</pre>
<p>Using the default region (rst1):</p>
<pre>
<span>provider </span><span>"openapi" </span>{
<span> # Resources using this default provider will be created in the 'rst1' region<br> ...<br></span>}
</pre>
<p>Using a specific region (dub1):</p>
<pre>
<span>provider </span><span>"openapi" </span>{
<span> alias </span>= <span>"dub1"</span>
<span> region </span>= <span>"dub1"<br> ...<br></span>}
<br>resource<span>"openapi_resource" "my_resource" {</span>
<span> provider = "openapi.dub1"<br> ...<br>}</span>
</pre>
<h4 id="provider_configuration_arguments_reference" dir="ltr">Arguments Reference</h4>
<p dir="ltr">The following arguments are supported:</p>
<ul dir="ltr">
<li><span>apikey_auth [string] - (Required) .</span></li></li>
<li><span>x_request_id [string] - (Required) .</span></li></li>
<li>
region [string] - (Optional) The region location to be used ([rst1 dub1]). If region isn't specified, the default is "rst1".
</li>
</ul>
<h2 id="provider_resources">Provider Resources</h2>
<h3 id="cdn_v1" dir="ltr">openapi_cdn_v1</h3>
<h4 id="resource_cdn_v1_example_usage" dir="ltr">Example usage</h4>
<pre>
<span>resource </span><span>"openapi_cdn_v1" "my_cdn_v1"</span>{
<span>hostnames </span>= <span>["hostnames1", "hostnames2"]</span>
<span>label </span>= <span>"label"</span>
<span>ips </span>= <span>["ips1", "ips2"]</span>
<span>}</span>
</pre>
<h4 id="resource_cdn_v1_arguments_reference" dir="ltr">Arguments Reference</h4>
<p dir="ltr">The following arguments are supported:</p>
<ul dir="ltr"><li> hostnames [list of strings] - (Required) </li>
<li> label [string] - (Required) </li>
<li> ips [list of strings] - (Required) </li>
<li> optional_computed [string] - (Optional) </li>
<li> optional_property [string] - (Optional) </li>
<li> example_boolean [boolean] - (Optional) </li>
<li><span class="wysiwyg-color-red">*</span> object_nested_scheme_property [object] - (Optional) . The following properties compose the object schema
:<ul dir="ltr"><li><span class="wysiwyg-color-red">*</span> object_property [object] - (Optional) . The following properties compose the object schema
:<ul dir="ltr"><li> account [string] - (Optional) </li>
</ul>
</li>
</ul>
</li>
<li> better_example_number_field_name [number] - (Optional) </li>
<li> example_int [integer] - (Optional) </li>
<li><span class="wysiwyg-color-red">*</span> object_property [object] - (Optional) . The following properties compose the object schema
:<ul dir="ltr"><li> detailed_message [string] - (Required) </li>
<li> example_number [number] - (Required) </li>
<li> example_int [integer] - (Required) </li>
<li> message [string] - (Required) </li>
<li> example_boolean [boolean] - (Required) </li>
</ul>
</li>
<li> array_of_objects_example [list of objects] - (Optional) . The following properties compose the object schema
:<ul dir="ltr"><li> protocol [string] - (Optional) </li>
<li> origin_port [integer] - (Optional) </li>
</ul>
</li>
</ul>
<p><span class="wysiwyg-color-red">* </span>Note: Object type properties are internally represented (in the state file) as a list of one elem due to <a href="https://github.com/hashicorp/terraform-plugin-sdk/issues/155#issuecomment-489699737" target="_blank">Terraform SDK's limitation for supporting complex object types</a>. Please index on the first elem of the array to reference the object values (eg: openapi_cdn_v1.my_cdn_v1.<b>object_property[0]</b>.object_property)</p>
<h4 id="resource_cdn_v1_attributes_reference" dir="ltr">Attributes Reference</h4>
<p dir="ltr">In addition to all arguments above, the following attributes are exported:</p>
<ul dir="ltr"><li> optional_computed_with_default [string] </li>
<li> optional_computed [string] </li>
<li> computed_with_default [string] </li>
<li><span class="wysiwyg-color-red">*</span> object_nested_scheme_property [object] The following properties compose the object schema:
<ul dir="ltr"><li> name [string] </li>
</ul>
</li>
<li> id [string] </li>
<li> computed [string] </li>
</ul>
<p><span class="wysiwyg-color-red">* </span>Note: Object type properties are internally represented (in the state file) as a list of one elem due to <a href="https://github.com/hashicorp/terraform-plugin-sdk/issues/155#issuecomment-489699737" target="_blank">Terraform SDK's limitation for supporting complex object types</a>. Please index on the first elem of the array to reference the object values (eg: openapi_cdn_v1.my_cdn_v1.<b>object_property[0]</b>.object_property)</p><h4 id="resource_cdn_v1_import" dir="ltr">Import</h4>
<p dir="ltr">
cdn_v1 resources can be imported using the <code>id</code> , e.g:
</p>
<pre dir="ltr">$ terraform import openapi_cdn_v1.my_cdn_v1 id</pre>
<p dir="ltr">
<strong>Note</strong>: In order for the import to work, the 'openapi' terraform
provider must be <a href="#provider_installation" target="_self">properly installed</a>. Read more about Terraform import usage <a href="https://www.terraform.io/docs/import/usage.html" target="_blank" rel="noopener noreferrer">here</a>.
</p>
<h3 id="cdn_v1_firewalls_v1" dir="ltr">openapi_cdn_v1_firewalls_v1</h3>
<h4 id="resource_cdn_v1_firewalls_v1_example_usage" dir="ltr">Example usage</h4>
<pre>
<span>resource </span><span>"openapi_cdn_v1_firewalls_v1" "my_cdn_v1_firewalls_v1"</span>{
<span>name </span>= <span>"name"</span>
<span>cdn_v1_id </span>= <span>"cdn_v1_id"</span>
<span>}</span>
</pre>
<h4 id="resource_cdn_v1_firewalls_v1_arguments_reference" dir="ltr">Arguments Reference</h4>
<p dir="ltr">The following arguments are supported:</p>
<ul dir="ltr"><li> name [string] - (Required) </li>
<li> cdn_v1_id [string] - (Required) The cdn_v1_id that this resource belongs to</li>
</ul>
<h4 id="resource_cdn_v1_firewalls_v1_attributes_reference" dir="ltr">Attributes Reference</h4>
<p dir="ltr">In addition to all arguments above, the following attributes are exported:</p>
<ul dir="ltr"><li> id [string] </li>
</ul><h4 id="resource_cdn_v1_firewalls_v1_import" dir="ltr">Import</h4>
<p dir="ltr">
cdn_v1_firewalls_v1 resources can be imported using the <code>id</code> . This is a sub-resource so the parent resource IDs (<code>[cdn_v1_id]</code>) are required to be able to retrieve an instance of this resource, e.g:
</p>
<pre dir="ltr">$ terraform import openapi_cdn_v1_firewalls_v1.my_cdn_v1_firewalls_v1 cdn_v1_id/cdn_v1_firewalls_v1_id</pre>
<p dir="ltr">
<strong>Note</strong>: In order for the import to work, the 'openapi' terraform
provider must be <a href="#provider_installation" target="_self">properly installed</a>. Read more about Terraform import usage <a href="https://www.terraform.io/docs/import/usage.html" target="_blank" rel="noopener noreferrer">here</a>.
</p>
<h3 id="lbs_v1" dir="ltr">openapi_lbs_v1</h3>
<h4 id="resource_lbs_v1_example_usage" dir="ltr">Example usage</h4>
<pre>
<span>resource </span><span>"openapi_lbs_v1" "my_lbs_v1"</span>{
<span>name </span>= <span>"name"</span>
<span>backends </span>= <span>["backends1", "backends2"]</span>
<span>}</span>
</pre>
<h4 id="resource_lbs_v1_arguments_reference" dir="ltr">Arguments Reference</h4>
<p dir="ltr">The following arguments are supported:</p>
<ul dir="ltr"><li> name [string] - (Required) </li>
<li> backends [list of strings] - (Required) </li>
<li> simulate_failure [boolean] - (Optional) </li>
</ul>
<p><span class="wysiwyg-color-red">* </span>Note: Object type properties are internally represented (in the state file) as a list of one elem due to <a href="https://github.com/hashicorp/terraform-plugin-sdk/issues/155#issuecomment-489699737" target="_blank">Terraform SDK's limitation for supporting complex object types</a>. Please index on the first elem of the array to reference the object values (eg: openapi_lbs_v1.my_lbs_v1.<b>new_status[0]</b>.object_property)</p>
<h4 id="resource_lbs_v1_attributes_reference" dir="ltr">Attributes Reference</h4>
<p dir="ltr">In addition to all arguments above, the following attributes are exported:</p>
<ul dir="ltr"><li> status [string] - lb resource status</li>
<li> id [string] </li>
<li> time_to_process [integer] </li>
</ul>
<p><span class="wysiwyg-color-red">* </span>Note: Object type properties are internally represented (in the state file) as a list of one elem due to <a href="https://github.com/hashicorp/terraform-plugin-sdk/issues/155#issuecomment-489699737" target="_blank">Terraform SDK's limitation for supporting complex object types</a>. Please index on the first elem of the array to reference the object values (eg: openapi_lbs_v1.my_lbs_v1.<b>new_status[0]</b>.object_property)</p><h4 id="resource_lbs_v1_import" dir="ltr">Import</h4>
<p dir="ltr">
lbs_v1 resources can be imported using the <code>id</code> , e.g:
</p>
<pre dir="ltr">$ terraform import openapi_lbs_v1.my_lbs_v1 id</pre>
<p dir="ltr">
<strong>Note</strong>: In order for the import to work, the 'openapi' terraform
provider must be <a href="#provider_installation" target="_self">properly installed</a>. Read more about Terraform import usage <a href="https://www.terraform.io/docs/import/usage.html" target="_blank" rel="noopener noreferrer">here</a>.
</p>
<h3 id="monitors_v1_dub1" dir="ltr">openapi_monitors_v1_dub1</h3>
<h4 id="resource_monitors_v1_dub1_example_usage" dir="ltr">Example usage</h4>
<pre>
<span>resource </span><span>"openapi_monitors_v1_dub1" "my_monitors_v1_dub1"</span>{
<span>name </span>= <span>"name"</span>
<span>}</span>
</pre>
<h4 id="resource_monitors_v1_dub1_arguments_reference" dir="ltr">Arguments Reference</h4>
<p dir="ltr">The following arguments are supported:</p>
<ul dir="ltr"><li> name [string] - (Required) </li>
</ul>
<h4 id="resource_monitors_v1_dub1_attributes_reference" dir="ltr">Attributes Reference</h4>
<p dir="ltr">In addition to all arguments above, the following attributes are exported:</p>
<ul dir="ltr"><li> id [string] </li>
</ul><h4 id="resource_monitors_v1_dub1_import" dir="ltr">Import</h4>
<p dir="ltr">
monitors_v1_dub1 resources can be imported using the <code>id</code> , e.g:
</p>
<pre dir="ltr">$ terraform import openapi_monitors_v1_dub1.my_monitors_v1_dub1 id</pre>
<p dir="ltr">
<strong>Note</strong>: In order for the import to work, the 'openapi' terraform
provider must be <a href="#provider_installation" target="_self">properly installed</a>. Read more about Terraform import usage <a href="https://www.terraform.io/docs/import/usage.html" target="_blank" rel="noopener noreferrer">here</a>.
</p>
<h3 id="monitors_v1_rst1" dir="ltr">openapi_monitors_v1_rst1</h3>
<h4 id="resource_monitors_v1_rst1_example_usage" dir="ltr">Example usage</h4>
<pre>
<span>resource </span><span>"openapi_monitors_v1_rst1" "my_monitors_v1_rst1"</span>{
<span>name </span>= <span>"name"</span>
<span>}</span>
</pre>
<h4 id="resource_monitors_v1_rst1_arguments_reference" dir="ltr">Arguments Reference</h4>
<p dir="ltr">The following arguments are supported:</p>
<ul dir="ltr"><li> name [string] - (Required) </li>
</ul>
<h4 id="resource_monitors_v1_rst1_attributes_reference" dir="ltr">Attributes Reference</h4>
<p dir="ltr">In addition to all arguments above, the following attributes are exported:</p>
<ul dir="ltr"><li> id [string] </li>
</ul><h4 id="resource_monitors_v1_rst1_import" dir="ltr">Import</h4>
<p dir="ltr">
monitors_v1_rst1 resources can be imported using the <code>id</code> , e.g:
</p>
<pre dir="ltr">$ terraform import openapi_monitors_v1_rst1.my_monitors_v1_rst1 id</pre>
<p dir="ltr">
<strong>Note</strong>: In order for the import to work, the 'openapi' terraform
provider must be <a href="#provider_installation" target="_self">properly installed</a>. Read more about Terraform import usage <a href="https://www.terraform.io/docs/import/usage.html" target="_blank" rel="noopener noreferrer">here</a>.
</p>
<h3 id="multiregionmonitors_v1" dir="ltr">openapi_multiregionmonitors_v1</h3>
<h4 id="resource_multiregionmonitors_v1_example_usage" dir="ltr">Example usage</h4>
<pre>
<span>resource </span><span>"openapi_multiregionmonitors_v1" "my_multiregionmonitors_v1"</span>{
<span>name </span>= <span>"name"</span>
<span>}</span>
</pre>
<h4 id="resource_multiregionmonitors_v1_arguments_reference" dir="ltr">Arguments Reference</h4>
<p dir="ltr">The following arguments are supported:</p>
<ul dir="ltr"><li> name [string] - (Required) </li>
</ul>
<h4 id="resource_multiregionmonitors_v1_attributes_reference" dir="ltr">Attributes Reference</h4>
<p dir="ltr">In addition to all arguments above, the following attributes are exported:</p>
<ul dir="ltr"><li> id [string] </li>
</ul><h4 id="resource_multiregionmonitors_v1_import" dir="ltr">Import</h4>
<p dir="ltr">
multiregionmonitors_v1 resources can be imported using the <code>id</code> , e.g:
</p>
<pre dir="ltr">$ terraform import openapi_multiregionmonitors_v1.my_multiregionmonitors_v1 id</pre>
<p dir="ltr">
<strong>Note</strong>: In order for the import to work, the 'openapi' terraform
provider must be <a href="#provider_installation" target="_self">properly installed</a>. Read more about Terraform import usage <a href="https://www.terraform.io/docs/import/usage.html" target="_blank" rel="noopener noreferrer">here</a>.
</p>
<h2 id="provider_datasources">Data Sources (using resource id)</h2>
<h3 id="cdn_v1_firewalls_v1_instance" dir="ltr">openapi_cdn_v1_firewalls_v1_instance</h3>
<p>Retrieve an existing resource using it's ID</p>
<h4 id="datasource_cdn_v1_firewalls_v1_instance_example_usage" dir="ltr">Example usage</h4>
<pre><span>data </span><span>"openapi_cdn_v1_firewalls_v1_instance" "my_cdn_v1_firewalls_v1_instance"</span>{
id = "existing_resource_id"
<span>}</span></pre>
<h4 id="datasource_cdn_v1_firewalls_v1_instance_arguments_reference" dir="ltr">Arguments Reference</h4>
<p dir="ltr">The following arguments are supported:</p>
<ul dir="ltr">
<li>id - (Required) ID of the existing resource to retrieve</li>
</ul>
<h4 id="datasource_cdn_v1_firewalls_v1_instance_attributes_reference" dir="ltr">Attributes Reference</h4>
<p dir="ltr">In addition to all arguments above, the following attributes are exported:</p>
<ul dir="ltr"><li> id [string] </li>
<li> name [string] </li>
</ul>
<h3 id="cdn_v1_instance" dir="ltr">openapi_cdn_v1_instance</h3>
<p>Retrieve an existing resource using it's ID</p>
<h4 id="datasource_cdn_v1_instance_example_usage" dir="ltr">Example usage</h4>
<pre><span>data </span><span>"openapi_cdn_v1_instance" "my_cdn_v1_instance"</span>{
id = "existing_resource_id"
<span>}</span></pre>
<h4 id="datasource_cdn_v1_instance_arguments_reference" dir="ltr">Arguments Reference</h4>
<p dir="ltr">The following arguments are supported:</p>
<ul dir="ltr">
<li>id - (Required) ID of the existing resource to retrieve</li>
</ul>
<h4 id="datasource_cdn_v1_instance_attributes_reference" dir="ltr">Attributes Reference</h4>
<p dir="ltr">In addition to all arguments above, the following attributes are exported:</p>
<ul dir="ltr"><li> array_of_objects_example [list of objects] The following properties compose the object schema:
<ul dir="ltr"><li> protocol [string] </li>
<li> origin_port [integer] </li>
</ul>
</li>
<li> ips [list of strings] </li>
<li> example_boolean [boolean] </li>
<li> optional_computed [string] </li>
<li><span class="wysiwyg-color-red">*</span> object_property [object] The following properties compose the object schema:
<ul dir="ltr"><li> message [string] </li>
<li> example_boolean [boolean] </li>
<li> example_int [integer] </li>
<li> detailed_message [string] </li>
<li> example_number [number] </li>
</ul>
</li>
<li> optional_property [string] </li>
<li><span class="wysiwyg-color-red">*</span> object_nested_scheme_property [object] The following properties compose the object schema:
<ul dir="ltr"><li> name [string] </li>
<li><span class="wysiwyg-color-red">*</span> object_property [object] The following properties compose the object schema:
<ul dir="ltr"><li> account [string] </li>
</ul>
</li>
</ul>
</li>
<li> better_example_number_field_name [number] </li>
<li> computed_with_default [string] </li>
<li> id [string] </li>
<li> computed [string] </li>
<li> label [string] </li>
<li> example_int [integer] </li>
<li> optional_computed_with_default [string] </li>
<li> hostnames [list of strings] </li>
</ul>
<p><span class="wysiwyg-color-red">* </span>Note: Object type properties are internally represented (in the state file) as a list of one elem due to <a href="https://github.com/hashicorp/terraform-plugin-sdk/issues/155#issuecomment-489699737" target="_blank">Terraform SDK's limitation for supporting complex object types</a>. Please index on the first elem of the array to reference the object values (eg: openapi_cdn_v1_instance.my_cdn_v1_instance.<b>object_nested_scheme_property[0]</b>.object_property)</p>
<h3 id="lbs_v1_instance" dir="ltr">openapi_lbs_v1_instance</h3>
<p>Retrieve an existing resource using it's ID</p>
<h4 id="datasource_lbs_v1_instance_example_usage" dir="ltr">Example usage</h4>
<pre><span>data </span><span>"openapi_lbs_v1_instance" "my_lbs_v1_instance"</span>{
id = "existing_resource_id"
<span>}</span></pre>
<h4 id="datasource_lbs_v1_instance_arguments_reference" dir="ltr">Arguments Reference</h4>
<p dir="ltr">The following arguments are supported:</p>
<ul dir="ltr">
<li>id - (Required) ID of the existing resource to retrieve</li>
</ul>
<h4 id="datasource_lbs_v1_instance_attributes_reference" dir="ltr">Attributes Reference</h4>
<p dir="ltr">In addition to all arguments above, the following attributes are exported:</p>
<ul dir="ltr"><li> backends [list of strings] </li>
<li> simulate_failure [boolean] </li>
<li> time_to_process [integer] </li>
<li> status [string] - lb resource status</li>
<li> id [string] </li>
<li> name [string] </li>
<li><span class="wysiwyg-color-red">*</span> new_status [object] The following properties compose the object schema:
<ul dir="ltr"><li> status [string] </li>
<li> message [string] </li>
</ul>
</li>
</ul>
<p><span class="wysiwyg-color-red">* </span>Note: Object type properties are internally represented (in the state file) as a list of one elem due to <a href="https://github.com/hashicorp/terraform-plugin-sdk/issues/155#issuecomment-489699737" target="_blank">Terraform SDK's limitation for supporting complex object types</a>. Please index on the first elem of the array to reference the object values (eg: openapi_lbs_v1_instance.my_lbs_v1_instance.<b>new_status[0]</b>.object_property)</p>
<h3 id="monitors_v1_dub1_instance" dir="ltr">openapi_monitors_v1_dub1_instance</h3>
<p>Retrieve an existing resource using it's ID</p>
<h4 id="datasource_monitors_v1_dub1_instance_example_usage" dir="ltr">Example usage</h4>
<pre><span>data </span><span>"openapi_monitors_v1_dub1_instance" "my_monitors_v1_dub1_instance"</span>{
id = "existing_resource_id"
<span>}</span></pre>
<h4 id="datasource_monitors_v1_dub1_instance_arguments_reference" dir="ltr">Arguments Reference</h4>
<p dir="ltr">The following arguments are supported:</p>
<ul dir="ltr">
<li>id - (Required) ID of the existing resource to retrieve</li>
</ul>
<h4 id="datasource_monitors_v1_dub1_instance_attributes_reference" dir="ltr">Attributes Reference</h4>
<p dir="ltr">In addition to all arguments above, the following attributes are exported:</p>
<ul dir="ltr"><li> id [string] </li>
<li> name [string] </li>
</ul>
<h3 id="monitors_v1_rst1_instance" dir="ltr">openapi_monitors_v1_rst1_instance</h3>
<p>Retrieve an existing resource using it's ID</p>
<h4 id="datasource_monitors_v1_rst1_instance_example_usage" dir="ltr">Example usage</h4>
<pre><span>data </span><span>"openapi_monitors_v1_rst1_instance" "my_monitors_v1_rst1_instance"</span>{
id = "existing_resource_id"
<span>}</span></pre>
<h4 id="datasource_monitors_v1_rst1_instance_arguments_reference" dir="ltr">Arguments Reference</h4>
<p dir="ltr">The following arguments are supported:</p>
<ul dir="ltr">
<li>id - (Required) ID of the existing resource to retrieve</li>
</ul>
<h4 id="datasource_monitors_v1_rst1_instance_attributes_reference" dir="ltr">Attributes Reference</h4>
<p dir="ltr">In addition to all arguments above, the following attributes are exported:</p>
<ul dir="ltr"><li> id [string] </li>
<li> name [string] </li>
</ul>
<h3 id="multiregionmonitors_v1_instance" dir="ltr">openapi_multiregionmonitors_v1_instance</h3>
<p>Retrieve an existing resource using it's ID</p>
<h4 id="datasource_multiregionmonitors_v1_instance_example_usage" dir="ltr">Example usage</h4>
<pre><span>data </span><span>"openapi_multiregionmonitors_v1_instance" "my_multiregionmonitors_v1_instance"</span>{
id = "existing_resource_id"
<span>}</span></pre>
<h4 id="datasource_multiregionmonitors_v1_instance_arguments_reference" dir="ltr">Arguments Reference</h4>
<p dir="ltr">The following arguments are supported:</p>
<ul dir="ltr">
<li>id - (Required) ID of the existing resource to retrieve</li>
</ul>
<h4 id="datasource_multiregionmonitors_v1_instance_attributes_reference" dir="ltr">Attributes Reference</h4>
<p dir="ltr">In addition to all arguments above, the following attributes are exported:</p>
<ul dir="ltr"><li> id [string] </li>
<li> name [string] </li>
</ul>
<h2 id="provider_datasources_filters">Data Sources (using filters)</h2>
No data sources using filters are supported at the moment.