Skip to content

Commit c6423eb

Browse files
committed
first gen successful
1 parent cca6a48 commit c6423eb

File tree

378 files changed

+20732
-11470
lines changed

Some content is hidden

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

378 files changed

+20732
-11470
lines changed

docs/data-sources/account_project.md

+17-29
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,29 @@
11
---
2-
subcategory: "Account"
3-
page_title: "Scaleway: scaleway_account_project"
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "scaleway_account_project Data Source - terraform-provider-scaleway"
4+
subcategory: ""
5+
description: |-
6+
47
---
58

6-
# scaleway_account_project
9+
# scaleway_account_project (Data Source)
710

8-
Gets information about an existing Project.
911

10-
## Example Usage
1112

12-
```hcl
13-
# Get info by name
14-
data scaleway_account_project "by_name" {
15-
name = "myproject"
16-
organization_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
17-
}
18-
# Get default project
19-
data scaleway_account_project "by_name" {
20-
name = "default"
21-
}
22-
# Get info by ID
23-
data scaleway_account_project "by_id" {
24-
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
25-
}
26-
```
2713

28-
## Argument Reference
2914

30-
- `name` - (Optional) The name of the Project.
31-
Only one of the `name` and `project_id` should be specified.
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
3217

33-
- `project_id` - (Optional) The ID of the Project.
34-
Only one of the `name` and `project_id` should be specified.
18+
### Optional
3519

36-
- `organization_id` - (Optional) The organization ID the Project is associated with.
37-
If no default organization_id is set, one must be set explicitly in this datasource
20+
- `name` (String) The name of the project
21+
- `organization_id` (String) The organization_id you want to attach the resource to
22+
- `project_id` (String) The ID of the SSH key
3823

39-
## Attribute Reference
24+
### Read-Only
4025

41-
Exported attributes are the ones from `account_project` [resource](../resources/account_project.md)
26+
- `created_at` (String) The date and time of the creation of the Project (Format ISO 8601)
27+
- `description` (String) Description of the project
28+
- `id` (String) The ID of this resource.
29+
- `updated_at` (String) The date and time of the last update of the Project (Format ISO 8601)

docs/data-sources/account_ssh_key.md

+20-24
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,32 @@
11
---
2-
subcategory: "Account"
3-
page_title: "Scaleway: scaleway_account_ssh_key"
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "scaleway_account_ssh_key Data Source - terraform-provider-scaleway"
4+
subcategory: ""
5+
description: |-
6+
47
---
58

6-
# scaleway_account_ssh_key
9+
# scaleway_account_ssh_key (Data Source)
710

8-
Use this data source to get SSH key information based on its ID or name.
911

10-
## Example Usage
1112

12-
```hcl
13-
# Get info by SSH key name
14-
data "scaleway_account_ssh_key" "my_key" {
15-
name = "my-key-name"
16-
}
1713

18-
# Get info by SSH key id
19-
data "scaleway_account_ssh_key" "my_key" {
20-
ssh_key_id = "11111111-1111-1111-1111-111111111111"
21-
}
22-
```
2314

24-
## Argument Reference
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
2517

26-
- `name` - The SSH key name. Only one of `name` and `ssh_key_id` should be specified.
27-
- `ssh_key_id` - The SSH key id. Only one of `name` and `ssh_key_id` should be specified.
28-
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the SSH key is associated with.
18+
### Optional
2919

30-
## Attributes Reference
20+
- `name` (String) The name of the iam SSH key
21+
- `project_id` (String) The project_id you want to attach the resource to
22+
- `ssh_key_id` (String) The ID of the SSH key
3123

32-
In addition to all above arguments, the following attributes are exported:
24+
### Read-Only
3325

34-
- `id` - The ID of the SSH public key.
35-
- `public_key` - The SSH public key string
36-
- `organization_id` - The ID of the organization the SSH key is associated with.
26+
- `created_at` (String) The date and time of the creation of the iam SSH Key
27+
- `disabled` (Boolean) The SSH key status
28+
- `fingerprint` (String) The fingerprint of the iam SSH key
29+
- `id` (String) The ID of this resource.
30+
- `organization_id` (String) The organization_id you want to attach the resource to
31+
- `public_key` (String) The public SSH key
32+
- `updated_at` (String) The date and time of the last update of the iam SSH Key
+21-19
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,33 @@
11
---
2-
subcategory: "Account"
3-
page_title: "Scaleway: scaleway_availability_zones"
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "scaleway_availability_zones Data Source - terraform-provider-scaleway"
4+
subcategory: ""
5+
description: |-
6+
47
---
58

6-
# scaleway_availability_zones
9+
# scaleway_availability_zones (Data Source)
710

8-
Use this data source to get the available zones information based on its Region.
911

10-
For technical and legal reasons, some products are split by Region or by Availability Zones. When using such product,
11-
you can choose the location that better fits your need (country, latency, …).
1212

13-
## Example Usage
1413

15-
```hcl
16-
# Get info by Region key
17-
data scaleway_availability_zones main {
18-
region = "nl-ams"
19-
}
20-
```
2114

22-
## Argument Reference
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
2317

24-
- `region` - Region is represented as a Geographical area such as France. Defaults: `fr-par`.
18+
### Optional
2519

26-
## Attributes Reference
20+
- `region` (String) Region is represented as a Geographical area such as France
21+
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
2722

28-
In addition to all above arguments, the following attributes are exported:
23+
### Read-Only
2924

30-
- `id` - The Region ID
31-
- `zones` - List of availability zones by regions
25+
- `id` (String) The ID of this resource.
26+
- `zones` (List of String) Availability Zones (AZ)
27+
28+
<a id="nestedblock--timeouts"></a>
29+
### Nested Schema for `timeouts`
30+
31+
Optional:
32+
33+
- `read` (String)

docs/data-sources/baremetal_offer.md

+41-59
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,64 @@
11
---
2-
subcategory: "Elastic Metal"
3-
page_title: "Scaleway: scaleway_baremetal_offer"
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "scaleway_baremetal_offer Data Source - terraform-provider-scaleway"
4+
subcategory: ""
5+
description: |-
6+
47
---
58

6-
# scaleway_baremetal_offer
9+
# scaleway_baremetal_offer (Data Source)
710

8-
Gets information about a baremetal offer. For more information, see [the documentation](https://developers.scaleway.com/en/products/baremetal/api).
911

10-
## Example Usage
1112

12-
```hcl
13-
# Get info by offer name
14-
data "scaleway_baremetal_offer" "my_offer" {
15-
zone = "fr-par-2"
16-
name = "EM-A210R-SATA"
17-
}
1813

19-
# Get info by offer id
20-
data "scaleway_baremetal_offer" "my_offer" {
21-
zone = "fr-par-2"
22-
offer_id = "25dcf38b-c90c-4b18-97a2-6956e9d1e113"
23-
}
24-
```
2514

26-
## Argument Reference
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
2717

28-
- `name` - (Optional) The offer name. Only one of `name` and `offer_id` should be specified.
18+
### Optional
2919

30-
- `subscription_period` - (Optional) Period of subscription the desired offer. Should be `hourly` or `monthly`.
20+
- `include_disabled` (Boolean) Include disabled offers
21+
- `name` (String) Exact name of the desired offer
22+
- `offer_id` (String) ID of the desired offer
23+
- `subscription_period` (String) Period of subscription the desired offer
24+
- `zone` (String) The zone you want to attach the resource to
3125

32-
- `offer_id` - (Optional) The offer id. Only one of `name` and `offer_id` should be specified.
26+
### Read-Only
3327

34-
- `allow_disabled` - (Optional, default `false`) Include disabled offers.
28+
- `bandwidth` (Number) Available Bandwidth with the offer
29+
- `commercial_range` (String) Commercial range of the offer
30+
- `cpu` (List of Object) CPU specifications of the offer (see [below for nested schema](#nestedatt--cpu))
31+
- `disk` (List of Object) Disk specifications of the offer (see [below for nested schema](#nestedatt--disk))
32+
- `id` (String) The ID of this resource.
33+
- `memory` (List of Object) Memory specifications of the offer (see [below for nested schema](#nestedatt--memory))
34+
- `stock` (String) Stock status for this offer
3535

36-
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the offer should be created.
36+
<a id="nestedatt--cpu"></a>
37+
### Nested Schema for `cpu`
3738

38-
## Attributes Reference
39+
Read-Only:
3940

40-
In addition to all above arguments, the following attributes are exported:
41+
- `core_count` (Number)
42+
- `frequency` (Number)
43+
- `name` (String)
44+
- `thread_count` (Number)
4145

42-
- `id` - The ID of the offer.
4346

44-
~> **Important:** Baremetal offers' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
47+
<a id="nestedatt--disk"></a>
48+
### Nested Schema for `disk`
4549

46-
- `bandwidth` - Available Bandwidth with the offer.
50+
Read-Only:
4751

48-
- `commercial_range` - Commercial range of the offer.
52+
- `capacity` (Number)
53+
- `type` (String)
4954

50-
- `cpu` - A list of cpu specifications. (Structure is documented below.)
5155

52-
- `disk` - A list of disk specifications. (Structure is documented below.)
56+
<a id="nestedatt--memory"></a>
57+
### Nested Schema for `memory`
5358

54-
- `memory` - A list of memory specifications. (Structure is documented below.)
59+
Read-Only:
5560

56-
- `stock` - Stock status for this offer. Possible values are: `empty`, `low` or `available`.
57-
58-
The `cpu` block supports:
59-
60-
- `name` - Name of the CPU.
61-
62-
- `core_count`- Number of core on this CPU.
63-
64-
- `frequency`- Frequency of the CPU in MHz.
65-
66-
- `thread_count`- Number of thread on this CPU.
67-
68-
The `disk` block supports:
69-
70-
- `type` - Type of disk.
71-
72-
- `capacity`- Capacity of the disk in GB.
73-
74-
The `memory` block supports:
75-
76-
- `type` - Type of memory.
77-
78-
- `capacity`- Capacity of the memory in GB.
79-
80-
- `frequency` - Frequency of the memory in MHz.
81-
82-
- `is_ecc`- True if error-correcting code is available on this memory.
61+
- `capacity` (Number)
62+
- `frequency` (Number)
63+
- `is_ecc` (Boolean)
64+
- `type` (String)

docs/data-sources/baremetal_option.md

+15-28
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,27 @@
11
---
2-
subcategory: "Elastic Metal"
3-
page_title: "Scaleway: scaleway_baremetal_option"
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "scaleway_baremetal_option Data Source - terraform-provider-scaleway"
4+
subcategory: ""
5+
description: |-
6+
47
---
58

6-
# scaleway_baremetal_option
9+
# scaleway_baremetal_option (Data Source)
710

8-
Gets information about a baremetal option.
9-
For more information, see [the documentation](https://developers.scaleway.com/en/products/baremetal/api).
1011

11-
## Example Usage
1212

13-
```hcl
14-
# Get info by option name
15-
data "scaleway_baremetal_option" "by_name" {
16-
name = "Remote Access"
17-
}
1813

19-
# Get info by option id
20-
data "scaleway_baremetal_option" "by_id" {
21-
option_id = "931df052-d713-4674-8b58-96a63244c8e2"
22-
}
23-
```
2414

25-
## Argument Reference
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
2617

27-
- `name` - (Optional) The option name. Only one of `name` and `option_id` should be specified.
28-
- `option_id` - (Optional) The option id. Only one of `name` and `option_id` should be specified.
29-
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the option exists.
18+
### Optional
3019

31-
## Attributes Reference
20+
- `name` (String) Exact label of the desired option
21+
- `option_id` (String) The ID of the option
22+
- `zone` (String) The zone you want to attach the resource to
3223

33-
In addition to all above arguments, the following attributes are exported:
24+
### Read-Only
3425

35-
- `id` - The ID of the option.
36-
37-
~> **Important:** Baremetal options' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
38-
39-
- `name` - The name of the option.
40-
- `manageable` - Is false if the option could not be added or removed.
26+
- `id` (String) The ID of this resource.
27+
- `manageable` (Boolean) Is false if the option could not be added or removed

0 commit comments

Comments
 (0)