@pulumi/vault 6.1.0 → 6.1.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 (491) hide show
  1. package/ad/secretBackend.d.ts +1 -3
  2. package/ad/secretBackend.js +1 -3
  3. package/ad/secretBackend.js.map +1 -1
  4. package/ad/secretLibrary.d.ts +1 -2
  5. package/ad/secretLibrary.js +1 -2
  6. package/ad/secretLibrary.js.map +1 -1
  7. package/ad/secretRole.d.ts +0 -2
  8. package/ad/secretRole.js +0 -2
  9. package/ad/secretRole.js.map +1 -1
  10. package/alicloud/authBackendRole.d.ts +30 -83
  11. package/alicloud/authBackendRole.js +3 -5
  12. package/alicloud/authBackendRole.js.map +1 -1
  13. package/approle/authBackendLogin.d.ts +0 -2
  14. package/approle/authBackendLogin.js +0 -2
  15. package/approle/authBackendLogin.js.map +1 -1
  16. package/approle/authBackendRole.d.ts +27 -80
  17. package/approle/authBackendRole.js +0 -2
  18. package/approle/authBackendRole.js.map +1 -1
  19. package/approle/authBackendRoleSecretId.d.ts +0 -2
  20. package/approle/authBackendRoleSecretId.js +0 -2
  21. package/approle/authBackendRoleSecretId.js.map +1 -1
  22. package/approle/getAuthBackendRoleId.d.ts +0 -4
  23. package/approle/getAuthBackendRoleId.js +0 -4
  24. package/approle/getAuthBackendRoleId.js.map +1 -1
  25. package/audit.d.ts +4 -8
  26. package/audit.js +4 -8
  27. package/audit.js.map +1 -1
  28. package/auditRequestHeader.d.ts +4 -3
  29. package/auditRequestHeader.js +4 -3
  30. package/auditRequestHeader.js.map +1 -1
  31. package/aws/authBackendClient.d.ts +3 -5
  32. package/aws/authBackendClient.js +3 -5
  33. package/aws/authBackendClient.js.map +1 -1
  34. package/aws/authBackendConfigIdentity.d.ts +0 -2
  35. package/aws/authBackendConfigIdentity.js +0 -2
  36. package/aws/authBackendConfigIdentity.js.map +1 -1
  37. package/aws/authBackendIdentityWhitelist.d.ts +3 -5
  38. package/aws/authBackendIdentityWhitelist.js +3 -5
  39. package/aws/authBackendIdentityWhitelist.js.map +1 -1
  40. package/aws/authBackendLogin.d.ts +0 -6
  41. package/aws/authBackendLogin.js.map +1 -1
  42. package/aws/authBackendRole.d.ts +27 -80
  43. package/aws/authBackendRole.js +0 -2
  44. package/aws/authBackendRole.js.map +1 -1
  45. package/aws/authBackendRoletagBlacklist.d.ts +3 -5
  46. package/aws/authBackendRoletagBlacklist.js +3 -5
  47. package/aws/authBackendRoletagBlacklist.js.map +1 -1
  48. package/aws/authBackendStsRole.d.ts +0 -2
  49. package/aws/authBackendStsRole.js +0 -2
  50. package/aws/authBackendStsRole.js.map +1 -1
  51. package/aws/secretBackend.d.ts +27 -0
  52. package/aws/secretBackend.js.map +1 -1
  53. package/aws/secretBackendRole.d.ts +1 -2
  54. package/aws/secretBackendRole.js +1 -2
  55. package/aws/secretBackendRole.js.map +1 -1
  56. package/aws/secretBackendStaticRole.d.ts +1 -2
  57. package/aws/secretBackendStaticRole.js +1 -2
  58. package/aws/secretBackendStaticRole.js.map +1 -1
  59. package/azure/authBackendConfig.d.ts +3 -5
  60. package/azure/authBackendConfig.js +3 -5
  61. package/azure/authBackendConfig.js.map +1 -1
  62. package/azure/authBackendRole.d.ts +27 -80
  63. package/azure/authBackendRole.js +0 -2
  64. package/azure/authBackendRole.js.map +1 -1
  65. package/azure/backend.d.ts +6 -10
  66. package/azure/backend.js +6 -10
  67. package/azure/backend.js.map +1 -1
  68. package/azure/backendRole.d.ts +7 -9
  69. package/azure/backendRole.js +7 -9
  70. package/azure/backendRole.js.map +1 -1
  71. package/azure/getAccessCredentials.d.ts +0 -4
  72. package/azure/getAccessCredentials.js +0 -4
  73. package/azure/getAccessCredentials.js.map +1 -1
  74. package/certAuthBackendRole.d.ts +35 -91
  75. package/certAuthBackendRole.js +8 -7
  76. package/certAuthBackendRole.js.map +1 -1
  77. package/consul/secretBackend.d.ts +4 -8
  78. package/consul/secretBackend.js +4 -8
  79. package/consul/secretBackend.js.map +1 -1
  80. package/consul/secretBackendRole.d.ts +1 -2
  81. package/consul/secretBackendRole.js +1 -2
  82. package/consul/secretBackendRole.js.map +1 -1
  83. package/database/secretBackendConnection.d.ts +1 -2
  84. package/database/secretBackendConnection.js +1 -2
  85. package/database/secretBackendConnection.js.map +1 -1
  86. package/database/secretBackendRole.d.ts +2 -2
  87. package/database/secretBackendRole.js +2 -2
  88. package/database/secretBackendStaticRole.d.ts +5 -4
  89. package/database/secretBackendStaticRole.js +5 -4
  90. package/database/secretBackendStaticRole.js.map +1 -1
  91. package/database/secretsMount.d.ts +2 -2
  92. package/database/secretsMount.js +2 -2
  93. package/egpPolicy.d.ts +2 -4
  94. package/egpPolicy.js +2 -4
  95. package/egpPolicy.js.map +1 -1
  96. package/gcp/authBackend.d.ts +0 -20
  97. package/gcp/authBackend.js +0 -20
  98. package/gcp/authBackend.js.map +1 -1
  99. package/gcp/authBackendRole.d.ts +27 -134
  100. package/gcp/authBackendRole.js +0 -2
  101. package/gcp/authBackendRole.js.map +1 -1
  102. package/gcp/getAuthBackendRole.d.ts +0 -4
  103. package/gcp/getAuthBackendRole.js +0 -4
  104. package/gcp/getAuthBackendRole.js.map +1 -1
  105. package/gcp/secretBackend.d.ts +4 -4
  106. package/gcp/secretBackend.js +4 -4
  107. package/gcp/secretImpersonatedAccount.d.ts +7 -7
  108. package/gcp/secretImpersonatedAccount.js +7 -7
  109. package/gcp/secretRoleset.d.ts +4 -4
  110. package/gcp/secretRoleset.js +4 -4
  111. package/gcp/secretStaticAccount.d.ts +8 -8
  112. package/gcp/secretStaticAccount.js +8 -8
  113. package/generic/endpoint.d.ts +2 -4
  114. package/generic/endpoint.js +2 -4
  115. package/generic/endpoint.js.map +1 -1
  116. package/generic/getSecret.d.ts +44 -4
  117. package/generic/getSecret.js +44 -4
  118. package/generic/getSecret.js.map +1 -1
  119. package/getAuthBackend.d.ts +0 -4
  120. package/getAuthBackend.js +0 -4
  121. package/getAuthBackend.js.map +1 -1
  122. package/getAuthBackends.d.ts +0 -8
  123. package/getAuthBackends.js +0 -8
  124. package/getAuthBackends.js.map +1 -1
  125. package/getNamespace.d.ts +0 -12
  126. package/getNamespace.js +0 -12
  127. package/getNamespace.js.map +1 -1
  128. package/getNamespaces.d.ts +4 -12
  129. package/getNamespaces.js +4 -12
  130. package/getNamespaces.js.map +1 -1
  131. package/getNomadAccessToken.d.ts +0 -4
  132. package/getNomadAccessToken.js +0 -4
  133. package/getNomadAccessToken.js.map +1 -1
  134. package/getPolicyDocument.d.ts +10 -8
  135. package/getPolicyDocument.js +10 -8
  136. package/getPolicyDocument.js.map +1 -1
  137. package/getRaftAutopilotState.d.ts +0 -4
  138. package/getRaftAutopilotState.js +0 -4
  139. package/getRaftAutopilotState.js.map +1 -1
  140. package/github/authBackend.d.ts +0 -2
  141. package/github/authBackend.js +0 -2
  142. package/github/authBackend.js.map +1 -1
  143. package/github/team.d.ts +1 -3
  144. package/github/team.js +1 -3
  145. package/github/team.js.map +1 -1
  146. package/github/user.d.ts +1 -3
  147. package/github/user.js +1 -3
  148. package/github/user.js.map +1 -1
  149. package/identity/entity.d.ts +2 -3
  150. package/identity/entity.js +2 -3
  151. package/identity/entity.js.map +1 -1
  152. package/identity/entityAlias.d.ts +2 -3
  153. package/identity/entityAlias.js +2 -3
  154. package/identity/entityAlias.js.map +1 -1
  155. package/identity/entityPolicies.d.ts +8 -6
  156. package/identity/entityPolicies.js +8 -6
  157. package/identity/entityPolicies.js.map +1 -1
  158. package/identity/getEntity.d.ts +0 -4
  159. package/identity/getEntity.js +0 -4
  160. package/identity/getEntity.js.map +1 -1
  161. package/identity/getGroup.d.ts +0 -4
  162. package/identity/getGroup.js +0 -4
  163. package/identity/getGroup.js.map +1 -1
  164. package/identity/getOidcClientCreds.d.ts +2 -4
  165. package/identity/getOidcClientCreds.js +2 -4
  166. package/identity/getOidcClientCreds.js.map +1 -1
  167. package/identity/getOidcOpenidConfig.d.ts +12 -6
  168. package/identity/getOidcOpenidConfig.js +12 -6
  169. package/identity/getOidcOpenidConfig.js.map +1 -1
  170. package/identity/getOidcPublicKeys.d.ts +12 -6
  171. package/identity/getOidcPublicKeys.js +12 -6
  172. package/identity/getOidcPublicKeys.js.map +1 -1
  173. package/identity/group.d.ts +18 -20
  174. package/identity/group.js +18 -20
  175. package/identity/group.js.map +1 -1
  176. package/identity/groupAlias.d.ts +1 -2
  177. package/identity/groupAlias.js +1 -2
  178. package/identity/groupAlias.js.map +1 -1
  179. package/identity/groupMemberEntityIds.d.ts +6 -8
  180. package/identity/groupMemberEntityIds.js +6 -8
  181. package/identity/groupMemberEntityIds.js.map +1 -1
  182. package/identity/groupMemberGroupIds.d.ts +14 -10
  183. package/identity/groupMemberGroupIds.js +14 -10
  184. package/identity/groupMemberGroupIds.js.map +1 -1
  185. package/identity/groupPolicies.d.ts +2 -4
  186. package/identity/groupPolicies.js +2 -4
  187. package/identity/groupPolicies.js.map +1 -1
  188. package/identity/mfaDuo.d.ts +1 -3
  189. package/identity/mfaDuo.js +1 -3
  190. package/identity/mfaDuo.js.map +1 -1
  191. package/identity/mfaLoginEnforcement.d.ts +5 -4
  192. package/identity/mfaLoginEnforcement.js +5 -4
  193. package/identity/mfaLoginEnforcement.js.map +1 -1
  194. package/identity/mfaOkta.d.ts +1 -3
  195. package/identity/mfaOkta.js +1 -3
  196. package/identity/mfaOkta.js.map +1 -1
  197. package/identity/mfaPingid.d.ts +0 -2
  198. package/identity/mfaPingid.js +0 -2
  199. package/identity/mfaPingid.js.map +1 -1
  200. package/identity/mfaTotp.d.ts +0 -2
  201. package/identity/mfaTotp.js +0 -2
  202. package/identity/mfaTotp.js.map +1 -1
  203. package/identity/oidc.d.ts +0 -2
  204. package/identity/oidc.js +0 -2
  205. package/identity/oidc.js.map +1 -1
  206. package/identity/oidcAssignment.d.ts +6 -3
  207. package/identity/oidcAssignment.js +6 -3
  208. package/identity/oidcAssignment.js.map +1 -1
  209. package/identity/oidcClient.d.ts +5 -5
  210. package/identity/oidcClient.js +5 -5
  211. package/identity/oidcKey.d.ts +10 -6
  212. package/identity/oidcKey.js +10 -6
  213. package/identity/oidcKey.js.map +1 -1
  214. package/identity/oidcKeyAllowedClientID.d.ts +10 -6
  215. package/identity/oidcKeyAllowedClientID.js +10 -6
  216. package/identity/oidcKeyAllowedClientID.js.map +1 -1
  217. package/identity/oidcProvider.d.ts +11 -8
  218. package/identity/oidcProvider.js +11 -8
  219. package/identity/oidcProvider.js.map +1 -1
  220. package/identity/oidcRole.d.ts +17 -10
  221. package/identity/oidcRole.js +17 -10
  222. package/identity/oidcRole.js.map +1 -1
  223. package/identity/oidcScope.d.ts +2 -3
  224. package/identity/oidcScope.js +2 -3
  225. package/identity/oidcScope.js.map +1 -1
  226. package/jwt/authBackend.d.ts +8 -14
  227. package/jwt/authBackend.js +8 -14
  228. package/jwt/authBackend.js.map +1 -1
  229. package/jwt/authBackendRole.d.ts +27 -82
  230. package/jwt/authBackendRole.js +0 -4
  231. package/jwt/authBackendRole.js.map +1 -1
  232. package/kmip/secretBackend.d.ts +5 -7
  233. package/kmip/secretBackend.js +5 -7
  234. package/kmip/secretBackend.js.map +1 -1
  235. package/kmip/secretRole.d.ts +0 -2
  236. package/kmip/secretRole.js +0 -2
  237. package/kmip/secretRole.js.map +1 -1
  238. package/kmip/secretScope.d.ts +0 -2
  239. package/kmip/secretScope.js +0 -2
  240. package/kmip/secretScope.js.map +1 -1
  241. package/kubernetes/authBackendConfig.d.ts +0 -2
  242. package/kubernetes/authBackendConfig.js +0 -2
  243. package/kubernetes/authBackendConfig.js.map +1 -1
  244. package/kubernetes/authBackendRole.d.ts +24 -74
  245. package/kubernetes/authBackendRole.js +0 -2
  246. package/kubernetes/authBackendRole.js.map +1 -1
  247. package/kubernetes/getServiceAccountToken.d.ts +16 -10
  248. package/kubernetes/getServiceAccountToken.js +16 -10
  249. package/kubernetes/getServiceAccountToken.js.map +1 -1
  250. package/kubernetes/secretBackend.d.ts +7 -5
  251. package/kubernetes/secretBackend.js +7 -5
  252. package/kubernetes/secretBackend.js.map +1 -1
  253. package/kubernetes/secretBackendRole.d.ts +24 -15
  254. package/kubernetes/secretBackendRole.js +24 -15
  255. package/kubernetes/secretBackendRole.js.map +1 -1
  256. package/kv/getSecret.d.ts +0 -4
  257. package/kv/getSecret.js +0 -4
  258. package/kv/getSecret.js.map +1 -1
  259. package/kv/getSecretSubkeysV2.d.ts +4 -6
  260. package/kv/getSecretSubkeysV2.js +4 -6
  261. package/kv/getSecretSubkeysV2.js.map +1 -1
  262. package/kv/getSecretV2.d.ts +64 -0
  263. package/kv/getSecretV2.js +64 -0
  264. package/kv/getSecretV2.js.map +1 -1
  265. package/kv/getSecretsList.d.ts +4 -8
  266. package/kv/getSecretsList.js +4 -8
  267. package/kv/getSecretsList.js.map +1 -1
  268. package/kv/getSecretsListV2.d.ts +14 -12
  269. package/kv/getSecretsListV2.js +14 -12
  270. package/kv/getSecretsListV2.js.map +1 -1
  271. package/kv/secret.d.ts +0 -2
  272. package/kv/secret.js +0 -2
  273. package/kv/secret.js.map +1 -1
  274. package/kv/secretBackendV2.d.ts +0 -2
  275. package/kv/secretBackendV2.js +0 -2
  276. package/kv/secretBackendV2.js.map +1 -1
  277. package/kv/secretV2.d.ts +1 -2
  278. package/kv/secretV2.js +1 -2
  279. package/kv/secretV2.js.map +1 -1
  280. package/ldap/authBackend.d.ts +29 -70
  281. package/ldap/authBackend.js +5 -7
  282. package/ldap/authBackend.js.map +1 -1
  283. package/ldap/authBackendGroup.d.ts +0 -2
  284. package/ldap/authBackendGroup.js +0 -2
  285. package/ldap/authBackendGroup.js.map +1 -1
  286. package/ldap/authBackendUser.d.ts +0 -2
  287. package/ldap/authBackendUser.js +0 -2
  288. package/ldap/authBackendUser.js.map +1 -1
  289. package/ldap/secretBackend.d.ts +2 -4
  290. package/ldap/secretBackend.js +2 -4
  291. package/ldap/secretBackend.js.map +1 -1
  292. package/ldap/secretBackendDynamicRole.d.ts +0 -2
  293. package/ldap/secretBackendDynamicRole.js +0 -2
  294. package/ldap/secretBackendDynamicRole.js.map +1 -1
  295. package/ldap/secretBackendLibrarySet.d.ts +1 -2
  296. package/ldap/secretBackendLibrarySet.js +1 -2
  297. package/ldap/secretBackendLibrarySet.js.map +1 -1
  298. package/ldap/secretBackendStaticRole.d.ts +0 -2
  299. package/ldap/secretBackendStaticRole.js +0 -2
  300. package/ldap/secretBackendStaticRole.js.map +1 -1
  301. package/managed/keys.d.ts +3 -12
  302. package/managed/keys.js.map +1 -1
  303. package/mfaDuo.d.ts +2 -3
  304. package/mfaDuo.js +2 -3
  305. package/mfaDuo.js.map +1 -1
  306. package/mfaOkta.d.ts +2 -3
  307. package/mfaOkta.js +2 -3
  308. package/mfaOkta.js.map +1 -1
  309. package/mfaPingid.d.ts +2 -3
  310. package/mfaPingid.js +2 -3
  311. package/mfaPingid.js.map +1 -1
  312. package/mfaTotp.d.ts +4 -5
  313. package/mfaTotp.js +4 -5
  314. package/mfaTotp.js.map +1 -1
  315. package/mongodbatlas/secretBackend.d.ts +0 -2
  316. package/mongodbatlas/secretBackend.js +0 -2
  317. package/mongodbatlas/secretBackend.js.map +1 -1
  318. package/mongodbatlas/secretRole.d.ts +1 -2
  319. package/mongodbatlas/secretRole.js +1 -2
  320. package/mongodbatlas/secretRole.js.map +1 -1
  321. package/mount.d.ts +10 -18
  322. package/mount.js +10 -18
  323. package/mount.js.map +1 -1
  324. package/nomadSecretBackend.d.ts +2 -4
  325. package/nomadSecretBackend.js +2 -4
  326. package/nomadSecretBackend.js.map +1 -1
  327. package/nomadSecretRole.d.ts +0 -2
  328. package/nomadSecretRole.js +0 -2
  329. package/nomadSecretRole.js.map +1 -1
  330. package/okta/authBackend.d.ts +3 -5
  331. package/okta/authBackend.js +3 -5
  332. package/okta/authBackend.js.map +1 -1
  333. package/okta/authBackendGroup.d.ts +0 -2
  334. package/okta/authBackendGroup.js +0 -2
  335. package/okta/authBackendGroup.js.map +1 -1
  336. package/okta/authBackendUser.d.ts +0 -2
  337. package/okta/authBackendUser.js +0 -2
  338. package/okta/authBackendUser.js.map +1 -1
  339. package/package.json +3 -2
  340. package/passwordPolicy.d.ts +5 -5
  341. package/passwordPolicy.js +5 -5
  342. package/pkisecret/backendConfigCluster.d.ts +0 -2
  343. package/pkisecret/backendConfigCluster.js +0 -2
  344. package/pkisecret/backendConfigCluster.js.map +1 -1
  345. package/pkisecret/getBackendIssuer.d.ts +44 -0
  346. package/pkisecret/getBackendIssuer.js +44 -0
  347. package/pkisecret/getBackendIssuer.js.map +1 -1
  348. package/pkisecret/getBackendIssuers.d.ts +0 -4
  349. package/pkisecret/getBackendIssuers.js +0 -4
  350. package/pkisecret/getBackendIssuers.js.map +1 -1
  351. package/pkisecret/getBackendKey.d.ts +2 -6
  352. package/pkisecret/getBackendKey.js +2 -6
  353. package/pkisecret/getBackendKey.js.map +1 -1
  354. package/pkisecret/getBackendKeys.d.ts +0 -4
  355. package/pkisecret/getBackendKeys.js +0 -4
  356. package/pkisecret/getBackendKeys.js.map +1 -1
  357. package/pkisecret/secretBackendCert.d.ts +3 -4
  358. package/pkisecret/secretBackendCert.js +3 -4
  359. package/pkisecret/secretBackendCert.js.map +1 -1
  360. package/pkisecret/secretBackendConfigCa.d.ts +2 -4
  361. package/pkisecret/secretBackendConfigCa.js +2 -4
  362. package/pkisecret/secretBackendConfigCa.js.map +1 -1
  363. package/pkisecret/secretBackendConfigIssuers.d.ts +0 -2
  364. package/pkisecret/secretBackendConfigIssuers.js +0 -2
  365. package/pkisecret/secretBackendConfigIssuers.js.map +1 -1
  366. package/pkisecret/secretBackendConfigUrls.d.ts +0 -2
  367. package/pkisecret/secretBackendConfigUrls.js +0 -2
  368. package/pkisecret/secretBackendConfigUrls.js.map +1 -1
  369. package/pkisecret/secretBackendCrlConfig.d.ts +1 -3
  370. package/pkisecret/secretBackendCrlConfig.js +1 -3
  371. package/pkisecret/secretBackendCrlConfig.js.map +1 -1
  372. package/pkisecret/secretBackendIntermediateCertRequest.d.ts +2 -4
  373. package/pkisecret/secretBackendIntermediateCertRequest.js +2 -4
  374. package/pkisecret/secretBackendIntermediateCertRequest.js.map +1 -1
  375. package/pkisecret/secretBackendIntermediateSetSigned.d.ts +5 -7
  376. package/pkisecret/secretBackendIntermediateSetSigned.js +5 -7
  377. package/pkisecret/secretBackendIntermediateSetSigned.js.map +1 -1
  378. package/pkisecret/secretBackendIssuer.d.ts +0 -2
  379. package/pkisecret/secretBackendIssuer.js +0 -2
  380. package/pkisecret/secretBackendIssuer.js.map +1 -1
  381. package/pkisecret/secretBackendRole.d.ts +1 -2
  382. package/pkisecret/secretBackendRole.js +1 -2
  383. package/pkisecret/secretBackendRole.js.map +1 -1
  384. package/pkisecret/secretBackendRootCert.d.ts +2 -4
  385. package/pkisecret/secretBackendRootCert.js +2 -4
  386. package/pkisecret/secretBackendRootCert.js.map +1 -1
  387. package/pkisecret/secretBackendRootSignIntermediate.d.ts +3 -5
  388. package/pkisecret/secretBackendRootSignIntermediate.js +3 -5
  389. package/pkisecret/secretBackendRootSignIntermediate.js.map +1 -1
  390. package/pkisecret/secretBackendSign.d.ts +3 -4
  391. package/pkisecret/secretBackendSign.js +3 -4
  392. package/pkisecret/secretBackendSign.js.map +1 -1
  393. package/provider.d.ts +0 -6
  394. package/provider.js.map +1 -1
  395. package/quotaLeaseCount.d.ts +2 -3
  396. package/quotaLeaseCount.js +2 -3
  397. package/quotaLeaseCount.js.map +1 -1
  398. package/quotaRateLimit.d.ts +1 -2
  399. package/quotaRateLimit.js +1 -2
  400. package/quotaRateLimit.js.map +1 -1
  401. package/rabbitmq/secretBackend.d.ts +1 -3
  402. package/rabbitmq/secretBackend.js +1 -3
  403. package/rabbitmq/secretBackend.js.map +1 -1
  404. package/rabbitmq/secretBackendRole.d.ts +1 -2
  405. package/rabbitmq/secretBackendRole.js +1 -2
  406. package/rabbitmq/secretBackendRole.js.map +1 -1
  407. package/raftAutopilot.d.ts +0 -2
  408. package/raftAutopilot.js +0 -2
  409. package/raftAutopilot.js.map +1 -1
  410. package/raftSnapshotAgentConfig.d.ts +44 -128
  411. package/raftSnapshotAgentConfig.js +8 -11
  412. package/raftSnapshotAgentConfig.js.map +1 -1
  413. package/rgpPolicy.d.ts +1 -3
  414. package/rgpPolicy.js +1 -3
  415. package/rgpPolicy.js.map +1 -1
  416. package/saml/authBackend.d.ts +3 -5
  417. package/saml/authBackend.js +3 -5
  418. package/saml/authBackend.js.map +1 -1
  419. package/saml/authBackendRole.d.ts +28 -77
  420. package/saml/authBackendRole.js +4 -5
  421. package/saml/authBackendRole.js.map +1 -1
  422. package/secrets/syncAssociation.d.ts +6 -5
  423. package/secrets/syncAssociation.js +6 -5
  424. package/secrets/syncAssociation.js.map +1 -1
  425. package/secrets/syncAwsDestination.d.ts +3 -4
  426. package/secrets/syncAwsDestination.js +3 -4
  427. package/secrets/syncAwsDestination.js.map +1 -1
  428. package/secrets/syncAzureDestination.d.ts +5 -6
  429. package/secrets/syncAzureDestination.js +5 -6
  430. package/secrets/syncAzureDestination.js.map +1 -1
  431. package/secrets/syncConfig.d.ts +1 -3
  432. package/secrets/syncConfig.js +1 -3
  433. package/secrets/syncConfig.js.map +1 -1
  434. package/secrets/syncGcpDestination.d.ts +5 -4
  435. package/secrets/syncGcpDestination.js +5 -4
  436. package/secrets/syncGcpDestination.js.map +1 -1
  437. package/secrets/syncGhDestination.d.ts +3 -4
  438. package/secrets/syncGhDestination.js +3 -4
  439. package/secrets/syncGhDestination.js.map +1 -1
  440. package/secrets/syncGithubApps.d.ts +6 -5
  441. package/secrets/syncGithubApps.js +6 -5
  442. package/secrets/syncGithubApps.js.map +1 -1
  443. package/secrets/syncVercelDestination.d.ts +3 -4
  444. package/secrets/syncVercelDestination.js +3 -4
  445. package/secrets/syncVercelDestination.js.map +1 -1
  446. package/ssh/secretBackendCa.d.ts +3 -5
  447. package/ssh/secretBackendCa.js +0 -2
  448. package/ssh/secretBackendCa.js.map +1 -1
  449. package/ssh/secretBackendRole.d.ts +2 -2
  450. package/ssh/secretBackendRole.js +2 -2
  451. package/terraformcloud/secretBackend.d.ts +0 -38
  452. package/terraformcloud/secretBackend.js +0 -2
  453. package/terraformcloud/secretBackend.js.map +1 -1
  454. package/terraformcloud/secretCreds.d.ts +1 -11
  455. package/terraformcloud/secretCreds.js +1 -2
  456. package/terraformcloud/secretCreds.js.map +1 -1
  457. package/terraformcloud/secretRole.d.ts +1 -47
  458. package/terraformcloud/secretRole.js +1 -2
  459. package/terraformcloud/secretRole.js.map +1 -1
  460. package/token.d.ts +6 -8
  461. package/token.js +6 -8
  462. package/token.js.map +1 -1
  463. package/tokenauth/authBackendRole.d.ts +28 -78
  464. package/tokenauth/authBackendRole.js +4 -6
  465. package/tokenauth/authBackendRole.js.map +1 -1
  466. package/transform/alphabet.d.ts +2 -3
  467. package/transform/alphabet.js +2 -3
  468. package/transform/alphabet.js.map +1 -1
  469. package/transform/getDecode.d.ts +4 -4
  470. package/transform/getDecode.js +4 -4
  471. package/transform/getEncode.d.ts +4 -4
  472. package/transform/getEncode.js +4 -4
  473. package/transform/role.d.ts +2 -3
  474. package/transform/role.js +2 -3
  475. package/transform/role.js.map +1 -1
  476. package/transform/template.d.ts +2 -2
  477. package/transform/template.js +2 -2
  478. package/transit/getDecrypt.d.ts +2 -30
  479. package/transit/getDecrypt.js +2 -6
  480. package/transit/getDecrypt.js.map +1 -1
  481. package/transit/getEncrypt.d.ts +0 -30
  482. package/transit/getEncrypt.js.map +1 -1
  483. package/transit/secretBackendKey.d.ts +4 -3
  484. package/transit/secretBackendKey.js +4 -3
  485. package/transit/secretBackendKey.js.map +1 -1
  486. package/transit/secretCacheConfig.d.ts +0 -2
  487. package/transit/secretCacheConfig.js +0 -2
  488. package/transit/secretCacheConfig.js.map +1 -1
  489. package/types/input.d.ts +310 -502
  490. package/types/output.d.ts +310 -490
  491. package/package.json.bak +0 -27
package/types/output.d.ts CHANGED
@@ -78,23 +78,11 @@ export interface GetPolicyDocumentRule {
78
78
  requiredParameters?: string[];
79
79
  }
80
80
  export interface GetPolicyDocumentRuleAllowedParameter {
81
- /**
82
- * name of permitted or denied parameter.
83
- */
84
81
  key: string;
85
- /**
86
- * list of values what are permitted or denied by policy rule.
87
- */
88
82
  values: string[];
89
83
  }
90
84
  export interface GetPolicyDocumentRuleDeniedParameter {
91
- /**
92
- * name of permitted or denied parameter.
93
- */
94
85
  key: string;
95
- /**
96
- * list of values what are permitted or denied by policy rule.
97
- */
98
86
  values: string[];
99
87
  }
100
88
  export declare namespace azure {
@@ -508,35 +496,31 @@ export declare namespace config {
508
496
  export declare namespace database {
509
497
  interface SecretBackendConnectionCassandra {
510
498
  /**
511
- * The number of seconds to use as a connection
512
- * timeout.
499
+ * The number of seconds to use as a connection timeout.
513
500
  */
514
501
  connectTimeout?: number;
515
502
  /**
516
- * The hosts to connect to.
503
+ * Cassandra hosts to connect to.
517
504
  */
518
505
  hosts?: string[];
519
506
  /**
520
- * Whether to skip verification of the server
521
- * certificate when using TLS.
507
+ * Whether to skip verification of the server certificate when using TLS.
522
508
  */
523
509
  insecureTls?: boolean;
524
510
  /**
525
- * The password to authenticate with.
511
+ * The password to use when authenticating with Cassandra.
526
512
  */
527
513
  password?: string;
528
514
  /**
529
- * Concatenated PEM blocks configuring the certificate
530
- * chain.
515
+ * Concatenated PEM blocks containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
531
516
  */
532
517
  pemBundle?: string;
533
518
  /**
534
- * A JSON structure configuring the certificate chain.
519
+ * Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
535
520
  */
536
521
  pemJson?: string;
537
522
  /**
538
- * The default port to connect to if no port is specified as
539
- * part of the host.
523
+ * The transport port to use to connect to Cassandra.
540
524
  */
541
525
  port?: number;
542
526
  /**
@@ -548,7 +532,7 @@ export declare namespace database {
548
532
  */
549
533
  tls?: boolean;
550
534
  /**
551
- * The username to authenticate with.
535
+ * The username to use when authenticating with Cassandra.
552
536
  */
553
537
  username?: string;
554
538
  }
@@ -562,24 +546,23 @@ export declare namespace database {
562
546
  */
563
547
  bucketName?: string;
564
548
  /**
565
- * The hosts to connect to.
549
+ * A set of Couchbase URIs to connect to. Must use `couchbases://` scheme if `tls` is `true`.
566
550
  */
567
551
  hosts: string[];
568
552
  /**
569
- * Whether to skip verification of the server
570
- * certificate when using TLS.
553
+ * Specifies whether to skip verification of the server certificate when using TLS.
571
554
  */
572
555
  insecureTls?: boolean;
573
556
  /**
574
- * The password to authenticate with.
557
+ * Specifies the password corresponding to the given username.
575
558
  */
576
559
  password: string;
577
560
  /**
578
- * Whether to use TLS when connecting to Cassandra.
561
+ * Specifies whether to use TLS when connecting to Couchbase.
579
562
  */
580
563
  tls?: boolean;
581
564
  /**
582
- * The username to authenticate with.
565
+ * Specifies the username for Vault to use.
583
566
  */
584
567
  username: string;
585
568
  /**
@@ -589,40 +572,39 @@ export declare namespace database {
589
572
  }
590
573
  interface SecretBackendConnectionElasticsearch {
591
574
  /**
592
- * The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.
575
+ * The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity
593
576
  */
594
577
  caCert?: string;
595
578
  /**
596
- * The path to a directory of PEM-encoded CA cert files to use to verify the Elasticsearch server's identity.
579
+ * The path to a directory of PEM-encoded CA cert files to use to verify the Elasticsearch server's identity
597
580
  */
598
581
  caPath?: string;
599
582
  /**
600
- * The path to the certificate for the Elasticsearch client to present for communication.
583
+ * The path to the certificate for the Elasticsearch client to present for communication
601
584
  */
602
585
  clientCert?: string;
603
586
  /**
604
- * The path to the key for the Elasticsearch client to use for communication.
587
+ * The path to the key for the Elasticsearch client to use for communication
605
588
  */
606
589
  clientKey?: string;
607
590
  /**
608
- * Whether to disable certificate verification.
591
+ * Whether to disable certificate verification
609
592
  */
610
593
  insecure?: boolean;
611
594
  /**
612
- * The password to authenticate with.
595
+ * The password to be used in the connection URL
613
596
  */
614
597
  password: string;
615
598
  /**
616
- * This, if set, is used to set the SNI host when connecting via TLS.
599
+ * This, if set, is used to set the SNI host when connecting via TLS
617
600
  */
618
601
  tlsServerName?: string;
619
602
  /**
620
- * The URL for Elasticsearch's API. https requires certificate
621
- * by trusted CA if used.
603
+ * The URL for Elasticsearch's API
622
604
  */
623
605
  url: string;
624
606
  /**
625
- * The username to authenticate with.
607
+ * The username to be used in the connection URL
626
608
  */
627
609
  username: string;
628
610
  /**
@@ -632,79 +614,69 @@ export declare namespace database {
632
614
  }
633
615
  interface SecretBackendConnectionHana {
634
616
  /**
635
- * A URL containing connection information. See
636
- * the [Vault
637
- * docs](https://www.vaultproject.io/api-docs/secret/databases/mongodb.html#sample-payload)
638
- * for an example.
617
+ * Connection string to use to connect to the database.
639
618
  */
640
619
  connectionUrl?: string;
641
620
  /**
642
- * Disable special character escaping in username and password.
621
+ * Disable special character escaping in username and password
643
622
  */
644
623
  disableEscaping?: boolean;
645
624
  /**
646
- * The maximum number of seconds to keep
647
- * a connection alive for.
625
+ * Maximum number of seconds a connection may be reused.
648
626
  */
649
627
  maxConnectionLifetime?: number;
650
628
  /**
651
- * The maximum number of idle connections to
652
- * maintain.
629
+ * Maximum number of idle connections to the database.
653
630
  */
654
631
  maxIdleConnections?: number;
655
632
  /**
656
- * The maximum number of open connections to
657
- * use.
633
+ * Maximum number of open connections to the database.
658
634
  */
659
635
  maxOpenConnections?: number;
660
636
  /**
661
- * The password to authenticate with.
637
+ * The root credential password used in the connection URL
662
638
  */
663
639
  password?: string;
664
640
  /**
665
- * The username to authenticate with.
641
+ * The root credential username used in the connection URL
666
642
  */
667
643
  username?: string;
668
644
  }
669
645
  interface SecretBackendConnectionInfluxdb {
670
646
  /**
671
- * The number of seconds to use as a connection
672
- * timeout.
647
+ * The number of seconds to use as a connection timeout.
673
648
  */
674
649
  connectTimeout?: number;
675
650
  /**
676
- * The host to connect to.
651
+ * Influxdb host to connect to.
677
652
  */
678
653
  host: string;
679
654
  /**
680
- * Whether to skip verification of the server
681
- * certificate when using TLS.
655
+ * Whether to skip verification of the server certificate when using TLS.
682
656
  */
683
657
  insecureTls?: boolean;
684
658
  /**
685
- * The password to authenticate with.
659
+ * Specifies the password corresponding to the given username.
686
660
  */
687
661
  password: string;
688
662
  /**
689
- * Concatenated PEM blocks configuring the certificate
690
- * chain.
663
+ * Concatenated PEM blocks containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
691
664
  */
692
665
  pemBundle?: string;
693
666
  /**
694
- * A JSON structure configuring the certificate chain.
667
+ * Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
695
668
  */
696
669
  pemJson?: string;
697
670
  /**
698
- * The default port to connect to if no port is specified as
699
- * part of the host.
671
+ * The transport port to use to connect to Influxdb.
700
672
  */
701
673
  port?: number;
702
674
  /**
703
- * Whether to use TLS when connecting to Cassandra.
675
+ * Whether to use TLS when connecting to Influxdb.
704
676
  */
705
677
  tls?: boolean;
706
678
  /**
707
- * The username to authenticate with.
679
+ * Specifies the username to use for superuser access.
708
680
  */
709
681
  username: string;
710
682
  /**
@@ -714,37 +686,31 @@ export declare namespace database {
714
686
  }
715
687
  interface SecretBackendConnectionMongodb {
716
688
  /**
717
- * A URL containing connection information. See
718
- * the [Vault
719
- * docs](https://www.vaultproject.io/api-docs/secret/databases/mongodb.html#sample-payload)
720
- * for an example.
689
+ * Connection string to use to connect to the database.
721
690
  */
722
691
  connectionUrl?: string;
723
692
  /**
724
- * The maximum number of seconds to keep
725
- * a connection alive for.
693
+ * Maximum number of seconds a connection may be reused.
726
694
  */
727
695
  maxConnectionLifetime?: number;
728
696
  /**
729
- * The maximum number of idle connections to
730
- * maintain.
697
+ * Maximum number of idle connections to the database.
731
698
  */
732
699
  maxIdleConnections?: number;
733
700
  /**
734
- * The maximum number of open connections to
735
- * use.
701
+ * Maximum number of open connections to the database.
736
702
  */
737
703
  maxOpenConnections?: number;
738
704
  /**
739
- * The password to authenticate with.
705
+ * The root credential password used in the connection URL
740
706
  */
741
707
  password?: string;
742
708
  /**
743
- * The username to authenticate with.
709
+ * The root credential username used in the connection URL
744
710
  */
745
711
  username?: string;
746
712
  /**
747
- * Template describing how dynamic usernames are generated.
713
+ * Username generation template.
748
714
  */
749
715
  usernameTemplate?: string;
750
716
  }
@@ -764,84 +730,69 @@ export declare namespace database {
764
730
  }
765
731
  interface SecretBackendConnectionMssql {
766
732
  /**
767
- * A URL containing connection information. See
768
- * the [Vault
769
- * docs](https://www.vaultproject.io/api-docs/secret/databases/mongodb.html#sample-payload)
770
- * for an example.
733
+ * Connection string to use to connect to the database.
771
734
  */
772
735
  connectionUrl?: string;
773
736
  /**
774
- * For Vault v1.9+. Set to true when the target is a
775
- * Contained Database, e.g. AzureSQL.
776
- * See the [Vault
777
- * docs](https://www.vaultproject.io/api/secret/databases/mssql#contained_db)
737
+ * Set to true when the target is a Contained Database, e.g. AzureSQL.
778
738
  */
779
739
  containedDb?: boolean;
780
740
  /**
781
- * Disable special character escaping in username and password.
741
+ * Disable special character escaping in username and password
782
742
  */
783
743
  disableEscaping?: boolean;
784
744
  /**
785
- * The maximum number of seconds to keep
786
- * a connection alive for.
745
+ * Maximum number of seconds a connection may be reused.
787
746
  */
788
747
  maxConnectionLifetime?: number;
789
748
  /**
790
- * The maximum number of idle connections to
791
- * maintain.
749
+ * Maximum number of idle connections to the database.
792
750
  */
793
751
  maxIdleConnections?: number;
794
752
  /**
795
- * The maximum number of open connections to
796
- * use.
753
+ * Maximum number of open connections to the database.
797
754
  */
798
755
  maxOpenConnections?: number;
799
756
  /**
800
- * The password to authenticate with.
757
+ * The root credential password used in the connection URL
801
758
  */
802
759
  password?: string;
803
760
  /**
804
- * The username to authenticate with.
761
+ * The root credential username used in the connection URL
805
762
  */
806
763
  username?: string;
807
764
  /**
808
- * Template describing how dynamic usernames are generated.
765
+ * Username generation template.
809
766
  */
810
767
  usernameTemplate?: string;
811
768
  }
812
769
  interface SecretBackendConnectionMysql {
813
770
  /**
814
- * Enable IAM authentication to a Google Cloud instance when set to `gcpIam`
771
+ * Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
815
772
  */
816
773
  authType?: string;
817
774
  /**
818
- * A URL containing connection information. See
819
- * the [Vault
820
- * docs](https://www.vaultproject.io/api-docs/secret/databases/mongodb.html#sample-payload)
821
- * for an example.
775
+ * Connection string to use to connect to the database.
822
776
  */
823
777
  connectionUrl?: string;
824
778
  /**
825
- * The maximum number of seconds to keep
826
- * a connection alive for.
779
+ * Maximum number of seconds a connection may be reused.
827
780
  */
828
781
  maxConnectionLifetime?: number;
829
782
  /**
830
- * The maximum number of idle connections to
831
- * maintain.
783
+ * Maximum number of idle connections to the database.
832
784
  */
833
785
  maxIdleConnections?: number;
834
786
  /**
835
- * The maximum number of open connections to
836
- * use.
787
+ * Maximum number of open connections to the database.
837
788
  */
838
789
  maxOpenConnections?: number;
839
790
  /**
840
- * The password to authenticate with.
791
+ * The root credential password used in the connection URL
841
792
  */
842
793
  password?: string;
843
794
  /**
844
- * JSON encoding of an IAM access key. Requires `authType` to be `gcpIam`.
795
+ * A JSON encoded credential for use with IAM authorization
845
796
  */
846
797
  serviceAccountJson?: string;
847
798
  /**
@@ -853,47 +804,41 @@ export declare namespace database {
853
804
  */
854
805
  tlsCertificateKey?: string;
855
806
  /**
856
- * The username to authenticate with.
807
+ * The root credential username used in the connection URL
857
808
  */
858
809
  username?: string;
859
810
  /**
860
- * Template describing how dynamic usernames are generated.
811
+ * Username generation template.
861
812
  */
862
813
  usernameTemplate?: string;
863
814
  }
864
815
  interface SecretBackendConnectionMysqlAurora {
865
816
  /**
866
- * Enable IAM authentication to a Google Cloud instance when set to `gcpIam`
817
+ * Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
867
818
  */
868
819
  authType?: string;
869
820
  /**
870
- * A URL containing connection information. See
871
- * the [Vault
872
- * docs](https://www.vaultproject.io/api-docs/secret/databases/mongodb.html#sample-payload)
873
- * for an example.
821
+ * Connection string to use to connect to the database.
874
822
  */
875
823
  connectionUrl?: string;
876
824
  /**
877
- * The maximum number of seconds to keep
878
- * a connection alive for.
825
+ * Maximum number of seconds a connection may be reused.
879
826
  */
880
827
  maxConnectionLifetime?: number;
881
828
  /**
882
- * The maximum number of idle connections to
883
- * maintain.
829
+ * Maximum number of idle connections to the database.
884
830
  */
885
831
  maxIdleConnections?: number;
886
832
  /**
887
- * The maximum number of open connections to
888
- * use.
833
+ * Maximum number of open connections to the database.
889
834
  */
890
835
  maxOpenConnections?: number;
891
836
  /**
892
- * The password to authenticate with.
837
+ * The root credential password used in the connection URL
893
838
  */
894
839
  password?: string;
895
840
  /**
896
- * JSON encoding of an IAM access key. Requires `authType` to be `gcpIam`.
841
+ * A JSON encoded credential for use with IAM authorization
897
842
  */
898
843
  serviceAccountJson?: string;
899
844
  /**
@@ -905,47 +850,41 @@ export declare namespace database {
905
850
  */
906
851
  tlsCertificateKey?: string;
907
852
  /**
908
- * The username to authenticate with.
853
+ * The root credential username used in the connection URL
909
854
  */
910
855
  username?: string;
911
856
  /**
912
- * Template describing how dynamic usernames are generated.
857
+ * Username generation template.
913
858
  */
914
859
  usernameTemplate?: string;
915
860
  }
916
861
  interface SecretBackendConnectionMysqlLegacy {
917
862
  /**
918
- * Enable IAM authentication to a Google Cloud instance when set to `gcpIam`
863
+ * Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
919
864
  */
920
865
  authType?: string;
921
866
  /**
922
- * A URL containing connection information. See
923
- * the [Vault
924
- * docs](https://www.vaultproject.io/api-docs/secret/databases/mongodb.html#sample-payload)
925
- * for an example.
867
+ * Connection string to use to connect to the database.
926
868
  */
927
869
  connectionUrl?: string;
928
870
  /**
929
- * The maximum number of seconds to keep
930
- * a connection alive for.
871
+ * Maximum number of seconds a connection may be reused.
931
872
  */
932
873
  maxConnectionLifetime?: number;
933
874
  /**
934
- * The maximum number of idle connections to
935
- * maintain.
875
+ * Maximum number of idle connections to the database.
936
876
  */
937
877
  maxIdleConnections?: number;
938
878
  /**
939
- * The maximum number of open connections to
940
- * use.
879
+ * Maximum number of open connections to the database.
941
880
  */
942
881
  maxOpenConnections?: number;
943
882
  /**
944
- * The password to authenticate with.
883
+ * The root credential password used in the connection URL
945
884
  */
946
885
  password?: string;
947
886
  /**
948
- * JSON encoding of an IAM access key. Requires `authType` to be `gcpIam`.
887
+ * A JSON encoded credential for use with IAM authorization
949
888
  */
950
889
  serviceAccountJson?: string;
951
890
  /**
@@ -957,47 +896,41 @@ export declare namespace database {
957
896
  */
958
897
  tlsCertificateKey?: string;
959
898
  /**
960
- * The username to authenticate with.
899
+ * The root credential username used in the connection URL
961
900
  */
962
901
  username?: string;
963
902
  /**
964
- * Template describing how dynamic usernames are generated.
903
+ * Username generation template.
965
904
  */
966
905
  usernameTemplate?: string;
967
906
  }
968
907
  interface SecretBackendConnectionMysqlRds {
969
908
  /**
970
- * Enable IAM authentication to a Google Cloud instance when set to `gcpIam`
909
+ * Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
971
910
  */
972
911
  authType?: string;
973
912
  /**
974
- * A URL containing connection information. See
975
- * the [Vault
976
- * docs](https://www.vaultproject.io/api-docs/secret/databases/mongodb.html#sample-payload)
977
- * for an example.
913
+ * Connection string to use to connect to the database.
978
914
  */
979
915
  connectionUrl?: string;
980
916
  /**
981
- * The maximum number of seconds to keep
982
- * a connection alive for.
917
+ * Maximum number of seconds a connection may be reused.
983
918
  */
984
919
  maxConnectionLifetime?: number;
985
920
  /**
986
- * The maximum number of idle connections to
987
- * maintain.
921
+ * Maximum number of idle connections to the database.
988
922
  */
989
923
  maxIdleConnections?: number;
990
924
  /**
991
- * The maximum number of open connections to
992
- * use.
925
+ * Maximum number of open connections to the database.
993
926
  */
994
927
  maxOpenConnections?: number;
995
928
  /**
996
- * The password to authenticate with.
929
+ * The root credential password used in the connection URL
997
930
  */
998
931
  password?: string;
999
932
  /**
1000
- * JSON encoding of an IAM access key. Requires `authType` to be `gcpIam`.
933
+ * A JSON encoded credential for use with IAM authorization
1001
934
  */
1002
935
  serviceAccountJson?: string;
1003
936
  /**
@@ -1009,230 +942,203 @@ export declare namespace database {
1009
942
  */
1010
943
  tlsCertificateKey?: string;
1011
944
  /**
1012
- * The username to authenticate with.
945
+ * The root credential username used in the connection URL
1013
946
  */
1014
947
  username?: string;
1015
948
  /**
1016
- * Template describing how dynamic usernames are generated.
949
+ * Username generation template.
1017
950
  */
1018
951
  usernameTemplate?: string;
1019
952
  }
1020
953
  interface SecretBackendConnectionOracle {
1021
954
  /**
1022
- * A URL containing connection information. See
1023
- * the [Vault
1024
- * docs](https://www.vaultproject.io/api-docs/secret/databases/mongodb.html#sample-payload)
1025
- * for an example.
955
+ * Connection string to use to connect to the database.
1026
956
  */
1027
957
  connectionUrl?: string;
1028
958
  /**
1029
- * Enable the built-in session disconnect mechanism.
959
+ * Set to true to disconnect any open sessions prior to running the revocation statements.
1030
960
  */
1031
961
  disconnectSessions?: boolean;
1032
962
  /**
1033
- * The maximum number of seconds to keep
1034
- * a connection alive for.
963
+ * Maximum number of seconds a connection may be reused.
1035
964
  */
1036
965
  maxConnectionLifetime?: number;
1037
966
  /**
1038
- * The maximum number of idle connections to
1039
- * maintain.
967
+ * Maximum number of idle connections to the database.
1040
968
  */
1041
969
  maxIdleConnections?: number;
1042
970
  /**
1043
- * The maximum number of open connections to
1044
- * use.
971
+ * Maximum number of open connections to the database.
1045
972
  */
1046
973
  maxOpenConnections?: number;
1047
974
  /**
1048
- * The password to authenticate with.
975
+ * The root credential password used in the connection URL
1049
976
  */
1050
977
  password?: string;
1051
978
  /**
1052
- * Enable spliting statements after semi-colons.
979
+ * Set to true in order to split statements after semi-colons.
1053
980
  */
1054
981
  splitStatements?: boolean;
1055
982
  /**
1056
- * The username to authenticate with.
983
+ * The root credential username used in the connection URL
1057
984
  */
1058
985
  username?: string;
1059
986
  /**
1060
- * Template describing how dynamic usernames are generated.
987
+ * Username generation template.
1061
988
  */
1062
989
  usernameTemplate?: string;
1063
990
  }
1064
991
  interface SecretBackendConnectionPostgresql {
1065
992
  /**
1066
- * Enable IAM authentication to a Google Cloud instance when set to `gcpIam`
993
+ * Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
1067
994
  */
1068
995
  authType?: string;
1069
996
  /**
1070
- * A URL containing connection information. See
1071
- * the [Vault
1072
- * docs](https://www.vaultproject.io/api-docs/secret/databases/mongodb.html#sample-payload)
1073
- * for an example.
997
+ * Connection string to use to connect to the database.
1074
998
  */
1075
999
  connectionUrl?: string;
1076
1000
  /**
1077
- * Disable special character escaping in username and password.
1001
+ * Disable special character escaping in username and password
1078
1002
  */
1079
1003
  disableEscaping?: boolean;
1080
1004
  /**
1081
- * The maximum number of seconds to keep
1082
- * a connection alive for.
1005
+ * Maximum number of seconds a connection may be reused.
1083
1006
  */
1084
1007
  maxConnectionLifetime?: number;
1085
1008
  /**
1086
- * The maximum number of idle connections to
1087
- * maintain.
1009
+ * Maximum number of idle connections to the database.
1088
1010
  */
1089
1011
  maxIdleConnections?: number;
1090
1012
  /**
1091
- * The maximum number of open connections to
1092
- * use.
1013
+ * Maximum number of open connections to the database.
1093
1014
  */
1094
1015
  maxOpenConnections?: number;
1095
1016
  /**
1096
- * The password to authenticate with.
1017
+ * The root credential password used in the connection URL
1097
1018
  */
1098
1019
  password?: string;
1099
1020
  /**
1100
- * JSON encoding of an IAM access key. Requires `authType` to be `gcpIam`.
1021
+ * A JSON encoded credential for use with IAM authorization
1101
1022
  */
1102
1023
  serviceAccountJson?: string;
1103
1024
  /**
1104
- * The username to authenticate with.
1025
+ * The root credential username used in the connection URL
1105
1026
  */
1106
1027
  username?: string;
1107
1028
  /**
1108
- * Template describing how dynamic usernames are generated.
1029
+ * Username generation template.
1109
1030
  */
1110
1031
  usernameTemplate?: string;
1111
1032
  }
1112
1033
  interface SecretBackendConnectionRedis {
1113
1034
  /**
1114
- * The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.
1035
+ * The contents of a PEM-encoded CA cert file to use to verify the Redis server's identity.
1115
1036
  */
1116
1037
  caCert?: string;
1117
1038
  /**
1118
- * The host to connect to.
1039
+ * Specifies the host to connect to
1119
1040
  */
1120
1041
  host: string;
1121
1042
  /**
1122
- * Whether to skip verification of the server
1123
- * certificate when using TLS.
1043
+ * Specifies whether to skip verification of the server certificate when using TLS.
1124
1044
  */
1125
1045
  insecureTls?: boolean;
1126
1046
  /**
1127
- * The password to authenticate with.
1047
+ * Specifies the password corresponding to the given username.
1128
1048
  */
1129
1049
  password: string;
1130
1050
  /**
1131
- * The default port to connect to if no port is specified as
1132
- * part of the host.
1051
+ * The transport port to use to connect to Redis.
1133
1052
  */
1134
1053
  port?: number;
1135
1054
  /**
1136
- * Whether to use TLS when connecting to Cassandra.
1055
+ * Specifies whether to use TLS when connecting to Redis.
1137
1056
  */
1138
1057
  tls?: boolean;
1139
1058
  /**
1140
- * The username to authenticate with.
1059
+ * Specifies the username for Vault to use.
1141
1060
  */
1142
1061
  username: string;
1143
1062
  }
1144
1063
  interface SecretBackendConnectionRedisElasticache {
1145
1064
  /**
1146
- * The password to authenticate with.
1065
+ * The AWS secret key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.
1147
1066
  */
1148
1067
  password?: string;
1149
1068
  /**
1150
- * The region where the ElastiCache cluster is hosted. If omitted Vault tries to infer from the environment instead.
1069
+ * The AWS region where the ElastiCache cluster is hosted. If omitted the plugin tries to infer the region from the environment.
1151
1070
  */
1152
1071
  region?: string;
1153
1072
  /**
1154
- * The URL for Elasticsearch's API. https requires certificate
1155
- * by trusted CA if used.
1073
+ * The configuration endpoint for the ElastiCache cluster to connect to.
1156
1074
  */
1157
1075
  url: string;
1158
1076
  /**
1159
- * The username to authenticate with.
1077
+ * The AWS access key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.
1160
1078
  */
1161
1079
  username?: string;
1162
1080
  }
1163
1081
  interface SecretBackendConnectionRedshift {
1164
1082
  /**
1165
- * A URL containing connection information. See
1166
- * the [Vault
1167
- * docs](https://www.vaultproject.io/api-docs/secret/databases/mongodb.html#sample-payload)
1168
- * for an example.
1083
+ * Connection string to use to connect to the database.
1169
1084
  */
1170
1085
  connectionUrl?: string;
1171
1086
  /**
1172
- * Disable special character escaping in username and password.
1087
+ * Disable special character escaping in username and password
1173
1088
  */
1174
1089
  disableEscaping?: boolean;
1175
1090
  /**
1176
- * The maximum number of seconds to keep
1177
- * a connection alive for.
1091
+ * Maximum number of seconds a connection may be reused.
1178
1092
  */
1179
1093
  maxConnectionLifetime?: number;
1180
1094
  /**
1181
- * The maximum number of idle connections to
1182
- * maintain.
1095
+ * Maximum number of idle connections to the database.
1183
1096
  */
1184
1097
  maxIdleConnections?: number;
1185
1098
  /**
1186
- * The maximum number of open connections to
1187
- * use.
1099
+ * Maximum number of open connections to the database.
1188
1100
  */
1189
1101
  maxOpenConnections?: number;
1190
1102
  /**
1191
- * The password to authenticate with.
1103
+ * The root credential password used in the connection URL
1192
1104
  */
1193
1105
  password?: string;
1194
1106
  /**
1195
- * The username to authenticate with.
1107
+ * The root credential username used in the connection URL
1196
1108
  */
1197
1109
  username?: string;
1198
1110
  /**
1199
- * Template describing how dynamic usernames are generated.
1111
+ * Username generation template.
1200
1112
  */
1201
1113
  usernameTemplate?: string;
1202
1114
  }
1203
1115
  interface SecretBackendConnectionSnowflake {
1204
1116
  /**
1205
- * A URL containing connection information. See
1206
- * the [Vault
1207
- * docs](https://www.vaultproject.io/api-docs/secret/databases/mongodb.html#sample-payload)
1208
- * for an example.
1117
+ * Connection string to use to connect to the database.
1209
1118
  */
1210
1119
  connectionUrl?: string;
1211
1120
  /**
1212
- * The maximum number of seconds to keep
1213
- * a connection alive for.
1121
+ * Maximum number of seconds a connection may be reused.
1214
1122
  */
1215
1123
  maxConnectionLifetime?: number;
1216
1124
  /**
1217
- * The maximum number of idle connections to
1218
- * maintain.
1125
+ * Maximum number of idle connections to the database.
1219
1126
  */
1220
1127
  maxIdleConnections?: number;
1221
1128
  /**
1222
- * The maximum number of open connections to
1223
- * use.
1129
+ * Maximum number of open connections to the database.
1224
1130
  */
1225
1131
  maxOpenConnections?: number;
1226
1132
  /**
1227
- * The password to authenticate with.
1133
+ * The root credential password used in the connection URL
1228
1134
  */
1229
1135
  password?: string;
1230
1136
  /**
1231
- * The username to authenticate with.
1137
+ * The root credential username used in the connection URL
1232
1138
  */
1233
1139
  username?: string;
1234
1140
  /**
1235
- * Template describing how dynamic usernames are generated.
1141
+ * Username generation template.
1236
1142
  */
1237
1143
  usernameTemplate?: string;
1238
1144
  }
@@ -1243,8 +1149,7 @@ export declare namespace database {
1243
1149
  */
1244
1150
  allowedRoles?: string[];
1245
1151
  /**
1246
- * The number of seconds to use as a connection
1247
- * timeout.
1152
+ * The number of seconds to use as a connection timeout.
1248
1153
  */
1249
1154
  connectTimeout?: number;
1250
1155
  /**
@@ -1256,12 +1161,11 @@ export declare namespace database {
1256
1161
  [key: string]: any;
1257
1162
  };
1258
1163
  /**
1259
- * The hosts to connect to.
1164
+ * Cassandra hosts to connect to.
1260
1165
  */
1261
1166
  hosts?: string[];
1262
1167
  /**
1263
- * Whether to skip verification of the server
1264
- * certificate when using TLS.
1168
+ * Whether to skip verification of the server certificate when using TLS.
1265
1169
  */
1266
1170
  insecureTls?: boolean;
1267
1171
  /**
@@ -1269,16 +1173,15 @@ export declare namespace database {
1269
1173
  */
1270
1174
  name: string;
1271
1175
  /**
1272
- * The root credential password used in the connection URL.
1176
+ * The password to use when authenticating with Cassandra.
1273
1177
  */
1274
1178
  password?: string;
1275
1179
  /**
1276
- * Concatenated PEM blocks configuring the certificate
1277
- * chain.
1180
+ * Concatenated PEM blocks containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
1278
1181
  */
1279
1182
  pemBundle?: string;
1280
1183
  /**
1281
- * A JSON structure configuring the certificate chain.
1184
+ * Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
1282
1185
  */
1283
1186
  pemJson?: string;
1284
1187
  /**
@@ -1286,8 +1189,7 @@ export declare namespace database {
1286
1189
  */
1287
1190
  pluginName: string;
1288
1191
  /**
1289
- * The default port to connect to if no port is specified as
1290
- * part of the host.
1192
+ * The transport port to use to connect to Cassandra.
1291
1193
  */
1292
1194
  port?: number;
1293
1195
  /**
@@ -1303,7 +1205,7 @@ export declare namespace database {
1303
1205
  */
1304
1206
  tls?: boolean;
1305
1207
  /**
1306
- * The root credential username used in the connection URL.
1208
+ * The username to use when authenticating with Cassandra.
1307
1209
  */
1308
1210
  username?: string;
1309
1211
  /**
@@ -1335,12 +1237,11 @@ export declare namespace database {
1335
1237
  [key: string]: any;
1336
1238
  };
1337
1239
  /**
1338
- * The hosts to connect to.
1240
+ * A set of Couchbase URIs to connect to. Must use `couchbases://` scheme if `tls` is `true`.
1339
1241
  */
1340
1242
  hosts: string[];
1341
1243
  /**
1342
- * Whether to skip verification of the server
1343
- * certificate when using TLS.
1244
+ * Specifies whether to skip verification of the server certificate when using TLS.
1344
1245
  */
1345
1246
  insecureTls?: boolean;
1346
1247
  /**
@@ -1348,7 +1249,7 @@ export declare namespace database {
1348
1249
  */
1349
1250
  name: string;
1350
1251
  /**
1351
- * The root credential password used in the connection URL.
1252
+ * Specifies the password corresponding to the given username.
1352
1253
  */
1353
1254
  password: string;
1354
1255
  /**
@@ -1360,15 +1261,15 @@ export declare namespace database {
1360
1261
  */
1361
1262
  rootRotationStatements?: string[];
1362
1263
  /**
1363
- * Whether to use TLS when connecting to Cassandra.
1264
+ * Specifies whether to use TLS when connecting to Couchbase.
1364
1265
  */
1365
1266
  tls?: boolean;
1366
1267
  /**
1367
- * The root credential username used in the connection URL.
1268
+ * Specifies the username for Vault to use.
1368
1269
  */
1369
1270
  username: string;
1370
1271
  /**
1371
- * [Template](https://www.vaultproject.io/docs/concepts/username-templating) describing how dynamic usernames are generated.
1272
+ * Template describing how dynamic usernames are generated.
1372
1273
  */
1373
1274
  usernameTemplate?: string;
1374
1275
  /**
@@ -1384,19 +1285,19 @@ export declare namespace database {
1384
1285
  */
1385
1286
  allowedRoles?: string[];
1386
1287
  /**
1387
- * The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.
1288
+ * The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity
1388
1289
  */
1389
1290
  caCert?: string;
1390
1291
  /**
1391
- * The path to a directory of PEM-encoded CA cert files to use to verify the Elasticsearch server's identity.
1292
+ * The path to a directory of PEM-encoded CA cert files to use to verify the Elasticsearch server's identity
1392
1293
  */
1393
1294
  caPath?: string;
1394
1295
  /**
1395
- * The path to the certificate for the Elasticsearch client to present for communication.
1296
+ * The path to the certificate for the Elasticsearch client to present for communication
1396
1297
  */
1397
1298
  clientCert?: string;
1398
1299
  /**
1399
- * The path to the key for the Elasticsearch client to use for communication.
1300
+ * The path to the key for the Elasticsearch client to use for communication
1400
1301
  */
1401
1302
  clientKey?: string;
1402
1303
  /**
@@ -1408,7 +1309,7 @@ export declare namespace database {
1408
1309
  [key: string]: any;
1409
1310
  };
1410
1311
  /**
1411
- * Whether to disable certificate verification.
1312
+ * Whether to disable certificate verification
1412
1313
  */
1413
1314
  insecure?: boolean;
1414
1315
  /**
@@ -1416,7 +1317,7 @@ export declare namespace database {
1416
1317
  */
1417
1318
  name: string;
1418
1319
  /**
1419
- * The root credential password used in the connection URL.
1320
+ * The password to be used in the connection URL
1420
1321
  */
1421
1322
  password: string;
1422
1323
  /**
@@ -1428,20 +1329,19 @@ export declare namespace database {
1428
1329
  */
1429
1330
  rootRotationStatements?: string[];
1430
1331
  /**
1431
- * This, if set, is used to set the SNI host when connecting via TLS.
1332
+ * This, if set, is used to set the SNI host when connecting via TLS
1432
1333
  */
1433
1334
  tlsServerName?: string;
1434
1335
  /**
1435
- * The URL for Elasticsearch's API. https requires certificate
1436
- * by trusted CA if used.
1336
+ * The URL for Elasticsearch's API
1437
1337
  */
1438
1338
  url: string;
1439
1339
  /**
1440
- * The root credential username used in the connection URL.
1340
+ * The username to be used in the connection URL
1441
1341
  */
1442
1342
  username: string;
1443
1343
  /**
1444
- * [Template](https://www.vaultproject.io/docs/concepts/username-templating) describing how dynamic usernames are generated.
1344
+ * Template describing how dynamic usernames are generated.
1445
1345
  */
1446
1346
  usernameTemplate?: string;
1447
1347
  /**
@@ -1457,8 +1357,7 @@ export declare namespace database {
1457
1357
  */
1458
1358
  allowedRoles?: string[];
1459
1359
  /**
1460
- * Specifies the Redshift DSN.
1461
- * See [Vault docs](https://www.vaultproject.io/api-docs/secret/databases/redshift#sample-payload)
1360
+ * Connection string to use to connect to the database.
1462
1361
  */
1463
1362
  connectionUrl?: string;
1464
1363
  /**
@@ -1470,21 +1369,19 @@ export declare namespace database {
1470
1369
  [key: string]: any;
1471
1370
  };
1472
1371
  /**
1473
- * Disable special character escaping in username and password.
1372
+ * Disable special character escaping in username and password
1474
1373
  */
1475
1374
  disableEscaping?: boolean;
1476
1375
  /**
1477
- * The maximum amount of time a connection may be reused.
1376
+ * Maximum number of seconds a connection may be reused.
1478
1377
  */
1479
1378
  maxConnectionLifetime?: number;
1480
1379
  /**
1481
- * The maximum number of idle connections to
1482
- * the database.
1380
+ * Maximum number of idle connections to the database.
1483
1381
  */
1484
1382
  maxIdleConnections?: number;
1485
1383
  /**
1486
- * The maximum number of open connections to
1487
- * the database.
1384
+ * Maximum number of open connections to the database.
1488
1385
  */
1489
1386
  maxOpenConnections?: number;
1490
1387
  /**
@@ -1492,7 +1389,7 @@ export declare namespace database {
1492
1389
  */
1493
1390
  name: string;
1494
1391
  /**
1495
- * The root credential password used in the connection URL.
1392
+ * The root credential password used in the connection URL
1496
1393
  */
1497
1394
  password?: string;
1498
1395
  /**
@@ -1504,7 +1401,7 @@ export declare namespace database {
1504
1401
  */
1505
1402
  rootRotationStatements?: string[];
1506
1403
  /**
1507
- * The root credential username used in the connection URL.
1404
+ * The root credential username used in the connection URL
1508
1405
  */
1509
1406
  username?: string;
1510
1407
  /**
@@ -1520,8 +1417,7 @@ export declare namespace database {
1520
1417
  */
1521
1418
  allowedRoles?: string[];
1522
1419
  /**
1523
- * The number of seconds to use as a connection
1524
- * timeout.
1420
+ * The number of seconds to use as a connection timeout.
1525
1421
  */
1526
1422
  connectTimeout?: number;
1527
1423
  /**
@@ -1533,12 +1429,11 @@ export declare namespace database {
1533
1429
  [key: string]: any;
1534
1430
  };
1535
1431
  /**
1536
- * The host to connect to.
1432
+ * Influxdb host to connect to.
1537
1433
  */
1538
1434
  host: string;
1539
1435
  /**
1540
- * Whether to skip verification of the server
1541
- * certificate when using TLS.
1436
+ * Whether to skip verification of the server certificate when using TLS.
1542
1437
  */
1543
1438
  insecureTls?: boolean;
1544
1439
  /**
@@ -1546,16 +1441,15 @@ export declare namespace database {
1546
1441
  */
1547
1442
  name: string;
1548
1443
  /**
1549
- * The root credential password used in the connection URL.
1444
+ * Specifies the password corresponding to the given username.
1550
1445
  */
1551
1446
  password: string;
1552
1447
  /**
1553
- * Concatenated PEM blocks configuring the certificate
1554
- * chain.
1448
+ * Concatenated PEM blocks containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
1555
1449
  */
1556
1450
  pemBundle?: string;
1557
1451
  /**
1558
- * A JSON structure configuring the certificate chain.
1452
+ * Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
1559
1453
  */
1560
1454
  pemJson?: string;
1561
1455
  /**
@@ -1563,8 +1457,7 @@ export declare namespace database {
1563
1457
  */
1564
1458
  pluginName: string;
1565
1459
  /**
1566
- * The default port to connect to if no port is specified as
1567
- * part of the host.
1460
+ * The transport port to use to connect to Influxdb.
1568
1461
  */
1569
1462
  port?: number;
1570
1463
  /**
@@ -1572,15 +1465,15 @@ export declare namespace database {
1572
1465
  */
1573
1466
  rootRotationStatements?: string[];
1574
1467
  /**
1575
- * Whether to use TLS when connecting to Cassandra.
1468
+ * Whether to use TLS when connecting to Influxdb.
1576
1469
  */
1577
1470
  tls?: boolean;
1578
1471
  /**
1579
- * The root credential username used in the connection URL.
1472
+ * Specifies the username to use for superuser access.
1580
1473
  */
1581
1474
  username: string;
1582
1475
  /**
1583
- * [Template](https://www.vaultproject.io/docs/concepts/username-templating) describing how dynamic usernames are generated.
1476
+ * Template describing how dynamic usernames are generated.
1584
1477
  */
1585
1478
  usernameTemplate?: string;
1586
1479
  /**
@@ -1596,8 +1489,7 @@ export declare namespace database {
1596
1489
  */
1597
1490
  allowedRoles?: string[];
1598
1491
  /**
1599
- * Specifies the Redshift DSN.
1600
- * See [Vault docs](https://www.vaultproject.io/api-docs/secret/databases/redshift#sample-payload)
1492
+ * Connection string to use to connect to the database.
1601
1493
  */
1602
1494
  connectionUrl?: string;
1603
1495
  /**
@@ -1609,17 +1501,15 @@ export declare namespace database {
1609
1501
  [key: string]: any;
1610
1502
  };
1611
1503
  /**
1612
- * The maximum amount of time a connection may be reused.
1504
+ * Maximum number of seconds a connection may be reused.
1613
1505
  */
1614
1506
  maxConnectionLifetime?: number;
1615
1507
  /**
1616
- * The maximum number of idle connections to
1617
- * the database.
1508
+ * Maximum number of idle connections to the database.
1618
1509
  */
1619
1510
  maxIdleConnections?: number;
1620
1511
  /**
1621
- * The maximum number of open connections to
1622
- * the database.
1512
+ * Maximum number of open connections to the database.
1623
1513
  */
1624
1514
  maxOpenConnections?: number;
1625
1515
  /**
@@ -1627,7 +1517,7 @@ export declare namespace database {
1627
1517
  */
1628
1518
  name: string;
1629
1519
  /**
1630
- * The root credential password used in the connection URL.
1520
+ * The root credential password used in the connection URL
1631
1521
  */
1632
1522
  password?: string;
1633
1523
  /**
@@ -1639,11 +1529,11 @@ export declare namespace database {
1639
1529
  */
1640
1530
  rootRotationStatements?: string[];
1641
1531
  /**
1642
- * The root credential username used in the connection URL.
1532
+ * The root credential username used in the connection URL
1643
1533
  */
1644
1534
  username?: string;
1645
1535
  /**
1646
- * [Template](https://www.vaultproject.io/docs/concepts/username-templating) describing how dynamic usernames are generated.
1536
+ * Username generation template.
1647
1537
  */
1648
1538
  usernameTemplate?: string;
1649
1539
  /**
@@ -1703,14 +1593,11 @@ export declare namespace database {
1703
1593
  */
1704
1594
  allowedRoles?: string[];
1705
1595
  /**
1706
- * Specifies the Redshift DSN.
1707
- * See [Vault docs](https://www.vaultproject.io/api-docs/secret/databases/redshift#sample-payload)
1596
+ * Connection string to use to connect to the database.
1708
1597
  */
1709
1598
  connectionUrl?: string;
1710
1599
  /**
1711
- * For Vault v1.9+. Set to true when the target is a
1712
- * Contained Database, e.g. AzureSQL.
1713
- * See [Vault docs](https://www.vaultproject.io/api/secret/databases/mssql#contained_db)
1600
+ * Set to true when the target is a Contained Database, e.g. AzureSQL.
1714
1601
  */
1715
1602
  containedDb?: boolean;
1716
1603
  /**
@@ -1722,21 +1609,19 @@ export declare namespace database {
1722
1609
  [key: string]: any;
1723
1610
  };
1724
1611
  /**
1725
- * Disable special character escaping in username and password.
1612
+ * Disable special character escaping in username and password
1726
1613
  */
1727
1614
  disableEscaping?: boolean;
1728
1615
  /**
1729
- * The maximum amount of time a connection may be reused.
1616
+ * Maximum number of seconds a connection may be reused.
1730
1617
  */
1731
1618
  maxConnectionLifetime?: number;
1732
1619
  /**
1733
- * The maximum number of idle connections to
1734
- * the database.
1620
+ * Maximum number of idle connections to the database.
1735
1621
  */
1736
1622
  maxIdleConnections?: number;
1737
1623
  /**
1738
- * The maximum number of open connections to
1739
- * the database.
1624
+ * Maximum number of open connections to the database.
1740
1625
  */
1741
1626
  maxOpenConnections?: number;
1742
1627
  /**
@@ -1744,7 +1629,7 @@ export declare namespace database {
1744
1629
  */
1745
1630
  name: string;
1746
1631
  /**
1747
- * The root credential password used in the connection URL.
1632
+ * The root credential password used in the connection URL
1748
1633
  */
1749
1634
  password?: string;
1750
1635
  /**
@@ -1756,11 +1641,11 @@ export declare namespace database {
1756
1641
  */
1757
1642
  rootRotationStatements?: string[];
1758
1643
  /**
1759
- * The root credential username used in the connection URL.
1644
+ * The root credential username used in the connection URL
1760
1645
  */
1761
1646
  username?: string;
1762
1647
  /**
1763
- * [Template](https://www.vaultproject.io/docs/concepts/username-templating) describing how dynamic usernames are generated.
1648
+ * Username generation template.
1764
1649
  */
1765
1650
  usernameTemplate?: string;
1766
1651
  /**
@@ -1780,8 +1665,7 @@ export declare namespace database {
1780
1665
  */
1781
1666
  authType?: string;
1782
1667
  /**
1783
- * Specifies the Redshift DSN.
1784
- * See [Vault docs](https://www.vaultproject.io/api-docs/secret/databases/redshift#sample-payload)
1668
+ * Connection string to use to connect to the database.
1785
1669
  */
1786
1670
  connectionUrl?: string;
1787
1671
  /**
@@ -1793,17 +1677,15 @@ export declare namespace database {
1793
1677
  [key: string]: any;
1794
1678
  };
1795
1679
  /**
1796
- * The maximum amount of time a connection may be reused.
1680
+ * Maximum number of seconds a connection may be reused.
1797
1681
  */
1798
1682
  maxConnectionLifetime?: number;
1799
1683
  /**
1800
- * The maximum number of idle connections to
1801
- * the database.
1684
+ * Maximum number of idle connections to the database.
1802
1685
  */
1803
1686
  maxIdleConnections?: number;
1804
1687
  /**
1805
- * The maximum number of open connections to
1806
- * the database.
1688
+ * Maximum number of open connections to the database.
1807
1689
  */
1808
1690
  maxOpenConnections?: number;
1809
1691
  /**
@@ -1811,7 +1693,7 @@ export declare namespace database {
1811
1693
  */
1812
1694
  name: string;
1813
1695
  /**
1814
- * The root credential password used in the connection URL.
1696
+ * The root credential password used in the connection URL
1815
1697
  */
1816
1698
  password?: string;
1817
1699
  /**
@@ -1835,11 +1717,11 @@ export declare namespace database {
1835
1717
  */
1836
1718
  tlsCertificateKey?: string;
1837
1719
  /**
1838
- * The root credential username used in the connection URL.
1720
+ * The root credential username used in the connection URL
1839
1721
  */
1840
1722
  username?: string;
1841
1723
  /**
1842
- * [Template](https://www.vaultproject.io/docs/concepts/username-templating) describing how dynamic usernames are generated.
1724
+ * Username generation template.
1843
1725
  */
1844
1726
  usernameTemplate?: string;
1845
1727
  /**
@@ -1859,8 +1741,7 @@ export declare namespace database {
1859
1741
  */
1860
1742
  authType?: string;
1861
1743
  /**
1862
- * Specifies the Redshift DSN.
1863
- * See [Vault docs](https://www.vaultproject.io/api-docs/secret/databases/redshift#sample-payload)
1744
+ * Connection string to use to connect to the database.
1864
1745
  */
1865
1746
  connectionUrl?: string;
1866
1747
  /**
@@ -1872,17 +1753,15 @@ export declare namespace database {
1872
1753
  [key: string]: any;
1873
1754
  };
1874
1755
  /**
1875
- * The maximum amount of time a connection may be reused.
1756
+ * Maximum number of seconds a connection may be reused.
1876
1757
  */
1877
1758
  maxConnectionLifetime?: number;
1878
1759
  /**
1879
- * The maximum number of idle connections to
1880
- * the database.
1760
+ * Maximum number of idle connections to the database.
1881
1761
  */
1882
1762
  maxIdleConnections?: number;
1883
1763
  /**
1884
- * The maximum number of open connections to
1885
- * the database.
1764
+ * Maximum number of open connections to the database.
1886
1765
  */
1887
1766
  maxOpenConnections?: number;
1888
1767
  /**
@@ -1890,7 +1769,7 @@ export declare namespace database {
1890
1769
  */
1891
1770
  name: string;
1892
1771
  /**
1893
- * The root credential password used in the connection URL.
1772
+ * The root credential password used in the connection URL
1894
1773
  */
1895
1774
  password?: string;
1896
1775
  /**
@@ -1914,11 +1793,11 @@ export declare namespace database {
1914
1793
  */
1915
1794
  tlsCertificateKey?: string;
1916
1795
  /**
1917
- * The root credential username used in the connection URL.
1796
+ * The root credential username used in the connection URL
1918
1797
  */
1919
1798
  username?: string;
1920
1799
  /**
1921
- * [Template](https://www.vaultproject.io/docs/concepts/username-templating) describing how dynamic usernames are generated.
1800
+ * Username generation template.
1922
1801
  */
1923
1802
  usernameTemplate?: string;
1924
1803
  /**
@@ -1938,8 +1817,7 @@ export declare namespace database {
1938
1817
  */
1939
1818
  authType?: string;
1940
1819
  /**
1941
- * Specifies the Redshift DSN.
1942
- * See [Vault docs](https://www.vaultproject.io/api-docs/secret/databases/redshift#sample-payload)
1820
+ * Connection string to use to connect to the database.
1943
1821
  */
1944
1822
  connectionUrl?: string;
1945
1823
  /**
@@ -1951,17 +1829,15 @@ export declare namespace database {
1951
1829
  [key: string]: any;
1952
1830
  };
1953
1831
  /**
1954
- * The maximum amount of time a connection may be reused.
1832
+ * Maximum number of seconds a connection may be reused.
1955
1833
  */
1956
1834
  maxConnectionLifetime?: number;
1957
1835
  /**
1958
- * The maximum number of idle connections to
1959
- * the database.
1836
+ * Maximum number of idle connections to the database.
1960
1837
  */
1961
1838
  maxIdleConnections?: number;
1962
1839
  /**
1963
- * The maximum number of open connections to
1964
- * the database.
1840
+ * Maximum number of open connections to the database.
1965
1841
  */
1966
1842
  maxOpenConnections?: number;
1967
1843
  /**
@@ -1969,7 +1845,7 @@ export declare namespace database {
1969
1845
  */
1970
1846
  name: string;
1971
1847
  /**
1972
- * The root credential password used in the connection URL.
1848
+ * The root credential password used in the connection URL
1973
1849
  */
1974
1850
  password?: string;
1975
1851
  /**
@@ -1993,11 +1869,11 @@ export declare namespace database {
1993
1869
  */
1994
1870
  tlsCertificateKey?: string;
1995
1871
  /**
1996
- * The root credential username used in the connection URL.
1872
+ * The root credential username used in the connection URL
1997
1873
  */
1998
1874
  username?: string;
1999
1875
  /**
2000
- * [Template](https://www.vaultproject.io/docs/concepts/username-templating) describing how dynamic usernames are generated.
1876
+ * Username generation template.
2001
1877
  */
2002
1878
  usernameTemplate?: string;
2003
1879
  /**
@@ -2017,8 +1893,7 @@ export declare namespace database {
2017
1893
  */
2018
1894
  authType?: string;
2019
1895
  /**
2020
- * Specifies the Redshift DSN.
2021
- * See [Vault docs](https://www.vaultproject.io/api-docs/secret/databases/redshift#sample-payload)
1896
+ * Connection string to use to connect to the database.
2022
1897
  */
2023
1898
  connectionUrl?: string;
2024
1899
  /**
@@ -2030,17 +1905,15 @@ export declare namespace database {
2030
1905
  [key: string]: any;
2031
1906
  };
2032
1907
  /**
2033
- * The maximum amount of time a connection may be reused.
1908
+ * Maximum number of seconds a connection may be reused.
2034
1909
  */
2035
1910
  maxConnectionLifetime?: number;
2036
1911
  /**
2037
- * The maximum number of idle connections to
2038
- * the database.
1912
+ * Maximum number of idle connections to the database.
2039
1913
  */
2040
1914
  maxIdleConnections?: number;
2041
1915
  /**
2042
- * The maximum number of open connections to
2043
- * the database.
1916
+ * Maximum number of open connections to the database.
2044
1917
  */
2045
1918
  maxOpenConnections?: number;
2046
1919
  /**
@@ -2048,7 +1921,7 @@ export declare namespace database {
2048
1921
  */
2049
1922
  name: string;
2050
1923
  /**
2051
- * The root credential password used in the connection URL.
1924
+ * The root credential password used in the connection URL
2052
1925
  */
2053
1926
  password?: string;
2054
1927
  /**
@@ -2072,11 +1945,11 @@ export declare namespace database {
2072
1945
  */
2073
1946
  tlsCertificateKey?: string;
2074
1947
  /**
2075
- * The root credential username used in the connection URL.
1948
+ * The root credential username used in the connection URL
2076
1949
  */
2077
1950
  username?: string;
2078
1951
  /**
2079
- * [Template](https://www.vaultproject.io/docs/concepts/username-templating) describing how dynamic usernames are generated.
1952
+ * Username generation template.
2080
1953
  */
2081
1954
  usernameTemplate?: string;
2082
1955
  /**
@@ -2092,8 +1965,7 @@ export declare namespace database {
2092
1965
  */
2093
1966
  allowedRoles?: string[];
2094
1967
  /**
2095
- * Specifies the Redshift DSN.
2096
- * See [Vault docs](https://www.vaultproject.io/api-docs/secret/databases/redshift#sample-payload)
1968
+ * Connection string to use to connect to the database.
2097
1969
  */
2098
1970
  connectionUrl?: string;
2099
1971
  /**
@@ -2109,17 +1981,15 @@ export declare namespace database {
2109
1981
  */
2110
1982
  disconnectSessions?: boolean;
2111
1983
  /**
2112
- * The maximum amount of time a connection may be reused.
1984
+ * Maximum number of seconds a connection may be reused.
2113
1985
  */
2114
1986
  maxConnectionLifetime?: number;
2115
1987
  /**
2116
- * The maximum number of idle connections to
2117
- * the database.
1988
+ * Maximum number of idle connections to the database.
2118
1989
  */
2119
1990
  maxIdleConnections?: number;
2120
1991
  /**
2121
- * The maximum number of open connections to
2122
- * the database.
1992
+ * Maximum number of open connections to the database.
2123
1993
  */
2124
1994
  maxOpenConnections?: number;
2125
1995
  /**
@@ -2127,7 +1997,7 @@ export declare namespace database {
2127
1997
  */
2128
1998
  name: string;
2129
1999
  /**
2130
- * The root credential password used in the connection URL.
2000
+ * The root credential password used in the connection URL
2131
2001
  */
2132
2002
  password?: string;
2133
2003
  /**
@@ -2143,11 +2013,11 @@ export declare namespace database {
2143
2013
  */
2144
2014
  splitStatements?: boolean;
2145
2015
  /**
2146
- * The root credential username used in the connection URL.
2016
+ * The root credential username used in the connection URL
2147
2017
  */
2148
2018
  username?: string;
2149
2019
  /**
2150
- * [Template](https://www.vaultproject.io/docs/concepts/username-templating) describing how dynamic usernames are generated.
2020
+ * Username generation template.
2151
2021
  */
2152
2022
  usernameTemplate?: string;
2153
2023
  /**
@@ -2167,8 +2037,7 @@ export declare namespace database {
2167
2037
  */
2168
2038
  authType?: string;
2169
2039
  /**
2170
- * Specifies the Redshift DSN.
2171
- * See [Vault docs](https://www.vaultproject.io/api-docs/secret/databases/redshift#sample-payload)
2040
+ * Connection string to use to connect to the database.
2172
2041
  */
2173
2042
  connectionUrl?: string;
2174
2043
  /**
@@ -2180,21 +2049,19 @@ export declare namespace database {
2180
2049
  [key: string]: any;
2181
2050
  };
2182
2051
  /**
2183
- * Disable special character escaping in username and password.
2052
+ * Disable special character escaping in username and password
2184
2053
  */
2185
2054
  disableEscaping?: boolean;
2186
2055
  /**
2187
- * The maximum amount of time a connection may be reused.
2056
+ * Maximum number of seconds a connection may be reused.
2188
2057
  */
2189
2058
  maxConnectionLifetime?: number;
2190
2059
  /**
2191
- * The maximum number of idle connections to
2192
- * the database.
2060
+ * Maximum number of idle connections to the database.
2193
2061
  */
2194
2062
  maxIdleConnections?: number;
2195
2063
  /**
2196
- * The maximum number of open connections to
2197
- * the database.
2064
+ * Maximum number of open connections to the database.
2198
2065
  */
2199
2066
  maxOpenConnections?: number;
2200
2067
  /**
@@ -2202,7 +2069,7 @@ export declare namespace database {
2202
2069
  */
2203
2070
  name: string;
2204
2071
  /**
2205
- * The root credential password used in the connection URL.
2072
+ * The root credential password used in the connection URL
2206
2073
  */
2207
2074
  password?: string;
2208
2075
  /**
@@ -2218,11 +2085,11 @@ export declare namespace database {
2218
2085
  */
2219
2086
  serviceAccountJson?: string;
2220
2087
  /**
2221
- * The root credential username used in the connection URL.
2088
+ * The root credential username used in the connection URL
2222
2089
  */
2223
2090
  username?: string;
2224
2091
  /**
2225
- * [Template](https://www.vaultproject.io/docs/concepts/username-templating) describing how dynamic usernames are generated.
2092
+ * Username generation template.
2226
2093
  */
2227
2094
  usernameTemplate?: string;
2228
2095
  /**
@@ -2238,7 +2105,7 @@ export declare namespace database {
2238
2105
  */
2239
2106
  allowedRoles?: string[];
2240
2107
  /**
2241
- * The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.
2108
+ * The contents of a PEM-encoded CA cert file to use to verify the Redis server's identity.
2242
2109
  */
2243
2110
  caCert?: string;
2244
2111
  /**
@@ -2250,12 +2117,11 @@ export declare namespace database {
2250
2117
  [key: string]: any;
2251
2118
  };
2252
2119
  /**
2253
- * The host to connect to.
2120
+ * Specifies the host to connect to
2254
2121
  */
2255
2122
  host: string;
2256
2123
  /**
2257
- * Whether to skip verification of the server
2258
- * certificate when using TLS.
2124
+ * Specifies whether to skip verification of the server certificate when using TLS.
2259
2125
  */
2260
2126
  insecureTls?: boolean;
2261
2127
  /**
@@ -2263,7 +2129,7 @@ export declare namespace database {
2263
2129
  */
2264
2130
  name: string;
2265
2131
  /**
2266
- * The root credential password used in the connection URL.
2132
+ * Specifies the password corresponding to the given username.
2267
2133
  */
2268
2134
  password: string;
2269
2135
  /**
@@ -2271,8 +2137,7 @@ export declare namespace database {
2271
2137
  */
2272
2138
  pluginName: string;
2273
2139
  /**
2274
- * The default port to connect to if no port is specified as
2275
- * part of the host.
2140
+ * The transport port to use to connect to Redis.
2276
2141
  */
2277
2142
  port?: number;
2278
2143
  /**
@@ -2280,11 +2145,11 @@ export declare namespace database {
2280
2145
  */
2281
2146
  rootRotationStatements?: string[];
2282
2147
  /**
2283
- * Whether to use TLS when connecting to Cassandra.
2148
+ * Specifies whether to use TLS when connecting to Redis.
2284
2149
  */
2285
2150
  tls?: boolean;
2286
2151
  /**
2287
- * The root credential username used in the connection URL.
2152
+ * Specifies the username for Vault to use.
2288
2153
  */
2289
2154
  username: string;
2290
2155
  /**
@@ -2312,7 +2177,7 @@ export declare namespace database {
2312
2177
  */
2313
2178
  name: string;
2314
2179
  /**
2315
- * The root credential password used in the connection URL.
2180
+ * The AWS secret key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.
2316
2181
  */
2317
2182
  password?: string;
2318
2183
  /**
@@ -2320,8 +2185,7 @@ export declare namespace database {
2320
2185
  */
2321
2186
  pluginName: string;
2322
2187
  /**
2323
- * The AWS region where the ElastiCache cluster is hosted.
2324
- * If omitted the plugin tries to infer the region from the environment.
2188
+ * The AWS region where the ElastiCache cluster is hosted. If omitted the plugin tries to infer the region from the environment.
2325
2189
  */
2326
2190
  region?: string;
2327
2191
  /**
@@ -2329,12 +2193,11 @@ export declare namespace database {
2329
2193
  */
2330
2194
  rootRotationStatements?: string[];
2331
2195
  /**
2332
- * The URL for Elasticsearch's API. https requires certificate
2333
- * by trusted CA if used.
2196
+ * The configuration endpoint for the ElastiCache cluster to connect to.
2334
2197
  */
2335
2198
  url: string;
2336
2199
  /**
2337
- * The root credential username used in the connection URL.
2200
+ * The AWS access key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.
2338
2201
  */
2339
2202
  username?: string;
2340
2203
  /**
@@ -2350,8 +2213,7 @@ export declare namespace database {
2350
2213
  */
2351
2214
  allowedRoles?: string[];
2352
2215
  /**
2353
- * Specifies the Redshift DSN.
2354
- * See [Vault docs](https://www.vaultproject.io/api-docs/secret/databases/redshift#sample-payload)
2216
+ * Connection string to use to connect to the database.
2355
2217
  */
2356
2218
  connectionUrl?: string;
2357
2219
  /**
@@ -2363,21 +2225,19 @@ export declare namespace database {
2363
2225
  [key: string]: any;
2364
2226
  };
2365
2227
  /**
2366
- * Disable special character escaping in username and password.
2228
+ * Disable special character escaping in username and password
2367
2229
  */
2368
2230
  disableEscaping?: boolean;
2369
2231
  /**
2370
- * The maximum amount of time a connection may be reused.
2232
+ * Maximum number of seconds a connection may be reused.
2371
2233
  */
2372
2234
  maxConnectionLifetime?: number;
2373
2235
  /**
2374
- * The maximum number of idle connections to
2375
- * the database.
2236
+ * Maximum number of idle connections to the database.
2376
2237
  */
2377
2238
  maxIdleConnections?: number;
2378
2239
  /**
2379
- * The maximum number of open connections to
2380
- * the database.
2240
+ * Maximum number of open connections to the database.
2381
2241
  */
2382
2242
  maxOpenConnections?: number;
2383
2243
  /**
@@ -2385,7 +2245,7 @@ export declare namespace database {
2385
2245
  */
2386
2246
  name: string;
2387
2247
  /**
2388
- * The root credential password used in the connection URL.
2248
+ * The root credential password used in the connection URL
2389
2249
  */
2390
2250
  password?: string;
2391
2251
  /**
@@ -2397,11 +2257,11 @@ export declare namespace database {
2397
2257
  */
2398
2258
  rootRotationStatements?: string[];
2399
2259
  /**
2400
- * The root credential username used in the connection URL.
2260
+ * The root credential username used in the connection URL
2401
2261
  */
2402
2262
  username?: string;
2403
2263
  /**
2404
- * [Template](https://www.vaultproject.io/docs/concepts/username-templating) describing how dynamic usernames are generated.
2264
+ * Username generation template.
2405
2265
  */
2406
2266
  usernameTemplate?: string;
2407
2267
  /**
@@ -2417,8 +2277,7 @@ export declare namespace database {
2417
2277
  */
2418
2278
  allowedRoles?: string[];
2419
2279
  /**
2420
- * Specifies the Redshift DSN.
2421
- * See [Vault docs](https://www.vaultproject.io/api-docs/secret/databases/redshift#sample-payload)
2280
+ * Connection string to use to connect to the database.
2422
2281
  */
2423
2282
  connectionUrl?: string;
2424
2283
  /**
@@ -2430,17 +2289,15 @@ export declare namespace database {
2430
2289
  [key: string]: any;
2431
2290
  };
2432
2291
  /**
2433
- * The maximum amount of time a connection may be reused.
2292
+ * Maximum number of seconds a connection may be reused.
2434
2293
  */
2435
2294
  maxConnectionLifetime?: number;
2436
2295
  /**
2437
- * The maximum number of idle connections to
2438
- * the database.
2296
+ * Maximum number of idle connections to the database.
2439
2297
  */
2440
2298
  maxIdleConnections?: number;
2441
2299
  /**
2442
- * The maximum number of open connections to
2443
- * the database.
2300
+ * Maximum number of open connections to the database.
2444
2301
  */
2445
2302
  maxOpenConnections?: number;
2446
2303
  /**
@@ -2448,7 +2305,7 @@ export declare namespace database {
2448
2305
  */
2449
2306
  name: string;
2450
2307
  /**
2451
- * The root credential password used in the connection URL.
2308
+ * The root credential password used in the connection URL
2452
2309
  */
2453
2310
  password?: string;
2454
2311
  /**
@@ -2460,11 +2317,11 @@ export declare namespace database {
2460
2317
  */
2461
2318
  rootRotationStatements?: string[];
2462
2319
  /**
2463
- * The root credential username used in the connection URL.
2320
+ * The root credential username used in the connection URL
2464
2321
  */
2465
2322
  username?: string;
2466
2323
  /**
2467
- * [Template](https://www.vaultproject.io/docs/concepts/username-templating) describing how dynamic usernames are generated.
2324
+ * Username generation template.
2468
2325
  */
2469
2326
  usernameTemplate?: string;
2470
2327
  /**
@@ -2730,62 +2587,55 @@ export declare namespace kv {
2730
2587
  export declare namespace managed {
2731
2588
  interface KeysAw {
2732
2589
  /**
2733
- * The AWS access key to use.
2590
+ * The AWS access key to use
2734
2591
  */
2735
2592
  accessKey: string;
2736
2593
  /**
2737
- * If no existing key can be found in
2738
- * the referenced backend, instructs Vault to generate a key within the backend.
2594
+ * If no existing key can be found in the referenced backend, instructs Vault to generate a key within the backend
2739
2595
  */
2740
2596
  allowGenerateKey: boolean;
2741
2597
  /**
2742
- * Controls the ability for Vault to replace through
2743
- * generation or importing a key into the configured backend even
2744
- * if a key is present, if set to `false` those operations are forbidden
2745
- * if a key exists.
2598
+ * Controls the ability for Vault to replace through generation or importing a key into the configured backend even if a key is present, if set to false those operations are forbidden if a key exists.
2746
2599
  */
2747
2600
  allowReplaceKey: boolean;
2748
2601
  /**
2749
- * Controls the ability for Vault to import a key to the
2750
- * configured backend, if `false`, those operations will be forbidden.
2602
+ * Controls the ability for Vault to import a key to the configured backend, if 'false', those operations will be forbidden
2751
2603
  */
2752
2604
  allowStoreKey: boolean;
2753
2605
  /**
2754
- * If `true`, allows usage from any mount point within the
2755
- * namespace.
2606
+ * Allow usage from any mount point within the namespace if 'true'
2756
2607
  */
2757
2608
  anyMount: boolean;
2758
2609
  /**
2759
- * The curve to use for an ECDSA key. Used when `keyType`
2760
- * is `ECDSA`. Required if `allowGenerateKey` is `true`.
2610
+ * The curve to use for an ECDSA key. Used when keyType is 'ECDSA'. Required if 'allow_generate_key' is true
2761
2611
  */
2762
2612
  curve?: string;
2763
2613
  /**
2764
- * Used to specify a custom AWS endpoint.
2614
+ * Used to specify a custom AWS endpoint
2765
2615
  */
2766
2616
  endpoint?: string;
2767
2617
  /**
2768
- * The size in bits for an RSA key.
2618
+ * The size in bits for an RSA key. This field is required when 'key_type' is 'RSA'
2769
2619
  */
2770
2620
  keyBits: string;
2771
2621
  /**
2772
- * The type of key to use.
2622
+ * The type of key to use
2773
2623
  */
2774
2624
  keyType: string;
2775
2625
  /**
2776
- * An identifier for the key.
2626
+ * An identifier for the key
2777
2627
  */
2778
2628
  kmsKey: string;
2779
2629
  /**
2780
- * A unique lowercase name that serves as identifying the key.
2630
+ * A unique lowercase name that serves as identifying the key
2781
2631
  */
2782
2632
  name: string;
2783
2633
  /**
2784
- * The AWS region where the keys are stored (or will be stored).
2634
+ * The AWS region where the keys are stored (or will be stored)
2785
2635
  */
2786
2636
  region: string;
2787
2637
  /**
2788
- * The AWS access key to use.
2638
+ * The AWS secret key to use
2789
2639
  */
2790
2640
  secretKey: string;
2791
2641
  /**
@@ -2795,61 +2645,55 @@ export declare namespace managed {
2795
2645
  }
2796
2646
  interface KeysAzure {
2797
2647
  /**
2798
- * If no existing key can be found in
2799
- * the referenced backend, instructs Vault to generate a key within the backend.
2648
+ * If no existing key can be found in the referenced backend, instructs Vault to generate a key within the backend
2800
2649
  */
2801
2650
  allowGenerateKey: boolean;
2802
2651
  /**
2803
- * Controls the ability for Vault to replace through
2804
- * generation or importing a key into the configured backend even
2805
- * if a key is present, if set to `false` those operations are forbidden
2806
- * if a key exists.
2652
+ * Controls the ability for Vault to replace through generation or importing a key into the configured backend even if a key is present, if set to false those operations are forbidden if a key exists.
2807
2653
  */
2808
2654
  allowReplaceKey: boolean;
2809
2655
  /**
2810
- * Controls the ability for Vault to import a key to the
2811
- * configured backend, if `false`, those operations will be forbidden.
2656
+ * Controls the ability for Vault to import a key to the configured backend, if 'false', those operations will be forbidden
2812
2657
  */
2813
2658
  allowStoreKey: boolean;
2814
2659
  /**
2815
- * If `true`, allows usage from any mount point within the
2816
- * namespace.
2660
+ * Allow usage from any mount point within the namespace if 'true'
2817
2661
  */
2818
2662
  anyMount: boolean;
2819
2663
  /**
2820
- * The client id for credentials to query the Azure APIs.
2664
+ * The client id for credentials to query the Azure APIs
2821
2665
  */
2822
2666
  clientId: string;
2823
2667
  /**
2824
- * The client secret for credentials to query the Azure APIs.
2668
+ * The client secret for credentials to query the Azure APIs
2825
2669
  */
2826
2670
  clientSecret: string;
2827
2671
  /**
2828
- * The Azure Cloud environment API endpoints to use.
2672
+ * The Azure Cloud environment API endpoints to use
2829
2673
  */
2830
2674
  environment: string;
2831
2675
  /**
2832
- * The size in bits for an RSA key.
2676
+ * The size in bits for an RSA key. This field is required when 'key_type' is 'RSA' or when 'allow_generate_key' is true
2833
2677
  */
2834
2678
  keyBits?: string;
2835
2679
  /**
2836
- * The Key Vault key to use for encryption and decryption.
2680
+ * The Key Vault key to use for encryption and decryption
2837
2681
  */
2838
2682
  keyName: string;
2839
2683
  /**
2840
- * The type of key to use.
2684
+ * The type of key to use
2841
2685
  */
2842
2686
  keyType: string;
2843
2687
  /**
2844
- * A unique lowercase name that serves as identifying the key.
2688
+ * A unique lowercase name that serves as identifying the key
2845
2689
  */
2846
2690
  name: string;
2847
2691
  /**
2848
- * The Azure Key Vault resource's DNS Suffix to connect to.
2692
+ * The Azure Key Vault resource's DNS Suffix to connect to
2849
2693
  */
2850
2694
  resource: string;
2851
2695
  /**
2852
- * The tenant id for the Azure Active Directory organization.
2696
+ * The tenant id for the Azure Active Directory organization
2853
2697
  */
2854
2698
  tenantId: string;
2855
2699
  /**
@@ -2857,80 +2701,69 @@ export declare namespace managed {
2857
2701
  */
2858
2702
  uuid: string;
2859
2703
  /**
2860
- * The Key Vault vault to use for encryption and decryption.
2704
+ * The Key Vault vault to use the encryption keys for encryption and decryption
2861
2705
  */
2862
2706
  vaultName: string;
2863
2707
  }
2864
2708
  interface KeysPkc {
2865
2709
  /**
2866
- * If no existing key can be found in
2867
- * the referenced backend, instructs Vault to generate a key within the backend.
2710
+ * If no existing key can be found in the referenced backend, instructs Vault to generate a key within the backend
2868
2711
  */
2869
2712
  allowGenerateKey: boolean;
2870
2713
  /**
2871
- * Controls the ability for Vault to replace through
2872
- * generation or importing a key into the configured backend even
2873
- * if a key is present, if set to `false` those operations are forbidden
2874
- * if a key exists.
2714
+ * Controls the ability for Vault to replace through generation or importing a key into the configured backend even if a key is present, if set to false those operations are forbidden if a key exists.
2875
2715
  */
2876
2716
  allowReplaceKey: boolean;
2877
2717
  /**
2878
- * Controls the ability for Vault to import a key to the
2879
- * configured backend, if `false`, those operations will be forbidden.
2718
+ * Controls the ability for Vault to import a key to the configured backend, if 'false', those operations will be forbidden
2880
2719
  */
2881
2720
  allowStoreKey: boolean;
2882
2721
  /**
2883
- * If `true`, allows usage from any mount point within the
2884
- * namespace.
2722
+ * Allow usage from any mount point within the namespace if 'true'
2885
2723
  */
2886
2724
  anyMount: boolean;
2887
2725
  /**
2888
- * The curve to use for an ECDSA key. Used when `keyType`
2889
- * is `ECDSA`. Required if `allowGenerateKey` is `true`.
2726
+ * Supplies the curve value when using the 'CKM_ECDSA' mechanism. Required if 'allow_generate_key' is true
2890
2727
  */
2891
2728
  curve?: string;
2892
2729
  /**
2893
- * Force all operations to open up a read-write session to
2894
- * the HSM.
2730
+ * Force all operations to open up a read-write session to the HSM
2895
2731
  */
2896
2732
  forceRwSession?: string;
2897
2733
  /**
2898
- * The size in bits for an RSA key.
2734
+ * Supplies the size in bits of the key when using 'CKM_RSA_PKCS_PSS', 'CKM_RSA_PKCS_OAEP' or 'CKM_RSA_PKCS' as a value for 'mechanism'. Required if 'allow_generate_key' is true
2899
2735
  */
2900
2736
  keyBits?: string;
2901
2737
  /**
2902
- * The id of a PKCS#11 key to use.
2738
+ * The id of a PKCS#11 key to use
2903
2739
  */
2904
2740
  keyId: string;
2905
2741
  /**
2906
- * The label of the key to use.
2742
+ * The label of the key to use
2907
2743
  */
2908
2744
  keyLabel: string;
2909
2745
  /**
2910
- * The name of the kmsLibrary stanza to use from Vault's config
2911
- * to lookup the local library path.
2746
+ * The name of the kmsLibrary stanza to use from Vault's config to lookup the local library path
2912
2747
  */
2913
2748
  library: string;
2914
2749
  /**
2915
- * The encryption/decryption mechanism to use, specified as a
2916
- * hexadecimal (prefixed by 0x) string.
2750
+ * The encryption/decryption mechanism to use, specified as a hexadecimal (prefixed by 0x) string.
2917
2751
  */
2918
2752
  mechanism: string;
2919
2753
  /**
2920
- * A unique lowercase name that serves as identifying the key.
2754
+ * A unique lowercase name that serves as identifying the key
2921
2755
  */
2922
2756
  name: string;
2923
2757
  /**
2924
- * The PIN for login.
2758
+ * The PIN for login
2925
2759
  */
2926
2760
  pin: string;
2927
2761
  /**
2928
- * The slot number to use, specified as a string in a decimal format
2929
- * (e.g. `2305843009213693953`).
2762
+ * The slot number to use, specified as a string in a decimal format (e.g. '2305843009213693953')
2930
2763
  */
2931
2764
  slot?: string;
2932
2765
  /**
2933
- * The slot token label to use.
2766
+ * The slot token label to use
2934
2767
  */
2935
2768
  tokenLabel?: string;
2936
2769
  /**
@@ -2942,21 +2775,21 @@ export declare namespace managed {
2942
2775
  export declare namespace okta {
2943
2776
  interface AuthBackendGroup {
2944
2777
  /**
2945
- * Name of the group within the Okta
2778
+ * Name of the Okta group
2946
2779
  */
2947
2780
  groupName: string;
2948
2781
  /**
2949
- * Vault policies to associate with this group
2782
+ * Policies to associate with this group
2950
2783
  */
2951
2784
  policies: string[];
2952
2785
  }
2953
2786
  interface AuthBackendUser {
2954
2787
  /**
2955
- * List of Okta groups to associate with this user
2788
+ * Groups within the Okta auth backend to associate with this user
2956
2789
  */
2957
2790
  groups?: string[];
2958
2791
  /**
2959
- * Vault policies to associate with this group
2792
+ * Policies to associate with this user
2960
2793
  */
2961
2794
  policies?: string[];
2962
2795
  /**
@@ -3051,25 +2884,12 @@ export declare namespace secrets {
3051
2884
  export declare namespace ssh {
3052
2885
  interface SecretBackendRoleAllowedUserKeyConfig {
3053
2886
  /**
3054
- * A list of allowed key lengths as integers.
3055
- * For key types that do not support setting the length a value of `[0]` should be used.
3056
- * Setting multiple lengths is only supported on Vault 1.10+. For prior releases `length`
3057
- * must be set to a single element list.
3058
- *
3059
- * Example configuration blocks that might be included in the `vault.ssh.SecretBackendRole`
3060
- *
3061
- * <!--Start PulumiCodeChooser -->
3062
- * ```typescript
3063
- * import * as pulumi from "@pulumi/pulumi";
3064
- * ```
3065
- * <!--End PulumiCodeChooser -->
2887
+ * List of allowed key lengths, vault-1.10 and above
3066
2888
  */
3067
2889
  lengths: number[];
3068
2890
  /**
3069
- * The SSH public key type.
3070
- * *Supported key types are:*
3071
- * `rsa`, `ecdsa`, `ec`, `dsa`, `ed25519`, `ssh-rsa`, `ssh-dss`, `ssh-ed25519`,
3072
- * `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, `ecdsa-sha2-nistp521`
2891
+ * Key type, choices:
2892
+ * rsa, ecdsa, ec, dsa, ed25519, ssh-rsa, ssh-dss, ssh-ed25519, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521
3073
2893
  */
3074
2894
  type: string;
3075
2895
  }