pulumiverse-scaleway 1.16.0a1730122985__py3-none-any.whl → 1.17.0a1730194779__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of pulumiverse-scaleway might be problematic. Click here for more details.

Files changed (34) hide show
  1. pulumiverse_scaleway/__init__.py +10 -0
  2. pulumiverse_scaleway/_inputs.py +165 -60
  3. pulumiverse_scaleway/block_snapshot.py +37 -27
  4. pulumiverse_scaleway/block_volume.py +49 -43
  5. pulumiverse_scaleway/cockpit.py +39 -24
  6. pulumiverse_scaleway/cockpit_alert_manager.py +42 -38
  7. pulumiverse_scaleway/cockpit_grafana_user.py +39 -31
  8. pulumiverse_scaleway/cockpit_source.py +86 -50
  9. pulumiverse_scaleway/cockpit_token.py +45 -27
  10. pulumiverse_scaleway/database_instance.py +13 -8
  11. pulumiverse_scaleway/domain_record.py +88 -46
  12. pulumiverse_scaleway/domain_zone.py +47 -75
  13. pulumiverse_scaleway/get_block_snapshot.py +16 -12
  14. pulumiverse_scaleway/get_block_volume.py +10 -8
  15. pulumiverse_scaleway/get_cockpit.py +44 -19
  16. pulumiverse_scaleway/get_cockpit_plan.py +18 -6
  17. pulumiverse_scaleway/get_domain_record.py +40 -34
  18. pulumiverse_scaleway/get_domain_zone.py +12 -36
  19. pulumiverse_scaleway/get_mnq_sns.py +150 -0
  20. pulumiverse_scaleway/get_secret.py +77 -29
  21. pulumiverse_scaleway/get_secret_version.py +75 -38
  22. pulumiverse_scaleway/iam_policy.py +46 -0
  23. pulumiverse_scaleway/instance_server.py +56 -4
  24. pulumiverse_scaleway/loadbalancer_frontend.py +4 -4
  25. pulumiverse_scaleway/outputs.py +169 -55
  26. pulumiverse_scaleway/pulumi-plugin.json +1 -1
  27. pulumiverse_scaleway/secret.py +162 -59
  28. pulumiverse_scaleway/secret_version.py +59 -54
  29. pulumiverse_scaleway/tem_domain.py +9 -4
  30. pulumiverse_scaleway/tem_webhook.py +640 -0
  31. {pulumiverse_scaleway-1.16.0a1730122985.dist-info → pulumiverse_scaleway-1.17.0a1730194779.dist-info}/METADATA +1 -1
  32. {pulumiverse_scaleway-1.16.0a1730122985.dist-info → pulumiverse_scaleway-1.17.0a1730194779.dist-info}/RECORD +34 -32
  33. {pulumiverse_scaleway-1.16.0a1730122985.dist-info → pulumiverse_scaleway-1.17.0a1730194779.dist-info}/WHEEL +0 -0
  34. {pulumiverse_scaleway-1.16.0a1730122985.dist-info → pulumiverse_scaleway-1.17.0a1730194779.dist-info}/top_level.txt +0 -0
@@ -110,14 +110,16 @@ def get_block_snapshot(name: Optional[str] = None,
110
110
  zone: Optional[str] = None,
111
111
  opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetBlockSnapshotResult:
112
112
  """
113
- Gets information about a Block Snapshot.
113
+ The `BlockSnapshot` data source is used to retrieve information about a Block Storage volume snapshot.
114
114
 
115
+ Refer to the Block Storage [product documentation](https://www.scaleway.com/en/docs/storage/block/) and [API documentation](https://www.scaleway.com/en/developers/api/block/) for more information.
115
116
 
116
- :param str name: The name of the snapshot. Only one of `name` and `snapshot_id` should be specified.
117
- :param str project_id: The ID of the project the snapshot is associated with.
118
- :param str snapshot_id: The ID of the snapshot. Only one of `name` and `snapshot_id` should be specified.
119
- :param str volume_id: The ID of the volume from which the snapshot has been created.
120
- :param str zone: `zone`) The zone in which the snapshot exists.
117
+
118
+ :param str name: The name of the snapshot. Only one of name or snapshot_id should be specified.
119
+ :param str project_id: The unique identifier of the Project to which the snapshot is associated.
120
+ :param str snapshot_id: The unique identifier of the snapshot. Only one of `name` and `snapshot_id` should be specified.
121
+ :param str volume_id: The unique identifier of the volume from which the snapshot was created.
122
+ :param str zone: ) The zone in which the snapshot exists.
121
123
  """
122
124
  __args__ = dict()
123
125
  __args__['name'] = name
@@ -143,14 +145,16 @@ def get_block_snapshot_output(name: Optional[pulumi.Input[Optional[str]]] = None
143
145
  zone: Optional[pulumi.Input[Optional[str]]] = None,
144
146
  opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetBlockSnapshotResult]:
145
147
  """
146
- Gets information about a Block Snapshot.
148
+ The `BlockSnapshot` data source is used to retrieve information about a Block Storage volume snapshot.
149
+
150
+ Refer to the Block Storage [product documentation](https://www.scaleway.com/en/docs/storage/block/) and [API documentation](https://www.scaleway.com/en/developers/api/block/) for more information.
147
151
 
148
152
 
149
- :param str name: The name of the snapshot. Only one of `name` and `snapshot_id` should be specified.
150
- :param str project_id: The ID of the project the snapshot is associated with.
151
- :param str snapshot_id: The ID of the snapshot. Only one of `name` and `snapshot_id` should be specified.
152
- :param str volume_id: The ID of the volume from which the snapshot has been created.
153
- :param str zone: `zone`) The zone in which the snapshot exists.
153
+ :param str name: The name of the snapshot. Only one of name or snapshot_id should be specified.
154
+ :param str project_id: The unique identifier of the Project to which the snapshot is associated.
155
+ :param str snapshot_id: The unique identifier of the snapshot. Only one of `name` and `snapshot_id` should be specified.
156
+ :param str volume_id: The unique identifier of the volume from which the snapshot was created.
157
+ :param str zone: ) The zone in which the snapshot exists.
154
158
  """
155
159
  __args__ = dict()
156
160
  __args__['name'] = name
@@ -127,13 +127,14 @@ def get_block_volume(name: Optional[str] = None,
127
127
  zone: Optional[str] = None,
128
128
  opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetBlockVolumeResult:
129
129
  """
130
- Gets information about a Block Volume.
130
+ The `BlockVolume` data source is used to retrieve information about a Block Storage volume.
131
+ Refer to the Block Storage [product documentation](https://www.scaleway.com/en/docs/storage/block/) and [API documentation](https://www.scaleway.com/en/developers/api/block/) for more information.
131
132
 
132
133
 
133
134
  :param str name: The name of the volume. Only one of `name` and `volume_id` should be specified.
134
- :param str project_id: The ID of the project the volume is associated with.
135
- :param str volume_id: The ID of the volume. Only one of `name` and `volume_id` should be specified.
136
- :param str zone: `zone`) The zone in which the volume exists.
135
+ :param str project_id: The unique identifier of the Project to which the volume is associated.
136
+ :param str volume_id: The unique identifier of the volume. Only one of `name` and `volume_id` should be specified.
137
+ :param str zone: ). The zone in which the volume exists.
137
138
  """
138
139
  __args__ = dict()
139
140
  __args__['name'] = name
@@ -159,13 +160,14 @@ def get_block_volume_output(name: Optional[pulumi.Input[Optional[str]]] = None,
159
160
  zone: Optional[pulumi.Input[Optional[str]]] = None,
160
161
  opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetBlockVolumeResult]:
161
162
  """
162
- Gets information about a Block Volume.
163
+ The `BlockVolume` data source is used to retrieve information about a Block Storage volume.
164
+ Refer to the Block Storage [product documentation](https://www.scaleway.com/en/docs/storage/block/) and [API documentation](https://www.scaleway.com/en/developers/api/block/) for more information.
163
165
 
164
166
 
165
167
  :param str name: The name of the volume. Only one of `name` and `volume_id` should be specified.
166
- :param str project_id: The ID of the project the volume is associated with.
167
- :param str volume_id: The ID of the volume. Only one of `name` and `volume_id` should be specified.
168
- :param str zone: `zone`) The zone in which the volume exists.
168
+ :param str project_id: The unique identifier of the Project to which the volume is associated.
169
+ :param str volume_id: The unique identifier of the volume. Only one of `name` and `volume_id` should be specified.
170
+ :param str zone: ). The zone in which the volume exists.
169
171
  """
170
172
  __args__ = dict()
171
173
  __args__['name'] = name
@@ -27,13 +27,16 @@ class GetCockpitResult:
27
27
  """
28
28
  A collection of values returned by getCockpit.
29
29
  """
30
- def __init__(__self__, endpoints=None, id=None, plan_id=None, project_id=None, push_urls=None):
30
+ def __init__(__self__, endpoints=None, id=None, plan=None, plan_id=None, project_id=None, push_urls=None):
31
31
  if endpoints and not isinstance(endpoints, list):
32
32
  raise TypeError("Expected argument 'endpoints' to be a list")
33
33
  pulumi.set(__self__, "endpoints", endpoints)
34
34
  if id and not isinstance(id, str):
35
35
  raise TypeError("Expected argument 'id' to be a str")
36
36
  pulumi.set(__self__, "id", id)
37
+ if plan and not isinstance(plan, str):
38
+ raise TypeError("Expected argument 'plan' to be a str")
39
+ pulumi.set(__self__, "plan", plan)
37
40
  if plan_id and not isinstance(plan_id, str):
38
41
  raise TypeError("Expected argument 'plan_id' to be a str")
39
42
  pulumi.set(__self__, "plan_id", plan_id)
@@ -48,7 +51,7 @@ class GetCockpitResult:
48
51
  @pulumi.getter
49
52
  def endpoints(self) -> Sequence['outputs.GetCockpitEndpointResult']:
50
53
  """
51
- Endpoints
54
+ (Deprecated) A list of [endpoints](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#endpoints) related to Cockpit, each with specific URLs:
52
55
  """
53
56
  return pulumi.get(self, "endpoints")
54
57
 
@@ -60,11 +63,16 @@ class GetCockpitResult:
60
63
  """
61
64
  return pulumi.get(self, "id")
62
65
 
66
+ @property
67
+ @pulumi.getter
68
+ def plan(self) -> str:
69
+ return pulumi.get(self, "plan")
70
+
63
71
  @property
64
72
  @pulumi.getter(name="planId")
65
73
  def plan_id(self) -> str:
66
74
  """
67
- The ID of the current plan
75
+ (Deprecated) ID of the current pricing plan
68
76
  """
69
77
  return pulumi.get(self, "plan_id")
70
78
 
@@ -87,6 +95,7 @@ class AwaitableGetCockpitResult(GetCockpitResult):
87
95
  return GetCockpitResult(
88
96
  endpoints=self.endpoints,
89
97
  id=self.id,
98
+ plan=self.plan,
90
99
  plan_id=self.plan_id,
91
100
  project_id=self.project_id,
92
101
  push_urls=self.push_urls)
@@ -95,21 +104,28 @@ class AwaitableGetCockpitResult(GetCockpitResult):
95
104
  def get_cockpit(project_id: Optional[str] = None,
96
105
  opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetCockpitResult:
97
106
  """
107
+ > **Important:** The data source `Cockpit` has been deprecated and will no longer be supported. Instead, use resource `Cockpit`.
108
+
98
109
  > **Note:**
99
- As of April 2024, Cockpit has introduced regionalization to offer more flexibility and resilience.
100
- If you have customized dashboards in Grafana for monitoring Scaleway resources, please update your queries to accommodate the new regionalized data sources.
110
+ As of April 2024, Cockpit has introduced [regionalization](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#region) to offer more flexibility and resilience.
111
+ If you have created customized dashboards with data for your Scaleway resources before April 2024, you will need to update your queries in Grafana, with the new regionalized data sources.
112
+
113
+ The `Cockpit` data source is used to retrieve information about a Scaleway Cockpit associated with a given Project. This can be the default Project or a specific Project identified by its ID.
101
114
 
102
- Gets information about the Scaleway Cockpit.
115
+ Refer to Cockpit's [product documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/) and [API documentation](https://www.scaleway.com/en/developers/api/cockpit/regional-api) for more information.
103
116
 
104
- For more information consult the [documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/).
117
+ ## Retrieve a Cockpit
105
118
 
106
- ## Example Usage
119
+ The following commands allow you to:
120
+
121
+ - get information on the Cockpit associated with your Scaleway default Project
122
+ - get information on the Cockpit associated with a specific Scaleway Project
107
123
 
108
124
  ```python
109
125
  import pulumi
110
126
  import pulumi_scaleway as scaleway
111
127
 
112
- # Get default project's cockpit
128
+ # Get the default Project's Cockpit
113
129
  main = scaleway.get_cockpit()
114
130
  ```
115
131
 
@@ -117,12 +133,12 @@ def get_cockpit(project_id: Optional[str] = None,
117
133
  import pulumi
118
134
  import pulumi_scaleway as scaleway
119
135
 
120
- # Get a specific project's cockpit
136
+ # Get a specific Project's Cockpit
121
137
  main = scaleway.get_cockpit(project_id="11111111-1111-1111-1111-111111111111")
122
138
  ```
123
139
 
124
140
 
125
- :param str project_id: `project_id`) The ID of the project the cockpit is associated with.
141
+ :param str project_id: Specifies the ID of the Scaleway Project that the Cockpit is associated with. If not specified, it defaults to the Project ID specified in the provider configuration.
126
142
  """
127
143
  __args__ = dict()
128
144
  __args__['projectId'] = project_id
@@ -132,27 +148,35 @@ def get_cockpit(project_id: Optional[str] = None,
132
148
  return AwaitableGetCockpitResult(
133
149
  endpoints=pulumi.get(__ret__, 'endpoints'),
134
150
  id=pulumi.get(__ret__, 'id'),
151
+ plan=pulumi.get(__ret__, 'plan'),
135
152
  plan_id=pulumi.get(__ret__, 'plan_id'),
136
153
  project_id=pulumi.get(__ret__, 'project_id'),
137
154
  push_urls=pulumi.get(__ret__, 'push_urls'))
138
155
  def get_cockpit_output(project_id: Optional[pulumi.Input[Optional[str]]] = None,
139
156
  opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetCockpitResult]:
140
157
  """
158
+ > **Important:** The data source `Cockpit` has been deprecated and will no longer be supported. Instead, use resource `Cockpit`.
159
+
141
160
  > **Note:**
142
- As of April 2024, Cockpit has introduced regionalization to offer more flexibility and resilience.
143
- If you have customized dashboards in Grafana for monitoring Scaleway resources, please update your queries to accommodate the new regionalized data sources.
161
+ As of April 2024, Cockpit has introduced [regionalization](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#region) to offer more flexibility and resilience.
162
+ If you have created customized dashboards with data for your Scaleway resources before April 2024, you will need to update your queries in Grafana, with the new regionalized data sources.
163
+
164
+ The `Cockpit` data source is used to retrieve information about a Scaleway Cockpit associated with a given Project. This can be the default Project or a specific Project identified by its ID.
165
+
166
+ Refer to Cockpit's [product documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/) and [API documentation](https://www.scaleway.com/en/developers/api/cockpit/regional-api) for more information.
144
167
 
145
- Gets information about the Scaleway Cockpit.
168
+ ## Retrieve a Cockpit
146
169
 
147
- For more information consult the [documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/).
170
+ The following commands allow you to:
148
171
 
149
- ## Example Usage
172
+ - get information on the Cockpit associated with your Scaleway default Project
173
+ - get information on the Cockpit associated with a specific Scaleway Project
150
174
 
151
175
  ```python
152
176
  import pulumi
153
177
  import pulumi_scaleway as scaleway
154
178
 
155
- # Get default project's cockpit
179
+ # Get the default Project's Cockpit
156
180
  main = scaleway.get_cockpit()
157
181
  ```
158
182
 
@@ -160,12 +184,12 @@ def get_cockpit_output(project_id: Optional[pulumi.Input[Optional[str]]] = None,
160
184
  import pulumi
161
185
  import pulumi_scaleway as scaleway
162
186
 
163
- # Get a specific project's cockpit
187
+ # Get a specific Project's Cockpit
164
188
  main = scaleway.get_cockpit(project_id="11111111-1111-1111-1111-111111111111")
165
189
  ```
166
190
 
167
191
 
168
- :param str project_id: `project_id`) The ID of the project the cockpit is associated with.
192
+ :param str project_id: Specifies the ID of the Scaleway Project that the Cockpit is associated with. If not specified, it defaults to the Project ID specified in the provider configuration.
169
193
  """
170
194
  __args__ = dict()
171
195
  __args__['projectId'] = project_id
@@ -174,6 +198,7 @@ def get_cockpit_output(project_id: Optional[pulumi.Input[Optional[str]]] = None,
174
198
  return __ret__.apply(lambda __response__: GetCockpitResult(
175
199
  endpoints=pulumi.get(__response__, 'endpoints'),
176
200
  id=pulumi.get(__response__, 'id'),
201
+ plan=pulumi.get(__response__, 'plan'),
177
202
  plan_id=pulumi.get(__response__, 'plan_id'),
178
203
  project_id=pulumi.get(__response__, 'project_id'),
179
204
  push_urls=pulumi.get(__response__, 'push_urls')))
@@ -61,9 +61,15 @@ class AwaitableGetCockpitPlanResult(GetCockpitPlanResult):
61
61
  def get_cockpit_plan(name: Optional[str] = None,
62
62
  opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetCockpitPlanResult:
63
63
  """
64
- Gets information about a Scaleway Cockpit plan.
64
+ The `get_cockpit_plan` data source is used to fetch details about a specific Scaleway Cockpit pricing plan. This information can then be used to configure resources like `Cockpit`.
65
65
 
66
- ## Example Usage
66
+ Find out more about [pricing plans](https://console.scaleway.com/cockpit/plans) in the Scaleway console.
67
+
68
+ Refer to Cockpit's [product documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/) and [API documentation](https://www.scaleway.com/en/developers/api/cockpit/regional-api) for more information.
69
+
70
+ ## Fetch and associate a pricing plan to a Cockpit
71
+
72
+ The following command shows how to fetch information about the `premium` pricing plan and how to associate it with the Cockpit of your Scaleway default Project.
67
73
 
68
74
  ```python
69
75
  import pulumi
@@ -75,7 +81,7 @@ def get_cockpit_plan(name: Optional[str] = None,
75
81
  ```
76
82
 
77
83
 
78
- :param str name: The name of the plan.
84
+ :param str name: Name of the pricing plan you want to retrieve information about.
79
85
  """
80
86
  __args__ = dict()
81
87
  __args__['name'] = name
@@ -88,9 +94,15 @@ def get_cockpit_plan(name: Optional[str] = None,
88
94
  def get_cockpit_plan_output(name: Optional[pulumi.Input[str]] = None,
89
95
  opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetCockpitPlanResult]:
90
96
  """
91
- Gets information about a Scaleway Cockpit plan.
97
+ The `get_cockpit_plan` data source is used to fetch details about a specific Scaleway Cockpit pricing plan. This information can then be used to configure resources like `Cockpit`.
98
+
99
+ Find out more about [pricing plans](https://console.scaleway.com/cockpit/plans) in the Scaleway console.
100
+
101
+ Refer to Cockpit's [product documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/) and [API documentation](https://www.scaleway.com/en/developers/api/cockpit/regional-api) for more information.
102
+
103
+ ## Fetch and associate a pricing plan to a Cockpit
92
104
 
93
- ## Example Usage
105
+ The following command shows how to fetch information about the `premium` pricing plan and how to associate it with the Cockpit of your Scaleway default Project.
94
106
 
95
107
  ```python
96
108
  import pulumi
@@ -102,7 +114,7 @@ def get_cockpit_plan_output(name: Optional[pulumi.Input[str]] = None,
102
114
  ```
103
115
 
104
116
 
105
- :param str name: The name of the plan.
117
+ :param str name: Name of the pricing plan you want to retrieve information about.
106
118
  """
107
119
  __args__ = dict()
108
120
  __args__['name'] = name
@@ -96,7 +96,7 @@ class GetDomainRecordResult:
96
96
  @pulumi.getter(name="geoIps")
97
97
  def geo_ips(self) -> Sequence['outputs.GetDomainRecordGeoIpResult']:
98
98
  """
99
- Dynamic record base on user geolocalisation (More information about dynamic records)
99
+ Information about dynamic records based on user geolocation. Find out more about dynamic records.
100
100
  """
101
101
  return pulumi.get(self, "geo_ips")
102
102
 
@@ -104,7 +104,7 @@ class GetDomainRecordResult:
104
104
  @pulumi.getter(name="httpServices")
105
105
  def http_services(self) -> Sequence['outputs.GetDomainRecordHttpServiceResult']:
106
106
  """
107
- Dynamic record base on URL resolve (More information about dynamic records)
107
+ Information about dynamic records based on URL resolution. Find out more about dynamic records.
108
108
  """
109
109
  return pulumi.get(self, "http_services")
110
110
 
@@ -130,7 +130,7 @@ class GetDomainRecordResult:
130
130
  @pulumi.getter
131
131
  def priority(self) -> int:
132
132
  """
133
- The priority of the record (mostly used with an `MX` record)
133
+ The priority of the record, mainly used with `MX` records.
134
134
  """
135
135
  return pulumi.get(self, "priority")
136
136
 
@@ -153,7 +153,7 @@ class GetDomainRecordResult:
153
153
  @pulumi.getter
154
154
  def ttl(self) -> int:
155
155
  """
156
- Time To Live of the record in seconds.
156
+ The Time To Live (TTL) of the record in seconds.
157
157
  """
158
158
  return pulumi.get(self, "ttl")
159
159
 
@@ -166,7 +166,7 @@ class GetDomainRecordResult:
166
166
  @pulumi.getter
167
167
  def views(self) -> Sequence['outputs.GetDomainRecordViewResult']:
168
168
  """
169
- Dynamic record based on the client’s (resolver) subnet (More information about dynamic records)
169
+ Information about dynamic records based on the client’s (resolver) subnet. Find out more about dynamic records.
170
170
  """
171
171
  return pulumi.get(self, "views")
172
172
 
@@ -174,7 +174,7 @@ class GetDomainRecordResult:
174
174
  @pulumi.getter
175
175
  def weighteds(self) -> Sequence['outputs.GetDomainRecordWeightedResult']:
176
176
  """
177
- Dynamic record base on IP weights (More information about dynamic records)
177
+ Information about dynamic records based on IP weights. Find out more about dynamic records.
178
178
  """
179
179
  return pulumi.get(self, "weighteds")
180
180
 
@@ -211,35 +211,38 @@ def get_domain_record(data: Optional[str] = None,
211
211
  type: Optional[str] = None,
212
212
  opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDomainRecordResult:
213
213
  """
214
- Gets information about a domain record.
214
+ The `DomainRecord` data source is used to get information about an existing domain record.
215
215
 
216
- ## Example Usage
216
+ Refer to the Domains and DNS [product documentation](https://www.scaleway.com/en/docs/network/domains-and-dns/) and [API documentation](https://www.scaleway.com/en/developers/api/domains-and-dns/) for more information.
217
+
218
+ ## Query domain records
219
+
220
+ The following commands allow you to:
221
+
222
+ - query a domain record specified by the DNS zone (`domain.tld`), the record name (`www`), the record type (`A`), and the record content (`1.2.3.4`).
223
+ - query a domain record specified by the DNS zone (`domain.tld`) and the unique record ID (`11111111-1111-1111-1111-111111111111`).
217
224
 
218
225
  ```python
219
226
  import pulumi
220
227
  import pulumi_scaleway as scaleway
221
228
 
222
- # Get record by name, type and data
229
+ # Query record by DNS zone, record name, type and content
223
230
  by_content = scaleway.get_domain_record(dns_zone="domain.tld",
224
231
  name="www",
225
232
  type="A",
226
233
  data="1.2.3.4")
227
- # Get info by ID
234
+ # Query record by DNS zone and record ID
228
235
  by_id = scaleway.get_domain_record(dns_zone="domain.tld",
229
236
  record_id="11111111-1111-1111-1111-111111111111")
230
237
  ```
231
238
 
232
239
 
233
- :param str data: The content of the record (an IPv4 for an `A`, a string for a `TXT`...).
234
- Cannot be used with `record_id`.
235
- :param str dns_zone: The IP address.
236
- :param str name: The name of the record (can be an empty string for a root record).
237
- Cannot be used with `record_id`.
238
- :param str project_id: `project_id`) The ID of the project the domain is associated with.
239
- :param str record_id: The record ID.
240
- Cannot be used with `name`, `type` and `data`.
241
- :param str type: The type of the record (`A`, `AAAA`, `MX`, `CNAME`, `DNAME`, `ALIAS`, `NS`, `PTR`, `SRV`, `TXT`, `TLSA`, or `CAA`).
242
- Cannot be used with `record_id`.
240
+ :param str data: The content of the record (e.g., an IPv4 address for an `A` record or a string for a `TXT` record). Cannot be used with `record_id`.
241
+ :param str dns_zone: The DNS zone (domain) to which the record belongs. This is a required field in both examples above but is optional in the context of defining the data source.
242
+ :param str name: The name of the record, which can be an empty string for a root record. Cannot be used with `record_id`.
243
+ :param str project_id: ). The ID of the Project associated with the domain.
244
+ :param str record_id: The unique identifier of the record. Cannot be used with `name`, `type`, and `data`.
245
+ :param str type: The type of the record (`A`, `AAAA`, `MX`, `CNAME`, etc.). Cannot be used with `record_id`.
243
246
  """
244
247
  __args__ = dict()
245
248
  __args__['data'] = data
@@ -276,35 +279,38 @@ def get_domain_record_output(data: Optional[pulumi.Input[Optional[str]]] = None,
276
279
  type: Optional[pulumi.Input[Optional[str]]] = None,
277
280
  opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetDomainRecordResult]:
278
281
  """
279
- Gets information about a domain record.
282
+ The `DomainRecord` data source is used to get information about an existing domain record.
283
+
284
+ Refer to the Domains and DNS [product documentation](https://www.scaleway.com/en/docs/network/domains-and-dns/) and [API documentation](https://www.scaleway.com/en/developers/api/domains-and-dns/) for more information.
285
+
286
+ ## Query domain records
287
+
288
+ The following commands allow you to:
280
289
 
281
- ## Example Usage
290
+ - query a domain record specified by the DNS zone (`domain.tld`), the record name (`www`), the record type (`A`), and the record content (`1.2.3.4`).
291
+ - query a domain record specified by the DNS zone (`domain.tld`) and the unique record ID (`11111111-1111-1111-1111-111111111111`).
282
292
 
283
293
  ```python
284
294
  import pulumi
285
295
  import pulumi_scaleway as scaleway
286
296
 
287
- # Get record by name, type and data
297
+ # Query record by DNS zone, record name, type and content
288
298
  by_content = scaleway.get_domain_record(dns_zone="domain.tld",
289
299
  name="www",
290
300
  type="A",
291
301
  data="1.2.3.4")
292
- # Get info by ID
302
+ # Query record by DNS zone and record ID
293
303
  by_id = scaleway.get_domain_record(dns_zone="domain.tld",
294
304
  record_id="11111111-1111-1111-1111-111111111111")
295
305
  ```
296
306
 
297
307
 
298
- :param str data: The content of the record (an IPv4 for an `A`, a string for a `TXT`...).
299
- Cannot be used with `record_id`.
300
- :param str dns_zone: The IP address.
301
- :param str name: The name of the record (can be an empty string for a root record).
302
- Cannot be used with `record_id`.
303
- :param str project_id: `project_id`) The ID of the project the domain is associated with.
304
- :param str record_id: The record ID.
305
- Cannot be used with `name`, `type` and `data`.
306
- :param str type: The type of the record (`A`, `AAAA`, `MX`, `CNAME`, `DNAME`, `ALIAS`, `NS`, `PTR`, `SRV`, `TXT`, `TLSA`, or `CAA`).
307
- Cannot be used with `record_id`.
308
+ :param str data: The content of the record (e.g., an IPv4 address for an `A` record or a string for a `TXT` record). Cannot be used with `record_id`.
309
+ :param str dns_zone: The DNS zone (domain) to which the record belongs. This is a required field in both examples above but is optional in the context of defining the data source.
310
+ :param str name: The name of the record, which can be an empty string for a root record. Cannot be used with `record_id`.
311
+ :param str project_id: ). The ID of the Project associated with the domain.
312
+ :param str record_id: The unique identifier of the record. Cannot be used with `name`, `type`, and `data`.
313
+ :param str type: The type of the record (`A`, `AAAA`, `MX`, `CNAME`, etc.). Cannot be used with `record_id`.
308
314
  """
309
315
  __args__ = dict()
310
316
  __args__['data'] = data
@@ -75,7 +75,7 @@ class GetDomainZoneResult:
75
75
  @pulumi.getter
76
76
  def message(self) -> str:
77
77
  """
78
- Message
78
+ Message associated with the domain zone (typically used for status or error messages).
79
79
  """
80
80
  return pulumi.get(self, "message")
81
81
 
@@ -83,7 +83,7 @@ class GetDomainZoneResult:
83
83
  @pulumi.getter
84
84
  def ns(self) -> Sequence[str]:
85
85
  """
86
- NameServer list for zone.
86
+ The list of name servers for the zone.
87
87
  """
88
88
  return pulumi.get(self, "ns")
89
89
 
@@ -91,7 +91,7 @@ class GetDomainZoneResult:
91
91
  @pulumi.getter(name="nsDefaults")
92
92
  def ns_defaults(self) -> Sequence[str]:
93
93
  """
94
- NameServer default list for zone.
94
+ The default list of name servers for the zone.
95
95
  """
96
96
  return pulumi.get(self, "ns_defaults")
97
97
 
@@ -99,7 +99,7 @@ class GetDomainZoneResult:
99
99
  @pulumi.getter(name="nsMasters")
100
100
  def ns_masters(self) -> Sequence[str]:
101
101
  """
102
- NameServer master list for zone.
102
+ The master list of name servers for the zone.
103
103
  """
104
104
  return pulumi.get(self, "ns_masters")
105
105
 
@@ -112,7 +112,7 @@ class GetDomainZoneResult:
112
112
  @pulumi.getter
113
113
  def status(self) -> str:
114
114
  """
115
- The domain zone status.
115
+ The status of the domain zone.
116
116
  """
117
117
  return pulumi.get(self, "status")
118
118
 
@@ -125,7 +125,7 @@ class GetDomainZoneResult:
125
125
  @pulumi.getter(name="updatedAt")
126
126
  def updated_at(self) -> str:
127
127
  """
128
- The date and time of the last update of the DNS zone.
128
+ The date and time of the last update to the DNS zone.
129
129
  """
130
130
  return pulumi.get(self, "updated_at")
131
131
 
@@ -152,22 +152,10 @@ def get_domain_zone(domain: Optional[str] = None,
152
152
  subdomain: Optional[str] = None,
153
153
  opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDomainZoneResult:
154
154
  """
155
- Gets information about a domain zone.
155
+ Use this data source to access information about an existing resource.
156
156
 
157
- ## Example Usage
158
-
159
- ```python
160
- import pulumi
161
- import pulumi_scaleway as scaleway
162
-
163
- # Get zone
164
- main = scaleway.get_domain_zone(domain="scaleway-terraform.com",
165
- subdomain="test")
166
- ```
167
-
168
-
169
- :param str domain: The domain where the DNS zone will be created.
170
- :param str subdomain: The subdomain(zone name) to create in the domain.
157
+ :param str domain: The primary domain name where the DNS zone is located. This is a mandatory field.
158
+ :param str subdomain: The subdomain (or zone name) within the primary domain. This is a mandatory field.
171
159
  """
172
160
  __args__ = dict()
173
161
  __args__['domain'] = domain
@@ -190,22 +178,10 @@ def get_domain_zone_output(domain: Optional[pulumi.Input[Optional[str]]] = None,
190
178
  subdomain: Optional[pulumi.Input[Optional[str]]] = None,
191
179
  opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetDomainZoneResult]:
192
180
  """
193
- Gets information about a domain zone.
194
-
195
- ## Example Usage
196
-
197
- ```python
198
- import pulumi
199
- import pulumi_scaleway as scaleway
200
-
201
- # Get zone
202
- main = scaleway.get_domain_zone(domain="scaleway-terraform.com",
203
- subdomain="test")
204
- ```
205
-
181
+ Use this data source to access information about an existing resource.
206
182
 
207
- :param str domain: The domain where the DNS zone will be created.
208
- :param str subdomain: The subdomain(zone name) to create in the domain.
183
+ :param str domain: The primary domain name where the DNS zone is located. This is a mandatory field.
184
+ :param str subdomain: The subdomain (or zone name) within the primary domain. This is a mandatory field.
209
185
  """
210
186
  __args__ = dict()
211
187
  __args__['domain'] = domain