pulumi-vault 6.2.0a1713561465__py3-none-any.whl → 6.2.0a1714114277__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 (179) hide show
  1. pulumi_vault/_inputs.py +0 -20
  2. pulumi_vault/ad/secret_backend.py +0 -4
  3. pulumi_vault/ad/secret_library.py +0 -4
  4. pulumi_vault/ad/secret_role.py +0 -4
  5. pulumi_vault/alicloud/auth_backend_role.py +63 -186
  6. pulumi_vault/approle/auth_backend_login.py +0 -4
  7. pulumi_vault/approle/auth_backend_role.py +63 -186
  8. pulumi_vault/approle/auth_backend_role_secret_id.py +0 -4
  9. pulumi_vault/approle/get_auth_backend_role_id.py +0 -4
  10. pulumi_vault/audit.py +0 -8
  11. pulumi_vault/audit_request_header.py +0 -4
  12. pulumi_vault/aws/auth_backend_client.py +0 -4
  13. pulumi_vault/aws/auth_backend_config_identity.py +0 -4
  14. pulumi_vault/aws/auth_backend_identity_whitelist.py +0 -4
  15. pulumi_vault/aws/auth_backend_role.py +63 -186
  16. pulumi_vault/aws/auth_backend_roletag_blacklist.py +0 -4
  17. pulumi_vault/aws/auth_backend_sts_role.py +0 -4
  18. pulumi_vault/aws/secret_backend_role.py +0 -4
  19. pulumi_vault/aws/secret_backend_static_role.py +0 -4
  20. pulumi_vault/azure/auth_backend_config.py +0 -4
  21. pulumi_vault/azure/auth_backend_role.py +63 -186
  22. pulumi_vault/azure/backend.py +0 -8
  23. pulumi_vault/azure/backend_role.py +0 -4
  24. pulumi_vault/azure/get_access_credentials.py +0 -4
  25. pulumi_vault/cert_auth_backend_role.py +63 -200
  26. pulumi_vault/consul/secret_backend.py +0 -8
  27. pulumi_vault/consul/secret_backend_role.py +0 -4
  28. pulumi_vault/database/_inputs.py +522 -784
  29. pulumi_vault/database/outputs.py +522 -784
  30. pulumi_vault/database/secret_backend_connection.py +0 -4
  31. pulumi_vault/database/secret_backend_role.py +0 -4
  32. pulumi_vault/database/secret_backend_static_role.py +0 -4
  33. pulumi_vault/database/secrets_mount.py +0 -4
  34. pulumi_vault/egp_policy.py +0 -4
  35. pulumi_vault/gcp/auth_backend_role.py +63 -264
  36. pulumi_vault/gcp/get_auth_backend_role.py +0 -4
  37. pulumi_vault/gcp/secret_backend.py +0 -4
  38. pulumi_vault/gcp/secret_impersonated_account.py +0 -4
  39. pulumi_vault/gcp/secret_roleset.py +0 -4
  40. pulumi_vault/gcp/secret_static_account.py +0 -4
  41. pulumi_vault/generic/endpoint.py +0 -4
  42. pulumi_vault/generic/get_secret.py +0 -8
  43. pulumi_vault/get_auth_backend.py +0 -4
  44. pulumi_vault/get_auth_backends.py +0 -8
  45. pulumi_vault/get_namespace.py +0 -12
  46. pulumi_vault/get_namespaces.py +0 -8
  47. pulumi_vault/get_nomad_access_token.py +0 -4
  48. pulumi_vault/get_policy_document.py +0 -4
  49. pulumi_vault/get_raft_autopilot_state.py +0 -4
  50. pulumi_vault/github/auth_backend.py +0 -4
  51. pulumi_vault/github/team.py +0 -4
  52. pulumi_vault/github/user.py +0 -4
  53. pulumi_vault/identity/entity.py +0 -4
  54. pulumi_vault/identity/entity_alias.py +0 -4
  55. pulumi_vault/identity/entity_policies.py +0 -8
  56. pulumi_vault/identity/get_entity.py +0 -4
  57. pulumi_vault/identity/get_group.py +0 -4
  58. pulumi_vault/identity/get_oidc_client_creds.py +0 -4
  59. pulumi_vault/identity/get_oidc_openid_config.py +0 -4
  60. pulumi_vault/identity/get_oidc_public_keys.py +0 -4
  61. pulumi_vault/identity/group.py +0 -12
  62. pulumi_vault/identity/group_alias.py +0 -4
  63. pulumi_vault/identity/group_member_entity_ids.py +0 -8
  64. pulumi_vault/identity/group_member_group_ids.py +0 -8
  65. pulumi_vault/identity/group_policies.py +0 -8
  66. pulumi_vault/identity/mfa_duo.py +0 -4
  67. pulumi_vault/identity/mfa_login_enforcement.py +0 -4
  68. pulumi_vault/identity/mfa_okta.py +0 -4
  69. pulumi_vault/identity/mfa_pingid.py +0 -4
  70. pulumi_vault/identity/mfa_totp.py +0 -4
  71. pulumi_vault/identity/oidc.py +0 -4
  72. pulumi_vault/identity/oidc_assignment.py +0 -4
  73. pulumi_vault/identity/oidc_client.py +0 -4
  74. pulumi_vault/identity/oidc_key.py +0 -4
  75. pulumi_vault/identity/oidc_key_allowed_client_id.py +0 -4
  76. pulumi_vault/identity/oidc_provider.py +0 -4
  77. pulumi_vault/identity/oidc_role.py +0 -8
  78. pulumi_vault/identity/oidc_scope.py +0 -4
  79. pulumi_vault/jwt/auth_backend.py +0 -12
  80. pulumi_vault/jwt/auth_backend_role.py +63 -190
  81. pulumi_vault/kmip/secret_backend.py +0 -4
  82. pulumi_vault/kmip/secret_role.py +0 -4
  83. pulumi_vault/kmip/secret_scope.py +0 -4
  84. pulumi_vault/kubernetes/auth_backend_config.py +0 -4
  85. pulumi_vault/kubernetes/auth_backend_role.py +56 -172
  86. pulumi_vault/kubernetes/get_service_account_token.py +0 -4
  87. pulumi_vault/kubernetes/secret_backend.py +0 -4
  88. pulumi_vault/kubernetes/secret_backend_role.py +0 -12
  89. pulumi_vault/kv/get_secret.py +0 -4
  90. pulumi_vault/kv/get_secret_subkeys_v2.py +0 -4
  91. pulumi_vault/kv/get_secret_v2.py +0 -4
  92. pulumi_vault/kv/get_secrets_list.py +0 -4
  93. pulumi_vault/kv/get_secrets_list_v2.py +0 -4
  94. pulumi_vault/kv/secret.py +0 -4
  95. pulumi_vault/kv/secret_backend_v2.py +0 -4
  96. pulumi_vault/kv/secret_v2.py +0 -4
  97. pulumi_vault/ldap/auth_backend.py +56 -151
  98. pulumi_vault/ldap/auth_backend_group.py +0 -4
  99. pulumi_vault/ldap/auth_backend_user.py +0 -4
  100. pulumi_vault/ldap/secret_backend.py +0 -4
  101. pulumi_vault/ldap/secret_backend_dynamic_role.py +0 -4
  102. pulumi_vault/ldap/secret_backend_library_set.py +0 -4
  103. pulumi_vault/ldap/secret_backend_static_role.py +0 -4
  104. pulumi_vault/managed/_inputs.py +84 -132
  105. pulumi_vault/managed/keys.py +7 -28
  106. pulumi_vault/managed/outputs.py +84 -132
  107. pulumi_vault/mfa_duo.py +0 -4
  108. pulumi_vault/mfa_okta.py +0 -4
  109. pulumi_vault/mfa_pingid.py +0 -4
  110. pulumi_vault/mfa_totp.py +0 -4
  111. pulumi_vault/mongodbatlas/secret_backend.py +0 -4
  112. pulumi_vault/mongodbatlas/secret_role.py +0 -4
  113. pulumi_vault/mount.py +0 -16
  114. pulumi_vault/nomad_secret_backend.py +0 -4
  115. pulumi_vault/nomad_secret_role.py +0 -4
  116. pulumi_vault/okta/_inputs.py +8 -8
  117. pulumi_vault/okta/auth_backend.py +0 -4
  118. pulumi_vault/okta/auth_backend_group.py +0 -4
  119. pulumi_vault/okta/auth_backend_user.py +0 -4
  120. pulumi_vault/okta/outputs.py +8 -8
  121. pulumi_vault/outputs.py +0 -20
  122. pulumi_vault/password_policy.py +0 -4
  123. pulumi_vault/pkisecret/backend_config_cluster.py +0 -4
  124. pulumi_vault/pkisecret/get_backend_issuer.py +0 -4
  125. pulumi_vault/pkisecret/get_backend_issuers.py +0 -4
  126. pulumi_vault/pkisecret/get_backend_key.py +0 -4
  127. pulumi_vault/pkisecret/get_backend_keys.py +0 -4
  128. pulumi_vault/pkisecret/secret_backend_cert.py +0 -4
  129. pulumi_vault/pkisecret/secret_backend_config_ca.py +0 -4
  130. pulumi_vault/pkisecret/secret_backend_config_issuers.py +0 -4
  131. pulumi_vault/pkisecret/secret_backend_config_urls.py +0 -4
  132. pulumi_vault/pkisecret/secret_backend_crl_config.py +0 -4
  133. pulumi_vault/pkisecret/secret_backend_intermediate_cert_request.py +0 -4
  134. pulumi_vault/pkisecret/secret_backend_intermediate_set_signed.py +0 -4
  135. pulumi_vault/pkisecret/secret_backend_issuer.py +0 -4
  136. pulumi_vault/pkisecret/secret_backend_role.py +0 -4
  137. pulumi_vault/pkisecret/secret_backend_root_cert.py +0 -4
  138. pulumi_vault/pkisecret/secret_backend_root_sign_intermediate.py +0 -4
  139. pulumi_vault/pkisecret/secret_backend_sign.py +0 -4
  140. pulumi_vault/quota_lease_count.py +0 -4
  141. pulumi_vault/quota_rate_limit.py +0 -4
  142. pulumi_vault/rabbitmq/secret_backend.py +0 -4
  143. pulumi_vault/rabbitmq/secret_backend_role.py +0 -4
  144. pulumi_vault/raft_autopilot.py +0 -4
  145. pulumi_vault/raft_snapshot_agent_config.py +91 -292
  146. pulumi_vault/rgp_policy.py +0 -4
  147. pulumi_vault/saml/auth_backend.py +0 -4
  148. pulumi_vault/saml/auth_backend_role.py +56 -172
  149. pulumi_vault/secrets/sync_association.py +0 -4
  150. pulumi_vault/secrets/sync_aws_destination.py +0 -4
  151. pulumi_vault/secrets/sync_azure_destination.py +0 -4
  152. pulumi_vault/secrets/sync_config.py +0 -4
  153. pulumi_vault/secrets/sync_gcp_destination.py +0 -4
  154. pulumi_vault/secrets/sync_gh_destination.py +0 -4
  155. pulumi_vault/secrets/sync_github_apps.py +0 -4
  156. pulumi_vault/secrets/sync_vercel_destination.py +0 -4
  157. pulumi_vault/ssh/_inputs.py +6 -20
  158. pulumi_vault/ssh/outputs.py +6 -20
  159. pulumi_vault/ssh/secret_backend_ca.py +0 -4
  160. pulumi_vault/ssh/secret_backend_role.py +0 -4
  161. pulumi_vault/terraformcloud/secret_backend.py +0 -4
  162. pulumi_vault/terraformcloud/secret_creds.py +0 -4
  163. pulumi_vault/terraformcloud/secret_role.py +0 -4
  164. pulumi_vault/token.py +0 -4
  165. pulumi_vault/tokenauth/auth_backend_role.py +56 -172
  166. pulumi_vault/transform/alphabet.py +0 -4
  167. pulumi_vault/transform/get_decode.py +0 -4
  168. pulumi_vault/transform/get_encode.py +0 -4
  169. pulumi_vault/transform/role.py +0 -4
  170. pulumi_vault/transform/template.py +0 -4
  171. pulumi_vault/transit/get_decrypt.py +0 -16
  172. pulumi_vault/transit/get_encrypt.py +0 -14
  173. pulumi_vault/transit/secret_backend_key.py +0 -4
  174. pulumi_vault/transit/secret_cache_config.py +0 -4
  175. {pulumi_vault-6.2.0a1713561465.dist-info → pulumi_vault-6.2.0a1714114277.dist-info}/METADATA +1 -1
  176. pulumi_vault-6.2.0a1714114277.dist-info/RECORD +252 -0
  177. pulumi_vault-6.2.0a1713561465.dist-info/RECORD +0 -252
  178. {pulumi_vault-6.2.0a1713561465.dist-info → pulumi_vault-6.2.0a1714114277.dist-info}/WHEEL +0 -0
  179. {pulumi_vault-6.2.0a1713561465.dist-info → pulumi_vault-6.2.0a1714114277.dist-info}/top_level.txt +0 -0
pulumi_vault/tokenauth/auth_backend_role.py CHANGED
@@ -50,31 +50,15 @@ class AuthBackendRoleArgs:
50
50
 
51
51
  > Due to a bug the resource. This *will* cause all existing tokens issued by this role to be revoked.
52
52
  :param pulumi.Input[bool] renewable: Whether to disable the ability of the token to be renewed past its initial TTL.
53
- :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: List of CIDR blocks; if set, specifies blocks of IP
54
- addresses which can authenticate successfully, and ties the resulting token to these blocks
55
- as well.
56
- :param pulumi.Input[int] token_explicit_max_ttl: If set, will encode an
57
- [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
58
- onto the token in number of seconds. This is a hard cap even if `token_ttl` and
59
- `token_max_ttl` would otherwise allow a renewal.
60
- :param pulumi.Input[int] token_max_ttl: The maximum lifetime for generated tokens in number of seconds.
61
- Its current value will be referenced at renewal time.
62
- :param pulumi.Input[bool] token_no_default_policy: If set, the default policy will not be set on
63
- generated tokens; otherwise it will be added to the policies set in token_policies.
64
- :param pulumi.Input[int] token_num_uses: The [maximum number](https://www.vaultproject.io/api-docs/token#token_num_uses)
65
- of times a generated token may be used (within its lifetime); 0 means unlimited.
66
- :param pulumi.Input[int] token_period: If set, indicates that the
67
- token generated using this role should never expire. The token should be renewed within the
68
- duration specified by this value. At each renewal, the token's TTL will be set to the
69
- value of this field. Specified in seconds.
53
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: Specifies the blocks of IP addresses which are allowed to use the generated token
54
+ :param pulumi.Input[int] token_explicit_max_ttl: Generated Token's Explicit Maximum TTL in seconds
55
+ :param pulumi.Input[int] token_max_ttl: The maximum lifetime of the generated token
56
+ :param pulumi.Input[bool] token_no_default_policy: If true, the 'default' policy will not automatically be added to generated tokens
57
+ :param pulumi.Input[int] token_num_uses: The maximum number of times a token may be used, a value of zero means unlimited
58
+ :param pulumi.Input[int] token_period: Generated Token's Period
70
59
  :param pulumi.Input[Sequence[pulumi.Input[str]]] token_policies: Generated Token's Policies
71
- :param pulumi.Input[int] token_ttl: The incremental lifetime for generated tokens in number of seconds.
72
- Its current value will be referenced at renewal time.
73
- :param pulumi.Input[str] token_type: The type of token that should be generated. Can be `service`,
74
- `batch`, or `default` to use the mount's tuned default (which unless changed will be
75
- `service` tokens). For token store roles, there are two additional possibilities:
76
- `default-service` and `default-batch` which specify the type to return unless the client
77
- requests a different type at generation time.
60
+ :param pulumi.Input[int] token_ttl: The initial ttl of the token to generate in seconds
61
+ :param pulumi.Input[str] token_type: The type of token to generate, service or batch
78
62
  """
79
63
  pulumi.set(__self__, "role_name", role_name)
80
64
  if allowed_entity_aliases is not None:
@@ -243,9 +227,7 @@ class AuthBackendRoleArgs:
243
227
  @pulumi.getter(name="tokenBoundCidrs")
244
228
  def token_bound_cidrs(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
245
229
  """
246
- List of CIDR blocks; if set, specifies blocks of IP
247
- addresses which can authenticate successfully, and ties the resulting token to these blocks
248
- as well.
230
+ Specifies the blocks of IP addresses which are allowed to use the generated token
249
231
  """
250
232
  return pulumi.get(self, "token_bound_cidrs")
251
233
 
@@ -257,10 +239,7 @@ class AuthBackendRoleArgs:
257
239
  @pulumi.getter(name="tokenExplicitMaxTtl")
258
240
  def token_explicit_max_ttl(self) -> Optional[pulumi.Input[int]]:
259
241
  """
260
- If set, will encode an
261
- [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
262
- onto the token in number of seconds. This is a hard cap even if `token_ttl` and
263
- `token_max_ttl` would otherwise allow a renewal.
242
+ Generated Token's Explicit Maximum TTL in seconds
264
243
  """
265
244
  return pulumi.get(self, "token_explicit_max_ttl")
266
245
 
@@ -272,8 +251,7 @@ class AuthBackendRoleArgs:
272
251
  @pulumi.getter(name="tokenMaxTtl")
273
252
  def token_max_ttl(self) -> Optional[pulumi.Input[int]]:
274
253
  """
275
- The maximum lifetime for generated tokens in number of seconds.
276
- Its current value will be referenced at renewal time.
254
+ The maximum lifetime of the generated token
277
255
  """
278
256
  return pulumi.get(self, "token_max_ttl")
279
257
 
@@ -285,8 +263,7 @@ class AuthBackendRoleArgs:
285
263
  @pulumi.getter(name="tokenNoDefaultPolicy")
286
264
  def token_no_default_policy(self) -> Optional[pulumi.Input[bool]]:
287
265
  """
288
- If set, the default policy will not be set on
289
- generated tokens; otherwise it will be added to the policies set in token_policies.
266
+ If true, the 'default' policy will not automatically be added to generated tokens
290
267
  """
291
268
  return pulumi.get(self, "token_no_default_policy")
292
269
 
@@ -298,8 +275,7 @@ class AuthBackendRoleArgs:
298
275
  @pulumi.getter(name="tokenNumUses")
299
276
  def token_num_uses(self) -> Optional[pulumi.Input[int]]:
300
277
  """
301
- The [maximum number](https://www.vaultproject.io/api-docs/token#token_num_uses)
302
- of times a generated token may be used (within its lifetime); 0 means unlimited.
278
+ The maximum number of times a token may be used, a value of zero means unlimited
303
279
  """
304
280
  return pulumi.get(self, "token_num_uses")
305
281
 
@@ -311,10 +287,7 @@ class AuthBackendRoleArgs:
311
287
  @pulumi.getter(name="tokenPeriod")
312
288
  def token_period(self) -> Optional[pulumi.Input[int]]:
313
289
  """
314
- If set, indicates that the
315
- token generated using this role should never expire. The token should be renewed within the
316
- duration specified by this value. At each renewal, the token's TTL will be set to the
317
- value of this field. Specified in seconds.
290
+ Generated Token's Period
318
291
  """
319
292
  return pulumi.get(self, "token_period")
320
293
 
@@ -338,8 +311,7 @@ class AuthBackendRoleArgs:
338
311
  @pulumi.getter(name="tokenTtl")
339
312
  def token_ttl(self) -> Optional[pulumi.Input[int]]:
340
313
  """
341
- The incremental lifetime for generated tokens in number of seconds.
342
- Its current value will be referenced at renewal time.
314
+ The initial ttl of the token to generate in seconds
343
315
  """
344
316
  return pulumi.get(self, "token_ttl")
345
317
 
@@ -351,11 +323,7 @@ class AuthBackendRoleArgs:
351
323
  @pulumi.getter(name="tokenType")
352
324
  def token_type(self) -> Optional[pulumi.Input[str]]:
353
325
  """
354
- The type of token that should be generated. Can be `service`,
355
- `batch`, or `default` to use the mount's tuned default (which unless changed will be
356
- `service` tokens). For token store roles, there are two additional possibilities:
357
- `default-service` and `default-batch` which specify the type to return unless the client
358
- requests a different type at generation time.
326
+ The type of token to generate, service or batch
359
327
  """
360
328
  return pulumi.get(self, "token_type")
361
329
 
@@ -403,31 +371,15 @@ class _AuthBackendRoleState:
403
371
  > Due to a bug the resource. This *will* cause all existing tokens issued by this role to be revoked.
404
372
  :param pulumi.Input[bool] renewable: Whether to disable the ability of the token to be renewed past its initial TTL.
405
373
  :param pulumi.Input[str] role_name: The name of the role.
406
- :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: List of CIDR blocks; if set, specifies blocks of IP
407
- addresses which can authenticate successfully, and ties the resulting token to these blocks
408
- as well.
409
- :param pulumi.Input[int] token_explicit_max_ttl: If set, will encode an
410
- [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
411
- onto the token in number of seconds. This is a hard cap even if `token_ttl` and
412
- `token_max_ttl` would otherwise allow a renewal.
413
- :param pulumi.Input[int] token_max_ttl: The maximum lifetime for generated tokens in number of seconds.
414
- Its current value will be referenced at renewal time.
415
- :param pulumi.Input[bool] token_no_default_policy: If set, the default policy will not be set on
416
- generated tokens; otherwise it will be added to the policies set in token_policies.
417
- :param pulumi.Input[int] token_num_uses: The [maximum number](https://www.vaultproject.io/api-docs/token#token_num_uses)
418
- of times a generated token may be used (within its lifetime); 0 means unlimited.
419
- :param pulumi.Input[int] token_period: If set, indicates that the
420
- token generated using this role should never expire. The token should be renewed within the
421
- duration specified by this value. At each renewal, the token's TTL will be set to the
422
- value of this field. Specified in seconds.
374
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: Specifies the blocks of IP addresses which are allowed to use the generated token
375
+ :param pulumi.Input[int] token_explicit_max_ttl: Generated Token's Explicit Maximum TTL in seconds
376
+ :param pulumi.Input[int] token_max_ttl: The maximum lifetime of the generated token
377
+ :param pulumi.Input[bool] token_no_default_policy: If true, the 'default' policy will not automatically be added to generated tokens
378
+ :param pulumi.Input[int] token_num_uses: The maximum number of times a token may be used, a value of zero means unlimited
379
+ :param pulumi.Input[int] token_period: Generated Token's Period
423
380
  :param pulumi.Input[Sequence[pulumi.Input[str]]] token_policies: Generated Token's Policies
424
- :param pulumi.Input[int] token_ttl: The incremental lifetime for generated tokens in number of seconds.
425
- Its current value will be referenced at renewal time.
426
- :param pulumi.Input[str] token_type: The type of token that should be generated. Can be `service`,
427
- `batch`, or `default` to use the mount's tuned default (which unless changed will be
428
- `service` tokens). For token store roles, there are two additional possibilities:
429
- `default-service` and `default-batch` which specify the type to return unless the client
430
- requests a different type at generation time.
381
+ :param pulumi.Input[int] token_ttl: The initial ttl of the token to generate in seconds
382
+ :param pulumi.Input[str] token_type: The type of token to generate, service or batch
431
383
  """
432
384
  if allowed_entity_aliases is not None:
433
385
  pulumi.set(__self__, "allowed_entity_aliases", allowed_entity_aliases)
@@ -597,9 +549,7 @@ class _AuthBackendRoleState:
597
549
  @pulumi.getter(name="tokenBoundCidrs")
598
550
  def token_bound_cidrs(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
599
551
  """
600
- List of CIDR blocks; if set, specifies blocks of IP
601
- addresses which can authenticate successfully, and ties the resulting token to these blocks
602
- as well.
552
+ Specifies the blocks of IP addresses which are allowed to use the generated token
603
553
  """
604
554
  return pulumi.get(self, "token_bound_cidrs")
605
555
 
@@ -611,10 +561,7 @@ class _AuthBackendRoleState:
611
561
  @pulumi.getter(name="tokenExplicitMaxTtl")
612
562
  def token_explicit_max_ttl(self) -> Optional[pulumi.Input[int]]:
613
563
  """
614
- If set, will encode an
615
- [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
616
- onto the token in number of seconds. This is a hard cap even if `token_ttl` and
617
- `token_max_ttl` would otherwise allow a renewal.
564
+ Generated Token's Explicit Maximum TTL in seconds
618
565
  """
619
566
  return pulumi.get(self, "token_explicit_max_ttl")
620
567
 
@@ -626,8 +573,7 @@ class _AuthBackendRoleState:
626
573
  @pulumi.getter(name="tokenMaxTtl")
627
574
  def token_max_ttl(self) -> Optional[pulumi.Input[int]]:
628
575
  """
629
- The maximum lifetime for generated tokens in number of seconds.
630
- Its current value will be referenced at renewal time.
576
+ The maximum lifetime of the generated token
631
577
  """
632
578
  return pulumi.get(self, "token_max_ttl")
633
579
 
@@ -639,8 +585,7 @@ class _AuthBackendRoleState:
639
585
  @pulumi.getter(name="tokenNoDefaultPolicy")
640
586
  def token_no_default_policy(self) -> Optional[pulumi.Input[bool]]:
641
587
  """
642
- If set, the default policy will not be set on
643
- generated tokens; otherwise it will be added to the policies set in token_policies.
588
+ If true, the 'default' policy will not automatically be added to generated tokens
644
589
  """
645
590
  return pulumi.get(self, "token_no_default_policy")
646
591
 
@@ -652,8 +597,7 @@ class _AuthBackendRoleState:
652
597
  @pulumi.getter(name="tokenNumUses")
653
598
  def token_num_uses(self) -> Optional[pulumi.Input[int]]:
654
599
  """
655
- The [maximum number](https://www.vaultproject.io/api-docs/token#token_num_uses)
656
- of times a generated token may be used (within its lifetime); 0 means unlimited.
600
+ The maximum number of times a token may be used, a value of zero means unlimited
657
601
  """
658
602
  return pulumi.get(self, "token_num_uses")
659
603
 
@@ -665,10 +609,7 @@ class _AuthBackendRoleState:
665
609
  @pulumi.getter(name="tokenPeriod")
666
610
  def token_period(self) -> Optional[pulumi.Input[int]]:
667
611
  """
668
- If set, indicates that the
669
- token generated using this role should never expire. The token should be renewed within the
670
- duration specified by this value. At each renewal, the token's TTL will be set to the
671
- value of this field. Specified in seconds.
612
+ Generated Token's Period
672
613
  """
673
614
  return pulumi.get(self, "token_period")
674
615
 
@@ -692,8 +633,7 @@ class _AuthBackendRoleState:
692
633
  @pulumi.getter(name="tokenTtl")
693
634
  def token_ttl(self) -> Optional[pulumi.Input[int]]:
694
635
  """
695
- The incremental lifetime for generated tokens in number of seconds.
696
- Its current value will be referenced at renewal time.
636
+ The initial ttl of the token to generate in seconds
697
637
  """
698
638
  return pulumi.get(self, "token_ttl")
699
639
 
@@ -705,11 +645,7 @@ class _AuthBackendRoleState:
705
645
  @pulumi.getter(name="tokenType")
706
646
  def token_type(self) -> Optional[pulumi.Input[str]]:
707
647
  """
708
- The type of token that should be generated. Can be `service`,
709
- `batch`, or `default` to use the mount's tuned default (which unless changed will be
710
- `service` tokens). For token store roles, there are two additional possibilities:
711
- `default-service` and `default-batch` which specify the type to return unless the client
712
- requests a different type at generation time.
648
+ The type of token to generate, service or batch
713
649
  """
714
650
  return pulumi.get(self, "token_type")
715
651
 
@@ -750,7 +686,6 @@ class AuthBackendRole(pulumi.CustomResource):
750
686
 
751
687
  ## Example Usage
752
688
 
753
- <!--Start PulumiCodeChooser -->
754
689
  ```python
755
690
  import pulumi
756
691
  import pulumi_vault as vault
@@ -769,7 +704,6 @@ class AuthBackendRole(pulumi.CustomResource):
769
704
  token_explicit_max_ttl=115200,
770
705
  path_suffix="path-suffix")
771
706
  ```
772
- <!--End PulumiCodeChooser -->
773
707
 
774
708
  ## Import
775
709
 
@@ -796,31 +730,15 @@ class AuthBackendRole(pulumi.CustomResource):
796
730
  > Due to a bug the resource. This *will* cause all existing tokens issued by this role to be revoked.
797
731
  :param pulumi.Input[bool] renewable: Whether to disable the ability of the token to be renewed past its initial TTL.
798
732
  :param pulumi.Input[str] role_name: The name of the role.
799
- :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: List of CIDR blocks; if set, specifies blocks of IP
800
- addresses which can authenticate successfully, and ties the resulting token to these blocks
801
- as well.
802
- :param pulumi.Input[int] token_explicit_max_ttl: If set, will encode an
803
- [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
804
- onto the token in number of seconds. This is a hard cap even if `token_ttl` and
805
- `token_max_ttl` would otherwise allow a renewal.
806
- :param pulumi.Input[int] token_max_ttl: The maximum lifetime for generated tokens in number of seconds.
807
- Its current value will be referenced at renewal time.
808
- :param pulumi.Input[bool] token_no_default_policy: If set, the default policy will not be set on
809
- generated tokens; otherwise it will be added to the policies set in token_policies.
810
- :param pulumi.Input[int] token_num_uses: The [maximum number](https://www.vaultproject.io/api-docs/token#token_num_uses)
811
- of times a generated token may be used (within its lifetime); 0 means unlimited.
812
- :param pulumi.Input[int] token_period: If set, indicates that the
813
- token generated using this role should never expire. The token should be renewed within the
814
- duration specified by this value. At each renewal, the token's TTL will be set to the
815
- value of this field. Specified in seconds.
733
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: Specifies the blocks of IP addresses which are allowed to use the generated token
734
+ :param pulumi.Input[int] token_explicit_max_ttl: Generated Token's Explicit Maximum TTL in seconds
735
+ :param pulumi.Input[int] token_max_ttl: The maximum lifetime of the generated token
736
+ :param pulumi.Input[bool] token_no_default_policy: If true, the 'default' policy will not automatically be added to generated tokens
737
+ :param pulumi.Input[int] token_num_uses: The maximum number of times a token may be used, a value of zero means unlimited
738
+ :param pulumi.Input[int] token_period: Generated Token's Period
816
739
  :param pulumi.Input[Sequence[pulumi.Input[str]]] token_policies: Generated Token's Policies
817
- :param pulumi.Input[int] token_ttl: The incremental lifetime for generated tokens in number of seconds.
818
- Its current value will be referenced at renewal time.
819
- :param pulumi.Input[str] token_type: The type of token that should be generated. Can be `service`,
820
- `batch`, or `default` to use the mount's tuned default (which unless changed will be
821
- `service` tokens). For token store roles, there are two additional possibilities:
822
- `default-service` and `default-batch` which specify the type to return unless the client
823
- requests a different type at generation time.
740
+ :param pulumi.Input[int] token_ttl: The initial ttl of the token to generate in seconds
741
+ :param pulumi.Input[str] token_type: The type of token to generate, service or batch
824
742
  """
825
743
  ...
826
744
  @overload
@@ -835,7 +753,6 @@ class AuthBackendRole(pulumi.CustomResource):
835
753
 
836
754
  ## Example Usage
837
755
 
838
- <!--Start PulumiCodeChooser -->
839
756
  ```python
840
757
  import pulumi
841
758
  import pulumi_vault as vault
@@ -854,7 +771,6 @@ class AuthBackendRole(pulumi.CustomResource):
854
771
  token_explicit_max_ttl=115200,
855
772
  path_suffix="path-suffix")
856
773
  ```
857
- <!--End PulumiCodeChooser -->
858
774
 
859
775
  ## Import
860
776
 
@@ -979,31 +895,15 @@ class AuthBackendRole(pulumi.CustomResource):
979
895
  > Due to a bug the resource. This *will* cause all existing tokens issued by this role to be revoked.
980
896
  :param pulumi.Input[bool] renewable: Whether to disable the ability of the token to be renewed past its initial TTL.
981
897
  :param pulumi.Input[str] role_name: The name of the role.
982
- :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: List of CIDR blocks; if set, specifies blocks of IP
983
- addresses which can authenticate successfully, and ties the resulting token to these blocks
984
- as well.
985
- :param pulumi.Input[int] token_explicit_max_ttl: If set, will encode an
986
- [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
987
- onto the token in number of seconds. This is a hard cap even if `token_ttl` and
988
- `token_max_ttl` would otherwise allow a renewal.
989
- :param pulumi.Input[int] token_max_ttl: The maximum lifetime for generated tokens in number of seconds.
990
- Its current value will be referenced at renewal time.
991
- :param pulumi.Input[bool] token_no_default_policy: If set, the default policy will not be set on
992
- generated tokens; otherwise it will be added to the policies set in token_policies.
993
- :param pulumi.Input[int] token_num_uses: The [maximum number](https://www.vaultproject.io/api-docs/token#token_num_uses)
994
- of times a generated token may be used (within its lifetime); 0 means unlimited.
995
- :param pulumi.Input[int] token_period: If set, indicates that the
996
- token generated using this role should never expire. The token should be renewed within the
997
- duration specified by this value. At each renewal, the token's TTL will be set to the
998
- value of this field. Specified in seconds.
898
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] token_bound_cidrs: Specifies the blocks of IP addresses which are allowed to use the generated token
899
+ :param pulumi.Input[int] token_explicit_max_ttl: Generated Token's Explicit Maximum TTL in seconds
900
+ :param pulumi.Input[int] token_max_ttl: The maximum lifetime of the generated token
901
+ :param pulumi.Input[bool] token_no_default_policy: If true, the 'default' policy will not automatically be added to generated tokens
902
+ :param pulumi.Input[int] token_num_uses: The maximum number of times a token may be used, a value of zero means unlimited
903
+ :param pulumi.Input[int] token_period: Generated Token's Period
999
904
  :param pulumi.Input[Sequence[pulumi.Input[str]]] token_policies: Generated Token's Policies
1000
- :param pulumi.Input[int] token_ttl: The incremental lifetime for generated tokens in number of seconds.
1001
- Its current value will be referenced at renewal time.
1002
- :param pulumi.Input[str] token_type: The type of token that should be generated. Can be `service`,
1003
- `batch`, or `default` to use the mount's tuned default (which unless changed will be
1004
- `service` tokens). For token store roles, there are two additional possibilities:
1005
- `default-service` and `default-batch` which specify the type to return unless the client
1006
- requests a different type at generation time.
905
+ :param pulumi.Input[int] token_ttl: The initial ttl of the token to generate in seconds
906
+ :param pulumi.Input[str] token_type: The type of token to generate, service or batch
1007
907
  """
1008
908
  opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
1009
909
 
@@ -1119,9 +1019,7 @@ class AuthBackendRole(pulumi.CustomResource):
1119
1019
  @pulumi.getter(name="tokenBoundCidrs")
1120
1020
  def token_bound_cidrs(self) -> pulumi.Output[Optional[Sequence[str]]]:
1121
1021
  """
1122
- List of CIDR blocks; if set, specifies blocks of IP
1123
- addresses which can authenticate successfully, and ties the resulting token to these blocks
1124
- as well.
1022
+ Specifies the blocks of IP addresses which are allowed to use the generated token
1125
1023
  """
1126
1024
  return pulumi.get(self, "token_bound_cidrs")
1127
1025
 
@@ -1129,10 +1027,7 @@ class AuthBackendRole(pulumi.CustomResource):
1129
1027
  @pulumi.getter(name="tokenExplicitMaxTtl")
1130
1028
  def token_explicit_max_ttl(self) -> pulumi.Output[Optional[int]]:
1131
1029
  """
1132
- If set, will encode an
1133
- [explicit max TTL](https://www.vaultproject.io/docs/concepts/tokens.html#token-time-to-live-periodic-tokens-and-explicit-max-ttls)
1134
- onto the token in number of seconds. This is a hard cap even if `token_ttl` and
1135
- `token_max_ttl` would otherwise allow a renewal.
1030
+ Generated Token's Explicit Maximum TTL in seconds
1136
1031
  """
1137
1032
  return pulumi.get(self, "token_explicit_max_ttl")
1138
1033
 
@@ -1140,8 +1035,7 @@ class AuthBackendRole(pulumi.CustomResource):
1140
1035
  @pulumi.getter(name="tokenMaxTtl")
1141
1036
  def token_max_ttl(self) -> pulumi.Output[Optional[int]]:
1142
1037
  """
1143
- The maximum lifetime for generated tokens in number of seconds.
1144
- Its current value will be referenced at renewal time.
1038
+ The maximum lifetime of the generated token
1145
1039
  """
1146
1040
  return pulumi.get(self, "token_max_ttl")
1147
1041
 
@@ -1149,8 +1043,7 @@ class AuthBackendRole(pulumi.CustomResource):
1149
1043
  @pulumi.getter(name="tokenNoDefaultPolicy")
1150
1044
  def token_no_default_policy(self) -> pulumi.Output[Optional[bool]]:
1151
1045
  """
1152
- If set, the default policy will not be set on
1153
- generated tokens; otherwise it will be added to the policies set in token_policies.
1046
+ If true, the 'default' policy will not automatically be added to generated tokens
1154
1047
  """
1155
1048
  return pulumi.get(self, "token_no_default_policy")
1156
1049
 
@@ -1158,8 +1051,7 @@ class AuthBackendRole(pulumi.CustomResource):
1158
1051
  @pulumi.getter(name="tokenNumUses")
1159
1052
  def token_num_uses(self) -> pulumi.Output[Optional[int]]:
1160
1053
  """
1161
- The [maximum number](https://www.vaultproject.io/api-docs/token#token_num_uses)
1162
- of times a generated token may be used (within its lifetime); 0 means unlimited.
1054
+ The maximum number of times a token may be used, a value of zero means unlimited
1163
1055
  """
1164
1056
  return pulumi.get(self, "token_num_uses")
1165
1057
 
@@ -1167,10 +1059,7 @@ class AuthBackendRole(pulumi.CustomResource):
1167
1059
  @pulumi.getter(name="tokenPeriod")
1168
1060
  def token_period(self) -> pulumi.Output[Optional[int]]:
1169
1061
  """
1170
- If set, indicates that the
1171
- token generated using this role should never expire. The token should be renewed within the
1172
- duration specified by this value. At each renewal, the token's TTL will be set to the
1173
- value of this field. Specified in seconds.
1062
+ Generated Token's Period
1174
1063
  """
1175
1064
  return pulumi.get(self, "token_period")
1176
1065
 
@@ -1186,8 +1075,7 @@ class AuthBackendRole(pulumi.CustomResource):
1186
1075
  @pulumi.getter(name="tokenTtl")
1187
1076
  def token_ttl(self) -> pulumi.Output[Optional[int]]:
1188
1077
  """
1189
- The incremental lifetime for generated tokens in number of seconds.
1190
- Its current value will be referenced at renewal time.
1078
+ The initial ttl of the token to generate in seconds
1191
1079
  """
1192
1080
  return pulumi.get(self, "token_ttl")
1193
1081
 
@@ -1195,11 +1083,7 @@ class AuthBackendRole(pulumi.CustomResource):
1195
1083
  @pulumi.getter(name="tokenType")
1196
1084
  def token_type(self) -> pulumi.Output[Optional[str]]:
1197
1085
  """
1198
- The type of token that should be generated. Can be `service`,
1199
- `batch`, or `default` to use the mount's tuned default (which unless changed will be
1200
- `service` tokens). For token store roles, there are two additional possibilities:
1201
- `default-service` and `default-batch` which specify the type to return unless the client
1202
- requests a different type at generation time.
1086
+ The type of token to generate, service or batch
1203
1087
  """
1204
1088
  return pulumi.get(self, "token_type")
1205
1089
 
pulumi_vault/transform/alphabet.py CHANGED
@@ -183,7 +183,6 @@ class Alphabet(pulumi.CustomResource):
183
183
 
184
184
  ## Example Usage
185
185
 
186
- <!--Start PulumiCodeChooser -->
187
186
  ```python
188
187
  import pulumi
189
188
  import pulumi_vault as vault
@@ -196,7 +195,6 @@ class Alphabet(pulumi.CustomResource):
196
195
  name="numerics",
197
196
  alphabet="0123456789")
198
197
  ```
199
- <!--End PulumiCodeChooser -->
200
198
 
201
199
  :param str resource_name: The name of the resource.
202
200
  :param pulumi.ResourceOptions opts: Options for the resource.
@@ -221,7 +219,6 @@ class Alphabet(pulumi.CustomResource):
221
219
 
222
220
  ## Example Usage
223
221
 
224
- <!--Start PulumiCodeChooser -->
225
222
  ```python
226
223
  import pulumi
227
224
  import pulumi_vault as vault
@@ -234,7 +231,6 @@ class Alphabet(pulumi.CustomResource):
234
231
  name="numerics",
235
232
  alphabet="0123456789")
236
233
  ```
237
- <!--End PulumiCodeChooser -->
238
234
 
239
235
  :param str resource_name: The name of the resource.
240
236
  :param AlphabetArgs args: The arguments to use to populate this resource's properties.
pulumi_vault/transform/get_decode.py CHANGED
@@ -142,7 +142,6 @@ def get_decode(batch_inputs: Optional[Sequence[Mapping[str, Any]]] = None,
142
142
 
143
143
  ## Example Usage
144
144
 
145
- <!--Start PulumiCodeChooser -->
146
145
  ```python
147
146
  import pulumi
148
147
  import pulumi_vault as vault
@@ -165,7 +164,6 @@ def get_decode(batch_inputs: Optional[Sequence[Mapping[str, Any]]] = None,
165
164
  role_name="payments",
166
165
  value="9300-3376-4943-8903")
167
166
  ```
168
- <!--End PulumiCodeChooser -->
169
167
 
170
168
 
171
169
  :param Sequence[Mapping[str, Any]] batch_inputs: Specifies a list of items to be decoded in a single batch. If this parameter is set, the top-level parameters 'value', 'transformation' and 'tweak' will be ignored. Each batch item within the list can specify these parameters instead.
@@ -225,7 +223,6 @@ def get_decode_output(batch_inputs: Optional[pulumi.Input[Optional[Sequence[Mapp
225
223
 
226
224
  ## Example Usage
227
225
 
228
- <!--Start PulumiCodeChooser -->
229
226
  ```python
230
227
  import pulumi
231
228
  import pulumi_vault as vault
@@ -248,7 +245,6 @@ def get_decode_output(batch_inputs: Optional[pulumi.Input[Optional[Sequence[Mapp
248
245
  role_name="payments",
249
246
  value="9300-3376-4943-8903")
250
247
  ```
251
- <!--End PulumiCodeChooser -->
252
248
 
253
249
 
254
250
  :param Sequence[Mapping[str, Any]] batch_inputs: Specifies a list of items to be decoded in a single batch. If this parameter is set, the top-level parameters 'value', 'transformation' and 'tweak' will be ignored. Each batch item within the list can specify these parameters instead.
pulumi_vault/transform/get_encode.py CHANGED
@@ -142,7 +142,6 @@ def get_encode(batch_inputs: Optional[Sequence[Mapping[str, Any]]] = None,
142
142
 
143
143
  ## Example Usage
144
144
 
145
- <!--Start PulumiCodeChooser -->
146
145
  ```python
147
146
  import pulumi
148
147
  import pulumi_vault as vault
@@ -167,7 +166,6 @@ def get_encode(batch_inputs: Optional[Sequence[Mapping[str, Any]]] = None,
167
166
  "value": "1111-2222-3333-4444",
168
167
  }])
169
168
  ```
170
- <!--End PulumiCodeChooser -->
171
169
 
172
170
 
173
171
  :param Sequence[Mapping[str, Any]] batch_inputs: Specifies a list of items to be encoded in a single batch. If this parameter is set, the parameters 'value', 'transformation' and 'tweak' will be ignored. Each batch item within the list can specify these parameters instead.
@@ -227,7 +225,6 @@ def get_encode_output(batch_inputs: Optional[pulumi.Input[Optional[Sequence[Mapp
227
225
 
228
226
  ## Example Usage
229
227
 
230
- <!--Start PulumiCodeChooser -->
231
228
  ```python
232
229
  import pulumi
233
230
  import pulumi_vault as vault
@@ -252,7 +249,6 @@ def get_encode_output(batch_inputs: Optional[pulumi.Input[Optional[Sequence[Mapp
252
249
  "value": "1111-2222-3333-4444",
253
250
  }])
254
251
  ```
255
- <!--End PulumiCodeChooser -->
256
252
 
257
253
 
258
254
  :param Sequence[Mapping[str, Any]] batch_inputs: Specifies a list of items to be encoded in a single batch. If this parameter is set, the parameters 'value', 'transformation' and 'tweak' will be ignored. Each batch item within the list can specify these parameters instead.
pulumi_vault/transform/role.py CHANGED
@@ -184,7 +184,6 @@ class Role(pulumi.CustomResource):
184
184
 
185
185
  ## Example Usage
186
186
 
187
- <!--Start PulumiCodeChooser -->
188
187
  ```python
189
188
  import pulumi
190
189
  import pulumi_vault as vault
@@ -197,7 +196,6 @@ class Role(pulumi.CustomResource):
197
196
  name="payments",
198
197
  transformations=["ccn-fpe"])
199
198
  ```
200
- <!--End PulumiCodeChooser -->
201
199
 
202
200
  :param str resource_name: The name of the resource.
203
201
  :param pulumi.ResourceOptions opts: Options for the resource.
@@ -223,7 +221,6 @@ class Role(pulumi.CustomResource):
223
221
 
224
222
  ## Example Usage
225
223
 
226
- <!--Start PulumiCodeChooser -->
227
224
  ```python
228
225
  import pulumi
229
226
  import pulumi_vault as vault
@@ -236,7 +233,6 @@ class Role(pulumi.CustomResource):
236
233
  name="payments",
237
234
  transformations=["ccn-fpe"])
238
235
  ```
239
- <!--End PulumiCodeChooser -->
240
236
 
241
237
  :param str resource_name: The name of the resource.
242
238
  :param RoleArgs args: The arguments to use to populate this resource's properties.
pulumi_vault/transform/template.py CHANGED
@@ -334,7 +334,6 @@ class Template(pulumi.CustomResource):
334
334
  backslashes must be escaped to appear correctly in Vault. For further
335
335
  assistance escaping your own custom regex, see String Literals.
336
336
 
337
- <!--Start PulumiCodeChooser -->
338
337
  ```python
339
338
  import pulumi
340
339
  import pulumi_vault as vault
@@ -357,7 +356,6 @@ class Template(pulumi.CustomResource):
357
356
  "last-four-digits": "$4",
358
357
  })
359
358
  ```
360
- <!--End PulumiCodeChooser -->
361
359
 
362
360
  :param str resource_name: The name of the resource.
363
361
  :param pulumi.ResourceOptions opts: Options for the resource.
@@ -399,7 +397,6 @@ class Template(pulumi.CustomResource):
399
397
  backslashes must be escaped to appear correctly in Vault. For further
400
398
  assistance escaping your own custom regex, see String Literals.
401
399
 
402
- <!--Start PulumiCodeChooser -->
403
400
  ```python
404
401
  import pulumi
405
402
  import pulumi_vault as vault
@@ -422,7 +419,6 @@ class Template(pulumi.CustomResource):
422
419
  "last-four-digits": "$4",
423
420
  })
424
421
  ```
425
- <!--End PulumiCodeChooser -->
426
422
 
427
423
  :param str resource_name: The name of the resource.
428
424
  :param TemplateArgs args: The arguments to use to populate this resource's properties.