You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The `scaleway_account_project` data source is used to retrieve information about a Scaleway project.
9
9
10
-
## Example Usage
10
+
Refer to the Organizations and Projects [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/organizations-and-projects/) and [API documentation](https://www.scaleway.com/en/developers/api/account/project-api/) for more information.
11
+
12
+
13
+
## Retrieve a Scaleway Project
14
+
15
+
The following commands allow you to:
16
+
17
+
- retrieve a Project by its name
18
+
- retrieve a Project by its ID
19
+
- retrieve the default project of an Organization
11
20
12
21
```hcl
13
22
# Get info by name
@@ -27,15 +36,18 @@ data scaleway_account_project "by_id" {
27
36
28
37
## Argument Reference
29
38
39
+
This section lists the arguments that you can provide to the `scaleway_account_project` data source to filter and retrieve the desired project. Each argument has a specific purpose:
40
+
30
41
-`name` - (Optional) The name of the Project.
31
42
Only one of the `name` and `project_id` should be specified.
32
43
33
-
-`project_id` - (Optional) The ID of the Project.
44
+
-`project_id` - (Optional) The unique identifier of the Project.
34
45
Only one of the `name` and `project_id` should be specified.
35
46
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
47
+
-`organization_id` - (Optional) The unique identifier of the Organization with which the Project is associated.
48
+
49
+
If no default `organization_id` is set, one must be set explicitly in this datasource
38
50
39
-
## Attribute Reference
51
+
## Attribute reference
40
52
41
-
Exported attributes are the ones from `account_project`[resource](../resources/account_project.md)
53
+
The `scaleway_account_project` data source exports certain attributes once the account information is retrieved. These attributes can be referenced in other parts of your Terraform configuration. The exported attributes come from the `account_project`[resource](../resources/account_project.md).
Use this data source to get SSH key information based on its ID or name.
8
+
The `scaleway_account_ssh_key` data source is used to retrieve information about a the SSH key of a Scaleway account.
9
9
10
-
## Example Usage
10
+
Refer to the Organizations and Projects [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/) and [API documentation](https://www.scaleway.com/en/developers/api/iam/#path-ssh-keys) for more information.
11
+
12
+
13
+
## Retrieve the SSH key of a Scaleway account
14
+
15
+
The following commands allow you to:
16
+
17
+
- retrieve an SSH key by its name
18
+
- retrieve an SSH key by its ID
11
19
12
20
```hcl
13
21
# Get info by SSH key name
@@ -23,17 +31,21 @@ data "scaleway_account_ssh_key" "my_key" {
23
31
24
32
## Argument Reference
25
33
26
-
-`name` - The SSH key name.
27
-
-`ssh_key_id` - The SSH key id.
34
+
This section lists the arguments that you can provide to the `scaleway_account_ssh_key` data source to filter and retrieve the desired SSH key. Each argument has a specific purpose:
35
+
36
+
-`name` - The name of the SSH key.
37
+
-`ssh_key_id` - The unique identifier of the SSH key.
28
38
29
39
-> **Note** You must specify at least one: `name` and/or `ssh_key_id`.
30
40
31
-
-`project_id` - (Defaults to [provider](../index.md#project_id)`project_id`) The ID of the project the SSH key is associated with.
41
+
-`project_id` - (Defaults to [provider](../index.md#project_id)`project_id`) The unique identifier of the project with which the SSH key is associated.
32
42
33
43
## Attributes Reference
34
44
45
+
The `scaleway_account_ssh_key` data source exports certain attributes once the SSH key information is retrieved. These attributes can be referenced in other parts of your Terraform configuration.
46
+
35
47
In addition to all above arguments, the following attributes are exported:
36
48
37
-
-`id` - The ID of the SSH public key.
38
-
-`public_key` - The SSH public key string
39
-
-`organization_id` - The ID of the organization the SSH key is associated with.
49
+
-`id` - The unique identifier of the SSH public key.
50
+
-`public_key` - The string of the SSH public key.
51
+
-`organization_id` - The unique identifier of the Organization with which the SSH key is associated.
Use this data source to get the available zones information based on its Region.
8
+
The `scaleway_availability_zones` data source is used to retrieve information about the available zones based on its Region.
9
9
10
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, …).
11
+
you can choose the location that better fits your need (country, latency, etc.).
12
12
13
-
## Example Usage
13
+
Refer to the Account [documentation](https://www.scaleway.com/en/docs/console/account/reference-content/products-availability/) for more information.
14
+
15
+
## Retrieve the Availability Zones of a Region
16
+
17
+
The following command allow you to retrieve a the AZs of a Region.
14
18
15
19
```hcl
16
20
# Get info by Region key
@@ -21,11 +25,15 @@ data scaleway_availability_zones main {
21
25
22
26
## Argument Reference
23
27
24
-
-`region` - Region is represented as a Geographical area such as France. Defaults: `fr-par`.
28
+
This section lists the arguments that you can provide to the `scaleway_availability_zones` data source to filter and retrieve the desired AZs:
29
+
30
+
-`region` - Region is represented as a Geographical area, such as France. Defaults to `fr-par`.
25
31
26
32
## Attributes Reference
27
33
34
+
The `scaleway_availability_zones` data source exports certain attributes once the Availability Zones information is retrieved. These attributes can be referenced in other parts of your Terraform configuration.
35
+
28
36
In addition to all above arguments, the following attributes are exported:
29
37
30
-
-`id` - The Region ID
31
-
-`zones` - List of availability zones by regions
38
+
-`id` - The unique identifier of the Region
39
+
-`zones` - The list of availability zones in each Region
The `scaleway_container` data source is used to retrieve information about a Serverless Container.
8
8
9
-
For more information consult the [documentation](https://www.scaleway.com/en/docs/faq/serverless-containers/).
9
+
Refer to the Serverless Containers [product documentation](https://www.scaleway.com/en/docs/serverless/containers/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-containers/) for more information.
10
10
11
-
For more details about the limitation check [containers-limitations](https://www.scaleway.com/en/docs/compute/containers/reference-content/containers-limitations/).
11
+
For more information on the limitations of Serverless Containers, refer to the [dedicated documentation](https://www.scaleway.com/en/docs/compute/containers/reference-content/containers-limitations/).
12
12
13
-
You can check also our [containers guide](https://www.scaleway.com/en/docs/compute/containers/concepts/).
13
+
## Retrieve a Serverless Container
14
14
15
-
## Example Usage
15
+
The following commands allow you to:
16
+
17
+
- retrieve a container by its name
18
+
- retrieve a container by its ID
16
19
17
20
```hcl
18
21
resource scaleway_container_namespace main {
@@ -36,20 +39,22 @@ data "scaleway_container" "by_id" {
36
39
}
37
40
```
38
41
39
-
## Arguments Reference
42
+
## Arguments reference
40
43
41
-
The following arguments are required:
44
+
This section lists the arguments that you can provide to the `scaleway_container` data source to filter and retrieve the desired namespace. Each argument has a specific purpose:
42
45
43
-
-`name` - (Required) The unique name of the container name.
46
+
-`name` - (Required) The unique name of the container.
44
47
45
48
-`namespace_id` - (Required) The container namespace ID of the container.
46
49
47
-
-`project_id` - (Optional) The ID of the project the container is associated with.
50
+
-`project_id` - (Optional) The unique identifier of the project with which the container is associated.
48
51
49
-
~> **Important**Updates to`name` will recreate the container.
52
+
~> **Important**Updating the`name` argument will recreate the container.
50
53
51
54
## Attributes Reference
52
55
56
+
The `scaleway_container` data source exports certain attributes once the container information is retrieved. These attributes can be referenced in other parts of your Terraform configuration.
57
+
53
58
In addition to all arguments above, the following attributes are exported:
54
59
55
60
-`id` - The ID of the container
@@ -60,29 +65,29 @@ In addition to all arguments above, the following attributes are exported:
60
65
61
66
-`environment_variables` - The [environment](https://www.scaleway.com/en/docs/compute/containers/concepts/#environment-variables) variables of the container.
62
67
63
-
-`min_scale` - The minimum of running container instances continuously. Defaults to 0.
68
+
-`min_scale` - The minimum number of container instances running continuously.
64
69
65
-
-`max_scale` - The maximum of number of instances this container can scale to. Default to 20.
70
+
-`max_scale` - The maximum number of instances the container can scale to.
66
71
67
-
-`memory_limit` - The memory computing resources in MB to allocate to each container. Defaults to 128.
72
+
-`memory_limit` - The memory resources in MB to allocate to each container.
68
73
69
-
-`cpu_limit` - The amount of vCPU computing resources to allocate to each container. Defaults to 70.
74
+
-`cpu_limit` - The amount of vCPU computing resources to allocate to each container.
70
75
71
-
-`timeout` - The maximum amount of time in seconds during which your container can process a request before we stop it. Defaults to 300s.
76
+
-`timeout` - The maximum amount of time your container can spend processing a request before being stopped.
72
77
73
-
-`privacy` - The privacy type define the way to authenticate to your container. Please check our dedicated [section](https://developers.scaleway.com/en/products/containers/api/#protocol-9dd4c8).
78
+
-`privacy` - The privacy type define the way to authenticate to your container. Refer to the [dedicated documentation](https://www.scaleway.com/en/developers/api/serverless-containers/#path-containers-update-an-existing-container) for more information.
74
79
75
-
-`registry_image` - The registry image address. e.g: **"rg.fr-par.scw.cloud/$NAMESPACE/$IMAGE"**.
80
+
-`registry_image` - The registry image address (e.g. `rg.fr-par.scw.cloud/$NAMESPACE/$IMAGE`).
76
81
77
82
-`registry_sha256` - The sha256 of your source registry image, changing it will re-apply the deployment. Can be any string.
78
83
79
-
-`max_concurrency` - The maximum number of simultaneous requests your container can handle at the same time. Defaults to 50.
84
+
-`max_concurrency` - The maximum number of simultaneous requests your container can handle at the same time.
80
85
81
86
-`domain_name` - The container domain name.
82
87
83
-
-`protocol` - The communication [protocol](https://developers.scaleway.com/en/products/containers/api/#protocol-9dd4c8)http1 or h2c. Defaults to http1.
88
+
-`protocol` - The communication [protocol](https://www.scaleway.com/en/developers/api/serverless-containers/#path-containers-update-an-existing-container)`http1` or `h2c`. Defaults to `http1`.
84
89
85
-
-`port` - The port to expose the container. Defaults to 8080.
90
+
-`port` - The port to expose the container.
86
91
87
92
-`deploy` - Boolean indicating whether the container is on a production environment.
The `scaleway_container_namespace` data source is used to retrieve information about a Serverless Containers namespace.
9
9
10
-
## Example Usage
10
+
Refer to the Serverless Containers [product documentation](https://www.scaleway.com/en/docs/serverless/containers/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-containers/) for more information.
11
+
12
+
## Retrieve a Serverless Containers namespace
13
+
14
+
The following commands allow you to:
15
+
16
+
- retrieve a namespace by its name
17
+
- retrieve a namespace by its ID
11
18
12
19
```hcl
13
20
// Get info by namespace name
@@ -23,24 +30,28 @@ data "scaleway_container_namespace" "by_id" {
23
30
24
31
## Argument Reference
25
32
26
-
-`name` - (Optional) The namespace name.
27
-
Only one of `name` and `namespace_id` should be specified.
33
+
This section lists the arguments that you can provide to the `scaleway_container_namespace` data source to filter and retrieve the desired namespace. Each argument has a specific purpose:
34
+
35
+
-`name` - (Optional) The name of the namespace. Only one of `name` and `namespace_id` should be specified.
28
36
29
-
-`namespace_id` - (Optional) The namespace id.
30
-
Only one of `name` and `namespace_id` should be specified.
31
-
-`region` - (Defaults to [provider](../index.md#region)`region`) The [region](../guides/regions_and_zones.md#regions) in which the namespace exists.
32
-
-`project_id` - (Defaults to [provider](../index.md#project_id)`project_id`) The ID of the project the namespace is associated with.
37
+
-`namespace_id` - (Optional) The unique identifier of the namespace. Only one of `name` and `namespace_id` should be specified.
38
+
39
+
-`region` - (Defaults to the region specified in the [provider configuration](../index.md#region)`region`) The [region](../guides/regions_and_zones.md#regions) in which the namespace exists.
40
+
41
+
-`project_id` - (Defaults to [provider](../index.md#project_id)`project_id`) The unique identifier of the project with which the namespace is associated.
33
42
34
43
## Attributes Reference
35
44
36
-
In addition to all above arguments, the following attributes are exported:
45
+
The `scaleway_container_namespace` data source exports certain attributes once the namespace information is retrieved. These attributes can be referenced in other parts of your Terraform configuration.
46
+
47
+
In addition to the arguments above, the following attributes are exported:
37
48
38
-
-`id` - The ID of the container namespace.
49
+
-`id` - The unique identifier of the container namespace.
39
50
40
-
~> **Important:**Container namespaces' IDs are [regional](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{region}/{id}`, e.g. `fr-par/11111111-1111-1111-1111-111111111111`
51
+
~> **Important:**Serverless Containers namespace IDs are [regional](../guides/regions_and_zones.md#resource-ids), which means they are expressed in the form `{region}/{id}`, e.g. `fr-par/11111111-1111-1111-1111-111111111111`
41
52
42
-
-`organization_id` - The organization ID the namespace is associated with.
53
+
-`organization_id` - The unique identifier of the organization with which the namespace is associated.
43
54
-`description` - The description of the namespace.
44
55
-`environment_variables` - The environment variables of the namespace.
45
56
-`registry_endpoint` - The registry endpoint of the namespace.
46
-
-`registry_namespace_id` - The registry namespace ID of the namespace.
57
+
-`registry_namespace_id` - The unique identifier of the registry namespace of the Serverless Containers namespace.
The `scaleway_function` data source is used to retrieve information about a Serverless Function.
9
9
10
-
## Example Usage
10
+
Refer to the Serverless Functions [product documentation](https://www.scaleway.com/en/docs/serverless/functions/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-functions/) for more information.
11
+
12
+
For more information on the limitations of Serverless Functions, refer to the [dedicated documentation](https://www.scaleway.com/en/docs/compute/functions/reference-content/functions-limitations/).
13
+
14
+
## Retrieve a Serverless Function
15
+
16
+
The following commands allow you to:
17
+
18
+
- retrieve a function by its name
19
+
- retrieve a function by its ID
11
20
12
21
```terraform
13
22
// Get info by function name
@@ -25,12 +34,18 @@ data "scaleway_function" "my_function" {
25
34
26
35
## Argument Reference
27
36
28
-
-`namespace_id` - (Required) The namespace id associated with this function.
29
-
-`name` - (Optional) The function name. Only one of `name` and `namespace_id` should be specified.
30
-
-`function_id` - (Optional) The function id. Only one of `name` and `function_id` should be specified.
31
-
-`region` - (Defaults to [provider](../index.md#region)`region`) The [region](../guides/regions_and_zones.md#regions) in which the function exists.
32
-
-`project_id` - (Optional) The ID of the project the function is associated with.
37
+
This section lists the arguments that you can provide to the `scaleway_function` data source to filter and retrieve the desired namespace. Each argument has a specific purpose:
38
+
39
+
-`namespace_id` - (Required) The namespace ID associated with this function.
40
+
41
+
-`name` - (Optional) The name of the function. Only one of `name` and `namespace_id` should be specified.
42
+
43
+
-`function_id` - (Optional) The unique identifier of the function. Only one of `name` and `function_id` should be specified.
44
+
45
+
-`region` - (Defaults to the region specified in the [provider configuration](../index.md#region)`region`) The [region](../guides/regions_and_zones.md#regions) in which the container exists.
46
+
47
+
-`project_id` - (Optional) The unique identifier of the project with which the function is associated.
33
48
34
49
## Attributes Reference
35
50
36
-
Exported attributes are the ones from `scaleway_function`[resource](../resources/function.md)
51
+
The `scaleway_function` data source exports certain attributes once the function information is retrieved. These attributes can be referenced in other parts of your Terraform configuration. The exported attributes come from the `scaleway_function`[resource](../resources/function.md).
0 commit comments