pulumi-vault 6.2.0__py3-none-any.whl → 6.2.0a1712470779__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (192) hide show
  1. pulumi_vault/__init__.py +0 -26
  2. pulumi_vault/_inputs.py +20 -0
  3. pulumi_vault/ad/secret_backend.py +6 -2
  4. pulumi_vault/ad/secret_library.py +4 -2
  5. pulumi_vault/ad/secret_role.py +4 -0
  6. pulumi_vault/alicloud/auth_backend_role.py +192 -69
  7. pulumi_vault/approle/auth_backend_login.py +4 -0
  8. pulumi_vault/approle/auth_backend_role.py +186 -63
  9. pulumi_vault/approle/auth_backend_role_secret_id.py +4 -0
  10. pulumi_vault/approle/get_auth_backend_role_id.py +4 -0
  11. pulumi_vault/audit.py +20 -12
  12. pulumi_vault/audit_request_header.py +6 -6
  13. pulumi_vault/auth_backend.py +0 -47
  14. pulumi_vault/aws/auth_backend_client.py +17 -253
  15. pulumi_vault/aws/auth_backend_config_identity.py +4 -0
  16. pulumi_vault/aws/auth_backend_identity_whitelist.py +10 -6
  17. pulumi_vault/aws/auth_backend_login.py +8 -0
  18. pulumi_vault/aws/auth_backend_role.py +186 -63
  19. pulumi_vault/aws/auth_backend_roletag_blacklist.py +10 -6
  20. pulumi_vault/aws/auth_backend_sts_role.py +4 -0
  21. pulumi_vault/aws/secret_backend_role.py +4 -56
  22. pulumi_vault/aws/secret_backend_static_role.py +4 -2
  23. pulumi_vault/azure/auth_backend_config.py +10 -139
  24. pulumi_vault/azure/auth_backend_role.py +186 -63
  25. pulumi_vault/azure/backend.py +22 -217
  26. pulumi_vault/azure/backend_role.py +18 -14
  27. pulumi_vault/azure/get_access_credentials.py +4 -0
  28. pulumi_vault/cert_auth_backend_role.py +208 -75
  29. pulumi_vault/consul/secret_backend.py +18 -10
  30. pulumi_vault/consul/secret_backend_role.py +4 -2
  31. pulumi_vault/database/_inputs.py +784 -522
  32. pulumi_vault/database/outputs.py +784 -522
  33. pulumi_vault/database/secret_backend_connection.py +4 -2
  34. pulumi_vault/database/secret_backend_role.py +4 -4
  35. pulumi_vault/database/secret_backend_static_role.py +8 -10
  36. pulumi_vault/database/secrets_mount.py +4 -286
  37. pulumi_vault/egp_policy.py +8 -4
  38. pulumi_vault/gcp/auth_backend.py +18 -226
  39. pulumi_vault/gcp/auth_backend_role.py +264 -63
  40. pulumi_vault/gcp/get_auth_backend_role.py +4 -0
  41. pulumi_vault/gcp/secret_backend.py +9 -275
  42. pulumi_vault/gcp/secret_impersonated_account.py +14 -12
  43. pulumi_vault/gcp/secret_roleset.py +6 -4
  44. pulumi_vault/gcp/secret_static_account.py +16 -14
  45. pulumi_vault/generic/endpoint.py +8 -4
  46. pulumi_vault/generic/get_secret.py +4 -40
  47. pulumi_vault/get_auth_backend.py +4 -0
  48. pulumi_vault/get_auth_backends.py +8 -0
  49. pulumi_vault/get_namespace.py +12 -0
  50. pulumi_vault/get_namespaces.py +12 -4
  51. pulumi_vault/get_nomad_access_token.py +4 -0
  52. pulumi_vault/get_policy_document.py +8 -8
  53. pulumi_vault/get_raft_autopilot_state.py +4 -0
  54. pulumi_vault/github/auth_backend.py +4 -0
  55. pulumi_vault/github/team.py +6 -2
  56. pulumi_vault/github/user.py +6 -2
  57. pulumi_vault/identity/entity.py +8 -6
  58. pulumi_vault/identity/entity_alias.py +8 -6
  59. pulumi_vault/identity/entity_policies.py +12 -12
  60. pulumi_vault/identity/get_entity.py +4 -0
  61. pulumi_vault/identity/get_group.py +4 -0
  62. pulumi_vault/identity/get_oidc_client_creds.py +4 -2
  63. pulumi_vault/identity/get_oidc_openid_config.py +6 -10
  64. pulumi_vault/identity/get_oidc_public_keys.py +6 -10
  65. pulumi_vault/identity/group.py +42 -38
  66. pulumi_vault/identity/group_alias.py +4 -2
  67. pulumi_vault/identity/group_member_entity_ids.py +16 -12
  68. pulumi_vault/identity/group_member_group_ids.py +20 -24
  69. pulumi_vault/identity/group_policies.py +8 -4
  70. pulumi_vault/identity/mfa_duo.py +8 -4
  71. pulumi_vault/identity/mfa_login_enforcement.py +8 -8
  72. pulumi_vault/identity/mfa_okta.py +8 -4
  73. pulumi_vault/identity/mfa_pingid.py +4 -0
  74. pulumi_vault/identity/mfa_totp.py +4 -0
  75. pulumi_vault/identity/oidc.py +4 -0
  76. pulumi_vault/identity/oidc_assignment.py +6 -10
  77. pulumi_vault/identity/oidc_client.py +10 -10
  78. pulumi_vault/identity/oidc_key.py +12 -16
  79. pulumi_vault/identity/oidc_key_allowed_client_id.py +12 -16
  80. pulumi_vault/identity/oidc_provider.py +16 -22
  81. pulumi_vault/identity/oidc_role.py +20 -28
  82. pulumi_vault/identity/oidc_scope.py +8 -6
  83. pulumi_vault/jwt/auth_backend.py +32 -20
  84. pulumi_vault/jwt/auth_backend_role.py +225 -91
  85. pulumi_vault/kmip/secret_backend.py +14 -10
  86. pulumi_vault/kmip/secret_role.py +4 -0
  87. pulumi_vault/kmip/secret_scope.py +4 -0
  88. pulumi_vault/kubernetes/auth_backend_config.py +4 -0
  89. pulumi_vault/kubernetes/auth_backend_role.py +172 -56
  90. pulumi_vault/kubernetes/get_service_account_token.py +8 -8
  91. pulumi_vault/kubernetes/secret_backend.py +8 -288
  92. pulumi_vault/kubernetes/secret_backend_role.py +24 -24
  93. pulumi_vault/kv/get_secret.py +4 -0
  94. pulumi_vault/kv/get_secret_subkeys_v2.py +6 -4
  95. pulumi_vault/kv/get_secret_v2.py +0 -58
  96. pulumi_vault/kv/get_secrets_list.py +8 -4
  97. pulumi_vault/kv/get_secrets_list_v2.py +12 -14
  98. pulumi_vault/kv/secret.py +4 -0
  99. pulumi_vault/kv/secret_backend_v2.py +4 -0
  100. pulumi_vault/kv/secret_v2.py +4 -2
  101. pulumi_vault/ldap/auth_backend.py +161 -66
  102. pulumi_vault/ldap/auth_backend_group.py +4 -0
  103. pulumi_vault/ldap/auth_backend_user.py +4 -0
  104. pulumi_vault/ldap/secret_backend.py +8 -286
  105. pulumi_vault/ldap/secret_backend_dynamic_role.py +4 -0
  106. pulumi_vault/ldap/secret_backend_library_set.py +4 -2
  107. pulumi_vault/ldap/secret_backend_static_role.py +4 -0
  108. pulumi_vault/managed/_inputs.py +132 -84
  109. pulumi_vault/managed/keys.py +28 -7
  110. pulumi_vault/managed/outputs.py +132 -84
  111. pulumi_vault/mfa_duo.py +6 -4
  112. pulumi_vault/mfa_okta.py +6 -4
  113. pulumi_vault/mfa_pingid.py +6 -4
  114. pulumi_vault/mfa_totp.py +12 -10
  115. pulumi_vault/mongodbatlas/secret_backend.py +4 -0
  116. pulumi_vault/mongodbatlas/secret_role.py +4 -2
  117. pulumi_vault/mount.py +42 -350
  118. pulumi_vault/nomad_secret_backend.py +8 -4
  119. pulumi_vault/nomad_secret_role.py +4 -0
  120. pulumi_vault/okta/_inputs.py +8 -8
  121. pulumi_vault/okta/auth_backend.py +10 -459
  122. pulumi_vault/okta/auth_backend_group.py +4 -0
  123. pulumi_vault/okta/auth_backend_user.py +4 -0
  124. pulumi_vault/okta/outputs.py +8 -8
  125. pulumi_vault/outputs.py +20 -0
  126. pulumi_vault/password_policy.py +8 -6
  127. pulumi_vault/pkisecret/__init__.py +0 -2
  128. pulumi_vault/pkisecret/_inputs.py +0 -30
  129. pulumi_vault/pkisecret/backend_config_cluster.py +4 -0
  130. pulumi_vault/pkisecret/get_backend_issuer.py +0 -36
  131. pulumi_vault/pkisecret/get_backend_issuers.py +4 -0
  132. pulumi_vault/pkisecret/get_backend_key.py +6 -2
  133. pulumi_vault/pkisecret/get_backend_keys.py +4 -0
  134. pulumi_vault/pkisecret/outputs.py +0 -54
  135. pulumi_vault/pkisecret/secret_backend_cert.py +8 -6
  136. pulumi_vault/pkisecret/secret_backend_config_ca.py +8 -4
  137. pulumi_vault/pkisecret/secret_backend_config_issuers.py +4 -0
  138. pulumi_vault/pkisecret/secret_backend_config_urls.py +4 -0
  139. pulumi_vault/pkisecret/secret_backend_crl_config.py +6 -2
  140. pulumi_vault/pkisecret/secret_backend_intermediate_cert_request.py +8 -4
  141. pulumi_vault/pkisecret/secret_backend_intermediate_set_signed.py +14 -10
  142. pulumi_vault/pkisecret/secret_backend_issuer.py +4 -0
  143. pulumi_vault/pkisecret/secret_backend_role.py +4 -2
  144. pulumi_vault/pkisecret/secret_backend_root_cert.py +8 -4
  145. pulumi_vault/pkisecret/secret_backend_root_sign_intermediate.py +10 -6
  146. pulumi_vault/pkisecret/secret_backend_sign.py +8 -6
  147. pulumi_vault/provider.py +8 -0
  148. pulumi_vault/pulumi-plugin.json +1 -2
  149. pulumi_vault/quota_lease_count.py +8 -53
  150. pulumi_vault/quota_rate_limit.py +4 -49
  151. pulumi_vault/rabbitmq/secret_backend.py +8 -4
  152. pulumi_vault/rabbitmq/secret_backend_role.py +4 -2
  153. pulumi_vault/raft_autopilot.py +4 -0
  154. pulumi_vault/raft_snapshot_agent_config.py +304 -109
  155. pulumi_vault/rgp_policy.py +6 -2
  156. pulumi_vault/saml/auth_backend.py +12 -8
  157. pulumi_vault/saml/auth_backend_role.py +178 -64
  158. pulumi_vault/secrets/sync_association.py +10 -12
  159. pulumi_vault/secrets/sync_aws_destination.py +8 -6
  160. pulumi_vault/secrets/sync_azure_destination.py +12 -10
  161. pulumi_vault/secrets/sync_config.py +6 -2
  162. pulumi_vault/secrets/sync_gcp_destination.py +6 -6
  163. pulumi_vault/secrets/sync_gh_destination.py +8 -6
  164. pulumi_vault/secrets/sync_github_apps.py +8 -8
  165. pulumi_vault/secrets/sync_vercel_destination.py +8 -6
  166. pulumi_vault/ssh/_inputs.py +32 -6
  167. pulumi_vault/ssh/outputs.py +32 -6
  168. pulumi_vault/ssh/secret_backend_ca.py +4 -94
  169. pulumi_vault/ssh/secret_backend_role.py +4 -4
  170. pulumi_vault/terraformcloud/secret_backend.py +56 -0
  171. pulumi_vault/terraformcloud/secret_creds.py +17 -2
  172. pulumi_vault/terraformcloud/secret_role.py +69 -2
  173. pulumi_vault/token.py +18 -14
  174. pulumi_vault/tokenauth/auth_backend_role.py +180 -64
  175. pulumi_vault/transform/alphabet.py +6 -4
  176. pulumi_vault/transform/get_decode.py +4 -4
  177. pulumi_vault/transform/get_encode.py +4 -4
  178. pulumi_vault/transform/role.py +6 -4
  179. pulumi_vault/transform/template.py +4 -4
  180. pulumi_vault/transit/get_decrypt.py +20 -4
  181. pulumi_vault/transit/get_encrypt.py +14 -0
  182. pulumi_vault/transit/secret_backend_key.py +6 -6
  183. pulumi_vault/transit/secret_cache_config.py +4 -0
  184. {pulumi_vault-6.2.0.dist-info → pulumi_vault-6.2.0a1712470779.dist-info}/METADATA +1 -1
  185. pulumi_vault-6.2.0a1712470779.dist-info/RECORD +252 -0
  186. {pulumi_vault-6.2.0.dist-info → pulumi_vault-6.2.0a1712470779.dist-info}/WHEEL +1 -1
  187. pulumi_vault/pkisecret/backend_config_est.py +0 -614
  188. pulumi_vault/pkisecret/get_backend_config_est.py +0 -233
  189. pulumi_vault/plugin.py +0 -590
  190. pulumi_vault/plugin_pinned_version.py +0 -293
  191. pulumi_vault-6.2.0.dist-info/RECORD +0 -256
  192. {pulumi_vault-6.2.0.dist-info → pulumi_vault-6.2.0a1712470779.dist-info}/top_level.txt +0 -0
@@ -182,18 +182,20 @@ class RgpPolicy(pulumi.CustomResource):
182
182
 
183
183
  ## Example Usage
184
184
 
185
+ <!--Start PulumiCodeChooser -->
185
186
  ```python
186
187
  import pulumi
187
188
  import pulumi_vault as vault
188
189
 
189
190
  allow_all = vault.RgpPolicy("allow-all",
190
- name="allow-all",
191
191
  enforcement_level="soft-mandatory",
192
192
  policy=\"\"\"main = rule {
193
193
  true
194
194
  }
195
+
195
196
  \"\"\")
196
197
  ```
198
+ <!--End PulumiCodeChooser -->
197
199
 
198
200
  :param str resource_name: The name of the resource.
199
201
  :param pulumi.ResourceOptions opts: Options for the resource.
@@ -218,18 +220,20 @@ class RgpPolicy(pulumi.CustomResource):
218
220
 
219
221
  ## Example Usage
220
222
 
223
+ <!--Start PulumiCodeChooser -->
221
224
  ```python
222
225
  import pulumi
223
226
  import pulumi_vault as vault
224
227
 
225
228
  allow_all = vault.RgpPolicy("allow-all",
226
- name="allow-all",
227
229
  enforcement_level="soft-mandatory",
228
230
  policy=\"\"\"main = rule {
229
231
  true
230
232
  }
233
+
231
234
  \"\"\")
232
235
  ```
236
+ <!--End PulumiCodeChooser -->
233
237
 
234
238
  :param str resource_name: The name of the resource.
235
239
  :param RgpPolicyArgs args: The arguments to use to populate this resource's properties.
@@ -445,17 +445,19 @@ class AuthBackend(pulumi.CustomResource):
445
445
 
446
446
  ## Example Usage
447
447
 
448
+ <!--Start PulumiCodeChooser -->
448
449
  ```python
449
450
  import pulumi
450
451
  import pulumi_vault as vault
451
452
 
452
453
  test = vault.saml.AuthBackend("test",
453
- path="saml",
454
- idp_metadata_url="https://company.okta.com/app/abc123eb9xnIfzlaf697/sso/saml/metadata",
455
- entity_id="https://my.vault/v1/auth/saml",
456
454
  acs_urls=["https://my.vault.primary/v1/auth/saml/callback"],
457
- default_role="admin")
455
+ default_role="admin",
456
+ entity_id="https://my.vault/v1/auth/saml",
457
+ idp_metadata_url="https://company.okta.com/app/abc123eb9xnIfzlaf697/sso/saml/metadata",
458
+ path="saml")
458
459
  ```
460
+ <!--End PulumiCodeChooser -->
459
461
 
460
462
  ## Import
461
463
 
@@ -503,17 +505,19 @@ class AuthBackend(pulumi.CustomResource):
503
505
 
504
506
  ## Example Usage
505
507
 
508
+ <!--Start PulumiCodeChooser -->
506
509
  ```python
507
510
  import pulumi
508
511
  import pulumi_vault as vault
509
512
 
510
513
  test = vault.saml.AuthBackend("test",
511
- path="saml",
512
- idp_metadata_url="https://company.okta.com/app/abc123eb9xnIfzlaf697/sso/saml/metadata",
513
- entity_id="https://my.vault/v1/auth/saml",
514
514
  acs_urls=["https://my.vault.primary/v1/auth/saml/callback"],
515
- default_role="admin")
515
+ default_role="admin",
516
+ entity_id="https://my.vault/v1/auth/saml",
517
+ idp_metadata_url="https://company.okta.com/app/abc123eb9xnIfzlaf697/sso/saml/metadata",
518
+ path="saml")
516
519
  ```
520
+ <!--End PulumiCodeChooser -->
517
521
 
518
522
  ## Import
519
523
 
@@ -47,15 +47,31 @@ class AuthBackendRoleArgs:
47
47
  The value should not contain leading or trailing forward slashes.
48
48
  The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
49
49
  *Available only for Vault Enterprise*.
50
- :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: Specifies the blocks of IP addresses which are allowed to use the generated token
51
- :param pulumi.Input[int] token_explicit_max_ttl: Generated Token's Explicit Maximum TTL in seconds
52
- :param pulumi.Input[int] token_max_ttl: The maximum lifetime of the generated token
53
- :param pulumi.Input[bool] token_no_default_policy: If true, the 'default' policy will not automatically be added to generated tokens
50
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: List of CIDR blocks; if set, specifies blocks of IP
51
+ addresses which can authenticate successfully, and ties the resulting token to these blocks
52
+ as well.
53
+ :param pulumi.Input[int] token_explicit_max_ttl: If set, will encode an
54
+ [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
55
+ onto the token in number of seconds. This is a hard cap even if `token_ttl` and
56
+ `token_max_ttl` would otherwise allow a renewal.
57
+ :param pulumi.Input[int] token_max_ttl: The maximum lifetime for generated tokens in number of seconds.
58
+ Its current value will be referenced at renewal time.
59
+ :param pulumi.Input[bool] token_no_default_policy: If set, the default policy will not be set on
60
+ generated tokens; otherwise it will be added to the policies set in token_policies.
54
61
  :param pulumi.Input[int] token_num_uses: The maximum number of times a token may be used, a value of zero means unlimited
55
- :param pulumi.Input[int] token_period: Generated Token's Period
56
- :param pulumi.Input[Sequence[pulumi.Input[str]]] token_policies: Generated Token's Policies
57
- :param pulumi.Input[int] token_ttl: The initial ttl of the token to generate in seconds
58
- :param pulumi.Input[str] token_type: The type of token to generate, service or batch
62
+ :param pulumi.Input[int] token_period: If set, indicates that the
63
+ token generated using this role should never expire. The token should be renewed within the
64
+ duration specified by this value. At each renewal, the token's TTL will be set to the
65
+ value of this field. Specified in seconds.
66
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] token_policies: List of policies to encode onto generated tokens. Depending
67
+ on the auth method, this list may be supplemented by user/group/other values.
68
+ :param pulumi.Input[int] token_ttl: The incremental lifetime for generated tokens in number of seconds.
69
+ Its current value will be referenced at renewal time.
70
+ :param pulumi.Input[str] token_type: The type of token that should be generated. Can be `service`,
71
+ `batch`, or `default` to use the mount's tuned default (which unless changed will be
72
+ `service` tokens). For token store roles, there are two additional possibilities:
73
+ `default-service` and `default-batch` which specify the type to return unless the client
74
+ requests a different type at generation time.
59
75
  """
60
76
  pulumi.set(__self__, "path", path)
61
77
  if bound_attributes is not None:
@@ -197,7 +213,9 @@ class AuthBackendRoleArgs:
197
213
  @pulumi.getter(name="tokenBoundCidrs")
198
214
  def token_bound_cidrs(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
199
215
  """
200
- Specifies the blocks of IP addresses which are allowed to use the generated token
216
+ List of CIDR blocks; if set, specifies blocks of IP
217
+ addresses which can authenticate successfully, and ties the resulting token to these blocks
218
+ as well.
201
219
  """
202
220
  return pulumi.get(self, "token_bound_cidrs")
203
221
 
@@ -209,7 +227,10 @@ class AuthBackendRoleArgs:
209
227
  @pulumi.getter(name="tokenExplicitMaxTtl")
210
228
  def token_explicit_max_ttl(self) -> Optional[pulumi.Input[int]]:
211
229
  """
212
- Generated Token's Explicit Maximum TTL in seconds
230
+ If set, will encode an
231
+ [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
232
+ onto the token in number of seconds. This is a hard cap even if `token_ttl` and
233
+ `token_max_ttl` would otherwise allow a renewal.
213
234
  """
214
235
  return pulumi.get(self, "token_explicit_max_ttl")
215
236
 
@@ -221,7 +242,8 @@ class AuthBackendRoleArgs:
221
242
  @pulumi.getter(name="tokenMaxTtl")
222
243
  def token_max_ttl(self) -> Optional[pulumi.Input[int]]:
223
244
  """
224
- The maximum lifetime of the generated token
245
+ The maximum lifetime for generated tokens in number of seconds.
246
+ Its current value will be referenced at renewal time.
225
247
  """
226
248
  return pulumi.get(self, "token_max_ttl")
227
249
 
@@ -233,7 +255,8 @@ class AuthBackendRoleArgs:
233
255
  @pulumi.getter(name="tokenNoDefaultPolicy")
234
256
  def token_no_default_policy(self) -> Optional[pulumi.Input[bool]]:
235
257
  """
236
- If true, the 'default' policy will not automatically be added to generated tokens
258
+ If set, the default policy will not be set on
259
+ generated tokens; otherwise it will be added to the policies set in token_policies.
237
260
  """
238
261
  return pulumi.get(self, "token_no_default_policy")
239
262
 
@@ -257,7 +280,10 @@ class AuthBackendRoleArgs:
257
280
  @pulumi.getter(name="tokenPeriod")
258
281
  def token_period(self) -> Optional[pulumi.Input[int]]:
259
282
  """
260
- Generated Token's Period
283
+ If set, indicates that the
284
+ token generated using this role should never expire. The token should be renewed within the
285
+ duration specified by this value. At each renewal, the token's TTL will be set to the
286
+ value of this field. Specified in seconds.
261
287
  """
262
288
  return pulumi.get(self, "token_period")
263
289
 
@@ -269,7 +295,8 @@ class AuthBackendRoleArgs:
269
295
  @pulumi.getter(name="tokenPolicies")
270
296
  def token_policies(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
271
297
  """
272
- Generated Token's Policies
298
+ List of policies to encode onto generated tokens. Depending
299
+ on the auth method, this list may be supplemented by user/group/other values.
273
300
  """
274
301
  return pulumi.get(self, "token_policies")
275
302
 
@@ -281,7 +308,8 @@ class AuthBackendRoleArgs:
281
308
  @pulumi.getter(name="tokenTtl")
282
309
  def token_ttl(self) -> Optional[pulumi.Input[int]]:
283
310
  """
284
- The initial ttl of the token to generate in seconds
311
+ The incremental lifetime for generated tokens in number of seconds.
312
+ Its current value will be referenced at renewal time.
285
313
  """
286
314
  return pulumi.get(self, "token_ttl")
287
315
 
@@ -293,7 +321,11 @@ class AuthBackendRoleArgs:
293
321
  @pulumi.getter(name="tokenType")
294
322
  def token_type(self) -> Optional[pulumi.Input[str]]:
295
323
  """
296
- The type of token to generate, service or batch
324
+ The type of token that should be generated. Can be `service`,
325
+ `batch`, or `default` to use the mount's tuned default (which unless changed will be
326
+ `service` tokens). For token store roles, there are two additional possibilities:
327
+ `default-service` and `default-batch` which specify the type to return unless the client
328
+ requests a different type at generation time.
297
329
  """
298
330
  return pulumi.get(self, "token_type")
299
331
 
@@ -338,15 +370,31 @@ class _AuthBackendRoleState:
338
370
  The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
339
371
  *Available only for Vault Enterprise*.
340
372
  :param pulumi.Input[str] path: Path where the auth backend is mounted.
341
- :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: Specifies the blocks of IP addresses which are allowed to use the generated token
342
- :param pulumi.Input[int] token_explicit_max_ttl: Generated Token's Explicit Maximum TTL in seconds
343
- :param pulumi.Input[int] token_max_ttl: The maximum lifetime of the generated token
344
- :param pulumi.Input[bool] token_no_default_policy: If true, the 'default' policy will not automatically be added to generated tokens
373
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: List of CIDR blocks; if set, specifies blocks of IP
374
+ addresses which can authenticate successfully, and ties the resulting token to these blocks
375
+ as well.
376
+ :param pulumi.Input[int] token_explicit_max_ttl: If set, will encode an
377
+ [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
378
+ onto the token in number of seconds. This is a hard cap even if `token_ttl` and
379
+ `token_max_ttl` would otherwise allow a renewal.
380
+ :param pulumi.Input[int] token_max_ttl: The maximum lifetime for generated tokens in number of seconds.
381
+ Its current value will be referenced at renewal time.
382
+ :param pulumi.Input[bool] token_no_default_policy: If set, the default policy will not be set on
383
+ generated tokens; otherwise it will be added to the policies set in token_policies.
345
384
  :param pulumi.Input[int] token_num_uses: The maximum number of times a token may be used, a value of zero means unlimited
346
- :param pulumi.Input[int] token_period: Generated Token's Period
347
- :param pulumi.Input[Sequence[pulumi.Input[str]]] token_policies: Generated Token's Policies
348
- :param pulumi.Input[int] token_ttl: The initial ttl of the token to generate in seconds
349
- :param pulumi.Input[str] token_type: The type of token to generate, service or batch
385
+ :param pulumi.Input[int] token_period: If set, indicates that the
386
+ token generated using this role should never expire. The token should be renewed within the
387
+ duration specified by this value. At each renewal, the token's TTL will be set to the
388
+ value of this field. Specified in seconds.
389
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] token_policies: List of policies to encode onto generated tokens. Depending
390
+ on the auth method, this list may be supplemented by user/group/other values.
391
+ :param pulumi.Input[int] token_ttl: The incremental lifetime for generated tokens in number of seconds.
392
+ Its current value will be referenced at renewal time.
393
+ :param pulumi.Input[str] token_type: The type of token that should be generated. Can be `service`,
394
+ `batch`, or `default` to use the mount's tuned default (which unless changed will be
395
+ `service` tokens). For token store roles, there are two additional possibilities:
396
+ `default-service` and `default-batch` which specify the type to return unless the client
397
+ requests a different type at generation time.
350
398
  """
351
399
  if bound_attributes is not None:
352
400
  pulumi.set(__self__, "bound_attributes", bound_attributes)
@@ -489,7 +537,9 @@ class _AuthBackendRoleState:
489
537
  @pulumi.getter(name="tokenBoundCidrs")
490
538
  def token_bound_cidrs(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
491
539
  """
492
- Specifies the blocks of IP addresses which are allowed to use the generated token
540
+ List of CIDR blocks; if set, specifies blocks of IP
541
+ addresses which can authenticate successfully, and ties the resulting token to these blocks
542
+ as well.
493
543
  """
494
544
  return pulumi.get(self, "token_bound_cidrs")
495
545
 
@@ -501,7 +551,10 @@ class _AuthBackendRoleState:
501
551
  @pulumi.getter(name="tokenExplicitMaxTtl")
502
552
  def token_explicit_max_ttl(self) -> Optional[pulumi.Input[int]]:
503
553
  """
504
- Generated Token's Explicit Maximum TTL in seconds
554
+ If set, will encode an
555
+ [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
556
+ onto the token in number of seconds. This is a hard cap even if `token_ttl` and
557
+ `token_max_ttl` would otherwise allow a renewal.
505
558
  """
506
559
  return pulumi.get(self, "token_explicit_max_ttl")
507
560
 
@@ -513,7 +566,8 @@ class _AuthBackendRoleState:
513
566
  @pulumi.getter(name="tokenMaxTtl")
514
567
  def token_max_ttl(self) -> Optional[pulumi.Input[int]]:
515
568
  """
516
- The maximum lifetime of the generated token
569
+ The maximum lifetime for generated tokens in number of seconds.
570
+ Its current value will be referenced at renewal time.
517
571
  """
518
572
  return pulumi.get(self, "token_max_ttl")
519
573
 
@@ -525,7 +579,8 @@ class _AuthBackendRoleState:
525
579
  @pulumi.getter(name="tokenNoDefaultPolicy")
526
580
  def token_no_default_policy(self) -> Optional[pulumi.Input[bool]]:
527
581
  """
528
- If true, the 'default' policy will not automatically be added to generated tokens
582
+ If set, the default policy will not be set on
583
+ generated tokens; otherwise it will be added to the policies set in token_policies.
529
584
  """
530
585
  return pulumi.get(self, "token_no_default_policy")
531
586
 
@@ -549,7 +604,10 @@ class _AuthBackendRoleState:
549
604
  @pulumi.getter(name="tokenPeriod")
550
605
  def token_period(self) -> Optional[pulumi.Input[int]]:
551
606
  """
552
- Generated Token's Period
607
+ If set, indicates that the
608
+ token generated using this role should never expire. The token should be renewed within the
609
+ duration specified by this value. At each renewal, the token's TTL will be set to the
610
+ value of this field. Specified in seconds.
553
611
  """
554
612
  return pulumi.get(self, "token_period")
555
613
 
@@ -561,7 +619,8 @@ class _AuthBackendRoleState:
561
619
  @pulumi.getter(name="tokenPolicies")
562
620
  def token_policies(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
563
621
  """
564
- Generated Token's Policies
622
+ List of policies to encode onto generated tokens. Depending
623
+ on the auth method, this list may be supplemented by user/group/other values.
565
624
  """
566
625
  return pulumi.get(self, "token_policies")
567
626
 
@@ -573,7 +632,8 @@ class _AuthBackendRoleState:
573
632
  @pulumi.getter(name="tokenTtl")
574
633
  def token_ttl(self) -> Optional[pulumi.Input[int]]:
575
634
  """
576
- The initial ttl of the token to generate in seconds
635
+ The incremental lifetime for generated tokens in number of seconds.
636
+ Its current value will be referenced at renewal time.
577
637
  """
578
638
  return pulumi.get(self, "token_ttl")
579
639
 
@@ -585,7 +645,11 @@ class _AuthBackendRoleState:
585
645
  @pulumi.getter(name="tokenType")
586
646
  def token_type(self) -> Optional[pulumi.Input[str]]:
587
647
  """
588
- The type of token to generate, service or batch
648
+ The type of token that should be generated. Can be `service`,
649
+ `batch`, or `default` to use the mount's tuned default (which unless changed will be
650
+ `service` tokens). For token store roles, there are two additional possibilities:
651
+ `default-service` and `default-batch` which specify the type to return unless the client
652
+ requests a different type at generation time.
589
653
  """
590
654
  return pulumi.get(self, "token_type")
591
655
 
@@ -624,19 +688,19 @@ class AuthBackendRole(pulumi.CustomResource):
624
688
 
625
689
  ## Example Usage
626
690
 
691
+ <!--Start PulumiCodeChooser -->
627
692
  ```python
628
693
  import pulumi
629
694
  import pulumi_vault as vault
630
695
 
631
- example = vault.saml.AuthBackend("example",
696
+ example_auth_backend = vault.saml.AuthBackend("exampleAuthBackend",
632
697
  path="saml",
633
698
  idp_metadata_url="https://company.okta.com/app/abc123eb9xnIfzlaf697/sso/saml/metadata",
634
699
  entity_id="https://my.vault/v1/auth/saml",
635
700
  acs_urls=["https://my.vault.primary/v1/auth/saml/callback"],
636
701
  default_role="default-role")
637
- example_auth_backend_role = vault.saml.AuthBackendRole("example",
638
- path=example.path,
639
- name="my-role",
702
+ example_auth_backend_role = vault.saml.AuthBackendRole("exampleAuthBackendRole",
703
+ path=example_auth_backend.path,
640
704
  groups_attribute="groups",
641
705
  bound_attributes={
642
706
  "group": "admin",
@@ -645,6 +709,7 @@ class AuthBackendRole(pulumi.CustomResource):
645
709
  token_policies=["writer"],
646
710
  token_ttl=86400)
647
711
  ```
712
+ <!--End PulumiCodeChooser -->
648
713
 
649
714
  ## Import
650
715
 
@@ -670,15 +735,31 @@ class AuthBackendRole(pulumi.CustomResource):
670
735
  The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
671
736
  *Available only for Vault Enterprise*.
672
737
  :param pulumi.Input[str] path: Path where the auth backend is mounted.
673
- :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: Specifies the blocks of IP addresses which are allowed to use the generated token
674
- :param pulumi.Input[int] token_explicit_max_ttl: Generated Token's Explicit Maximum TTL in seconds
675
- :param pulumi.Input[int] token_max_ttl: The maximum lifetime of the generated token
676
- :param pulumi.Input[bool] token_no_default_policy: If true, the 'default' policy will not automatically be added to generated tokens
738
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: List of CIDR blocks; if set, specifies blocks of IP
739
+ addresses which can authenticate successfully, and ties the resulting token to these blocks
740
+ as well.
741
+ :param pulumi.Input[int] token_explicit_max_ttl: If set, will encode an
742
+ [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
743
+ onto the token in number of seconds. This is a hard cap even if `token_ttl` and
744
+ `token_max_ttl` would otherwise allow a renewal.
745
+ :param pulumi.Input[int] token_max_ttl: The maximum lifetime for generated tokens in number of seconds.
746
+ Its current value will be referenced at renewal time.
747
+ :param pulumi.Input[bool] token_no_default_policy: If set, the default policy will not be set on
748
+ generated tokens; otherwise it will be added to the policies set in token_policies.
677
749
  :param pulumi.Input[int] token_num_uses: The maximum number of times a token may be used, a value of zero means unlimited
678
- :param pulumi.Input[int] token_period: Generated Token's Period
679
- :param pulumi.Input[Sequence[pulumi.Input[str]]] token_policies: Generated Token's Policies
680
- :param pulumi.Input[int] token_ttl: The initial ttl of the token to generate in seconds
681
- :param pulumi.Input[str] token_type: The type of token to generate, service or batch
750
+ :param pulumi.Input[int] token_period: If set, indicates that the
751
+ token generated using this role should never expire. The token should be renewed within the
752
+ duration specified by this value. At each renewal, the token's TTL will be set to the
753
+ value of this field. Specified in seconds.
754
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] token_policies: List of policies to encode onto generated tokens. Depending
755
+ on the auth method, this list may be supplemented by user/group/other values.
756
+ :param pulumi.Input[int] token_ttl: The incremental lifetime for generated tokens in number of seconds.
757
+ Its current value will be referenced at renewal time.
758
+ :param pulumi.Input[str] token_type: The type of token that should be generated. Can be `service`,
759
+ `batch`, or `default` to use the mount's tuned default (which unless changed will be
760
+ `service` tokens). For token store roles, there are two additional possibilities:
761
+ `default-service` and `default-batch` which specify the type to return unless the client
762
+ requests a different type at generation time.
682
763
  """
683
764
  ...
684
765
  @overload
@@ -693,19 +774,19 @@ class AuthBackendRole(pulumi.CustomResource):
693
774
 
694
775
  ## Example Usage
695
776
 
777
+ <!--Start PulumiCodeChooser -->
696
778
  ```python
697
779
  import pulumi
698
780
  import pulumi_vault as vault
699
781
 
700
- example = vault.saml.AuthBackend("example",
782
+ example_auth_backend = vault.saml.AuthBackend("exampleAuthBackend",
701
783
  path="saml",
702
784
  idp_metadata_url="https://company.okta.com/app/abc123eb9xnIfzlaf697/sso/saml/metadata",
703
785
  entity_id="https://my.vault/v1/auth/saml",
704
786
  acs_urls=["https://my.vault.primary/v1/auth/saml/callback"],
705
787
  default_role="default-role")
706
- example_auth_backend_role = vault.saml.AuthBackendRole("example",
707
- path=example.path,
708
- name="my-role",
788
+ example_auth_backend_role = vault.saml.AuthBackendRole("exampleAuthBackendRole",
789
+ path=example_auth_backend.path,
709
790
  groups_attribute="groups",
710
791
  bound_attributes={
711
792
  "group": "admin",
@@ -714,6 +795,7 @@ class AuthBackendRole(pulumi.CustomResource):
714
795
  token_policies=["writer"],
715
796
  token_ttl=86400)
716
797
  ```
798
+ <!--End PulumiCodeChooser -->
717
799
 
718
800
  ## Import
719
801
 
@@ -831,15 +913,31 @@ class AuthBackendRole(pulumi.CustomResource):
831
913
  The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
832
914
  *Available only for Vault Enterprise*.
833
915
  :param pulumi.Input[str] path: Path where the auth backend is mounted.
834
- :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: Specifies the blocks of IP addresses which are allowed to use the generated token
835
- :param pulumi.Input[int] token_explicit_max_ttl: Generated Token's Explicit Maximum TTL in seconds
836
- :param pulumi.Input[int] token_max_ttl: The maximum lifetime of the generated token
837
- :param pulumi.Input[bool] token_no_default_policy: If true, the 'default' policy will not automatically be added to generated tokens
916
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: List of CIDR blocks; if set, specifies blocks of IP
917
+ addresses which can authenticate successfully, and ties the resulting token to these blocks
918
+ as well.
919
+ :param pulumi.Input[int] token_explicit_max_ttl: If set, will encode an
920
+ [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
921
+ onto the token in number of seconds. This is a hard cap even if `token_ttl` and
922
+ `token_max_ttl` would otherwise allow a renewal.
923
+ :param pulumi.Input[int] token_max_ttl: The maximum lifetime for generated tokens in number of seconds.
924
+ Its current value will be referenced at renewal time.
925
+ :param pulumi.Input[bool] token_no_default_policy: If set, the default policy will not be set on
926
+ generated tokens; otherwise it will be added to the policies set in token_policies.
838
927
  :param pulumi.Input[int] token_num_uses: The maximum number of times a token may be used, a value of zero means unlimited
839
- :param pulumi.Input[int] token_period: Generated Token's Period
840
- :param pulumi.Input[Sequence[pulumi.Input[str]]] token_policies: Generated Token's Policies
841
- :param pulumi.Input[int] token_ttl: The initial ttl of the token to generate in seconds
842
- :param pulumi.Input[str] token_type: The type of token to generate, service or batch
928
+ :param pulumi.Input[int] token_period: If set, indicates that the
929
+ token generated using this role should never expire. The token should be renewed within the
930
+ duration specified by this value. At each renewal, the token's TTL will be set to the
931
+ value of this field. Specified in seconds.
932
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] token_policies: List of policies to encode onto generated tokens. Depending
933
+ on the auth method, this list may be supplemented by user/group/other values.
934
+ :param pulumi.Input[int] token_ttl: The incremental lifetime for generated tokens in number of seconds.
935
+ Its current value will be referenced at renewal time.
936
+ :param pulumi.Input[str] token_type: The type of token that should be generated. Can be `service`,
937
+ `batch`, or `default` to use the mount's tuned default (which unless changed will be
938
+ `service` tokens). For token store roles, there are two additional possibilities:
939
+ `default-service` and `default-batch` which specify the type to return unless the client
940
+ requests a different type at generation time.
843
941
  """
844
942
  opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
845
943
 
@@ -938,7 +1036,9 @@ class AuthBackendRole(pulumi.CustomResource):
938
1036
  @pulumi.getter(name="tokenBoundCidrs")
939
1037
  def token_bound_cidrs(self) -> pulumi.Output[Optional[Sequence[str]]]:
940
1038
  """
941
- Specifies the blocks of IP addresses which are allowed to use the generated token
1039
+ List of CIDR blocks; if set, specifies blocks of IP
1040
+ addresses which can authenticate successfully, and ties the resulting token to these blocks
1041
+ as well.
942
1042
  """
943
1043
  return pulumi.get(self, "token_bound_cidrs")
944
1044
 
@@ -946,7 +1046,10 @@ class AuthBackendRole(pulumi.CustomResource):
946
1046
  @pulumi.getter(name="tokenExplicitMaxTtl")
947
1047
  def token_explicit_max_ttl(self) -> pulumi.Output[Optional[int]]:
948
1048
  """
949
- Generated Token's Explicit Maximum TTL in seconds
1049
+ If set, will encode an
1050
+ [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
1051
+ onto the token in number of seconds. This is a hard cap even if `token_ttl` and
1052
+ `token_max_ttl` would otherwise allow a renewal.
950
1053
  """
951
1054
  return pulumi.get(self, "token_explicit_max_ttl")
952
1055
 
@@ -954,7 +1057,8 @@ class AuthBackendRole(pulumi.CustomResource):
954
1057
  @pulumi.getter(name="tokenMaxTtl")
955
1058
  def token_max_ttl(self) -> pulumi.Output[Optional[int]]:
956
1059
  """
957
- The maximum lifetime of the generated token
1060
+ The maximum lifetime for generated tokens in number of seconds.
1061
+ Its current value will be referenced at renewal time.
958
1062
  """
959
1063
  return pulumi.get(self, "token_max_ttl")
960
1064
 
@@ -962,7 +1066,8 @@ class AuthBackendRole(pulumi.CustomResource):
962
1066
  @pulumi.getter(name="tokenNoDefaultPolicy")
963
1067
  def token_no_default_policy(self) -> pulumi.Output[Optional[bool]]:
964
1068
  """
965
- If true, the 'default' policy will not automatically be added to generated tokens
1069
+ If set, the default policy will not be set on
1070
+ generated tokens; otherwise it will be added to the policies set in token_policies.
966
1071
  """
967
1072
  return pulumi.get(self, "token_no_default_policy")
968
1073
 
@@ -978,7 +1083,10 @@ class AuthBackendRole(pulumi.CustomResource):
978
1083
  @pulumi.getter(name="tokenPeriod")
979
1084
  def token_period(self) -> pulumi.Output[Optional[int]]:
980
1085
  """
981
- Generated Token's Period
1086
+ If set, indicates that the
1087
+ token generated using this role should never expire. The token should be renewed within the
1088
+ duration specified by this value. At each renewal, the token's TTL will be set to the
1089
+ value of this field. Specified in seconds.
982
1090
  """
983
1091
  return pulumi.get(self, "token_period")
984
1092
 
@@ -986,7 +1094,8 @@ class AuthBackendRole(pulumi.CustomResource):
986
1094
  @pulumi.getter(name="tokenPolicies")
987
1095
  def token_policies(self) -> pulumi.Output[Optional[Sequence[str]]]:
988
1096
  """
989
- Generated Token's Policies
1097
+ List of policies to encode onto generated tokens. Depending
1098
+ on the auth method, this list may be supplemented by user/group/other values.
990
1099
  """
991
1100
  return pulumi.get(self, "token_policies")
992
1101
 
@@ -994,7 +1103,8 @@ class AuthBackendRole(pulumi.CustomResource):
994
1103
  @pulumi.getter(name="tokenTtl")
995
1104
  def token_ttl(self) -> pulumi.Output[Optional[int]]:
996
1105
  """
997
- The initial ttl of the token to generate in seconds
1106
+ The incremental lifetime for generated tokens in number of seconds.
1107
+ Its current value will be referenced at renewal time.
998
1108
  """
999
1109
  return pulumi.get(self, "token_ttl")
1000
1110
 
@@ -1002,7 +1112,11 @@ class AuthBackendRole(pulumi.CustomResource):
1002
1112
  @pulumi.getter(name="tokenType")
1003
1113
  def token_type(self) -> pulumi.Output[Optional[str]]:
1004
1114
  """
1005
- The type of token to generate, service or batch
1115
+ The type of token that should be generated. Can be `service`,
1116
+ `batch`, or `default` to use the mount's tuned default (which unless changed will be
1117
+ `service` tokens). For token store roles, there are two additional possibilities:
1118
+ `default-service` and `default-batch` which specify the type to return unless the client
1119
+ requests a different type at generation time.
1006
1120
  """
1007
1121
  return pulumi.get(self, "token_type")
1008
1122