@pulumiverse/scaleway 1.16.0 → 1.17.0

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.
Files changed (79) hide show
  1. package/blockSnapshot.d.ts +17 -12
  2. package/blockSnapshot.js +8 -3
  3. package/blockSnapshot.js.map +1 -1
  4. package/blockVolume.d.ts +22 -19
  5. package/blockVolume.js +7 -4
  6. package/blockVolume.js.map +1 -1
  7. package/cockpit.d.ts +23 -11
  8. package/cockpit.js +1 -1
  9. package/cockpit.js.map +1 -1
  10. package/cockpitAlertManager.d.ts +19 -17
  11. package/cockpitAlertManager.js +5 -3
  12. package/cockpitAlertManager.js.map +1 -1
  13. package/cockpitGrafanaUser.d.ts +18 -14
  14. package/cockpitGrafanaUser.js +7 -3
  15. package/cockpitGrafanaUser.js.map +1 -1
  16. package/cockpitSource.d.ts +35 -23
  17. package/cockpitSource.js +9 -3
  18. package/cockpitSource.js.map +1 -1
  19. package/cockpitToken.d.ts +21 -12
  20. package/cockpitToken.js +12 -3
  21. package/cockpitToken.js.map +1 -1
  22. package/databaseInstance.d.ts +8 -4
  23. package/databaseInstance.js.map +1 -1
  24. package/domainRecord.d.ts +42 -21
  25. package/domainRecord.js +30 -9
  26. package/domainRecord.js.map +1 -1
  27. package/domainZone.d.ts +22 -37
  28. package/domainZone.js +1 -16
  29. package/domainZone.js.map +1 -1
  30. package/getBlockSnapshot.d.ts +16 -12
  31. package/getBlockSnapshot.js +6 -2
  32. package/getBlockSnapshot.js.map +1 -1
  33. package/getBlockVolume.d.ts +10 -8
  34. package/getBlockVolume.js +4 -2
  35. package/getBlockVolume.js.map +1 -1
  36. package/getCockpit.d.ts +33 -18
  37. package/getCockpit.js +28 -14
  38. package/getCockpit.js.map +1 -1
  39. package/getCockpitPlan.d.ts +18 -6
  40. package/getCockpitPlan.js +16 -4
  41. package/getCockpitPlan.js.map +1 -1
  42. package/getDomainRecord.d.ts +40 -34
  43. package/getDomainRecord.js +22 -8
  44. package/getDomainRecord.js.map +1 -1
  45. package/getDomainZone.d.ts +10 -42
  46. package/getDomainZone.js +0 -32
  47. package/getDomainZone.js.map +1 -1
  48. package/getMnqSns.d.ts +82 -0
  49. package/getMnqSns.js +64 -0
  50. package/getMnqSns.js.map +1 -0
  51. package/getSecret.d.ts +46 -28
  52. package/getSecret.js +28 -12
  53. package/getSecret.js.map +1 -1
  54. package/getSecretVersion.d.ts +60 -39
  55. package/getSecretVersion.js +46 -16
  56. package/getSecretVersion.js.map +1 -1
  57. package/iamPolicy.d.ts +24 -0
  58. package/iamPolicy.js +24 -0
  59. package/iamPolicy.js.map +1 -1
  60. package/index.d.ts +6 -0
  61. package/index.js +11 -3
  62. package/index.js.map +1 -1
  63. package/instanceServer.d.ts +35 -2
  64. package/instanceServer.js.map +1 -1
  65. package/loadbalancerFrontend.d.ts +2 -2
  66. package/package.json +2 -2
  67. package/secret.d.ts +47 -30
  68. package/secret.js +7 -22
  69. package/secret.js.map +1 -1
  70. package/secretVersion.d.ts +28 -25
  71. package/secretVersion.js +11 -5
  72. package/secretVersion.js.map +1 -1
  73. package/temDomain.d.ts +6 -2
  74. package/temDomain.js.map +1 -1
  75. package/temWebhook.d.ts +229 -0
  76. package/temWebhook.js +171 -0
  77. package/temWebhook.js.map +1 -0
  78. package/types/input.d.ts +44 -20
  79. package/types/output.d.ts +68 -28
package/getCockpit.js CHANGED
@@ -6,21 +6,28 @@ exports.getCockpitOutput = exports.getCockpit = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
+ * > **Important:** The data source `scaleway.Cockpit` has been deprecated and will no longer be supported. Instead, use resource `scaleway.Cockpit`.
10
+ *
9
11
  * > **Note:**
10
- * As of April 2024, Cockpit has introduced regionalization to offer more flexibility and resilience.
11
- * If you have customized dashboards in Grafana for monitoring Scaleway resources, please update your queries to accommodate the new regionalized data sources.
12
+ * As of April 2024, Cockpit has introduced [regionalization](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#region) to offer more flexibility and resilience.
13
+ * 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.
14
+ *
15
+ * The `scaleway.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.
16
+ *
17
+ * 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.
12
18
  *
13
- * Gets information about the Scaleway Cockpit.
19
+ * ## Retrieve a Cockpit
14
20
  *
15
- * For more information consult the [documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/).
21
+ * The following commands allow you to:
16
22
  *
17
- * ## Example Usage
23
+ * - get information on the Cockpit associated with your Scaleway default Project
24
+ * - get information on the Cockpit associated with a specific Scaleway Project
18
25
  *
19
26
  * ```typescript
20
27
  * import * as pulumi from "@pulumi/pulumi";
21
28
  * import * as scaleway from "@pulumi/scaleway";
22
29
  *
23
- * // Get default project's cockpit
30
+ * // Get the default Project's Cockpit
24
31
  * const main = scaleway.getCockpit({});
25
32
  * ```
26
33
  *
@@ -28,7 +35,7 @@ const utilities = require("./utilities");
28
35
  * import * as pulumi from "@pulumi/pulumi";
29
36
  * import * as scaleway from "@pulumi/scaleway";
30
37
  *
31
- * // Get a specific project's cockpit
38
+ * // Get a specific Project's Cockpit
32
39
  * const main = scaleway.getCockpit({
33
40
  * projectId: "11111111-1111-1111-1111-111111111111",
34
41
  * });
@@ -43,21 +50,28 @@ function getCockpit(args, opts) {
43
50
  }
44
51
  exports.getCockpit = getCockpit;
45
52
  /**
53
+ * > **Important:** The data source `scaleway.Cockpit` has been deprecated and will no longer be supported. Instead, use resource `scaleway.Cockpit`.
54
+ *
46
55
  * > **Note:**
47
- * As of April 2024, Cockpit has introduced regionalization to offer more flexibility and resilience.
48
- * If you have customized dashboards in Grafana for monitoring Scaleway resources, please update your queries to accommodate the new regionalized data sources.
56
+ * As of April 2024, Cockpit has introduced [regionalization](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#region) to offer more flexibility and resilience.
57
+ * 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.
58
+ *
59
+ * The `scaleway.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.
60
+ *
61
+ * 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.
49
62
  *
50
- * Gets information about the Scaleway Cockpit.
63
+ * ## Retrieve a Cockpit
51
64
  *
52
- * For more information consult the [documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/).
65
+ * The following commands allow you to:
53
66
  *
54
- * ## Example Usage
67
+ * - get information on the Cockpit associated with your Scaleway default Project
68
+ * - get information on the Cockpit associated with a specific Scaleway Project
55
69
  *
56
70
  * ```typescript
57
71
  * import * as pulumi from "@pulumi/pulumi";
58
72
  * import * as scaleway from "@pulumi/scaleway";
59
73
  *
60
- * // Get default project's cockpit
74
+ * // Get the default Project's Cockpit
61
75
  * const main = scaleway.getCockpit({});
62
76
  * ```
63
77
  *
@@ -65,7 +79,7 @@ exports.getCockpit = getCockpit;
65
79
  * import * as pulumi from "@pulumi/pulumi";
66
80
  * import * as scaleway from "@pulumi/scaleway";
67
81
  *
68
- * // Get a specific project's cockpit
82
+ * // Get a specific Project's Cockpit
69
83
  * const main = scaleway.getCockpit({
70
84
  * projectId: "11111111-1111-1111-1111-111111111111",
71
85
  * });
package/getCockpit.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"getCockpit.js","sourceRoot":"","sources":["../getCockpit.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,SAAgB,UAAU,CAAC,IAAqB,EAAE,IAA2B;IACzE,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,sCAAsC,EAAE;QACjE,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,gCAMC;AA+BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,SAAgB,gBAAgB,CAAC,IAA2B,EAAE,IAA2B;IACrF,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,sCAAsC,EAAE;QACvE,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,4CAMC"}
1
+ {"version":3,"file":"getCockpit.js","sourceRoot":"","sources":["../getCockpit.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,SAAgB,UAAU,CAAC,IAAqB,EAAE,IAA2B;IACzE,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,sCAAsC,EAAE;QACjE,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,gCAMC;AAgCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,SAAgB,gBAAgB,CAAC,IAA2B,EAAE,IAA2B;IACrF,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,sCAAsC,EAAE;QACvE,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,4CAMC"}
@@ -1,8 +1,14 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
2
  /**
3
- * Gets information about a Scaleway Cockpit plan.
3
+ * The `scaleway.getCockpitPlan` data source is used to fetch details about a specific Scaleway Cockpit pricing plan. This information can then be used to configure resources like `scaleway.Cockpit`.
4
4
  *
5
- * ## Example Usage
5
+ * Find out more about [pricing plans](https://console.scaleway.com/cockpit/plans) in the Scaleway console.
6
+ *
7
+ * 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.
8
+ *
9
+ * ## Fetch and associate a pricing plan to a Cockpit
10
+ *
11
+ * 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.
6
12
  *
7
13
  * ```typescript
8
14
  * import * as pulumi from "@pulumi/pulumi";
@@ -21,7 +27,7 @@ export declare function getCockpitPlan(args: GetCockpitPlanArgs, opts?: pulumi.I
21
27
  */
22
28
  export interface GetCockpitPlanArgs {
23
29
  /**
24
- * The name of the plan.
30
+ * Name of the pricing plan you want to retrieve information about.
25
31
  */
26
32
  name: string;
27
33
  }
@@ -36,9 +42,15 @@ export interface GetCockpitPlanResult {
36
42
  readonly name: string;
37
43
  }
38
44
  /**
39
- * Gets information about a Scaleway Cockpit plan.
45
+ * The `scaleway.getCockpitPlan` data source is used to fetch details about a specific Scaleway Cockpit pricing plan. This information can then be used to configure resources like `scaleway.Cockpit`.
46
+ *
47
+ * Find out more about [pricing plans](https://console.scaleway.com/cockpit/plans) in the Scaleway console.
48
+ *
49
+ * 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.
50
+ *
51
+ * ## Fetch and associate a pricing plan to a Cockpit
40
52
  *
41
- * ## Example Usage
53
+ * 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.
42
54
  *
43
55
  * ```typescript
44
56
  * import * as pulumi from "@pulumi/pulumi";
@@ -57,7 +69,7 @@ export declare function getCockpitPlanOutput(args: GetCockpitPlanOutputArgs, opt
57
69
  */
58
70
  export interface GetCockpitPlanOutputArgs {
59
71
  /**
60
- * The name of the plan.
72
+ * Name of the pricing plan you want to retrieve information about.
61
73
  */
62
74
  name: pulumi.Input<string>;
63
75
  }
package/getCockpitPlan.js CHANGED
@@ -6,9 +6,15 @@ exports.getCockpitPlanOutput = exports.getCockpitPlan = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
- * Gets information about a Scaleway Cockpit plan.
9
+ * The `scaleway.getCockpitPlan` data source is used to fetch details about a specific Scaleway Cockpit pricing plan. This information can then be used to configure resources like `scaleway.Cockpit`.
10
10
  *
11
- * ## Example Usage
11
+ * Find out more about [pricing plans](https://console.scaleway.com/cockpit/plans) in the Scaleway console.
12
+ *
13
+ * 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.
14
+ *
15
+ * ## Fetch and associate a pricing plan to a Cockpit
16
+ *
17
+ * 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.
12
18
  *
13
19
  * ```typescript
14
20
  * import * as pulumi from "@pulumi/pulumi";
@@ -29,9 +35,15 @@ function getCockpitPlan(args, opts) {
29
35
  }
30
36
  exports.getCockpitPlan = getCockpitPlan;
31
37
  /**
32
- * Gets information about a Scaleway Cockpit plan.
38
+ * The `scaleway.getCockpitPlan` data source is used to fetch details about a specific Scaleway Cockpit pricing plan. This information can then be used to configure resources like `scaleway.Cockpit`.
39
+ *
40
+ * Find out more about [pricing plans](https://console.scaleway.com/cockpit/plans) in the Scaleway console.
41
+ *
42
+ * 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.
43
+ *
44
+ * ## Fetch and associate a pricing plan to a Cockpit
33
45
  *
34
- * ## Example Usage
46
+ * 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.
35
47
  *
36
48
  * ```typescript
37
49
  * import * as pulumi from "@pulumi/pulumi";
@@ -1 +1 @@
1
- {"version":3,"file":"getCockpitPlan.js","sourceRoot":"","sources":["../getCockpitPlan.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,cAAc,CAAC,IAAwB,EAAE,IAA2B;IAChF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,8CAA8C,EAAE;QACzE,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,wCAKC;AAsBD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,oBAAoB,CAAC,IAA8B,EAAE,IAA2B;IAC5F,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,8CAA8C,EAAE;QAC/E,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,oDAKC"}
1
+ {"version":3,"file":"getCockpitPlan.js","sourceRoot":"","sources":["../getCockpitPlan.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,cAAc,CAAC,IAAwB,EAAE,IAA2B;IAChF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,8CAA8C,EAAE;QACzE,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,wCAKC;AAsBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,oBAAoB,CAAC,IAA8B,EAAE,IAA2B;IAC5F,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,8CAA8C,EAAE;QAC/E,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,oDAKC"}
@@ -1,22 +1,29 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
2
  import * as outputs from "./types/output";
3
3
  /**
4
- * Gets information about a domain record.
4
+ * The `scaleway.DomainRecord` data source is used to get information about an existing domain record.
5
5
  *
6
- * ## Example Usage
6
+ * 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.
7
+ *
8
+ * ## Query domain records
9
+ *
10
+ * The following commands allow you to:
11
+ *
12
+ * - 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`).
13
+ * - query a domain record specified by the DNS zone (`domain.tld`) and the unique record ID (`11111111-1111-1111-1111-111111111111`).
7
14
  *
8
15
  * ```typescript
9
16
  * import * as pulumi from "@pulumi/pulumi";
10
17
  * import * as scaleway from "@pulumi/scaleway";
11
18
  *
12
- * // Get record by name, type and data
19
+ * // Query record by DNS zone, record name, type and content
13
20
  * const byContent = scaleway.getDomainRecord({
14
21
  * dnsZone: "domain.tld",
15
22
  * name: "www",
16
23
  * type: "A",
17
24
  * data: "1.2.3.4",
18
25
  * });
19
- * // Get info by ID
26
+ * // Query record by DNS zone and record ID
20
27
  * const byId = scaleway.getDomainRecord({
21
28
  * dnsZone: "domain.tld",
22
29
  * recordId: "11111111-1111-1111-1111-111111111111",
@@ -29,31 +36,27 @@ export declare function getDomainRecord(args?: GetDomainRecordArgs, opts?: pulum
29
36
  */
30
37
  export interface GetDomainRecordArgs {
31
38
  /**
32
- * The content of the record (an IPv4 for an `A`, a string for a `TXT`...).
33
- * Cannot be used with `recordId`.
39
+ * 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 `recordId`.
34
40
  */
35
41
  data?: string;
36
42
  /**
37
- * The IP address.
43
+ * 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.
38
44
  */
39
45
  dnsZone?: string;
40
46
  /**
41
- * The name of the record (can be an empty string for a root record).
42
- * Cannot be used with `recordId`.
47
+ * The name of the record, which can be an empty string for a root record. Cannot be used with `recordId`.
43
48
  */
44
49
  name?: string;
45
50
  /**
46
- * `projectId`) The ID of the project the domain is associated with.
51
+ * ). The ID of the Project associated with the domain.
47
52
  */
48
53
  projectId?: string;
49
54
  /**
50
- * The record ID.
51
- * Cannot be used with `name`, `type` and `data`.
55
+ * The unique identifier of the record. Cannot be used with `name`, `type`, and `data`.
52
56
  */
53
57
  recordId?: string;
54
58
  /**
55
- * The type of the record (`A`, `AAAA`, `MX`, `CNAME`, `DNAME`, `ALIAS`, `NS`, `PTR`, `SRV`, `TXT`, `TLSA`, or `CAA`).
56
- * Cannot be used with `recordId`.
59
+ * The type of the record (`A`, `AAAA`, `MX`, `CNAME`, etc.). Cannot be used with `recordId`.
57
60
  */
58
61
  type?: string;
59
62
  }
@@ -65,11 +68,11 @@ export interface GetDomainRecordResult {
65
68
  readonly dnsZone?: string;
66
69
  readonly fqdn: string;
67
70
  /**
68
- * Dynamic record base on user geolocalisation (More information about dynamic records)
71
+ * Information about dynamic records based on user geolocation. Find out more about dynamic records.
69
72
  */
70
73
  readonly geoIps: outputs.GetDomainRecordGeoIp[];
71
74
  /**
72
- * Dynamic record base on URL resolve (More information about dynamic records)
75
+ * Information about dynamic records based on URL resolution. Find out more about dynamic records.
73
76
  */
74
77
  readonly httpServices: outputs.GetDomainRecordHttpService[];
75
78
  /**
@@ -79,43 +82,50 @@ export interface GetDomainRecordResult {
79
82
  readonly keepEmptyZone: boolean;
80
83
  readonly name?: string;
81
84
  /**
82
- * The priority of the record (mostly used with an `MX` record)
85
+ * The priority of the record, mainly used with `MX` records.
83
86
  */
84
87
  readonly priority: number;
85
88
  readonly projectId?: string;
86
89
  readonly recordId?: string;
87
90
  readonly rootZone: boolean;
88
91
  /**
89
- * Time To Live of the record in seconds.
92
+ * The Time To Live (TTL) of the record in seconds.
90
93
  */
91
94
  readonly ttl: number;
92
95
  readonly type?: string;
93
96
  /**
94
- * Dynamic record based on the client’s (resolver) subnet (More information about dynamic records)
97
+ * Information about dynamic records based on the client’s (resolver) subnet. Find out more about dynamic records.
95
98
  */
96
99
  readonly views: outputs.GetDomainRecordView[];
97
100
  /**
98
- * Dynamic record base on IP weights (More information about dynamic records)
101
+ * Information about dynamic records based on IP weights. Find out more about dynamic records.
99
102
  */
100
103
  readonly weighteds: outputs.GetDomainRecordWeighted[];
101
104
  }
102
105
  /**
103
- * Gets information about a domain record.
106
+ * The `scaleway.DomainRecord` data source is used to get information about an existing domain record.
107
+ *
108
+ * 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.
109
+ *
110
+ * ## Query domain records
111
+ *
112
+ * The following commands allow you to:
104
113
  *
105
- * ## Example Usage
114
+ * - 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`).
115
+ * - query a domain record specified by the DNS zone (`domain.tld`) and the unique record ID (`11111111-1111-1111-1111-111111111111`).
106
116
  *
107
117
  * ```typescript
108
118
  * import * as pulumi from "@pulumi/pulumi";
109
119
  * import * as scaleway from "@pulumi/scaleway";
110
120
  *
111
- * // Get record by name, type and data
121
+ * // Query record by DNS zone, record name, type and content
112
122
  * const byContent = scaleway.getDomainRecord({
113
123
  * dnsZone: "domain.tld",
114
124
  * name: "www",
115
125
  * type: "A",
116
126
  * data: "1.2.3.4",
117
127
  * });
118
- * // Get info by ID
128
+ * // Query record by DNS zone and record ID
119
129
  * const byId = scaleway.getDomainRecord({
120
130
  * dnsZone: "domain.tld",
121
131
  * recordId: "11111111-1111-1111-1111-111111111111",
@@ -128,31 +138,27 @@ export declare function getDomainRecordOutput(args?: GetDomainRecordOutputArgs,
128
138
  */
129
139
  export interface GetDomainRecordOutputArgs {
130
140
  /**
131
- * The content of the record (an IPv4 for an `A`, a string for a `TXT`...).
132
- * Cannot be used with `recordId`.
141
+ * 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 `recordId`.
133
142
  */
134
143
  data?: pulumi.Input<string>;
135
144
  /**
136
- * The IP address.
145
+ * 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.
137
146
  */
138
147
  dnsZone?: pulumi.Input<string>;
139
148
  /**
140
- * The name of the record (can be an empty string for a root record).
141
- * Cannot be used with `recordId`.
149
+ * The name of the record, which can be an empty string for a root record. Cannot be used with `recordId`.
142
150
  */
143
151
  name?: pulumi.Input<string>;
144
152
  /**
145
- * `projectId`) The ID of the project the domain is associated with.
153
+ * ). The ID of the Project associated with the domain.
146
154
  */
147
155
  projectId?: pulumi.Input<string>;
148
156
  /**
149
- * The record ID.
150
- * Cannot be used with `name`, `type` and `data`.
157
+ * The unique identifier of the record. Cannot be used with `name`, `type`, and `data`.
151
158
  */
152
159
  recordId?: pulumi.Input<string>;
153
160
  /**
154
- * The type of the record (`A`, `AAAA`, `MX`, `CNAME`, `DNAME`, `ALIAS`, `NS`, `PTR`, `SRV`, `TXT`, `TLSA`, or `CAA`).
155
- * Cannot be used with `recordId`.
161
+ * The type of the record (`A`, `AAAA`, `MX`, `CNAME`, etc.). Cannot be used with `recordId`.
156
162
  */
157
163
  type?: pulumi.Input<string>;
158
164
  }
@@ -6,22 +6,29 @@ exports.getDomainRecordOutput = exports.getDomainRecord = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
- * Gets information about a domain record.
9
+ * The `scaleway.DomainRecord` data source is used to get information about an existing domain record.
10
10
  *
11
- * ## Example Usage
11
+ * 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.
12
+ *
13
+ * ## Query domain records
14
+ *
15
+ * The following commands allow you to:
16
+ *
17
+ * - 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`).
18
+ * - query a domain record specified by the DNS zone (`domain.tld`) and the unique record ID (`11111111-1111-1111-1111-111111111111`).
12
19
  *
13
20
  * ```typescript
14
21
  * import * as pulumi from "@pulumi/pulumi";
15
22
  * import * as scaleway from "@pulumi/scaleway";
16
23
  *
17
- * // Get record by name, type and data
24
+ * // Query record by DNS zone, record name, type and content
18
25
  * const byContent = scaleway.getDomainRecord({
19
26
  * dnsZone: "domain.tld",
20
27
  * name: "www",
21
28
  * type: "A",
22
29
  * data: "1.2.3.4",
23
30
  * });
24
- * // Get info by ID
31
+ * // Query record by DNS zone and record ID
25
32
  * const byId = scaleway.getDomainRecord({
26
33
  * dnsZone: "domain.tld",
27
34
  * recordId: "11111111-1111-1111-1111-111111111111",
@@ -42,22 +49,29 @@ function getDomainRecord(args, opts) {
42
49
  }
43
50
  exports.getDomainRecord = getDomainRecord;
44
51
  /**
45
- * Gets information about a domain record.
52
+ * The `scaleway.DomainRecord` data source is used to get information about an existing domain record.
53
+ *
54
+ * 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.
55
+ *
56
+ * ## Query domain records
57
+ *
58
+ * The following commands allow you to:
46
59
  *
47
- * ## Example Usage
60
+ * - 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`).
61
+ * - query a domain record specified by the DNS zone (`domain.tld`) and the unique record ID (`11111111-1111-1111-1111-111111111111`).
48
62
  *
49
63
  * ```typescript
50
64
  * import * as pulumi from "@pulumi/pulumi";
51
65
  * import * as scaleway from "@pulumi/scaleway";
52
66
  *
53
- * // Get record by name, type and data
67
+ * // Query record by DNS zone, record name, type and content
54
68
  * const byContent = scaleway.getDomainRecord({
55
69
  * dnsZone: "domain.tld",
56
70
  * name: "www",
57
71
  * type: "A",
58
72
  * data: "1.2.3.4",
59
73
  * });
60
- * // Get info by ID
74
+ * // Query record by DNS zone and record ID
61
75
  * const byId = scaleway.getDomainRecord({
62
76
  * dnsZone: "domain.tld",
63
77
  * recordId: "11111111-1111-1111-1111-111111111111",
@@ -1 +1 @@
1
- {"version":3,"file":"getDomainRecord.js","sourceRoot":"","sources":["../getDomainRecord.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,SAAgB,eAAe,CAAC,IAA0B,EAAE,IAA2B;IACnF,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gDAAgD,EAAE;QAC3E,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,UAAU,EAAE,IAAI,CAAC,QAAQ;QACzB,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAXD,0CAWC;AA8ED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,SAAgB,qBAAqB,CAAC,IAAgC,EAAE,IAA2B;IAC/F,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,gDAAgD,EAAE;QACjF,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,UAAU,EAAE,IAAI,CAAC,QAAQ;QACzB,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAXD,sDAWC"}
1
+ {"version":3,"file":"getDomainRecord.js","sourceRoot":"","sources":["../getDomainRecord.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,SAAgB,eAAe,CAAC,IAA0B,EAAE,IAA2B;IACnF,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gDAAgD,EAAE;QAC3E,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,UAAU,EAAE,IAAI,CAAC,QAAQ;QACzB,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAXD,0CAWC;AA0ED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,SAAgB,qBAAqB,CAAC,IAAgC,EAAE,IAA2B;IAC/F,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,gDAAgD,EAAE;QACjF,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,UAAU,EAAE,IAAI,CAAC,QAAQ;QACzB,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAXD,sDAWC"}
@@ -1,31 +1,15 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
- /**
3
- * Gets information about a domain zone.
4
- *
5
- * ## Example Usage
6
- *
7
- * ```typescript
8
- * import * as pulumi from "@pulumi/pulumi";
9
- * import * as scaleway from "@pulumi/scaleway";
10
- *
11
- * // Get zone
12
- * const main = scaleway.getDomainZone({
13
- * domain: "scaleway-terraform.com",
14
- * subdomain: "test",
15
- * });
16
- * ```
17
- */
18
2
  export declare function getDomainZone(args?: GetDomainZoneArgs, opts?: pulumi.InvokeOptions): Promise<GetDomainZoneResult>;
19
3
  /**
20
4
  * A collection of arguments for invoking getDomainZone.
21
5
  */
22
6
  export interface GetDomainZoneArgs {
23
7
  /**
24
- * The domain where the DNS zone will be created.
8
+ * The primary domain name where the DNS zone is located. This is a mandatory field.
25
9
  */
26
10
  domain?: string;
27
11
  /**
28
- * The subdomain(zone name) to create in the domain.
12
+ * The subdomain (or zone name) within the primary domain. This is a mandatory field.
29
13
  */
30
14
  subdomain?: string;
31
15
  }
@@ -39,59 +23,43 @@ export interface GetDomainZoneResult {
39
23
  */
40
24
  readonly id: string;
41
25
  /**
42
- * Message
26
+ * Message associated with the domain zone (typically used for status or error messages).
43
27
  */
44
28
  readonly message: string;
45
29
  /**
46
- * NameServer list for zone.
30
+ * The list of name servers for the zone.
47
31
  */
48
32
  readonly ns: string[];
49
33
  /**
50
- * NameServer default list for zone.
34
+ * The default list of name servers for the zone.
51
35
  */
52
36
  readonly nsDefaults: string[];
53
37
  /**
54
- * NameServer master list for zone.
38
+ * The master list of name servers for the zone.
55
39
  */
56
40
  readonly nsMasters: string[];
57
41
  readonly projectId: string;
58
42
  /**
59
- * The domain zone status.
43
+ * The status of the domain zone.
60
44
  */
61
45
  readonly status: string;
62
46
  readonly subdomain?: string;
63
47
  /**
64
- * The date and time of the last update of the DNS zone.
48
+ * The date and time of the last update to the DNS zone.
65
49
  */
66
50
  readonly updatedAt: string;
67
51
  }
68
- /**
69
- * Gets information about a domain zone.
70
- *
71
- * ## Example Usage
72
- *
73
- * ```typescript
74
- * import * as pulumi from "@pulumi/pulumi";
75
- * import * as scaleway from "@pulumi/scaleway";
76
- *
77
- * // Get zone
78
- * const main = scaleway.getDomainZone({
79
- * domain: "scaleway-terraform.com",
80
- * subdomain: "test",
81
- * });
82
- * ```
83
- */
84
52
  export declare function getDomainZoneOutput(args?: GetDomainZoneOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetDomainZoneResult>;
85
53
  /**
86
54
  * A collection of arguments for invoking getDomainZone.
87
55
  */
88
56
  export interface GetDomainZoneOutputArgs {
89
57
  /**
90
- * The domain where the DNS zone will be created.
58
+ * The primary domain name where the DNS zone is located. This is a mandatory field.
91
59
  */
92
60
  domain?: pulumi.Input<string>;
93
61
  /**
94
- * The subdomain(zone name) to create in the domain.
62
+ * The subdomain (or zone name) within the primary domain. This is a mandatory field.
95
63
  */
96
64
  subdomain?: pulumi.Input<string>;
97
65
  }
package/getDomainZone.js CHANGED
@@ -5,22 +5,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
5
5
  exports.getDomainZoneOutput = exports.getDomainZone = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
- /**
9
- * Gets information about a domain zone.
10
- *
11
- * ## Example Usage
12
- *
13
- * ```typescript
14
- * import * as pulumi from "@pulumi/pulumi";
15
- * import * as scaleway from "@pulumi/scaleway";
16
- *
17
- * // Get zone
18
- * const main = scaleway.getDomainZone({
19
- * domain: "scaleway-terraform.com",
20
- * subdomain: "test",
21
- * });
22
- * ```
23
- */
24
8
  function getDomainZone(args, opts) {
25
9
  args = args || {};
26
10
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -30,22 +14,6 @@ function getDomainZone(args, opts) {
30
14
  }, opts);
31
15
  }
32
16
  exports.getDomainZone = getDomainZone;
33
- /**
34
- * Gets information about a domain zone.
35
- *
36
- * ## Example Usage
37
- *
38
- * ```typescript
39
- * import * as pulumi from "@pulumi/pulumi";
40
- * import * as scaleway from "@pulumi/scaleway";
41
- *
42
- * // Get zone
43
- * const main = scaleway.getDomainZone({
44
- * domain: "scaleway-terraform.com",
45
- * subdomain: "test",
46
- * });
47
- * ```
48
- */
49
17
  function getDomainZoneOutput(args, opts) {
50
18
  args = args || {};
51
19
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -1 +1 @@
1
- {"version":3,"file":"getDomainZone.js","sourceRoot":"","sources":["../getDomainZone.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,aAAa,CAAC,IAAwB,EAAE,IAA2B;IAC/E,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,4CAA4C,EAAE;QACvE,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,sCAOC;AAoDD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,mBAAmB,CAAC,IAA8B,EAAE,IAA2B;IAC3F,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,4CAA4C,EAAE;QAC7E,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,kDAOC"}
1
+ {"version":3,"file":"getDomainZone.js","sourceRoot":"","sources":["../getDomainZone.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,aAAa,CAAC,IAAwB,EAAE,IAA2B;IAC/E,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,4CAA4C,EAAE;QACvE,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,sCAOC;AAoDD,SAAgB,mBAAmB,CAAC,IAA8B,EAAE,IAA2B;IAC3F,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,4CAA4C,EAAE;QAC7E,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,kDAOC"}