@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
@@ -1,10 +1,15 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
2
  /**
3
- * Creates and manages Scaleway Block Snapshots.
4
- * For more information, see [the documentation](https://www.scaleway.com/en/developers/api/block/).
3
+ * The `scaleway.BlockSnapshot` resource is used to create and manage snapshots of Block Storage volumes.
4
+ *
5
+ * 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.
5
6
  *
6
7
  * ## Example Usage
7
8
  *
9
+ * ### Create a snapshot of a Block Storage volume
10
+ *
11
+ * The following command allows you to create a snapshot (`some-snapshot-name`) from a Block Storage volume specified by its ID.
12
+ *
8
13
  * ```typescript
9
14
  * import * as pulumi from "@pulumi/pulumi";
10
15
  * import * as scaleway from "@pulumiverse/scaleway";
@@ -22,7 +27,7 @@ import * as pulumi from "@pulumi/pulumi";
22
27
  *
23
28
  * ## Import
24
29
  *
25
- * Block Snapshots can be imported using the `{zone}/{id}`, e.g.
30
+ * This section explains how to import the snapshot of a Block Storage volume using the zoned ID format (`{zone}/{id}`).
26
31
  *
27
32
  * bash
28
33
  *
@@ -47,11 +52,11 @@ export declare class BlockSnapshot extends pulumi.CustomResource {
47
52
  */
48
53
  static isInstance(obj: any): obj is BlockSnapshot;
49
54
  /**
50
- * The name of the snapshot. If not provided it will be randomly generated.
55
+ * The name of the snapshot. If not provided, a name will be randomly generated.
51
56
  */
52
57
  readonly name: pulumi.Output<string>;
53
58
  /**
54
- * `projectId`) The ID of the project the snapshot is associated with.
59
+ * ). The ID of the Scaleway Project the snapshot is associated with.
55
60
  */
56
61
  readonly projectId: pulumi.Output<string>;
57
62
  /**
@@ -63,7 +68,7 @@ export declare class BlockSnapshot extends pulumi.CustomResource {
63
68
  */
64
69
  readonly volumeId: pulumi.Output<string>;
65
70
  /**
66
- * `zone`) The zone in which the snapshot should be created.
71
+ * ). The zone in which the snapshot should be created.
67
72
  */
68
73
  readonly zone: pulumi.Output<string>;
69
74
  /**
@@ -80,11 +85,11 @@ export declare class BlockSnapshot extends pulumi.CustomResource {
80
85
  */
81
86
  export interface BlockSnapshotState {
82
87
  /**
83
- * The name of the snapshot. If not provided it will be randomly generated.
88
+ * The name of the snapshot. If not provided, a name will be randomly generated.
84
89
  */
85
90
  name?: pulumi.Input<string>;
86
91
  /**
87
- * `projectId`) The ID of the project the snapshot is associated with.
92
+ * ). The ID of the Scaleway Project the snapshot is associated with.
88
93
  */
89
94
  projectId?: pulumi.Input<string>;
90
95
  /**
@@ -96,7 +101,7 @@ export interface BlockSnapshotState {
96
101
  */
97
102
  volumeId?: pulumi.Input<string>;
98
103
  /**
99
- * `zone`) The zone in which the snapshot should be created.
104
+ * ). The zone in which the snapshot should be created.
100
105
  */
101
106
  zone?: pulumi.Input<string>;
102
107
  }
@@ -105,11 +110,11 @@ export interface BlockSnapshotState {
105
110
  */
106
111
  export interface BlockSnapshotArgs {
107
112
  /**
108
- * The name of the snapshot. If not provided it will be randomly generated.
113
+ * The name of the snapshot. If not provided, a name will be randomly generated.
109
114
  */
110
115
  name?: pulumi.Input<string>;
111
116
  /**
112
- * `projectId`) The ID of the project the snapshot is associated with.
117
+ * ). The ID of the Scaleway Project the snapshot is associated with.
113
118
  */
114
119
  projectId?: pulumi.Input<string>;
115
120
  /**
@@ -121,7 +126,7 @@ export interface BlockSnapshotArgs {
121
126
  */
122
127
  volumeId: pulumi.Input<string>;
123
128
  /**
124
- * `zone`) The zone in which the snapshot should be created.
129
+ * ). The zone in which the snapshot should be created.
125
130
  */
126
131
  zone?: pulumi.Input<string>;
127
132
  }
package/blockSnapshot.js CHANGED
@@ -6,11 +6,16 @@ exports.BlockSnapshot = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
- * Creates and manages Scaleway Block Snapshots.
10
- * For more information, see [the documentation](https://www.scaleway.com/en/developers/api/block/).
9
+ * The `scaleway.BlockSnapshot` resource is used to create and manage snapshots of Block Storage volumes.
10
+ *
11
+ * 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.
11
12
  *
12
13
  * ## Example Usage
13
14
  *
15
+ * ### Create a snapshot of a Block Storage volume
16
+ *
17
+ * The following command allows you to create a snapshot (`some-snapshot-name`) from a Block Storage volume specified by its ID.
18
+ *
14
19
  * ```typescript
15
20
  * import * as pulumi from "@pulumi/pulumi";
16
21
  * import * as scaleway from "@pulumiverse/scaleway";
@@ -28,7 +33,7 @@ const utilities = require("./utilities");
28
33
  *
29
34
  * ## Import
30
35
  *
31
- * Block Snapshots can be imported using the `{zone}/{id}`, e.g.
36
+ * This section explains how to import the snapshot of a Block Storage volume using the zoned ID format (`{zone}/{id}`).
32
37
  *
33
38
  * bash
34
39
  *
@@ -1 +1 @@
1
- {"version":3,"file":"blockSnapshot.js","sourceRoot":"","sources":["../blockSnapshot.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAa,aAAc,SAAQ,MAAM,CAAC,cAAc;IACpD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA0B,EAAE,IAAmC;QACxH,OAAO,IAAI,aAAa,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACpE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,aAAa,CAAC,YAAY,CAAC;IAC9D,CAAC;IA+BD,YAAY,IAAY,EAAE,WAAoD,EAAE,IAAmC;QAC/G,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA6C,CAAC;YAC5D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3D;aAAM;YACH,MAAM,IAAI,GAAG,WAA4C,CAAC;YAC1D,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACrD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aAC3D;YACD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;SACzD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,aAAa,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAClE,CAAC;;AAhFL,sCAiFC;AAnEG,gBAAgB;AACO,0BAAY,GAAG,4CAA4C,CAAC"}
1
+ {"version":3,"file":"blockSnapshot.js","sourceRoot":"","sources":["../blockSnapshot.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAa,aAAc,SAAQ,MAAM,CAAC,cAAc;IACpD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA0B,EAAE,IAAmC;QACxH,OAAO,IAAI,aAAa,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACpE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,aAAa,CAAC,YAAY,CAAC;IAC9D,CAAC;IA+BD,YAAY,IAAY,EAAE,WAAoD,EAAE,IAAmC;QAC/G,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA6C,CAAC;YAC5D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3D;aAAM;YACH,MAAM,IAAI,GAAG,WAA4C,CAAC;YAC1D,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACrD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aAC3D;YACD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;SACzD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,aAAa,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAClE,CAAC;;AAhFL,sCAiFC;AAnEG,gBAAgB;AACO,0BAAY,GAAG,4CAA4C,CAAC"}
package/blockVolume.d.ts CHANGED
@@ -1,11 +1,14 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
2
  /**
3
- * Creates and manages Scaleway Block Volumes.
4
- * For more information, see [the documentation](https://www.scaleway.com/en/developers/api/block/).
3
+ * The `scaleway.BlockVolume` resource is used to create and manage Scaleway Block Storage volumes.
4
+ *
5
+ * 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.
5
6
  *
6
7
  * ## Example Usage
7
8
  *
8
- * ### Basic
9
+ * ### Create a Block Storage volume
10
+ *
11
+ * The following command allows you to create a Block Storage volume of 20 GB with a 5000 [IOPS](https://www.scaleway.com/en/docs/storage/block/concepts/#iops).
9
12
  *
10
13
  * ```typescript
11
14
  * import * as pulumi from "@pulumi/pulumi";
@@ -42,7 +45,7 @@ import * as pulumi from "@pulumi/pulumi";
42
45
  *
43
46
  * ## Import
44
47
  *
45
- * Block Volumes can be imported using the `{zone}/{id}`, e.g.
48
+ * This section explains how to import a Block Storage volume using the zoned ID (`{zone}/{id}`) format.
46
49
  *
47
50
  * bash
48
51
  *
@@ -67,19 +70,19 @@ export declare class BlockVolume extends pulumi.CustomResource {
67
70
  */
68
71
  static isInstance(obj: any): obj is BlockVolume;
69
72
  /**
70
- * The maximum IO/s expected, must match available options.
73
+ * The maximum [IOPs](https://www.scaleway.com/en/docs/storage/block/concepts/#iops) expected, must match available options.
71
74
  */
72
75
  readonly iops: pulumi.Output<number>;
73
76
  /**
74
- * The name of the volume. If not provided it will be randomly generated.
77
+ * The name of the volume. If not provided, a name will be randomly generated.
75
78
  */
76
79
  readonly name: pulumi.Output<string>;
77
80
  /**
78
- * `projectId`) The ID of the project the volume is associated with.
81
+ * ). The ID of the Project the volume is associated with.
79
82
  */
80
83
  readonly projectId: pulumi.Output<string>;
81
84
  /**
82
- * The size of the volume. Only one of `sizeInGb`, and `snapshotId` should be specified.
85
+ * The size of the volume in gigabytes. Only one of `sizeInGb`, and `snapshotId` should be specified.
83
86
  */
84
87
  readonly sizeInGb: pulumi.Output<number>;
85
88
  /**
@@ -91,7 +94,7 @@ export declare class BlockVolume extends pulumi.CustomResource {
91
94
  */
92
95
  readonly tags: pulumi.Output<string[] | undefined>;
93
96
  /**
94
- * `zone`) The zone in which the volume should be created.
97
+ * ). The zone in which the volume should be created.
95
98
  */
96
99
  readonly zone: pulumi.Output<string>;
97
100
  /**
@@ -108,19 +111,19 @@ export declare class BlockVolume extends pulumi.CustomResource {
108
111
  */
109
112
  export interface BlockVolumeState {
110
113
  /**
111
- * The maximum IO/s expected, must match available options.
114
+ * The maximum [IOPs](https://www.scaleway.com/en/docs/storage/block/concepts/#iops) expected, must match available options.
112
115
  */
113
116
  iops?: pulumi.Input<number>;
114
117
  /**
115
- * The name of the volume. If not provided it will be randomly generated.
118
+ * The name of the volume. If not provided, a name will be randomly generated.
116
119
  */
117
120
  name?: pulumi.Input<string>;
118
121
  /**
119
- * `projectId`) The ID of the project the volume is associated with.
122
+ * ). The ID of the Project the volume is associated with.
120
123
  */
121
124
  projectId?: pulumi.Input<string>;
122
125
  /**
123
- * The size of the volume. Only one of `sizeInGb`, and `snapshotId` should be specified.
126
+ * The size of the volume in gigabytes. Only one of `sizeInGb`, and `snapshotId` should be specified.
124
127
  */
125
128
  sizeInGb?: pulumi.Input<number>;
126
129
  /**
@@ -132,7 +135,7 @@ export interface BlockVolumeState {
132
135
  */
133
136
  tags?: pulumi.Input<pulumi.Input<string>[]>;
134
137
  /**
135
- * `zone`) The zone in which the volume should be created.
138
+ * ). The zone in which the volume should be created.
136
139
  */
137
140
  zone?: pulumi.Input<string>;
138
141
  }
@@ -141,19 +144,19 @@ export interface BlockVolumeState {
141
144
  */
142
145
  export interface BlockVolumeArgs {
143
146
  /**
144
- * The maximum IO/s expected, must match available options.
147
+ * The maximum [IOPs](https://www.scaleway.com/en/docs/storage/block/concepts/#iops) expected, must match available options.
145
148
  */
146
149
  iops: pulumi.Input<number>;
147
150
  /**
148
- * The name of the volume. If not provided it will be randomly generated.
151
+ * The name of the volume. If not provided, a name will be randomly generated.
149
152
  */
150
153
  name?: pulumi.Input<string>;
151
154
  /**
152
- * `projectId`) The ID of the project the volume is associated with.
155
+ * ). The ID of the Project the volume is associated with.
153
156
  */
154
157
  projectId?: pulumi.Input<string>;
155
158
  /**
156
- * The size of the volume. Only one of `sizeInGb`, and `snapshotId` should be specified.
159
+ * The size of the volume in gigabytes. Only one of `sizeInGb`, and `snapshotId` should be specified.
157
160
  */
158
161
  sizeInGb?: pulumi.Input<number>;
159
162
  /**
@@ -165,7 +168,7 @@ export interface BlockVolumeArgs {
165
168
  */
166
169
  tags?: pulumi.Input<pulumi.Input<string>[]>;
167
170
  /**
168
- * `zone`) The zone in which the volume should be created.
171
+ * ). The zone in which the volume should be created.
169
172
  */
170
173
  zone?: pulumi.Input<string>;
171
174
  }
package/blockVolume.js CHANGED
@@ -6,12 +6,15 @@ exports.BlockVolume = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
- * Creates and manages Scaleway Block Volumes.
10
- * For more information, see [the documentation](https://www.scaleway.com/en/developers/api/block/).
9
+ * The `scaleway.BlockVolume` resource is used to create and manage Scaleway Block Storage volumes.
10
+ *
11
+ * 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.
11
12
  *
12
13
  * ## Example Usage
13
14
  *
14
- * ### Basic
15
+ * ### Create a Block Storage volume
16
+ *
17
+ * The following command allows you to create a Block Storage volume of 20 GB with a 5000 [IOPS](https://www.scaleway.com/en/docs/storage/block/concepts/#iops).
15
18
  *
16
19
  * ```typescript
17
20
  * import * as pulumi from "@pulumi/pulumi";
@@ -48,7 +51,7 @@ const utilities = require("./utilities");
48
51
  *
49
52
  * ## Import
50
53
  *
51
- * Block Volumes can be imported using the `{zone}/{id}`, e.g.
54
+ * This section explains how to import a Block Storage volume using the zoned ID (`{zone}/{id}`) format.
52
55
  *
53
56
  * bash
54
57
  *
@@ -1 +1 @@
1
- {"version":3,"file":"blockVolume.js","sourceRoot":"","sources":["../blockVolume.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAa,WAAY,SAAQ,MAAM,CAAC,cAAc;IAClD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAwB,EAAE,IAAmC;QACtH,OAAO,IAAI,WAAW,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAClE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,WAAW,CAAC,YAAY,CAAC;IAC5D,CAAC;IAuCD,YAAY,IAAY,EAAE,WAAgD,EAAE,IAAmC;QAC3G,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA2C,CAAC;YAC1D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3D;aAAM;YACH,MAAM,IAAI,GAAG,WAA0C,CAAC;YACxD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACjD,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;aACvD;YACD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;SACzD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,WAAW,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAChE,CAAC;;AA5FL,kCA6FC;AA/EG,gBAAgB;AACO,wBAAY,GAAG,wCAAwC,CAAC"}
1
+ {"version":3,"file":"blockVolume.js","sourceRoot":"","sources":["../blockVolume.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,MAAa,WAAY,SAAQ,MAAM,CAAC,cAAc;IAClD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAwB,EAAE,IAAmC;QACtH,OAAO,IAAI,WAAW,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAClE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,WAAW,CAAC,YAAY,CAAC;IAC5D,CAAC;IAuCD,YAAY,IAAY,EAAE,WAAgD,EAAE,IAAmC;QAC3G,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA2C,CAAC;YAC1D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3D;aAAM;YACH,MAAM,IAAI,GAAG,WAA0C,CAAC;YACxD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACjD,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;aACvD;YACD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;SACzD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,WAAW,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAChE,CAAC;;AA5FL,kCA6FC;AA/EG,gBAAgB;AACO,wBAAY,GAAG,wCAAwC,CAAC"}
package/cockpit.d.ts CHANGED
@@ -4,7 +4,7 @@ import * as outputs from "./types/output";
4
4
  /**
5
5
  * ## Import
6
6
  *
7
- * Cockpits can be imported using the `{project_id}`, e.g.
7
+ * This section explains how to import a Cockpit using its `{project_id}`.
8
8
  *
9
9
  * bash
10
10
  *
@@ -29,23 +29,29 @@ export declare class Cockpit extends pulumi.CustomResource {
29
29
  */
30
30
  static isInstance(obj: any): obj is Cockpit;
31
31
  /**
32
- * Endpoints.
32
+ * (Deprecated) A list of [endpoints](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#endpoints) related to Cockpit, each with specific URLs:
33
+ *
34
+ * @deprecated Please use `scaleway.CockpitSource` instead
33
35
  */
34
36
  readonly endpoints: pulumi.Output<outputs.CockpitEndpoint[]>;
35
37
  /**
36
- * Name or ID of the plan to use.
38
+ * Name of the plan to use. Available plans are: free, premium, and custom.
37
39
  */
38
40
  readonly plan: pulumi.Output<string | undefined>;
39
41
  /**
40
- * The ID of the current plan.
42
+ * (Deprecated) The ID of the current pricing plan.
43
+ *
44
+ * @deprecated Please use Name only
41
45
  */
42
46
  readonly planId: pulumi.Output<string>;
43
47
  /**
44
- * `projectId`) The ID of the project the cockpit is associated with.
48
+ * ) The ID of the Project the Cockpit is associated with.
45
49
  */
46
50
  readonly projectId: pulumi.Output<string>;
47
51
  /**
48
52
  * Push_url
53
+ *
54
+ * @deprecated Please use `scaleway.CockpitSource` instead
49
55
  */
50
56
  readonly pushUrls: pulumi.Output<outputs.CockpitPushUrl[]>;
51
57
  /**
@@ -62,23 +68,29 @@ export declare class Cockpit extends pulumi.CustomResource {
62
68
  */
63
69
  export interface CockpitState {
64
70
  /**
65
- * Endpoints.
71
+ * (Deprecated) A list of [endpoints](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#endpoints) related to Cockpit, each with specific URLs:
72
+ *
73
+ * @deprecated Please use `scaleway.CockpitSource` instead
66
74
  */
67
75
  endpoints?: pulumi.Input<pulumi.Input<inputs.CockpitEndpoint>[]>;
68
76
  /**
69
- * Name or ID of the plan to use.
77
+ * Name of the plan to use. Available plans are: free, premium, and custom.
70
78
  */
71
79
  plan?: pulumi.Input<string>;
72
80
  /**
73
- * The ID of the current plan.
81
+ * (Deprecated) The ID of the current pricing plan.
82
+ *
83
+ * @deprecated Please use Name only
74
84
  */
75
85
  planId?: pulumi.Input<string>;
76
86
  /**
77
- * `projectId`) The ID of the project the cockpit is associated with.
87
+ * ) The ID of the Project the Cockpit is associated with.
78
88
  */
79
89
  projectId?: pulumi.Input<string>;
80
90
  /**
81
91
  * Push_url
92
+ *
93
+ * @deprecated Please use `scaleway.CockpitSource` instead
82
94
  */
83
95
  pushUrls?: pulumi.Input<pulumi.Input<inputs.CockpitPushUrl>[]>;
84
96
  }
@@ -87,11 +99,11 @@ export interface CockpitState {
87
99
  */
88
100
  export interface CockpitArgs {
89
101
  /**
90
- * Name or ID of the plan to use.
102
+ * Name of the plan to use. Available plans are: free, premium, and custom.
91
103
  */
92
104
  plan?: pulumi.Input<string>;
93
105
  /**
94
- * `projectId`) The ID of the project the cockpit is associated with.
106
+ * ) The ID of the Project the Cockpit is associated with.
95
107
  */
96
108
  projectId?: pulumi.Input<string>;
97
109
  }
package/cockpit.js CHANGED
@@ -8,7 +8,7 @@ const utilities = require("./utilities");
8
8
  /**
9
9
  * ## Import
10
10
  *
11
- * Cockpits can be imported using the `{project_id}`, e.g.
11
+ * This section explains how to import a Cockpit using its `{project_id}`.
12
12
  *
13
13
  * bash
14
14
  *
package/cockpit.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"cockpit.js","sourceRoot":"","sources":["../cockpit.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;GAUG;AACH,MAAa,OAAQ,SAAQ,MAAM,CAAC,cAAc;IAC9C;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAoB,EAAE,IAAmC;QAClH,OAAO,IAAI,OAAO,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC9D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC;IACxD,CAAC;IA+BD,YAAY,IAAY,EAAE,WAAwC,EAAE,IAAmC;QACnG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAuC,CAAC;YACtD,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;SACnE;aAAM;YACH,MAAM,IAAI,GAAG,WAAsC,CAAC;YACpD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAChD,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7C,cAAc,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAClD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC5D,CAAC;;AA7EL,0BA8EC;AAhEG,gBAAgB;AACO,oBAAY,GAAG,gCAAgC,CAAC"}
1
+ {"version":3,"file":"cockpit.js","sourceRoot":"","sources":["../cockpit.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;GAUG;AACH,MAAa,OAAQ,SAAQ,MAAM,CAAC,cAAc;IAC9C;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAoB,EAAE,IAAmC;QAClH,OAAO,IAAI,OAAO,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC9D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC;IACxD,CAAC;IAqCD,YAAY,IAAY,EAAE,WAAwC,EAAE,IAAmC;QACnG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAuC,CAAC;YACtD,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;SACnE;aAAM;YACH,MAAM,IAAI,GAAG,WAAsC,CAAC;YACpD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAChD,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7C,cAAc,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAClD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC5D,CAAC;;AAnFL,0BAoFC;AAtEG,gBAAgB;AACO,oBAAY,GAAG,gCAAgC,CAAC"}
@@ -2,13 +2,15 @@ import * as pulumi from "@pulumi/pulumi";
2
2
  import * as inputs from "./types/input";
3
3
  import * as outputs from "./types/output";
4
4
  /**
5
- * Creates and manages Scaleway Cockpit Alert Managers.
5
+ * The `scaleway.CockpitAlertManager` resource allows you to enable and manage the Scaleway Cockpit [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager).
6
6
  *
7
- * For more information consult the [documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#grafana-users).
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
+ * ## Example Usage
8
10
  *
9
11
  * ## Import
10
12
  *
11
- * Alert managers can be imported using the project ID, e.g.
13
+ * This section explains how to import alert managers using the ID of the Project associated with Cockpit.
12
14
  *
13
15
  * bash
14
16
  *
@@ -33,23 +35,23 @@ export declare class CockpitAlertManager extends pulumi.CustomResource {
33
35
  */
34
36
  static isInstance(obj: any): obj is CockpitAlertManager;
35
37
  /**
36
- * Alert manager URL.
38
+ * The URL of the alert manager.
37
39
  */
38
40
  readonly alertManagerUrl: pulumi.Output<string>;
39
41
  /**
40
- * A list of contact points with email addresses for the alert receivers. Each map should contain a single key email.
42
+ * A list of contact points with email addresses that will receive alerts. Each map should contain a single key email.
41
43
  */
42
44
  readonly contactPoints: pulumi.Output<outputs.CockpitAlertManagerContactPoint[] | undefined>;
43
45
  /**
44
- * Indicates whether the alert manager should be enabled. Defaults to true.
46
+ * Specifies whether the alert manager should be enabled. Defaults to true.
45
47
  */
46
48
  readonly enableManagedAlerts: pulumi.Output<boolean | undefined>;
47
49
  /**
48
- * `projectId`) The ID of the project the cockpit is associated with.
50
+ * ) The ID of the Project the Cockpit is associated with.
49
51
  */
50
52
  readonly projectId: pulumi.Output<string>;
51
53
  /**
52
- * `region`) The region in which alertManager should be created.
54
+ * ) The region where the [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager) should be enabled.
53
55
  */
54
56
  readonly region: pulumi.Output<string>;
55
57
  /**
@@ -66,23 +68,23 @@ export declare class CockpitAlertManager extends pulumi.CustomResource {
66
68
  */
67
69
  export interface CockpitAlertManagerState {
68
70
  /**
69
- * Alert manager URL.
71
+ * The URL of the alert manager.
70
72
  */
71
73
  alertManagerUrl?: pulumi.Input<string>;
72
74
  /**
73
- * A list of contact points with email addresses for the alert receivers. Each map should contain a single key email.
75
+ * A list of contact points with email addresses that will receive alerts. Each map should contain a single key email.
74
76
  */
75
77
  contactPoints?: pulumi.Input<pulumi.Input<inputs.CockpitAlertManagerContactPoint>[]>;
76
78
  /**
77
- * Indicates whether the alert manager should be enabled. Defaults to true.
79
+ * Specifies whether the alert manager should be enabled. Defaults to true.
78
80
  */
79
81
  enableManagedAlerts?: pulumi.Input<boolean>;
80
82
  /**
81
- * `projectId`) The ID of the project the cockpit is associated with.
83
+ * ) The ID of the Project the Cockpit is associated with.
82
84
  */
83
85
  projectId?: pulumi.Input<string>;
84
86
  /**
85
- * `region`) The region in which alertManager should be created.
87
+ * ) The region where the [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager) should be enabled.
86
88
  */
87
89
  region?: pulumi.Input<string>;
88
90
  }
@@ -91,19 +93,19 @@ export interface CockpitAlertManagerState {
91
93
  */
92
94
  export interface CockpitAlertManagerArgs {
93
95
  /**
94
- * A list of contact points with email addresses for the alert receivers. Each map should contain a single key email.
96
+ * A list of contact points with email addresses that will receive alerts. Each map should contain a single key email.
95
97
  */
96
98
  contactPoints?: pulumi.Input<pulumi.Input<inputs.CockpitAlertManagerContactPoint>[]>;
97
99
  /**
98
- * Indicates whether the alert manager should be enabled. Defaults to true.
100
+ * Specifies whether the alert manager should be enabled. Defaults to true.
99
101
  */
100
102
  enableManagedAlerts?: pulumi.Input<boolean>;
101
103
  /**
102
- * `projectId`) The ID of the project the cockpit is associated with.
104
+ * ) The ID of the Project the Cockpit is associated with.
103
105
  */
104
106
  projectId?: pulumi.Input<string>;
105
107
  /**
106
- * `region`) The region in which alertManager should be created.
108
+ * ) The region where the [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager) should be enabled.
107
109
  */
108
110
  region?: pulumi.Input<string>;
109
111
  }
@@ -6,13 +6,15 @@ exports.CockpitAlertManager = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
- * Creates and manages Scaleway Cockpit Alert Managers.
9
+ * The `scaleway.CockpitAlertManager` resource allows you to enable and manage the Scaleway Cockpit [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager).
10
10
  *
11
- * For more information consult the [documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#grafana-users).
11
+ * 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
+ *
13
+ * ## Example Usage
12
14
  *
13
15
  * ## Import
14
16
  *
15
- * Alert managers can be imported using the project ID, e.g.
17
+ * This section explains how to import alert managers using the ID of the Project associated with Cockpit.
16
18
  *
17
19
  * bash
18
20
  *
@@ -1 +1 @@
1
- {"version":3,"file":"cockpitAlertManager.js","sourceRoot":"","sources":["../cockpitAlertManager.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;GAcG;AACH,MAAa,mBAAoB,SAAQ,MAAM,CAAC,cAAc;IAC1D;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAgC,EAAE,IAAmC;QAC9H,OAAO,IAAI,mBAAmB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC1E,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,mBAAmB,CAAC,YAAY,CAAC;IACpE,CAAC;IA+BD,YAAY,IAAY,EAAE,WAAgE,EAAE,IAAmC;QAC3H,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAmD,CAAC;YAClE,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,qBAAqB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/D;aAAM;YACH,MAAM,IAAI,GAAG,WAAkD,CAAC;YAChE,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACzD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,mBAAmB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACxE,CAAC;;AA7EL,kDA8EC;AAhEG,gBAAgB;AACO,gCAAY,GAAG,wDAAwD,CAAC"}
1
+ {"version":3,"file":"cockpitAlertManager.js","sourceRoot":"","sources":["../cockpitAlertManager.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,mBAAoB,SAAQ,MAAM,CAAC,cAAc;IAC1D;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAgC,EAAE,IAAmC;QAC9H,OAAO,IAAI,mBAAmB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC1E,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,mBAAmB,CAAC,YAAY,CAAC;IACpE,CAAC;IA+BD,YAAY,IAAY,EAAE,WAAgE,EAAE,IAAmC;QAC3H,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAmD,CAAC;YAClE,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,qBAAqB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/D;aAAM;YACH,MAAM,IAAI,GAAG,WAAkD,CAAC;YAChE,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACzD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,mBAAmB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACxE,CAAC;;AA7EL,kDA8EC;AAhEG,gBAAgB;AACO,gCAAY,GAAG,wDAAwD,CAAC"}
@@ -1,11 +1,15 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
2
  /**
3
- * Creates and manages Scaleway Cockpit Grafana Users.
3
+ * The `scaleway.CockpitGrafanaUser` resource allows you to create and manage [Grafana users](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#grafana-users) in Scaleway Cockpit.
4
4
  *
5
- * For more information consult the [documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#grafana-users).
5
+ * 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.
6
6
  *
7
7
  * ## Example Usage
8
8
  *
9
+ * ### Create a Grafana user
10
+ *
11
+ * The following command allows you to create a Grafana user within a specific Scaleway Project.
12
+ *
9
13
  * ```typescript
10
14
  * import * as pulumi from "@pulumi/pulumi";
11
15
  * import * as scaleway from "@pulumiverse/scaleway";
@@ -20,7 +24,7 @@ import * as pulumi from "@pulumi/pulumi";
20
24
  *
21
25
  * ## Import
22
26
  *
23
- * Cockpits Grafana Users can be imported using the project ID and the grafana user ID formatted `{project_id}/{grafana_user_id}`, e.g.
27
+ * This section explains how to import Grafana users using the ID of the Project associated with Cockpit, and the Grafana user ID in the `{project_id}/{grafana_user_id}` format.
24
28
  *
25
29
  * bash
26
30
  *
@@ -45,19 +49,19 @@ export declare class CockpitGrafanaUser extends pulumi.CustomResource {
45
49
  */
46
50
  static isInstance(obj: any): obj is CockpitGrafanaUser;
47
51
  /**
48
- * The login of the grafana user.
52
+ * The username of the Grafana user. The `admin` user is not yet available for creation. You need your Grafana username to log in to Grafana and access your dashboards.
49
53
  */
50
54
  readonly login: pulumi.Output<string>;
51
55
  /**
52
- * The password of the grafana user
56
+ * The password of the Grafana user.
53
57
  */
54
58
  readonly password: pulumi.Output<string>;
55
59
  /**
56
- * `projectId`) The ID of the project the cockpit is associated with.
60
+ * ) The ID of the Project the Cockpit is associated with.
57
61
  */
58
62
  readonly projectId: pulumi.Output<string>;
59
63
  /**
60
- * The role of the grafana user. Must be `editor` or `viewer`.
64
+ * The role assigned to the Grafana user. Must be `editor` or `viewer`.
61
65
  */
62
66
  readonly role: pulumi.Output<string>;
63
67
  /**
@@ -74,19 +78,19 @@ export declare class CockpitGrafanaUser extends pulumi.CustomResource {
74
78
  */
75
79
  export interface CockpitGrafanaUserState {
76
80
  /**
77
- * The login of the grafana user.
81
+ * The username of the Grafana user. The `admin` user is not yet available for creation. You need your Grafana username to log in to Grafana and access your dashboards.
78
82
  */
79
83
  login?: pulumi.Input<string>;
80
84
  /**
81
- * The password of the grafana user
85
+ * The password of the Grafana user.
82
86
  */
83
87
  password?: pulumi.Input<string>;
84
88
  /**
85
- * `projectId`) The ID of the project the cockpit is associated with.
89
+ * ) The ID of the Project the Cockpit is associated with.
86
90
  */
87
91
  projectId?: pulumi.Input<string>;
88
92
  /**
89
- * The role of the grafana user. Must be `editor` or `viewer`.
93
+ * The role assigned to the Grafana user. Must be `editor` or `viewer`.
90
94
  */
91
95
  role?: pulumi.Input<string>;
92
96
  }
@@ -95,15 +99,15 @@ export interface CockpitGrafanaUserState {
95
99
  */
96
100
  export interface CockpitGrafanaUserArgs {
97
101
  /**
98
- * The login of the grafana user.
102
+ * The username of the Grafana user. The `admin` user is not yet available for creation. You need your Grafana username to log in to Grafana and access your dashboards.
99
103
  */
100
104
  login: pulumi.Input<string>;
101
105
  /**
102
- * `projectId`) The ID of the project the cockpit is associated with.
106
+ * ) The ID of the Project the Cockpit is associated with.
103
107
  */
104
108
  projectId?: pulumi.Input<string>;
105
109
  /**
106
- * The role of the grafana user. Must be `editor` or `viewer`.
110
+ * The role assigned to the Grafana user. Must be `editor` or `viewer`.
107
111
  */
108
112
  role: pulumi.Input<string>;
109
113
  }