pulumi-vault 6.2.0__py3-none-any.whl → 6.2.0a1712731873__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.0a1712731873.dist-info}/METADATA +1 -1
  185. pulumi_vault-6.2.0a1712731873.dist-info/RECORD +252 -0
  186. {pulumi_vault-6.2.0.dist-info → pulumi_vault-6.2.0a1712731873.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.0a1712731873.dist-info}/top_level.txt +0 -0
@@ -53,29 +53,56 @@ class RaftSnapshotAgentConfigArgs:
53
53
  or "google-gcs". The remaining parameters described below are all specific to
54
54
  the selected `storage_type` and prefixed accordingly.
55
55
  :param pulumi.Input[str] aws_access_key_id: AWS access key ID.
56
- :param pulumi.Input[str] aws_s3_bucket: S3 bucket to write snapshots to.
57
- :param pulumi.Input[bool] aws_s3_disable_tls: Disable TLS for the S3 endpoint. This should only be used for testing purposes.
56
+ :param pulumi.Input[str] aws_s3_bucket: `<required>` - S3 bucket to write snapshots to.
57
+ :param pulumi.Input[bool] aws_s3_disable_tls: Disable TLS for the S3 endpoint. This
58
+ should only be used for testing purposes, typically in conjunction with
59
+ `aws_s3_endpoint`.
58
60
  :param pulumi.Input[bool] aws_s3_enable_kms: Use KMS to encrypt bucket contents.
59
- :param pulumi.Input[str] aws_s3_endpoint: AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
60
- :param pulumi.Input[bool] aws_s3_force_path_style: Use the endpoint/bucket URL style instead of bucket.endpoint.
61
- :param pulumi.Input[str] aws_s3_kms_key: Use named KMS key, when aws_s3_enable_kms=true
62
- :param pulumi.Input[str] aws_s3_region: AWS region bucket is in.
61
+ :param pulumi.Input[str] aws_s3_endpoint: AWS endpoint. This is typically only set when
62
+ using a non-AWS S3 implementation like Minio.
63
+ :param pulumi.Input[bool] aws_s3_force_path_style: Use the endpoint/bucket URL style
64
+ instead of bucket.endpoint. May be needed when setting `aws_s3_endpoint`.
65
+ :param pulumi.Input[str] aws_s3_kms_key: Use named KMS key, when `aws_s3_enable_kms = true`
66
+ :param pulumi.Input[str] aws_s3_region: `<required>` - AWS region bucket is in.
63
67
  :param pulumi.Input[bool] aws_s3_server_side_encryption: Use AES256 to encrypt bucket contents.
64
68
  :param pulumi.Input[str] aws_secret_access_key: AWS secret access key.
65
69
  :param pulumi.Input[str] aws_session_token: AWS session token.
66
70
  :param pulumi.Input[str] azure_account_key: Azure account key.
67
71
  :param pulumi.Input[str] azure_account_name: Azure account name.
68
72
  :param pulumi.Input[str] azure_blob_environment: Azure blob environment.
69
- :param pulumi.Input[str] azure_container_name: Azure container name to write snapshots to.
70
- :param pulumi.Input[str] azure_endpoint: Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
73
+ :param pulumi.Input[str] azure_container_name: `<required>` - Azure container name to write
74
+ snapshots to.
75
+ :param pulumi.Input[str] azure_endpoint: Azure blob storage endpoint. This is typically
76
+ only set when using a non-Azure implementation like Azurite.
71
77
  :param pulumi.Input[str] file_prefix: Within the directory or bucket
72
78
  prefix given by `path_prefix`, the file or object name of snapshot files
73
79
  will start with this string.
74
- :param pulumi.Input[bool] google_disable_tls: Disable TLS for the GCS endpoint.
75
- :param pulumi.Input[str] google_endpoint: GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
76
- :param pulumi.Input[str] google_gcs_bucket: GCS bucket to write snapshots to.
77
- :param pulumi.Input[str] google_service_account_key: Google service account key in JSON format.
78
- :param pulumi.Input[int] local_max_space: The maximum space, in bytes, to use for snapshots.
80
+ :param pulumi.Input[bool] google_disable_tls: Disable TLS for the GCS endpoint. This
81
+ should only be used for testing purposes, typically in conjunction with
82
+ `google_endpoint`.
83
+ :param pulumi.Input[str] google_endpoint: GCS endpoint. This is typically only set when
84
+ using a non-Google GCS implementation like fake-gcs-server.
85
+ :param pulumi.Input[str] google_gcs_bucket: `<required>` - GCS bucket to write snapshots to.
86
+ :param pulumi.Input[str] google_service_account_key: Google service account key in JSON format.
87
+ The raw value looks like this:
88
+
89
+ ```json
90
+ {
91
+ "type": "service_account",
92
+ "project_id": "project-id",
93
+ "private_key_id": "key-id",
94
+ "private_key": "-----BEGIN RSA PRIVATE KEY-----\\nMIIEpQ ... /WZs=\\n-----END RSA PRIVATE KEY-----\\n",
95
+ "client_email": "service-account-email",
96
+ "client_id": "client-id",
97
+ "auth_uri": "https://accounts.google.com/o/oauth2/auth",
98
+ "token_uri": "https://accounts.google.com/o/oauth2/token",
99
+ "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
100
+ "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/service-account-email"
101
+ }
102
+ ```
103
+ :param pulumi.Input[int] local_max_space: For `storage_type = local`, the maximum
104
+ space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough
105
+ space left in this allowance.
79
106
  :param pulumi.Input[str] name: `<required>` – Name of the configuration to modify.
80
107
  :param pulumi.Input[str] namespace: The namespace to provision the resource in.
81
108
  The value should not contain leading or trailing forward slashes.
@@ -196,7 +223,7 @@ class RaftSnapshotAgentConfigArgs:
196
223
  @pulumi.getter(name="awsS3Bucket")
197
224
  def aws_s3_bucket(self) -> Optional[pulumi.Input[str]]:
198
225
  """
199
- S3 bucket to write snapshots to.
226
+ `<required>` - S3 bucket to write snapshots to.
200
227
  """
201
228
  return pulumi.get(self, "aws_s3_bucket")
202
229
 
@@ -208,7 +235,9 @@ class RaftSnapshotAgentConfigArgs:
208
235
  @pulumi.getter(name="awsS3DisableTls")
209
236
  def aws_s3_disable_tls(self) -> Optional[pulumi.Input[bool]]:
210
237
  """
211
- Disable TLS for the S3 endpoint. This should only be used for testing purposes.
238
+ Disable TLS for the S3 endpoint. This
239
+ should only be used for testing purposes, typically in conjunction with
240
+ `aws_s3_endpoint`.
212
241
  """
213
242
  return pulumi.get(self, "aws_s3_disable_tls")
214
243
 
@@ -232,7 +261,8 @@ class RaftSnapshotAgentConfigArgs:
232
261
  @pulumi.getter(name="awsS3Endpoint")
233
262
  def aws_s3_endpoint(self) -> Optional[pulumi.Input[str]]:
234
263
  """
235
- AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
264
+ AWS endpoint. This is typically only set when
265
+ using a non-AWS S3 implementation like Minio.
236
266
  """
237
267
  return pulumi.get(self, "aws_s3_endpoint")
238
268
 
@@ -244,7 +274,8 @@ class RaftSnapshotAgentConfigArgs:
244
274
  @pulumi.getter(name="awsS3ForcePathStyle")
245
275
  def aws_s3_force_path_style(self) -> Optional[pulumi.Input[bool]]:
246
276
  """
247
- Use the endpoint/bucket URL style instead of bucket.endpoint.
277
+ Use the endpoint/bucket URL style
278
+ instead of bucket.endpoint. May be needed when setting `aws_s3_endpoint`.
248
279
  """
249
280
  return pulumi.get(self, "aws_s3_force_path_style")
250
281
 
@@ -256,7 +287,7 @@ class RaftSnapshotAgentConfigArgs:
256
287
  @pulumi.getter(name="awsS3KmsKey")
257
288
  def aws_s3_kms_key(self) -> Optional[pulumi.Input[str]]:
258
289
  """
259
- Use named KMS key, when aws_s3_enable_kms=true
290
+ Use named KMS key, when `aws_s3_enable_kms = true`
260
291
  """
261
292
  return pulumi.get(self, "aws_s3_kms_key")
262
293
 
@@ -268,7 +299,7 @@ class RaftSnapshotAgentConfigArgs:
268
299
  @pulumi.getter(name="awsS3Region")
269
300
  def aws_s3_region(self) -> Optional[pulumi.Input[str]]:
270
301
  """
271
- AWS region bucket is in.
302
+ `<required>` - AWS region bucket is in.
272
303
  """
273
304
  return pulumi.get(self, "aws_s3_region")
274
305
 
@@ -352,7 +383,8 @@ class RaftSnapshotAgentConfigArgs:
352
383
  @pulumi.getter(name="azureContainerName")
353
384
  def azure_container_name(self) -> Optional[pulumi.Input[str]]:
354
385
  """
355
- Azure container name to write snapshots to.
386
+ `<required>` - Azure container name to write
387
+ snapshots to.
356
388
  """
357
389
  return pulumi.get(self, "azure_container_name")
358
390
 
@@ -364,7 +396,8 @@ class RaftSnapshotAgentConfigArgs:
364
396
  @pulumi.getter(name="azureEndpoint")
365
397
  def azure_endpoint(self) -> Optional[pulumi.Input[str]]:
366
398
  """
367
- Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
399
+ Azure blob storage endpoint. This is typically
400
+ only set when using a non-Azure implementation like Azurite.
368
401
  """
369
402
  return pulumi.get(self, "azure_endpoint")
370
403
 
@@ -390,7 +423,9 @@ class RaftSnapshotAgentConfigArgs:
390
423
  @pulumi.getter(name="googleDisableTls")
391
424
  def google_disable_tls(self) -> Optional[pulumi.Input[bool]]:
392
425
  """
393
- Disable TLS for the GCS endpoint.
426
+ Disable TLS for the GCS endpoint. This
427
+ should only be used for testing purposes, typically in conjunction with
428
+ `google_endpoint`.
394
429
  """
395
430
  return pulumi.get(self, "google_disable_tls")
396
431
 
@@ -402,7 +437,8 @@ class RaftSnapshotAgentConfigArgs:
402
437
  @pulumi.getter(name="googleEndpoint")
403
438
  def google_endpoint(self) -> Optional[pulumi.Input[str]]:
404
439
  """
405
- GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
440
+ GCS endpoint. This is typically only set when
441
+ using a non-Google GCS implementation like fake-gcs-server.
406
442
  """
407
443
  return pulumi.get(self, "google_endpoint")
408
444
 
@@ -414,7 +450,7 @@ class RaftSnapshotAgentConfigArgs:
414
450
  @pulumi.getter(name="googleGcsBucket")
415
451
  def google_gcs_bucket(self) -> Optional[pulumi.Input[str]]:
416
452
  """
417
- GCS bucket to write snapshots to.
453
+ `<required>` - GCS bucket to write snapshots to.
418
454
  """
419
455
  return pulumi.get(self, "google_gcs_bucket")
420
456
 
@@ -426,7 +462,23 @@ class RaftSnapshotAgentConfigArgs:
426
462
  @pulumi.getter(name="googleServiceAccountKey")
427
463
  def google_service_account_key(self) -> Optional[pulumi.Input[str]]:
428
464
  """
429
- Google service account key in JSON format.
465
+ Google service account key in JSON format.
466
+ The raw value looks like this:
467
+
468
+ ```json
469
+ {
470
+ "type": "service_account",
471
+ "project_id": "project-id",
472
+ "private_key_id": "key-id",
473
+ "private_key": "-----BEGIN RSA PRIVATE KEY-----\\nMIIEpQ ... /WZs=\\n-----END RSA PRIVATE KEY-----\\n",
474
+ "client_email": "service-account-email",
475
+ "client_id": "client-id",
476
+ "auth_uri": "https://accounts.google.com/o/oauth2/auth",
477
+ "token_uri": "https://accounts.google.com/o/oauth2/token",
478
+ "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
479
+ "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/service-account-email"
480
+ }
481
+ ```
430
482
  """
431
483
  return pulumi.get(self, "google_service_account_key")
432
484
 
@@ -438,7 +490,9 @@ class RaftSnapshotAgentConfigArgs:
438
490
  @pulumi.getter(name="localMaxSpace")
439
491
  def local_max_space(self) -> Optional[pulumi.Input[int]]:
440
492
  """
441
- The maximum space, in bytes, to use for snapshots.
493
+ For `storage_type = local`, the maximum
494
+ space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough
495
+ space left in this allowance.
442
496
  """
443
497
  return pulumi.get(self, "local_max_space")
444
498
 
@@ -522,30 +576,57 @@ class _RaftSnapshotAgentConfigState:
522
576
  """
523
577
  Input properties used for looking up and filtering RaftSnapshotAgentConfig resources.
524
578
  :param pulumi.Input[str] aws_access_key_id: AWS access key ID.
525
- :param pulumi.Input[str] aws_s3_bucket: S3 bucket to write snapshots to.
526
- :param pulumi.Input[bool] aws_s3_disable_tls: Disable TLS for the S3 endpoint. This should only be used for testing purposes.
579
+ :param pulumi.Input[str] aws_s3_bucket: `<required>` - S3 bucket to write snapshots to.
580
+ :param pulumi.Input[bool] aws_s3_disable_tls: Disable TLS for the S3 endpoint. This
581
+ should only be used for testing purposes, typically in conjunction with
582
+ `aws_s3_endpoint`.
527
583
  :param pulumi.Input[bool] aws_s3_enable_kms: Use KMS to encrypt bucket contents.
528
- :param pulumi.Input[str] aws_s3_endpoint: AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
529
- :param pulumi.Input[bool] aws_s3_force_path_style: Use the endpoint/bucket URL style instead of bucket.endpoint.
530
- :param pulumi.Input[str] aws_s3_kms_key: Use named KMS key, when aws_s3_enable_kms=true
531
- :param pulumi.Input[str] aws_s3_region: AWS region bucket is in.
584
+ :param pulumi.Input[str] aws_s3_endpoint: AWS endpoint. This is typically only set when
585
+ using a non-AWS S3 implementation like Minio.
586
+ :param pulumi.Input[bool] aws_s3_force_path_style: Use the endpoint/bucket URL style
587
+ instead of bucket.endpoint. May be needed when setting `aws_s3_endpoint`.
588
+ :param pulumi.Input[str] aws_s3_kms_key: Use named KMS key, when `aws_s3_enable_kms = true`
589
+ :param pulumi.Input[str] aws_s3_region: `<required>` - AWS region bucket is in.
532
590
  :param pulumi.Input[bool] aws_s3_server_side_encryption: Use AES256 to encrypt bucket contents.
533
591
  :param pulumi.Input[str] aws_secret_access_key: AWS secret access key.
534
592
  :param pulumi.Input[str] aws_session_token: AWS session token.
535
593
  :param pulumi.Input[str] azure_account_key: Azure account key.
536
594
  :param pulumi.Input[str] azure_account_name: Azure account name.
537
595
  :param pulumi.Input[str] azure_blob_environment: Azure blob environment.
538
- :param pulumi.Input[str] azure_container_name: Azure container name to write snapshots to.
539
- :param pulumi.Input[str] azure_endpoint: Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
596
+ :param pulumi.Input[str] azure_container_name: `<required>` - Azure container name to write
597
+ snapshots to.
598
+ :param pulumi.Input[str] azure_endpoint: Azure blob storage endpoint. This is typically
599
+ only set when using a non-Azure implementation like Azurite.
540
600
  :param pulumi.Input[str] file_prefix: Within the directory or bucket
541
601
  prefix given by `path_prefix`, the file or object name of snapshot files
542
602
  will start with this string.
543
- :param pulumi.Input[bool] google_disable_tls: Disable TLS for the GCS endpoint.
544
- :param pulumi.Input[str] google_endpoint: GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
545
- :param pulumi.Input[str] google_gcs_bucket: GCS bucket to write snapshots to.
546
- :param pulumi.Input[str] google_service_account_key: Google service account key in JSON format.
603
+ :param pulumi.Input[bool] google_disable_tls: Disable TLS for the GCS endpoint. This
604
+ should only be used for testing purposes, typically in conjunction with
605
+ `google_endpoint`.
606
+ :param pulumi.Input[str] google_endpoint: GCS endpoint. This is typically only set when
607
+ using a non-Google GCS implementation like fake-gcs-server.
608
+ :param pulumi.Input[str] google_gcs_bucket: `<required>` - GCS bucket to write snapshots to.
609
+ :param pulumi.Input[str] google_service_account_key: Google service account key in JSON format.
610
+ The raw value looks like this:
611
+
612
+ ```json
613
+ {
614
+ "type": "service_account",
615
+ "project_id": "project-id",
616
+ "private_key_id": "key-id",
617
+ "private_key": "-----BEGIN RSA PRIVATE KEY-----\\nMIIEpQ ... /WZs=\\n-----END RSA PRIVATE KEY-----\\n",
618
+ "client_email": "service-account-email",
619
+ "client_id": "client-id",
620
+ "auth_uri": "https://accounts.google.com/o/oauth2/auth",
621
+ "token_uri": "https://accounts.google.com/o/oauth2/token",
622
+ "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
623
+ "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/service-account-email"
624
+ }
625
+ ```
547
626
  :param pulumi.Input[int] interval_seconds: `<required>` - Time (in seconds) between snapshots.
548
- :param pulumi.Input[int] local_max_space: The maximum space, in bytes, to use for snapshots.
627
+ :param pulumi.Input[int] local_max_space: For `storage_type = local`, the maximum
628
+ space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough
629
+ space left in this allowance.
549
630
  :param pulumi.Input[str] name: `<required>` – Name of the configuration to modify.
550
631
  :param pulumi.Input[str] namespace: The namespace to provision the resource in.
551
632
  The value should not contain leading or trailing forward slashes.
@@ -635,7 +716,7 @@ class _RaftSnapshotAgentConfigState:
635
716
  @pulumi.getter(name="awsS3Bucket")
636
717
  def aws_s3_bucket(self) -> Optional[pulumi.Input[str]]:
637
718
  """
638
- S3 bucket to write snapshots to.
719
+ `<required>` - S3 bucket to write snapshots to.
639
720
  """
640
721
  return pulumi.get(self, "aws_s3_bucket")
641
722
 
@@ -647,7 +728,9 @@ class _RaftSnapshotAgentConfigState:
647
728
  @pulumi.getter(name="awsS3DisableTls")
648
729
  def aws_s3_disable_tls(self) -> Optional[pulumi.Input[bool]]:
649
730
  """
650
- Disable TLS for the S3 endpoint. This should only be used for testing purposes.
731
+ Disable TLS for the S3 endpoint. This
732
+ should only be used for testing purposes, typically in conjunction with
733
+ `aws_s3_endpoint`.
651
734
  """
652
735
  return pulumi.get(self, "aws_s3_disable_tls")
653
736
 
@@ -671,7 +754,8 @@ class _RaftSnapshotAgentConfigState:
671
754
  @pulumi.getter(name="awsS3Endpoint")
672
755
  def aws_s3_endpoint(self) -> Optional[pulumi.Input[str]]:
673
756
  """
674
- AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
757
+ AWS endpoint. This is typically only set when
758
+ using a non-AWS S3 implementation like Minio.
675
759
  """
676
760
  return pulumi.get(self, "aws_s3_endpoint")
677
761
 
@@ -683,7 +767,8 @@ class _RaftSnapshotAgentConfigState:
683
767
  @pulumi.getter(name="awsS3ForcePathStyle")
684
768
  def aws_s3_force_path_style(self) -> Optional[pulumi.Input[bool]]:
685
769
  """
686
- Use the endpoint/bucket URL style instead of bucket.endpoint.
770
+ Use the endpoint/bucket URL style
771
+ instead of bucket.endpoint. May be needed when setting `aws_s3_endpoint`.
687
772
  """
688
773
  return pulumi.get(self, "aws_s3_force_path_style")
689
774
 
@@ -695,7 +780,7 @@ class _RaftSnapshotAgentConfigState:
695
780
  @pulumi.getter(name="awsS3KmsKey")
696
781
  def aws_s3_kms_key(self) -> Optional[pulumi.Input[str]]:
697
782
  """
698
- Use named KMS key, when aws_s3_enable_kms=true
783
+ Use named KMS key, when `aws_s3_enable_kms = true`
699
784
  """
700
785
  return pulumi.get(self, "aws_s3_kms_key")
701
786
 
@@ -707,7 +792,7 @@ class _RaftSnapshotAgentConfigState:
707
792
  @pulumi.getter(name="awsS3Region")
708
793
  def aws_s3_region(self) -> Optional[pulumi.Input[str]]:
709
794
  """
710
- AWS region bucket is in.
795
+ `<required>` - AWS region bucket is in.
711
796
  """
712
797
  return pulumi.get(self, "aws_s3_region")
713
798
 
@@ -791,7 +876,8 @@ class _RaftSnapshotAgentConfigState:
791
876
  @pulumi.getter(name="azureContainerName")
792
877
  def azure_container_name(self) -> Optional[pulumi.Input[str]]:
793
878
  """
794
- Azure container name to write snapshots to.
879
+ `<required>` - Azure container name to write
880
+ snapshots to.
795
881
  """
796
882
  return pulumi.get(self, "azure_container_name")
797
883
 
@@ -803,7 +889,8 @@ class _RaftSnapshotAgentConfigState:
803
889
  @pulumi.getter(name="azureEndpoint")
804
890
  def azure_endpoint(self) -> Optional[pulumi.Input[str]]:
805
891
  """
806
- Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
892
+ Azure blob storage endpoint. This is typically
893
+ only set when using a non-Azure implementation like Azurite.
807
894
  """
808
895
  return pulumi.get(self, "azure_endpoint")
809
896
 
@@ -829,7 +916,9 @@ class _RaftSnapshotAgentConfigState:
829
916
  @pulumi.getter(name="googleDisableTls")
830
917
  def google_disable_tls(self) -> Optional[pulumi.Input[bool]]:
831
918
  """
832
- Disable TLS for the GCS endpoint.
919
+ Disable TLS for the GCS endpoint. This
920
+ should only be used for testing purposes, typically in conjunction with
921
+ `google_endpoint`.
833
922
  """
834
923
  return pulumi.get(self, "google_disable_tls")
835
924
 
@@ -841,7 +930,8 @@ class _RaftSnapshotAgentConfigState:
841
930
  @pulumi.getter(name="googleEndpoint")
842
931
  def google_endpoint(self) -> Optional[pulumi.Input[str]]:
843
932
  """
844
- GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
933
+ GCS endpoint. This is typically only set when
934
+ using a non-Google GCS implementation like fake-gcs-server.
845
935
  """
846
936
  return pulumi.get(self, "google_endpoint")
847
937
 
@@ -853,7 +943,7 @@ class _RaftSnapshotAgentConfigState:
853
943
  @pulumi.getter(name="googleGcsBucket")
854
944
  def google_gcs_bucket(self) -> Optional[pulumi.Input[str]]:
855
945
  """
856
- GCS bucket to write snapshots to.
946
+ `<required>` - GCS bucket to write snapshots to.
857
947
  """
858
948
  return pulumi.get(self, "google_gcs_bucket")
859
949
 
@@ -865,7 +955,23 @@ class _RaftSnapshotAgentConfigState:
865
955
  @pulumi.getter(name="googleServiceAccountKey")
866
956
  def google_service_account_key(self) -> Optional[pulumi.Input[str]]:
867
957
  """
868
- Google service account key in JSON format.
958
+ Google service account key in JSON format.
959
+ The raw value looks like this:
960
+
961
+ ```json
962
+ {
963
+ "type": "service_account",
964
+ "project_id": "project-id",
965
+ "private_key_id": "key-id",
966
+ "private_key": "-----BEGIN RSA PRIVATE KEY-----\\nMIIEpQ ... /WZs=\\n-----END RSA PRIVATE KEY-----\\n",
967
+ "client_email": "service-account-email",
968
+ "client_id": "client-id",
969
+ "auth_uri": "https://accounts.google.com/o/oauth2/auth",
970
+ "token_uri": "https://accounts.google.com/o/oauth2/token",
971
+ "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
972
+ "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/service-account-email"
973
+ }
974
+ ```
869
975
  """
870
976
  return pulumi.get(self, "google_service_account_key")
871
977
 
@@ -889,7 +995,9 @@ class _RaftSnapshotAgentConfigState:
889
995
  @pulumi.getter(name="localMaxSpace")
890
996
  def local_max_space(self) -> Optional[pulumi.Input[int]]:
891
997
  """
892
- The maximum space, in bytes, to use for snapshots.
998
+ For `storage_type = local`, the maximum
999
+ space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough
1000
+ space left in this allowance.
893
1001
  """
894
1002
  return pulumi.get(self, "local_max_space")
895
1003
 
@@ -1006,20 +1114,22 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1006
1114
  ## Example Usage
1007
1115
 
1008
1116
  ### Local Storage
1117
+ <!--Start PulumiCodeChooser -->
1009
1118
  ```python
1010
1119
  import pulumi
1011
1120
  import pulumi_vault as vault
1012
1121
 
1013
- local_backups = vault.RaftSnapshotAgentConfig("local_backups",
1014
- name="local",
1122
+ local_backups = vault.RaftSnapshotAgentConfig("localBackups",
1015
1123
  interval_seconds=86400,
1016
- retain=7,
1124
+ local_max_space=10000000,
1017
1125
  path_prefix="/opt/vault/snapshots/",
1018
- storage_type="local",
1019
- local_max_space=10000000)
1126
+ retain=7,
1127
+ storage_type="local")
1020
1128
  ```
1129
+ <!--End PulumiCodeChooser -->
1021
1130
 
1022
1131
  ### AWS S3
1132
+ <!--Start PulumiCodeChooser -->
1023
1133
  ```python
1024
1134
  import pulumi
1025
1135
  import pulumi_aws as aws
@@ -1029,8 +1139,7 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1029
1139
  aws_access_key_id = config.require_object("awsAccessKeyId")
1030
1140
  aws_secret_access_key = config.require_object("awsSecretAccessKey")
1031
1141
  current = aws.get_region()
1032
- s3_backups = vault.RaftSnapshotAgentConfig("s3_backups",
1033
- name="s3",
1142
+ s3_backups = vault.RaftSnapshotAgentConfig("s3Backups",
1034
1143
  interval_seconds=86400,
1035
1144
  retain=7,
1036
1145
  path_prefix="/path/in/bucket",
@@ -1041,9 +1150,11 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1041
1150
  aws_secret_access_key=aws_secret_access_key,
1042
1151
  aws_s3_enable_kms=True)
1043
1152
  ```
1153
+ <!--End PulumiCodeChooser -->
1044
1154
 
1045
1155
  ### Azure BLOB
1046
1156
 
1157
+ <!--Start PulumiCodeChooser -->
1047
1158
  ```python
1048
1159
  import pulumi
1049
1160
  import pulumi_vault as vault
@@ -1051,8 +1162,7 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1051
1162
  config = pulumi.Config()
1052
1163
  azure_account_name = config.require_object("azureAccountName")
1053
1164
  azure_account_key = config.require_object("azureAccountKey")
1054
- azure_backups = vault.RaftSnapshotAgentConfig("azure_backups",
1055
- name="azure_backup",
1165
+ azure_backups = vault.RaftSnapshotAgentConfig("azureBackups",
1056
1166
  interval_seconds=86400,
1057
1167
  retain=7,
1058
1168
  path_prefix="/",
@@ -1061,6 +1171,7 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1061
1171
  azure_account_name=azure_account_name,
1062
1172
  azure_account_key=azure_account_key)
1063
1173
  ```
1174
+ <!--End PulumiCodeChooser -->
1064
1175
 
1065
1176
  ## Import
1066
1177
 
@@ -1073,30 +1184,57 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1073
1184
  :param str resource_name: The name of the resource.
1074
1185
  :param pulumi.ResourceOptions opts: Options for the resource.
1075
1186
  :param pulumi.Input[str] aws_access_key_id: AWS access key ID.
1076
- :param pulumi.Input[str] aws_s3_bucket: S3 bucket to write snapshots to.
1077
- :param pulumi.Input[bool] aws_s3_disable_tls: Disable TLS for the S3 endpoint. This should only be used for testing purposes.
1187
+ :param pulumi.Input[str] aws_s3_bucket: `<required>` - S3 bucket to write snapshots to.
1188
+ :param pulumi.Input[bool] aws_s3_disable_tls: Disable TLS for the S3 endpoint. This
1189
+ should only be used for testing purposes, typically in conjunction with
1190
+ `aws_s3_endpoint`.
1078
1191
  :param pulumi.Input[bool] aws_s3_enable_kms: Use KMS to encrypt bucket contents.
1079
- :param pulumi.Input[str] aws_s3_endpoint: AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
1080
- :param pulumi.Input[bool] aws_s3_force_path_style: Use the endpoint/bucket URL style instead of bucket.endpoint.
1081
- :param pulumi.Input[str] aws_s3_kms_key: Use named KMS key, when aws_s3_enable_kms=true
1082
- :param pulumi.Input[str] aws_s3_region: AWS region bucket is in.
1192
+ :param pulumi.Input[str] aws_s3_endpoint: AWS endpoint. This is typically only set when
1193
+ using a non-AWS S3 implementation like Minio.
1194
+ :param pulumi.Input[bool] aws_s3_force_path_style: Use the endpoint/bucket URL style
1195
+ instead of bucket.endpoint. May be needed when setting `aws_s3_endpoint`.
1196
+ :param pulumi.Input[str] aws_s3_kms_key: Use named KMS key, when `aws_s3_enable_kms = true`
1197
+ :param pulumi.Input[str] aws_s3_region: `<required>` - AWS region bucket is in.
1083
1198
  :param pulumi.Input[bool] aws_s3_server_side_encryption: Use AES256 to encrypt bucket contents.
1084
1199
  :param pulumi.Input[str] aws_secret_access_key: AWS secret access key.
1085
1200
  :param pulumi.Input[str] aws_session_token: AWS session token.
1086
1201
  :param pulumi.Input[str] azure_account_key: Azure account key.
1087
1202
  :param pulumi.Input[str] azure_account_name: Azure account name.
1088
1203
  :param pulumi.Input[str] azure_blob_environment: Azure blob environment.
1089
- :param pulumi.Input[str] azure_container_name: Azure container name to write snapshots to.
1090
- :param pulumi.Input[str] azure_endpoint: Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
1204
+ :param pulumi.Input[str] azure_container_name: `<required>` - Azure container name to write
1205
+ snapshots to.
1206
+ :param pulumi.Input[str] azure_endpoint: Azure blob storage endpoint. This is typically
1207
+ only set when using a non-Azure implementation like Azurite.
1091
1208
  :param pulumi.Input[str] file_prefix: Within the directory or bucket
1092
1209
  prefix given by `path_prefix`, the file or object name of snapshot files
1093
1210
  will start with this string.
1094
- :param pulumi.Input[bool] google_disable_tls: Disable TLS for the GCS endpoint.
1095
- :param pulumi.Input[str] google_endpoint: GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
1096
- :param pulumi.Input[str] google_gcs_bucket: GCS bucket to write snapshots to.
1097
- :param pulumi.Input[str] google_service_account_key: Google service account key in JSON format.
1211
+ :param pulumi.Input[bool] google_disable_tls: Disable TLS for the GCS endpoint. This
1212
+ should only be used for testing purposes, typically in conjunction with
1213
+ `google_endpoint`.
1214
+ :param pulumi.Input[str] google_endpoint: GCS endpoint. This is typically only set when
1215
+ using a non-Google GCS implementation like fake-gcs-server.
1216
+ :param pulumi.Input[str] google_gcs_bucket: `<required>` - GCS bucket to write snapshots to.
1217
+ :param pulumi.Input[str] google_service_account_key: Google service account key in JSON format.
1218
+ The raw value looks like this:
1219
+
1220
+ ```json
1221
+ {
1222
+ "type": "service_account",
1223
+ "project_id": "project-id",
1224
+ "private_key_id": "key-id",
1225
+ "private_key": "-----BEGIN RSA PRIVATE KEY-----\\nMIIEpQ ... /WZs=\\n-----END RSA PRIVATE KEY-----\\n",
1226
+ "client_email": "service-account-email",
1227
+ "client_id": "client-id",
1228
+ "auth_uri": "https://accounts.google.com/o/oauth2/auth",
1229
+ "token_uri": "https://accounts.google.com/o/oauth2/token",
1230
+ "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
1231
+ "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/service-account-email"
1232
+ }
1233
+ ```
1098
1234
  :param pulumi.Input[int] interval_seconds: `<required>` - Time (in seconds) between snapshots.
1099
- :param pulumi.Input[int] local_max_space: The maximum space, in bytes, to use for snapshots.
1235
+ :param pulumi.Input[int] local_max_space: For `storage_type = local`, the maximum
1236
+ space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough
1237
+ space left in this allowance.
1100
1238
  :param pulumi.Input[str] name: `<required>` – Name of the configuration to modify.
1101
1239
  :param pulumi.Input[str] namespace: The namespace to provision the resource in.
1102
1240
  The value should not contain leading or trailing forward slashes.
@@ -1123,20 +1261,22 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1123
1261
  ## Example Usage
1124
1262
 
1125
1263
  ### Local Storage
1264
+ <!--Start PulumiCodeChooser -->
1126
1265
  ```python
1127
1266
  import pulumi
1128
1267
  import pulumi_vault as vault
1129
1268
 
1130
- local_backups = vault.RaftSnapshotAgentConfig("local_backups",
1131
- name="local",
1269
+ local_backups = vault.RaftSnapshotAgentConfig("localBackups",
1132
1270
  interval_seconds=86400,
1133
- retain=7,
1271
+ local_max_space=10000000,
1134
1272
  path_prefix="/opt/vault/snapshots/",
1135
- storage_type="local",
1136
- local_max_space=10000000)
1273
+ retain=7,
1274
+ storage_type="local")
1137
1275
  ```
1276
+ <!--End PulumiCodeChooser -->
1138
1277
 
1139
1278
  ### AWS S3
1279
+ <!--Start PulumiCodeChooser -->
1140
1280
  ```python
1141
1281
  import pulumi
1142
1282
  import pulumi_aws as aws
@@ -1146,8 +1286,7 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1146
1286
  aws_access_key_id = config.require_object("awsAccessKeyId")
1147
1287
  aws_secret_access_key = config.require_object("awsSecretAccessKey")
1148
1288
  current = aws.get_region()
1149
- s3_backups = vault.RaftSnapshotAgentConfig("s3_backups",
1150
- name="s3",
1289
+ s3_backups = vault.RaftSnapshotAgentConfig("s3Backups",
1151
1290
  interval_seconds=86400,
1152
1291
  retain=7,
1153
1292
  path_prefix="/path/in/bucket",
@@ -1158,9 +1297,11 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1158
1297
  aws_secret_access_key=aws_secret_access_key,
1159
1298
  aws_s3_enable_kms=True)
1160
1299
  ```
1300
+ <!--End PulumiCodeChooser -->
1161
1301
 
1162
1302
  ### Azure BLOB
1163
1303
 
1304
+ <!--Start PulumiCodeChooser -->
1164
1305
  ```python
1165
1306
  import pulumi
1166
1307
  import pulumi_vault as vault
@@ -1168,8 +1309,7 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1168
1309
  config = pulumi.Config()
1169
1310
  azure_account_name = config.require_object("azureAccountName")
1170
1311
  azure_account_key = config.require_object("azureAccountKey")
1171
- azure_backups = vault.RaftSnapshotAgentConfig("azure_backups",
1172
- name="azure_backup",
1312
+ azure_backups = vault.RaftSnapshotAgentConfig("azureBackups",
1173
1313
  interval_seconds=86400,
1174
1314
  retain=7,
1175
1315
  path_prefix="/",
@@ -1178,6 +1318,7 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1178
1318
  azure_account_name=azure_account_name,
1179
1319
  azure_account_key=azure_account_key)
1180
1320
  ```
1321
+ <!--End PulumiCodeChooser -->
1181
1322
 
1182
1323
  ## Import
1183
1324
 
@@ -1319,30 +1460,57 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1319
1460
  :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
1320
1461
  :param pulumi.ResourceOptions opts: Options for the resource.
1321
1462
  :param pulumi.Input[str] aws_access_key_id: AWS access key ID.
1322
- :param pulumi.Input[str] aws_s3_bucket: S3 bucket to write snapshots to.
1323
- :param pulumi.Input[bool] aws_s3_disable_tls: Disable TLS for the S3 endpoint. This should only be used for testing purposes.
1463
+ :param pulumi.Input[str] aws_s3_bucket: `<required>` - S3 bucket to write snapshots to.
1464
+ :param pulumi.Input[bool] aws_s3_disable_tls: Disable TLS for the S3 endpoint. This
1465
+ should only be used for testing purposes, typically in conjunction with
1466
+ `aws_s3_endpoint`.
1324
1467
  :param pulumi.Input[bool] aws_s3_enable_kms: Use KMS to encrypt bucket contents.
1325
- :param pulumi.Input[str] aws_s3_endpoint: AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
1326
- :param pulumi.Input[bool] aws_s3_force_path_style: Use the endpoint/bucket URL style instead of bucket.endpoint.
1327
- :param pulumi.Input[str] aws_s3_kms_key: Use named KMS key, when aws_s3_enable_kms=true
1328
- :param pulumi.Input[str] aws_s3_region: AWS region bucket is in.
1468
+ :param pulumi.Input[str] aws_s3_endpoint: AWS endpoint. This is typically only set when
1469
+ using a non-AWS S3 implementation like Minio.
1470
+ :param pulumi.Input[bool] aws_s3_force_path_style: Use the endpoint/bucket URL style
1471
+ instead of bucket.endpoint. May be needed when setting `aws_s3_endpoint`.
1472
+ :param pulumi.Input[str] aws_s3_kms_key: Use named KMS key, when `aws_s3_enable_kms = true`
1473
+ :param pulumi.Input[str] aws_s3_region: `<required>` - AWS region bucket is in.
1329
1474
  :param pulumi.Input[bool] aws_s3_server_side_encryption: Use AES256 to encrypt bucket contents.
1330
1475
  :param pulumi.Input[str] aws_secret_access_key: AWS secret access key.
1331
1476
  :param pulumi.Input[str] aws_session_token: AWS session token.
1332
1477
  :param pulumi.Input[str] azure_account_key: Azure account key.
1333
1478
  :param pulumi.Input[str] azure_account_name: Azure account name.
1334
1479
  :param pulumi.Input[str] azure_blob_environment: Azure blob environment.
1335
- :param pulumi.Input[str] azure_container_name: Azure container name to write snapshots to.
1336
- :param pulumi.Input[str] azure_endpoint: Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
1480
+ :param pulumi.Input[str] azure_container_name: `<required>` - Azure container name to write
1481
+ snapshots to.
1482
+ :param pulumi.Input[str] azure_endpoint: Azure blob storage endpoint. This is typically
1483
+ only set when using a non-Azure implementation like Azurite.
1337
1484
  :param pulumi.Input[str] file_prefix: Within the directory or bucket
1338
1485
  prefix given by `path_prefix`, the file or object name of snapshot files
1339
1486
  will start with this string.
1340
- :param pulumi.Input[bool] google_disable_tls: Disable TLS for the GCS endpoint.
1341
- :param pulumi.Input[str] google_endpoint: GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
1342
- :param pulumi.Input[str] google_gcs_bucket: GCS bucket to write snapshots to.
1343
- :param pulumi.Input[str] google_service_account_key: Google service account key in JSON format.
1487
+ :param pulumi.Input[bool] google_disable_tls: Disable TLS for the GCS endpoint. This
1488
+ should only be used for testing purposes, typically in conjunction with
1489
+ `google_endpoint`.
1490
+ :param pulumi.Input[str] google_endpoint: GCS endpoint. This is typically only set when
1491
+ using a non-Google GCS implementation like fake-gcs-server.
1492
+ :param pulumi.Input[str] google_gcs_bucket: `<required>` - GCS bucket to write snapshots to.
1493
+ :param pulumi.Input[str] google_service_account_key: Google service account key in JSON format.
1494
+ The raw value looks like this:
1495
+
1496
+ ```json
1497
+ {
1498
+ "type": "service_account",
1499
+ "project_id": "project-id",
1500
+ "private_key_id": "key-id",
1501
+ "private_key": "-----BEGIN RSA PRIVATE KEY-----\\nMIIEpQ ... /WZs=\\n-----END RSA PRIVATE KEY-----\\n",
1502
+ "client_email": "service-account-email",
1503
+ "client_id": "client-id",
1504
+ "auth_uri": "https://accounts.google.com/o/oauth2/auth",
1505
+ "token_uri": "https://accounts.google.com/o/oauth2/token",
1506
+ "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
1507
+ "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/service-account-email"
1508
+ }
1509
+ ```
1344
1510
  :param pulumi.Input[int] interval_seconds: `<required>` - Time (in seconds) between snapshots.
1345
- :param pulumi.Input[int] local_max_space: The maximum space, in bytes, to use for snapshots.
1511
+ :param pulumi.Input[int] local_max_space: For `storage_type = local`, the maximum
1512
+ space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough
1513
+ space left in this allowance.
1346
1514
  :param pulumi.Input[str] name: `<required>` – Name of the configuration to modify.
1347
1515
  :param pulumi.Input[str] namespace: The namespace to provision the resource in.
1348
1516
  The value should not contain leading or trailing forward slashes.
@@ -1405,7 +1573,7 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1405
1573
  @pulumi.getter(name="awsS3Bucket")
1406
1574
  def aws_s3_bucket(self) -> pulumi.Output[Optional[str]]:
1407
1575
  """
1408
- S3 bucket to write snapshots to.
1576
+ `<required>` - S3 bucket to write snapshots to.
1409
1577
  """
1410
1578
  return pulumi.get(self, "aws_s3_bucket")
1411
1579
 
@@ -1413,7 +1581,9 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1413
1581
  @pulumi.getter(name="awsS3DisableTls")
1414
1582
  def aws_s3_disable_tls(self) -> pulumi.Output[Optional[bool]]:
1415
1583
  """
1416
- Disable TLS for the S3 endpoint. This should only be used for testing purposes.
1584
+ Disable TLS for the S3 endpoint. This
1585
+ should only be used for testing purposes, typically in conjunction with
1586
+ `aws_s3_endpoint`.
1417
1587
  """
1418
1588
  return pulumi.get(self, "aws_s3_disable_tls")
1419
1589
 
@@ -1429,7 +1599,8 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1429
1599
  @pulumi.getter(name="awsS3Endpoint")
1430
1600
  def aws_s3_endpoint(self) -> pulumi.Output[Optional[str]]:
1431
1601
  """
1432
- AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
1602
+ AWS endpoint. This is typically only set when
1603
+ using a non-AWS S3 implementation like Minio.
1433
1604
  """
1434
1605
  return pulumi.get(self, "aws_s3_endpoint")
1435
1606
 
@@ -1437,7 +1608,8 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1437
1608
  @pulumi.getter(name="awsS3ForcePathStyle")
1438
1609
  def aws_s3_force_path_style(self) -> pulumi.Output[Optional[bool]]:
1439
1610
  """
1440
- Use the endpoint/bucket URL style instead of bucket.endpoint.
1611
+ Use the endpoint/bucket URL style
1612
+ instead of bucket.endpoint. May be needed when setting `aws_s3_endpoint`.
1441
1613
  """
1442
1614
  return pulumi.get(self, "aws_s3_force_path_style")
1443
1615
 
@@ -1445,7 +1617,7 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1445
1617
  @pulumi.getter(name="awsS3KmsKey")
1446
1618
  def aws_s3_kms_key(self) -> pulumi.Output[Optional[str]]:
1447
1619
  """
1448
- Use named KMS key, when aws_s3_enable_kms=true
1620
+ Use named KMS key, when `aws_s3_enable_kms = true`
1449
1621
  """
1450
1622
  return pulumi.get(self, "aws_s3_kms_key")
1451
1623
 
@@ -1453,7 +1625,7 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1453
1625
  @pulumi.getter(name="awsS3Region")
1454
1626
  def aws_s3_region(self) -> pulumi.Output[Optional[str]]:
1455
1627
  """
1456
- AWS region bucket is in.
1628
+ `<required>` - AWS region bucket is in.
1457
1629
  """
1458
1630
  return pulumi.get(self, "aws_s3_region")
1459
1631
 
@@ -1509,7 +1681,8 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1509
1681
  @pulumi.getter(name="azureContainerName")
1510
1682
  def azure_container_name(self) -> pulumi.Output[Optional[str]]:
1511
1683
  """
1512
- Azure container name to write snapshots to.
1684
+ `<required>` - Azure container name to write
1685
+ snapshots to.
1513
1686
  """
1514
1687
  return pulumi.get(self, "azure_container_name")
1515
1688
 
@@ -1517,7 +1690,8 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1517
1690
  @pulumi.getter(name="azureEndpoint")
1518
1691
  def azure_endpoint(self) -> pulumi.Output[Optional[str]]:
1519
1692
  """
1520
- Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
1693
+ Azure blob storage endpoint. This is typically
1694
+ only set when using a non-Azure implementation like Azurite.
1521
1695
  """
1522
1696
  return pulumi.get(self, "azure_endpoint")
1523
1697
 
@@ -1535,7 +1709,9 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1535
1709
  @pulumi.getter(name="googleDisableTls")
1536
1710
  def google_disable_tls(self) -> pulumi.Output[Optional[bool]]:
1537
1711
  """
1538
- Disable TLS for the GCS endpoint.
1712
+ Disable TLS for the GCS endpoint. This
1713
+ should only be used for testing purposes, typically in conjunction with
1714
+ `google_endpoint`.
1539
1715
  """
1540
1716
  return pulumi.get(self, "google_disable_tls")
1541
1717
 
@@ -1543,7 +1719,8 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1543
1719
  @pulumi.getter(name="googleEndpoint")
1544
1720
  def google_endpoint(self) -> pulumi.Output[Optional[str]]:
1545
1721
  """
1546
- GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
1722
+ GCS endpoint. This is typically only set when
1723
+ using a non-Google GCS implementation like fake-gcs-server.
1547
1724
  """
1548
1725
  return pulumi.get(self, "google_endpoint")
1549
1726
 
@@ -1551,7 +1728,7 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1551
1728
  @pulumi.getter(name="googleGcsBucket")
1552
1729
  def google_gcs_bucket(self) -> pulumi.Output[Optional[str]]:
1553
1730
  """
1554
- GCS bucket to write snapshots to.
1731
+ `<required>` - GCS bucket to write snapshots to.
1555
1732
  """
1556
1733
  return pulumi.get(self, "google_gcs_bucket")
1557
1734
 
@@ -1559,7 +1736,23 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1559
1736
  @pulumi.getter(name="googleServiceAccountKey")
1560
1737
  def google_service_account_key(self) -> pulumi.Output[Optional[str]]:
1561
1738
  """
1562
- Google service account key in JSON format.
1739
+ Google service account key in JSON format.
1740
+ The raw value looks like this:
1741
+
1742
+ ```json
1743
+ {
1744
+ "type": "service_account",
1745
+ "project_id": "project-id",
1746
+ "private_key_id": "key-id",
1747
+ "private_key": "-----BEGIN RSA PRIVATE KEY-----\\nMIIEpQ ... /WZs=\\n-----END RSA PRIVATE KEY-----\\n",
1748
+ "client_email": "service-account-email",
1749
+ "client_id": "client-id",
1750
+ "auth_uri": "https://accounts.google.com/o/oauth2/auth",
1751
+ "token_uri": "https://accounts.google.com/o/oauth2/token",
1752
+ "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
1753
+ "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/service-account-email"
1754
+ }
1755
+ ```
1563
1756
  """
1564
1757
  return pulumi.get(self, "google_service_account_key")
1565
1758
 
@@ -1575,7 +1768,9 @@ class RaftSnapshotAgentConfig(pulumi.CustomResource):
1575
1768
  @pulumi.getter(name="localMaxSpace")
1576
1769
  def local_max_space(self) -> pulumi.Output[Optional[int]]:
1577
1770
  """
1578
- The maximum space, in bytes, to use for snapshots.
1771
+ For `storage_type = local`, the maximum
1772
+ space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough
1773
+ space left in this allowance.
1579
1774
  """
1580
1775
  return pulumi.get(self, "local_max_space")
1581
1776