@pulumiverse/grafana 0.5.0 → 0.5.1

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 (256) hide show
  1. package/annotation.d.ts +28 -3
  2. package/annotation.js +25 -0
  3. package/annotation.js.map +1 -1
  4. package/apiKey.d.ts +18 -0
  5. package/apiKey.js +18 -0
  6. package/apiKey.js.map +1 -1
  7. package/cloudAccessPolicy.d.ts +57 -15
  8. package/cloudAccessPolicy.js +51 -0
  9. package/cloudAccessPolicy.js.map +1 -1
  10. package/cloudAccessPolicyToken.d.ts +54 -9
  11. package/cloudAccessPolicyToken.js +51 -0
  12. package/cloudAccessPolicyToken.js.map +1 -1
  13. package/cloudApiKey.d.ts +35 -6
  14. package/cloudApiKey.js +32 -0
  15. package/cloudApiKey.js.map +1 -1
  16. package/cloudOrgMember.d.ts +9 -0
  17. package/cloudOrgMember.js +9 -0
  18. package/cloudOrgMember.js.map +1 -1
  19. package/cloudPluginInstallation.d.ts +32 -0
  20. package/cloudPluginInstallation.js +32 -0
  21. package/cloudPluginInstallation.js.map +1 -1
  22. package/cloudStack.d.ts +49 -38
  23. package/cloudStack.js +30 -0
  24. package/cloudStack.js.map +1 -1
  25. package/cloudStackServiceAccount.d.ts +36 -3
  26. package/cloudStackServiceAccount.js +33 -0
  27. package/cloudStackServiceAccount.js.map +1 -1
  28. package/cloudStackServiceAccountToken.d.ts +28 -0
  29. package/cloudStackServiceAccountToken.js +28 -0
  30. package/cloudStackServiceAccountToken.js.map +1 -1
  31. package/contactPoint.d.ts +44 -9
  32. package/contactPoint.js +38 -0
  33. package/contactPoint.js.map +1 -1
  34. package/dashboard.d.ts +44 -16
  35. package/dashboard.js +37 -0
  36. package/dashboard.js.map +1 -1
  37. package/dashboardPermission.d.ts +55 -3
  38. package/dashboardPermission.js +52 -0
  39. package/dashboardPermission.js.map +1 -1
  40. package/dashboardPermissionItem.d.ts +48 -0
  41. package/dashboardPermissionItem.js +48 -0
  42. package/dashboardPermissionItem.js.map +1 -1
  43. package/dashboardPublic.d.ts +73 -12
  44. package/dashboardPublic.js +67 -0
  45. package/dashboardPublic.js.map +1 -1
  46. package/dataSource.d.ts +102 -36
  47. package/dataSource.js +78 -0
  48. package/dataSource.js.map +1 -1
  49. package/dataSourceConfig.d.ts +69 -18
  50. package/dataSourceConfig.js +63 -0
  51. package/dataSourceConfig.js.map +1 -1
  52. package/dataSourcePermission.d.ts +66 -3
  53. package/dataSourcePermission.js +63 -0
  54. package/dataSourcePermission.js.map +1 -1
  55. package/dataSourcePermissionItem.d.ts +61 -0
  56. package/dataSourcePermissionItem.js +61 -0
  57. package/dataSourcePermissionItem.js.map +1 -1
  58. package/folder.d.ts +43 -9
  59. package/folder.js +37 -0
  60. package/folder.js.map +1 -1
  61. package/folderPermission.d.ts +49 -0
  62. package/folderPermission.js +49 -0
  63. package/folderPermission.js.map +1 -1
  64. package/folderPermissionItem.d.ts +47 -0
  65. package/folderPermissionItem.js +47 -0
  66. package/folderPermissionItem.js.map +1 -1
  67. package/getCloudIps.d.ts +43 -0
  68. package/getCloudIps.js +28 -0
  69. package/getCloudIps.js.map +1 -1
  70. package/getCloudOrganization.d.ts +37 -0
  71. package/getCloudOrganization.js +28 -0
  72. package/getCloudOrganization.js.map +1 -1
  73. package/getCloudStack.d.ts +84 -0
  74. package/getCloudStack.js +6 -0
  75. package/getCloudStack.js.map +1 -1
  76. package/getDashboard.d.ts +114 -0
  77. package/getDashboard.js +64 -0
  78. package/getDashboard.js.map +1 -1
  79. package/getDashboards.d.ts +56 -0
  80. package/getDashboards.js +14 -0
  81. package/getDashboards.js.map +1 -1
  82. package/getDataSource.d.ts +118 -0
  83. package/getDataSource.js +76 -0
  84. package/getDataSource.js.map +1 -1
  85. package/getFolder.d.ts +71 -0
  86. package/getFolder.js +44 -0
  87. package/getFolder.js.map +1 -1
  88. package/getFolders.d.ts +60 -0
  89. package/getFolders.js +48 -0
  90. package/getFolders.js.map +1 -1
  91. package/getLibraryPanel.d.ts +65 -0
  92. package/getLibraryPanel.js +6 -0
  93. package/getLibraryPanel.js.map +1 -1
  94. package/getOnCallSlackChannel.d.ts +44 -0
  95. package/getOnCallSlackChannel.js +32 -0
  96. package/getOnCallSlackChannel.js.map +1 -1
  97. package/getOncallAction.d.ts +21 -0
  98. package/getOncallAction.js +12 -0
  99. package/getOncallAction.js.map +1 -1
  100. package/getOncallEscalationChain.d.ts +41 -0
  101. package/getOncallEscalationChain.js +32 -0
  102. package/getOncallEscalationChain.js.map +1 -1
  103. package/getOncallIntegration.d.ts +44 -0
  104. package/getOncallIntegration.js +32 -0
  105. package/getOncallIntegration.js.map +1 -1
  106. package/getOncallOutgoingWebhook.d.ts +41 -0
  107. package/getOncallOutgoingWebhook.js +32 -0
  108. package/getOncallOutgoingWebhook.js.map +1 -1
  109. package/getOncallSchedule.d.ts +46 -0
  110. package/getOncallSchedule.js +34 -0
  111. package/getOncallSchedule.js.map +1 -1
  112. package/getOncallTeam.d.ts +37 -0
  113. package/getOncallTeam.js +28 -0
  114. package/getOncallTeam.js.map +1 -1
  115. package/getOncallUser.d.ts +47 -0
  116. package/getOncallUser.js +32 -0
  117. package/getOncallUser.js.map +1 -1
  118. package/getOncallUserGroup.d.ts +32 -0
  119. package/getOncallUserGroup.js +32 -0
  120. package/getOncallUserGroup.js.map +1 -1
  121. package/getOrganization.d.ts +70 -0
  122. package/getOrganization.js +52 -0
  123. package/getOrganization.js.map +1 -1
  124. package/getOrganizationPreferences.d.ts +53 -0
  125. package/getOrganizationPreferences.js +30 -0
  126. package/getOrganizationPreferences.js.map +1 -1
  127. package/getRole.d.ts +118 -0
  128. package/getRole.js +82 -0
  129. package/getRole.js.map +1 -1
  130. package/getServiceAccount.d.ts +32 -0
  131. package/getServiceAccount.js +8 -0
  132. package/getServiceAccount.js.map +1 -1
  133. package/getSlos.d.ts +17 -0
  134. package/getSlos.js +14 -0
  135. package/getSlos.js.map +1 -1
  136. package/getSyntheticMonitoringProbe.d.ts +62 -0
  137. package/getSyntheticMonitoringProbe.js +32 -0
  138. package/getSyntheticMonitoringProbe.js.map +1 -1
  139. package/getSyntheticMonitoringProbes.d.ts +40 -0
  140. package/getSyntheticMonitoringProbes.js +28 -0
  141. package/getSyntheticMonitoringProbes.js.map +1 -1
  142. package/getTeam.d.ts +50 -0
  143. package/getTeam.js +50 -0
  144. package/getTeam.js.map +1 -1
  145. package/getUser.d.ts +99 -0
  146. package/getUser.js +66 -0
  147. package/getUser.js.map +1 -1
  148. package/getUsers.d.ts +51 -0
  149. package/getUsers.js +48 -0
  150. package/getUsers.js.map +1 -1
  151. package/libraryPanel.d.ts +43 -12
  152. package/libraryPanel.js +37 -0
  153. package/libraryPanel.js.map +1 -1
  154. package/machineLearningHoliday.d.ts +14 -3
  155. package/machineLearningHoliday.js +11 -0
  156. package/machineLearningHoliday.js.map +1 -1
  157. package/machineLearningJob.d.ts +18 -12
  158. package/machineLearningJob.js +9 -0
  159. package/machineLearningJob.js.map +1 -1
  160. package/machineLearningOutlierDetector.d.ts +22 -12
  161. package/machineLearningOutlierDetector.js +13 -0
  162. package/machineLearningOutlierDetector.js.map +1 -1
  163. package/messageTemplate.d.ts +32 -0
  164. package/messageTemplate.js +32 -0
  165. package/messageTemplate.js.map +1 -1
  166. package/muteTiming.d.ts +51 -0
  167. package/muteTiming.js +51 -0
  168. package/muteTiming.js.map +1 -1
  169. package/notificationPolicy.d.ts +98 -9
  170. package/notificationPolicy.js +92 -0
  171. package/notificationPolicy.js.map +1 -1
  172. package/oncallEscalation.d.ts +81 -41
  173. package/oncallEscalation.js +52 -0
  174. package/oncallEscalation.js.map +1 -1
  175. package/oncallEscalationChain.d.ts +25 -6
  176. package/oncallEscalationChain.js +22 -0
  177. package/oncallEscalationChain.js.map +1 -1
  178. package/oncallIntegration.d.ts +16 -15
  179. package/oncallIntegration.js +10 -0
  180. package/oncallIntegration.js.map +1 -1
  181. package/oncallOnCallShift.d.ts +30 -27
  182. package/oncallOnCallShift.js +9 -0
  183. package/oncallOnCallShift.js.map +1 -1
  184. package/oncallOutgoingWebhook.d.ts +34 -21
  185. package/oncallOutgoingWebhook.js +22 -0
  186. package/oncallOutgoingWebhook.js.map +1 -1
  187. package/oncallRoute.d.ts +49 -3
  188. package/oncallRoute.js +46 -0
  189. package/oncallRoute.js.map +1 -1
  190. package/oncallSchedule.d.ts +49 -9
  191. package/oncallSchedule.js +43 -0
  192. package/oncallSchedule.js.map +1 -1
  193. package/organization.d.ts +94 -39
  194. package/organization.js +37 -0
  195. package/organization.js.map +1 -1
  196. package/organizationPreference.d.ts +31 -9
  197. package/organizationPreference.js +25 -0
  198. package/organizationPreference.js.map +1 -1
  199. package/package.json +2 -2
  200. package/package.json.dev +1 -1
  201. package/playlist.d.ts +41 -0
  202. package/playlist.js +41 -0
  203. package/playlist.js.map +1 -1
  204. package/report.d.ts +56 -15
  205. package/report.js +41 -0
  206. package/report.js.map +1 -1
  207. package/role.d.ts +58 -15
  208. package/role.js +46 -0
  209. package/role.js.map +1 -1
  210. package/roleAssignment.d.ts +48 -0
  211. package/roleAssignment.js +48 -0
  212. package/roleAssignment.js.map +1 -1
  213. package/roleAssignmentItem.d.ts +51 -0
  214. package/roleAssignmentItem.js +51 -0
  215. package/roleAssignmentItem.js.map +1 -1
  216. package/ruleGroup.d.ts +117 -9
  217. package/ruleGroup.js +111 -0
  218. package/ruleGroup.js.map +1 -1
  219. package/serviceAccount.d.ts +33 -3
  220. package/serviceAccount.js +30 -0
  221. package/serviceAccount.js.map +1 -1
  222. package/serviceAccountPermission.d.ts +50 -0
  223. package/serviceAccountPermission.js +50 -0
  224. package/serviceAccountPermission.js.map +1 -1
  225. package/serviceAccountPermissionItem.d.ts +44 -0
  226. package/serviceAccountPermissionItem.js +44 -0
  227. package/serviceAccountPermissionItem.js.map +1 -1
  228. package/serviceAccountToken.d.ts +27 -9
  229. package/serviceAccountToken.js +24 -0
  230. package/serviceAccountToken.js.map +1 -1
  231. package/slo.d.ts +39 -27
  232. package/slo.js +15 -0
  233. package/slo.js.map +1 -1
  234. package/ssoSettings.d.ts +75 -3
  235. package/ssoSettings.js +72 -0
  236. package/ssoSettings.js.map +1 -1
  237. package/syntheticMonitoringCheck.d.ts +431 -36
  238. package/syntheticMonitoringCheck.js +413 -0
  239. package/syntheticMonitoringCheck.js.map +1 -1
  240. package/syntheticMonitoringInstallation.d.ts +75 -24
  241. package/syntheticMonitoringInstallation.js +69 -0
  242. package/syntheticMonitoringInstallation.js.map +1 -1
  243. package/syntheticMonitoringProbe.d.ts +39 -6
  244. package/syntheticMonitoringProbe.js +36 -0
  245. package/syntheticMonitoringProbe.js.map +1 -1
  246. package/team.d.ts +33 -0
  247. package/team.js +33 -0
  248. package/team.js.map +1 -1
  249. package/teamExternalGroup.d.ts +31 -0
  250. package/teamExternalGroup.js +31 -0
  251. package/teamExternalGroup.js.map +1 -1
  252. package/types/input.d.ts +123 -123
  253. package/types/output.d.ts +123 -123
  254. package/user.d.ts +33 -3
  255. package/user.js +30 -0
  256. package/user.js.map +1 -1
package/types/output.d.ts CHANGED
@@ -26,11 +26,11 @@ export interface ContactPointAlertmanager {
26
26
  */
27
27
  basicAuthUser?: string;
28
28
  /**
29
- * Whether to disable sending resolve messages.
29
+ * Whether to disable sending resolve messages. Defaults to `false`.
30
30
  */
31
31
  disableResolveMessage?: boolean;
32
32
  /**
33
- * Additional custom properties to attach to the notifier.
33
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
34
34
  */
35
35
  settings?: {
36
36
  [key: string]: string;
@@ -46,7 +46,7 @@ export interface ContactPointAlertmanager {
46
46
  }
47
47
  export interface ContactPointDingding {
48
48
  /**
49
- * Whether to disable sending resolve messages.
49
+ * Whether to disable sending resolve messages. Defaults to `false`.
50
50
  */
51
51
  disableResolveMessage?: boolean;
52
52
  /**
@@ -58,7 +58,7 @@ export interface ContactPointDingding {
58
58
  */
59
59
  messageType?: string;
60
60
  /**
61
- * Additional custom properties to attach to the notifier.
61
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
62
62
  */
63
63
  settings?: {
64
64
  [key: string]: string;
@@ -78,19 +78,19 @@ export interface ContactPointDingding {
78
78
  }
79
79
  export interface ContactPointDiscord {
80
80
  /**
81
- * The URL of a custom avatar image to use.
81
+ * The URL of a custom avatar image to use. Defaults to ``.
82
82
  */
83
83
  avatarUrl?: string;
84
84
  /**
85
- * Whether to disable sending resolve messages.
85
+ * Whether to disable sending resolve messages. Defaults to `false`.
86
86
  */
87
87
  disableResolveMessage?: boolean;
88
88
  /**
89
- * The templated content of the message.
89
+ * The templated content of the message. Defaults to ``.
90
90
  */
91
91
  message?: string;
92
92
  /**
93
- * Additional custom properties to attach to the notifier.
93
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
94
94
  */
95
95
  settings?: {
96
96
  [key: string]: string;
@@ -108,7 +108,7 @@ export interface ContactPointDiscord {
108
108
  */
109
109
  url: string;
110
110
  /**
111
- * Whether to use the bot account's plain username instead of "Grafana."
111
+ * Whether to use the bot account's plain username instead of "Grafana." Defaults to `false`.
112
112
  */
113
113
  useDiscordUsername?: boolean;
114
114
  }
@@ -118,25 +118,25 @@ export interface ContactPointEmail {
118
118
  */
119
119
  addresses: string[];
120
120
  /**
121
- * Whether to disable sending resolve messages.
121
+ * Whether to disable sending resolve messages. Defaults to `false`.
122
122
  */
123
123
  disableResolveMessage?: boolean;
124
124
  /**
125
- * The templated content of the email.
125
+ * The templated content of the email. Defaults to ``.
126
126
  */
127
127
  message?: string;
128
128
  /**
129
- * Additional custom properties to attach to the notifier.
129
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
130
130
  */
131
131
  settings?: {
132
132
  [key: string]: string;
133
133
  };
134
134
  /**
135
- * Whether to send a single email CC'ing all addresses, rather than a separate email to each address.
135
+ * Whether to send a single email CC'ing all addresses, rather than a separate email to each address. Defaults to `false`.
136
136
  */
137
137
  singleEmail?: boolean;
138
138
  /**
139
- * The templated subject line of the email.
139
+ * The templated subject line of the email. Defaults to ``.
140
140
  */
141
141
  subject?: string;
142
142
  /**
@@ -146,7 +146,7 @@ export interface ContactPointEmail {
146
146
  }
147
147
  export interface ContactPointGooglechat {
148
148
  /**
149
- * Whether to disable sending resolve messages.
149
+ * Whether to disable sending resolve messages. Defaults to `false`.
150
150
  */
151
151
  disableResolveMessage?: boolean;
152
152
  /**
@@ -154,7 +154,7 @@ export interface ContactPointGooglechat {
154
154
  */
155
155
  message?: string;
156
156
  /**
157
- * Additional custom properties to attach to the notifier.
157
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
158
158
  */
159
159
  settings?: {
160
160
  [key: string]: string;
@@ -174,7 +174,7 @@ export interface ContactPointGooglechat {
174
174
  }
175
175
  export interface ContactPointKafka {
176
176
  /**
177
- * The API version to use when contacting the Kafka REST Server. Supported: v2 (default) and v3.
177
+ * The API version to use when contacting the Kafka REST Server. Supported: v2 (default) and v3. Defaults to `v2`.
178
178
  */
179
179
  apiVersion?: string;
180
180
  /**
@@ -190,7 +190,7 @@ export interface ContactPointKafka {
190
190
  */
191
191
  details?: string;
192
192
  /**
193
- * Whether to disable sending resolve messages.
193
+ * Whether to disable sending resolve messages. Defaults to `false`.
194
194
  */
195
195
  disableResolveMessage?: boolean;
196
196
  /**
@@ -202,7 +202,7 @@ export interface ContactPointKafka {
202
202
  */
203
203
  restProxyUrl: string;
204
204
  /**
205
- * Additional custom properties to attach to the notifier.
205
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
206
206
  */
207
207
  settings?: {
208
208
  [key: string]: string;
@@ -226,11 +226,11 @@ export interface ContactPointLine {
226
226
  */
227
227
  description?: string;
228
228
  /**
229
- * Whether to disable sending resolve messages.
229
+ * Whether to disable sending resolve messages. Defaults to `false`.
230
230
  */
231
231
  disableResolveMessage?: boolean;
232
232
  /**
233
- * Additional custom properties to attach to the notifier.
233
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
234
234
  */
235
235
  settings?: {
236
236
  [key: string]: string;
@@ -266,7 +266,7 @@ export interface ContactPointOncall {
266
266
  */
267
267
  basicAuthUser?: string;
268
268
  /**
269
- * Whether to disable sending resolve messages.
269
+ * Whether to disable sending resolve messages. Defaults to `false`.
270
270
  */
271
271
  disableResolveMessage?: boolean;
272
272
  /**
@@ -282,7 +282,7 @@ export interface ContactPointOncall {
282
282
  */
283
283
  message?: string;
284
284
  /**
285
- * Additional custom properties to attach to the notifier.
285
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
286
286
  */
287
287
  settings?: {
288
288
  [key: string]: string;
@@ -314,7 +314,7 @@ export interface ContactPointOpsgeny {
314
314
  */
315
315
  description?: string;
316
316
  /**
317
- * Whether to disable sending resolve messages.
317
+ * Whether to disable sending resolve messages. Defaults to `false`.
318
318
  */
319
319
  disableResolveMessage?: boolean;
320
320
  /**
@@ -334,7 +334,7 @@ export interface ContactPointOpsgeny {
334
334
  */
335
335
  sendTagsAs?: string;
336
336
  /**
337
- * Additional custom properties to attach to the notifier.
337
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
338
338
  */
339
339
  settings?: {
340
340
  [key: string]: string;
@@ -362,7 +362,7 @@ export interface ContactPointOpsgenyResponder {
362
362
  */
363
363
  type: string;
364
364
  /**
365
- * User name of the responder. Must be specified if name and id are empty.
365
+ * The user name to use when making a call to the Kafka REST Proxy
366
366
  */
367
367
  username?: string;
368
368
  }
@@ -390,7 +390,7 @@ export interface ContactPointPagerduty {
390
390
  [key: string]: string;
391
391
  };
392
392
  /**
393
- * Whether to disable sending resolve messages.
393
+ * Whether to disable sending resolve messages. Defaults to `false`.
394
394
  */
395
395
  disableResolveMessage?: boolean;
396
396
  /**
@@ -402,7 +402,7 @@ export interface ContactPointPagerduty {
402
402
  */
403
403
  integrationKey: string;
404
404
  /**
405
- * Additional custom properties to attach to the notifier.
405
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
406
406
  */
407
407
  settings?: {
408
408
  [key: string]: string;
@@ -434,7 +434,7 @@ export interface ContactPointPushover {
434
434
  */
435
435
  device?: string;
436
436
  /**
437
- * Whether to disable sending resolve messages.
437
+ * Whether to disable sending resolve messages. Defaults to `false`.
438
438
  */
439
439
  disableResolveMessage?: boolean;
440
440
  /**
@@ -462,7 +462,7 @@ export interface ContactPointPushover {
462
462
  */
463
463
  retry?: number;
464
464
  /**
465
- * Additional custom properties to attach to the notifier.
465
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
466
466
  */
467
467
  settings?: {
468
468
  [key: string]: string;
@@ -498,7 +498,7 @@ export interface ContactPointSensugo {
498
498
  */
499
499
  check?: string;
500
500
  /**
501
- * Whether to disable sending resolve messages.
501
+ * Whether to disable sending resolve messages. Defaults to `false`.
502
502
  */
503
503
  disableResolveMessage?: boolean;
504
504
  /**
@@ -518,7 +518,7 @@ export interface ContactPointSensugo {
518
518
  */
519
519
  namespace?: string;
520
520
  /**
521
- * Additional custom properties to attach to the notifier.
521
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
522
522
  */
523
523
  settings?: {
524
524
  [key: string]: string;
@@ -534,7 +534,7 @@ export interface ContactPointSensugo {
534
534
  }
535
535
  export interface ContactPointSlack {
536
536
  /**
537
- * Whether to disable sending resolve messages.
537
+ * Whether to disable sending resolve messages. Defaults to `false`.
538
538
  */
539
539
  disableResolveMessage?: boolean;
540
540
  /**
@@ -566,7 +566,7 @@ export interface ContactPointSlack {
566
566
  */
567
567
  recipient?: string;
568
568
  /**
569
- * Additional custom properties to attach to the notifier.
569
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
570
570
  */
571
571
  settings?: {
572
572
  [key: string]: string;
@@ -606,12 +606,12 @@ export interface ContactPointSn {
606
606
  */
607
607
  assumeRoleArn?: string;
608
608
  /**
609
- * The authentication provider to use. Valid values are `default`, `arn` and `keys`. Default is `default`.
609
+ * The authentication provider to use. Valid values are `default`, `arn` and `keys`. Default is `default`. Defaults to `default`.
610
610
  */
611
611
  authProvider?: string;
612
612
  body?: string;
613
613
  /**
614
- * Whether to disable sending resolve messages.
614
+ * Whether to disable sending resolve messages. Defaults to `false`.
615
615
  */
616
616
  disableResolveMessage?: boolean;
617
617
  /**
@@ -619,7 +619,7 @@ export interface ContactPointSn {
619
619
  */
620
620
  externalId?: string;
621
621
  /**
622
- * The format of the message to send. Valid values are `text`, `body` and `json`. Default is `text`.
622
+ * The format of the message to send. Valid values are `text`, `body` and `json`. Default is `text`. Defaults to `text`.
623
623
  */
624
624
  messageFormat?: string;
625
625
  /**
@@ -627,7 +627,7 @@ export interface ContactPointSn {
627
627
  */
628
628
  secretKey?: string;
629
629
  /**
630
- * Additional custom properties to attach to the notifier.
630
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
631
631
  */
632
632
  settings?: {
633
633
  [key: string]: string;
@@ -644,7 +644,7 @@ export interface ContactPointSn {
644
644
  }
645
645
  export interface ContactPointTeam {
646
646
  /**
647
- * Whether to disable sending resolve messages.
647
+ * Whether to disable sending resolve messages. Defaults to `false`.
648
648
  */
649
649
  disableResolveMessage?: boolean;
650
650
  /**
@@ -656,7 +656,7 @@ export interface ContactPointTeam {
656
656
  */
657
657
  sectionTitle?: string;
658
658
  /**
659
- * Additional custom properties to attach to the notifier.
659
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
660
660
  */
661
661
  settings?: {
662
662
  [key: string]: string;
@@ -684,7 +684,7 @@ export interface ContactPointTelegram {
684
684
  */
685
685
  disableNotifications?: boolean;
686
686
  /**
687
- * Whether to disable sending resolve messages.
687
+ * Whether to disable sending resolve messages. Defaults to `false`.
688
688
  */
689
689
  disableResolveMessage?: boolean;
690
690
  /**
@@ -704,7 +704,7 @@ export interface ContactPointTelegram {
704
704
  */
705
705
  protectContent?: boolean;
706
706
  /**
707
- * Additional custom properties to attach to the notifier.
707
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
708
708
  */
709
709
  settings?: {
710
710
  [key: string]: string;
@@ -728,7 +728,7 @@ export interface ContactPointThreema {
728
728
  */
729
729
  description?: string;
730
730
  /**
731
- * Whether to disable sending resolve messages.
731
+ * Whether to disable sending resolve messages. Defaults to `false`.
732
732
  */
733
733
  disableResolveMessage?: boolean;
734
734
  /**
@@ -740,7 +740,7 @@ export interface ContactPointThreema {
740
740
  */
741
741
  recipientId: string;
742
742
  /**
743
- * Additional custom properties to attach to the notifier.
743
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
744
744
  */
745
745
  settings?: {
746
746
  [key: string]: string;
@@ -760,7 +760,7 @@ export interface ContactPointVictorop {
760
760
  */
761
761
  description?: string;
762
762
  /**
763
- * Whether to disable sending resolve messages.
763
+ * Whether to disable sending resolve messages. Defaults to `false`.
764
764
  */
765
765
  disableResolveMessage?: boolean;
766
766
  /**
@@ -768,7 +768,7 @@ export interface ContactPointVictorop {
768
768
  */
769
769
  messageType?: string;
770
770
  /**
771
- * Additional custom properties to attach to the notifier.
771
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
772
772
  */
773
773
  settings?: {
774
774
  [key: string]: string;
@@ -792,7 +792,7 @@ export interface ContactPointWebex {
792
792
  */
793
793
  apiUrl?: string;
794
794
  /**
795
- * Whether to disable sending resolve messages.
795
+ * Whether to disable sending resolve messages. Defaults to `false`.
796
796
  */
797
797
  disableResolveMessage?: boolean;
798
798
  /**
@@ -804,7 +804,7 @@ export interface ContactPointWebex {
804
804
  */
805
805
  roomId?: string;
806
806
  /**
807
- * Additional custom properties to attach to the notifier.
807
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
808
808
  */
809
809
  settings?: {
810
810
  [key: string]: string;
@@ -836,7 +836,7 @@ export interface ContactPointWebhook {
836
836
  */
837
837
  basicAuthUser?: string;
838
838
  /**
839
- * Whether to disable sending resolve messages.
839
+ * Whether to disable sending resolve messages. Defaults to `false`.
840
840
  */
841
841
  disableResolveMessage?: boolean;
842
842
  /**
@@ -852,7 +852,7 @@ export interface ContactPointWebhook {
852
852
  */
853
853
  message?: string;
854
854
  /**
855
- * Additional custom properties to attach to the notifier.
855
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
856
856
  */
857
857
  settings?: {
858
858
  [key: string]: string;
@@ -880,7 +880,7 @@ export interface ContactPointWecom {
880
880
  */
881
881
  corpId?: string;
882
882
  /**
883
- * Whether to disable sending resolve messages.
883
+ * Whether to disable sending resolve messages. Defaults to `false`.
884
884
  */
885
885
  disableResolveMessage?: boolean;
886
886
  /**
@@ -896,7 +896,7 @@ export interface ContactPointWecom {
896
896
  */
897
897
  secret?: string;
898
898
  /**
899
- * Additional custom properties to attach to the notifier.
899
+ * Additional custom properties to attach to the notifier. Defaults to `map[]`.
900
900
  */
901
901
  settings?: {
902
902
  [key: string]: string;
@@ -928,11 +928,11 @@ export interface DashboardPermissionPermission {
928
928
  */
929
929
  role?: string;
930
930
  /**
931
- * ID of the team to manage permissions for.
931
+ * ID of the team to manage permissions for. Defaults to `0`.
932
932
  */
933
933
  teamId?: string;
934
934
  /**
935
- * ID of the user or service account to manage permissions for.
935
+ * ID of the user or service account to manage permissions for. Defaults to `0`.
936
936
  */
937
937
  userId?: string;
938
938
  }
@@ -946,11 +946,11 @@ export interface DataSourcePermissionPermission {
946
946
  */
947
947
  permission: string;
948
948
  /**
949
- * ID of the team to manage permissions for.
949
+ * ID of the team to manage permissions for. Defaults to `0`.
950
950
  */
951
951
  teamId?: string;
952
952
  /**
953
- * ID of the user or service account to manage permissions for.
953
+ * ID of the user or service account to manage permissions for. Defaults to `0`.
954
954
  */
955
955
  userId?: string;
956
956
  }
@@ -964,11 +964,11 @@ export interface FolderPermissionPermission {
964
964
  */
965
965
  role?: string;
966
966
  /**
967
- * ID of the team to manage permissions for.
967
+ * ID of the team to manage permissions for. Defaults to `0`.
968
968
  */
969
969
  teamId?: string;
970
970
  /**
971
- * ID of the user or service account to manage permissions for.
971
+ * ID of the user or service account to manage permissions for. Defaults to `0`.
972
972
  */
973
973
  userId?: string;
974
974
  }
@@ -1485,7 +1485,7 @@ export interface OncallIntegrationDefaultRoute {
1485
1485
  }
1486
1486
  export interface OncallIntegrationDefaultRouteMsteams {
1487
1487
  /**
1488
- * Enable notification in MS teams.
1488
+ * Enable notification in MS teams. Defaults to `true`.
1489
1489
  */
1490
1490
  enabled?: boolean;
1491
1491
  /**
@@ -1499,13 +1499,13 @@ export interface OncallIntegrationDefaultRouteSlack {
1499
1499
  */
1500
1500
  channelId?: string;
1501
1501
  /**
1502
- * Enable notification in Slack.
1502
+ * Enable notification in MS teams. Defaults to `true`.
1503
1503
  */
1504
1504
  enabled?: boolean;
1505
1505
  }
1506
1506
  export interface OncallIntegrationDefaultRouteTelegram {
1507
1507
  /**
1508
- * Enable notification in Telegram.
1508
+ * Enable notification in MS teams. Defaults to `true`.
1509
1509
  */
1510
1510
  enabled?: boolean;
1511
1511
  /**
@@ -1639,7 +1639,7 @@ export interface OncallIntegrationTemplatesWeb {
1639
1639
  }
1640
1640
  export interface OncallRouteMsteams {
1641
1641
  /**
1642
- * Enable notification in MS teams.
1642
+ * Enable notification in MS teams. Defaults to `true`.
1643
1643
  */
1644
1644
  enabled?: boolean;
1645
1645
  /**
@@ -1653,13 +1653,13 @@ export interface OncallRouteSlack {
1653
1653
  */
1654
1654
  channelId?: string;
1655
1655
  /**
1656
- * Enable notification in Slack.
1656
+ * Enable notification in Slack. Defaults to `true`.
1657
1657
  */
1658
1658
  enabled?: boolean;
1659
1659
  }
1660
1660
  export interface OncallRouteTelegram {
1661
1661
  /**
1662
- * Enable notification in Telegram.
1662
+ * Enable notification in Telegram. Defaults to `true`.
1663
1663
  */
1664
1664
  enabled?: boolean;
1665
1665
  /**
@@ -1725,7 +1725,7 @@ export interface ReportSchedule {
1725
1725
  */
1726
1726
  frequency: string;
1727
1727
  /**
1728
- * Send the report on the last day of the month
1728
+ * Send the report on the last day of the month Defaults to `false`.
1729
1729
  */
1730
1730
  lastDayOfMonth?: boolean;
1731
1731
  /**
@@ -1733,11 +1733,11 @@ export interface ReportSchedule {
1733
1733
  */
1734
1734
  startTime?: string;
1735
1735
  /**
1736
- * Set the report time zone.
1736
+ * Set the report time zone. Defaults to `GMT`.
1737
1737
  */
1738
1738
  timezone?: string;
1739
1739
  /**
1740
- * Whether to send the report only on work days.
1740
+ * Whether to send the report only on work days. Defaults to `false`.
1741
1741
  */
1742
1742
  workdaysOnly?: boolean;
1743
1743
  }
@@ -1757,13 +1757,13 @@ export interface RolePermission {
1757
1757
  */
1758
1758
  action: string;
1759
1759
  /**
1760
- * Scope to restrict the action to a set of resources (for example: `users:*` or `roles:customrole1`)
1760
+ * Scope to restrict the action to a set of resources (for example: `users:*` or `roles:customrole1`) Defaults to ``.
1761
1761
  */
1762
1762
  scope?: string;
1763
1763
  }
1764
1764
  export interface RuleGroupRule {
1765
1765
  /**
1766
- * Key-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing.
1766
+ * Key-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`.
1767
1767
  */
1768
1768
  annotations?: {
1769
1769
  [key: string]: string;
@@ -1777,19 +1777,19 @@ export interface RuleGroupRule {
1777
1777
  */
1778
1778
  datas: outputs.RuleGroupRuleData[];
1779
1779
  /**
1780
- * Describes what state to enter when the rule's query is invalid and the rule cannot be executed. Options are OK, Error, KeepLast, and Alerting.
1780
+ * Describes what state to enter when the rule's query is invalid and the rule cannot be executed. Options are OK, Error, KeepLast, and Alerting. Defaults to `Alerting`.
1781
1781
  */
1782
1782
  execErrState?: string;
1783
1783
  /**
1784
- * The amount of time for which the rule must be breached for the rule to be considered to be Firing. Before this time has elapsed, the rule is only considered to be Pending.
1784
+ * The amount of time for which the rule must be breached for the rule to be considered to be Firing. Before this time has elapsed, the rule is only considered to be Pending. Defaults to `0`.
1785
1785
  */
1786
1786
  for?: string;
1787
1787
  /**
1788
- * Sets whether the alert should be paused or not.
1788
+ * Sets whether the alert should be paused or not. Defaults to `false`.
1789
1789
  */
1790
1790
  isPaused?: boolean;
1791
1791
  /**
1792
- * Key-value pairs to attach to the alert rule that can be used in matching, grouping, and routing.
1792
+ * Key-value pairs to attach to the alert rule that can be used in matching, grouping, and routing. Defaults to `map[]`.
1793
1793
  */
1794
1794
  labels?: {
1795
1795
  [key: string]: string;
@@ -1799,7 +1799,7 @@ export interface RuleGroupRule {
1799
1799
  */
1800
1800
  name: string;
1801
1801
  /**
1802
- * Describes what state to enter when the rule's query returns No Data. Options are OK, NoData, KeepLast, and Alerting.
1802
+ * Describes what state to enter when the rule's query returns No Data. Options are OK, NoData, KeepLast, and Alerting. Defaults to `NoData`.
1803
1803
  */
1804
1804
  noDataState?: string;
1805
1805
  /**
@@ -1821,7 +1821,7 @@ export interface RuleGroupRuleData {
1821
1821
  */
1822
1822
  model: string;
1823
1823
  /**
1824
- * An optional identifier for the type of query being executed.
1824
+ * An optional identifier for the type of query being executed. Defaults to ``.
1825
1825
  */
1826
1826
  queryType?: string;
1827
1827
  /**
@@ -1893,7 +1893,7 @@ export interface SLOAlertingAnnotation {
1893
1893
  }
1894
1894
  export interface SLOAlertingFastburn {
1895
1895
  /**
1896
- * Annotations to attach only to Fast Burn alerts.
1896
+ * Annotations will be attached to all alerts generated by any of these rules.
1897
1897
  */
1898
1898
  annotations?: outputs.SLOAlertingFastburnAnnotation[];
1899
1899
  /**
@@ -1915,11 +1915,11 @@ export interface SLOAlertingLabel {
1915
1915
  }
1916
1916
  export interface SLOAlertingSlowburn {
1917
1917
  /**
1918
- * Annotations to attach only to Slow Burn alerts.
1918
+ * Annotations will be attached to all alerts generated by any of these rules.
1919
1919
  */
1920
1920
  annotations?: outputs.SLOAlertingSlowburnAnnotation[];
1921
1921
  /**
1922
- * Labels to attach only to Slow Burn alerts.
1922
+ * Labels to attach only to Fast Burn alerts.
1923
1923
  */
1924
1924
  labels?: outputs.SLOAlertingSlowburnLabel[];
1925
1925
  }
@@ -1967,7 +1967,7 @@ export interface SLOQueryFreeform {
1967
1967
  }
1968
1968
  export interface SLOQueryRatio {
1969
1969
  /**
1970
- * Defines Group By Labels used for per-label alerting. These appear as variables on SLO dashboards to enable filtering and aggregation. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
1970
+ * Defines Group By Labels used for per-label alerting. These appear as variables on SLO dashboards to enable filtering and aggregation. Labels must adhere to Prometheus label name schema - "^[a-zA-Z*][a-zA-Z0-9*]*$"
1971
1971
  */
1972
1972
  groupByLabels?: string[];
1973
1973
  /**
@@ -1985,11 +1985,11 @@ export interface ServiceAccountPermissionPermission {
1985
1985
  */
1986
1986
  permission: string;
1987
1987
  /**
1988
- * ID of the team to manage permissions for.
1988
+ * ID of the team to manage permissions for. Defaults to `0`.
1989
1989
  */
1990
1990
  teamId?: string;
1991
1991
  /**
1992
- * ID of the user or service account to manage permissions for.
1992
+ * ID of the user or service account to manage permissions for. Defaults to `0`.
1993
1993
  */
1994
1994
  userId?: string;
1995
1995
  }
@@ -2007,7 +2007,7 @@ export interface SsoSettingsOauth2Settings {
2007
2007
  */
2008
2008
  allowedDomains?: string;
2009
2009
  /**
2010
- * List of comma- or space-separated groups. The user should be a member of at least one group to log in. For Generic OAuth, if you configure allowed_groups, you must also configure groups_attribute_path.
2010
+ * List of comma- or space-separated groups. The user should be a member of at least one group to log in. For Generic OAuth, if you configure allowed*groups, you must also configure groups*attribute_path.
2011
2011
  */
2012
2012
  allowedGroups?: string;
2013
2013
  /**
@@ -2019,7 +2019,7 @@ export interface SsoSettingsOauth2Settings {
2019
2019
  */
2020
2020
  apiUrl?: string;
2021
2021
  /**
2022
- * It determines how clientId and clientSecret are sent to Oauth2 provider. Possible values are AutoDetect, InParams, InHeader. Default is AutoDetect.
2022
+ * It determines how client*id and client*secret are sent to Oauth2 provider. Possible values are AutoDetect, InParams, InHeader. Default is AutoDetect.
2023
2023
  */
2024
2024
  authStyle?: string;
2025
2025
  /**
@@ -2039,7 +2039,7 @@ export interface SsoSettingsOauth2Settings {
2039
2039
  */
2040
2040
  clientSecret?: string;
2041
2041
  /**
2042
- * Custom fields to configure for OAuth2 such as the [forceUseGraphApi](https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-authentication/azuread/#force-fetching-groups-from-microsoft-graph-api) field.
2042
+ * Custom fields to configure for OAuth2 such as the [force*use*graph_api](https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-authentication/azuread/#force-fetching-groups-from-microsoft-graph-api) field.
2043
2043
  */
2044
2044
  custom?: {
2045
2045
  [key: string]: string;
@@ -2065,11 +2065,11 @@ export interface SsoSettingsOauth2Settings {
2065
2065
  */
2066
2066
  emptyScopes?: boolean;
2067
2067
  /**
2068
- * Define whether this configuration is enabled for the specified provider.
2068
+ * Define whether this configuration is enabled for the specified provider. Defaults to `true`.
2069
2069
  */
2070
2070
  enabled?: boolean;
2071
2071
  /**
2072
- * JMESPath expression to use for user group lookup. If you configure allowed_groups, you must also configure groups_attribute_path.
2072
+ * JMESPath expression to use for user group lookup. If you configure allowed*groups, you must also configure groups*attribute_path.
2073
2073
  */
2074
2074
  groupsAttributePath?: string;
2075
2075
  /**
@@ -2109,7 +2109,7 @@ export interface SsoSettingsOauth2Settings {
2109
2109
  */
2110
2110
  skipOrgRoleSync?: boolean;
2111
2111
  /**
2112
- * String list of Team Ids. If set, the user must be a member of one of the given teams to log in. If you configure team_ids, you must also configure teamsUrl and team_ids_attribute_path.
2112
+ * String list of Team Ids. If set, the user must be a member of one of the given teams to log in. If you configure team*ids, you must also configure teams*url and team*ids*attribute_path.
2113
2113
  */
2114
2114
  teamIds?: string;
2115
2115
  /**
@@ -2117,7 +2117,7 @@ export interface SsoSettingsOauth2Settings {
2117
2117
  */
2118
2118
  teamIdsAttributePath?: string;
2119
2119
  /**
2120
- * The URL used to query for Team Ids. If not set, the default value is /teams. If you configure teams_url, you must also configure team_ids_attribute_path. Only applicable to Generic OAuth.
2120
+ * The URL used to query for Team Ids. If not set, the default value is /teams. If you configure teams*url, you must also configure team*ids*attribute*path. Only applicable to Generic OAuth.
2121
2121
  */
2122
2122
  teamsUrl?: string;
2123
2123
  /**
@@ -2199,7 +2199,7 @@ export interface SsoSettingsSamlSettings {
2199
2199
  */
2200
2200
  certificatePath?: string;
2201
2201
  /**
2202
- * Define whether this configuration is enabled for SAML.
2202
+ * Define whether this configuration is enabled for SAML. Defaults to `true`.
2203
2203
  */
2204
2204
  enabled?: boolean;
2205
2205
  /**
@@ -2303,23 +2303,23 @@ export interface SyntheticMonitoringCheckSettings {
2303
2303
  }
2304
2304
  export interface SyntheticMonitoringCheckSettingsDns {
2305
2305
  /**
2306
- * Options are `V4`, `V6`, `Any`. Specifies whether the corresponding check will be performed using IPv4 or IPv6. The `Any` value indicates that IPv6 should be used, falling back to IPv4 if that's not available.
2306
+ * Options are `V4`, `V6`, `Any`. Specifies whether the corresponding check will be performed using IPv4 or IPv6. The `Any` value indicates that IPv6 should be used, falling back to IPv4 if that's not available. Defaults to `V4`.
2307
2307
  */
2308
2308
  ipVersion?: string;
2309
2309
  /**
2310
- * Port to target.
2310
+ * Port to target. Defaults to `53`.
2311
2311
  */
2312
2312
  port?: number;
2313
2313
  /**
2314
- * `TCP` or `UDP`.
2314
+ * `TCP` or `UDP`. Defaults to `UDP`.
2315
2315
  */
2316
2316
  protocol?: string;
2317
2317
  /**
2318
- * One of `ANY`, `A`, `AAAA`, `CNAME`, `MX`, `NS`, `PTR`, `SOA`, `SRV`, `TXT`.
2318
+ * One of `ANY`, `A`, `AAAA`, `CNAME`, `MX`, `NS`, `PTR`, `SOA`, `SRV`, `TXT`. Defaults to `A`.
2319
2319
  */
2320
2320
  recordType?: string;
2321
2321
  /**
2322
- * DNS server address to target.
2322
+ * DNS server address to target. Defaults to `8.8.8.8`.
2323
2323
  */
2324
2324
  server?: string;
2325
2325
  /**
@@ -2407,11 +2407,11 @@ export interface SyntheticMonitoringCheckSettingsHttp {
2407
2407
  */
2408
2408
  failIfHeaderNotMatchesRegexps?: outputs.SyntheticMonitoringCheckSettingsHttpFailIfHeaderNotMatchesRegexp[];
2409
2409
  /**
2410
- * Fail if SSL is not present.
2410
+ * Fail if SSL is not present. Defaults to `false`.
2411
2411
  */
2412
2412
  failIfNotSsl?: boolean;
2413
2413
  /**
2414
- * Fail if SSL is present.
2414
+ * Fail if SSL is present. Defaults to `false`.
2415
2415
  */
2416
2416
  failIfSsl?: boolean;
2417
2417
  /**
@@ -2419,15 +2419,15 @@ export interface SyntheticMonitoringCheckSettingsHttp {
2419
2419
  */
2420
2420
  headers?: string[];
2421
2421
  /**
2422
- * Options are `V4`, `V6`, `Any`. Specifies whether the corresponding check will be performed using IPv4 or IPv6. The `Any` value indicates that IPv6 should be used, falling back to IPv4 if that's not available.
2422
+ * Options are `V4`, `V6`, `Any`. Specifies whether the corresponding check will be performed using IPv4 or IPv6. The `Any` value indicates that IPv6 should be used, falling back to IPv4 if that's not available. Defaults to `V4`.
2423
2423
  */
2424
2424
  ipVersion?: string;
2425
2425
  /**
2426
- * Request method. One of `GET`, `CONNECT`, `DELETE`, `HEAD`, `OPTIONS`, `POST`, `PUT`, `TRACE`
2426
+ * Request method. One of `GET`, `CONNECT`, `DELETE`, `HEAD`, `OPTIONS`, `POST`, `PUT`, `TRACE` Defaults to `GET`.
2427
2427
  */
2428
2428
  method?: string;
2429
2429
  /**
2430
- * Do not follow redirects.
2430
+ * Do not follow redirects. Defaults to `false`.
2431
2431
  */
2432
2432
  noFollowRedirects?: boolean;
2433
2433
  /**
@@ -2463,7 +2463,7 @@ export interface SyntheticMonitoringCheckSettingsHttpBasicAuth {
2463
2463
  }
2464
2464
  export interface SyntheticMonitoringCheckSettingsHttpFailIfHeaderMatchesRegexp {
2465
2465
  /**
2466
- * Allow header to be missing from responses.
2466
+ * Allow header to be missing from responses. Defaults to `false`.
2467
2467
  */
2468
2468
  allowMissing?: boolean;
2469
2469
  /**
@@ -2477,7 +2477,7 @@ export interface SyntheticMonitoringCheckSettingsHttpFailIfHeaderMatchesRegexp {
2477
2477
  }
2478
2478
  export interface SyntheticMonitoringCheckSettingsHttpFailIfHeaderNotMatchesRegexp {
2479
2479
  /**
2480
- * Allow header to be missing from responses.
2480
+ * Allow header to be missing from responses. Defaults to `false`.
2481
2481
  */
2482
2482
  allowMissing?: boolean;
2483
2483
  /**
@@ -2503,7 +2503,7 @@ export interface SyntheticMonitoringCheckSettingsHttpTlsConfig {
2503
2503
  */
2504
2504
  clientKey?: string;
2505
2505
  /**
2506
- * Disable target certificate validation.
2506
+ * Disable target certificate validation. Defaults to `false`.
2507
2507
  */
2508
2508
  insecureSkipVerify?: boolean;
2509
2509
  /**
@@ -2530,7 +2530,7 @@ export interface SyntheticMonitoringCheckSettingsMultihttpEntry {
2530
2530
  }
2531
2531
  export interface SyntheticMonitoringCheckSettingsMultihttpEntryAssertion {
2532
2532
  /**
2533
- * The condition of the assertion: NOT_CONTAINS, EQUALS, STARTS_WITH, ENDS_WITH, TYPE_OF, CONTAINS
2533
+ * The condition of the assertion: NOT*CONTAINS, EQUALS, STARTS*WITH, ENDS*WITH, TYPE*OF, CONTAINS
2534
2534
  */
2535
2535
  condition?: string;
2536
2536
  /**
@@ -2538,11 +2538,11 @@ export interface SyntheticMonitoringCheckSettingsMultihttpEntryAssertion {
2538
2538
  */
2539
2539
  expression?: string;
2540
2540
  /**
2541
- * The subject of the assertion: RESPONSE_HEADERS, HTTP_STATUS_CODE, RESPONSE_BODY
2541
+ * The subject of the assertion: RESPONSE*HEADERS, HTTP*STATUS*CODE, RESPONSE*BODY
2542
2542
  */
2543
2543
  subject?: string;
2544
2544
  /**
2545
- * The type of assertion to make: TEXT, JSON_PATH_VALUE, JSON_PATH_ASSERTION, REGEX_ASSERTION
2545
+ * The type of assertion to make: TEXT, JSON*PATH*VALUE, JSON*PATH*ASSERTION, REGEX_ASSERTION
2546
2546
  */
2547
2547
  type: string;
2548
2548
  /**
@@ -2556,11 +2556,11 @@ export interface SyntheticMonitoringCheckSettingsMultihttpEntryRequest {
2556
2556
  */
2557
2557
  bodies?: outputs.SyntheticMonitoringCheckSettingsMultihttpEntryRequestBody[];
2558
2558
  /**
2559
- * The headers to send with the request
2559
+ * The HTTP headers set for the probe.
2560
2560
  */
2561
2561
  headers?: outputs.SyntheticMonitoringCheckSettingsMultihttpEntryRequestHeader[];
2562
2562
  /**
2563
- * The HTTP method to use
2563
+ * Request method. One of `GET`, `CONNECT`, `DELETE`, `HEAD`, `OPTIONS`, `POST`, `PUT`, `TRACE` Defaults to `GET`.
2564
2564
  */
2565
2565
  method: string;
2566
2566
  /**
@@ -2592,17 +2592,17 @@ export interface SyntheticMonitoringCheckSettingsMultihttpEntryRequestHeader {
2592
2592
  */
2593
2593
  name: string;
2594
2594
  /**
2595
- * Value of the header to send
2595
+ * The value of the assertion
2596
2596
  */
2597
2597
  value: string;
2598
2598
  }
2599
2599
  export interface SyntheticMonitoringCheckSettingsMultihttpEntryRequestQueryField {
2600
2600
  /**
2601
- * Name of the query field to send
2601
+ * Name of the header to send
2602
2602
  */
2603
2603
  name: string;
2604
2604
  /**
2605
- * Value of the query field to send
2605
+ * The value of the assertion
2606
2606
  */
2607
2607
  value: string;
2608
2608
  }
@@ -2612,29 +2612,29 @@ export interface SyntheticMonitoringCheckSettingsMultihttpEntryVariable {
2612
2612
  */
2613
2613
  attribute?: string;
2614
2614
  /**
2615
- * The expression to when finding the variable. Should start with $. Only use when type is JSON_PATH or REGEX
2615
+ * The expression of the assertion. Should start with $.
2616
2616
  */
2617
2617
  expression?: string;
2618
2618
  /**
2619
- * The name of the variable to extract
2619
+ * Name of the header to send
2620
2620
  */
2621
2621
  name?: string;
2622
2622
  /**
2623
- * The method of finding the variable value to extract. JSON_PATH, REGEX, CSS_SELECTOR
2623
+ * The type of assertion to make: TEXT, JSON*PATH*VALUE, JSON*PATH*ASSERTION, REGEX_ASSERTION
2624
2624
  */
2625
2625
  type: string;
2626
2626
  }
2627
2627
  export interface SyntheticMonitoringCheckSettingsPing {
2628
2628
  /**
2629
- * Set the DF-bit in the IP-header. Only works with ipV4.
2629
+ * Set the DF-bit in the IP-header. Only works with ipV4. Defaults to `false`.
2630
2630
  */
2631
2631
  dontFragment?: boolean;
2632
2632
  /**
2633
- * Options are `V4`, `V6`, `Any`. Specifies whether the corresponding check will be performed using IPv4 or IPv6. The `Any` value indicates that IPv6 should be used, falling back to IPv4 if that's not available.
2633
+ * Options are `V4`, `V6`, `Any`. Specifies whether the corresponding check will be performed using IPv4 or IPv6. The `Any` value indicates that IPv6 should be used, falling back to IPv4 if that's not available. Defaults to `V4`.
2634
2634
  */
2635
2635
  ipVersion?: string;
2636
2636
  /**
2637
- * Payload size.
2637
+ * Payload size. Defaults to `0`.
2638
2638
  */
2639
2639
  payloadSize?: number;
2640
2640
  /**
@@ -2644,7 +2644,7 @@ export interface SyntheticMonitoringCheckSettingsPing {
2644
2644
  }
2645
2645
  export interface SyntheticMonitoringCheckSettingsTcp {
2646
2646
  /**
2647
- * Options are `V4`, `V6`, `Any`. Specifies whether the corresponding check will be performed using IPv4 or IPv6. The `Any` value indicates that IPv6 should be used, falling back to IPv4 if that's not available.
2647
+ * Options are `V4`, `V6`, `Any`. Specifies whether the corresponding check will be performed using IPv4 or IPv6. The `Any` value indicates that IPv6 should be used, falling back to IPv4 if that's not available. Defaults to `V4`.
2648
2648
  */
2649
2649
  ipVersion?: string;
2650
2650
  /**
@@ -2656,7 +2656,7 @@ export interface SyntheticMonitoringCheckSettingsTcp {
2656
2656
  */
2657
2657
  sourceIpAddress?: string;
2658
2658
  /**
2659
- * Whether or not TLS is used when the connection is initiated.
2659
+ * Whether or not TLS is used when the connection is initiated. Defaults to `false`.
2660
2660
  */
2661
2661
  tls?: boolean;
2662
2662
  /**
@@ -2674,7 +2674,7 @@ export interface SyntheticMonitoringCheckSettingsTcpQueryResponse {
2674
2674
  */
2675
2675
  send: string;
2676
2676
  /**
2677
- * Upgrade TCP connection to TLS.
2677
+ * Upgrade TCP connection to TLS. Defaults to `false`.
2678
2678
  */
2679
2679
  startTls?: boolean;
2680
2680
  }
@@ -2692,7 +2692,7 @@ export interface SyntheticMonitoringCheckSettingsTcpTlsConfig {
2692
2692
  */
2693
2693
  clientKey?: string;
2694
2694
  /**
2695
- * Disable target certificate validation.
2695
+ * Disable target certificate validation. Defaults to `false`.
2696
2696
  */
2697
2697
  insecureSkipVerify?: boolean;
2698
2698
  /**
@@ -2702,15 +2702,15 @@ export interface SyntheticMonitoringCheckSettingsTcpTlsConfig {
2702
2702
  }
2703
2703
  export interface SyntheticMonitoringCheckSettingsTraceroute {
2704
2704
  /**
2705
- * Maximum TTL for the trace
2705
+ * Maximum TTL for the trace Defaults to `64`.
2706
2706
  */
2707
2707
  maxHops?: number;
2708
2708
  /**
2709
- * Maximum number of hosts to travers that give no response
2709
+ * Maximum number of hosts to travers that give no response Defaults to `15`.
2710
2710
  */
2711
2711
  maxUnknownHops?: number;
2712
2712
  /**
2713
- * Reverse lookup hostnames from IP addresses
2713
+ * Reverse lookup hostnames from IP addresses Defaults to `true`.
2714
2714
  */
2715
2715
  ptrLookup?: boolean;
2716
2716
  }