pulumi-vault 5.21.0a1709368526__py3-none-any.whl → 5.21.0a1710888431__py3-none-any.whl

pulumi_vault/namespace.py

@@ -209,57 +209,47 @@ class Namespace(pulumi.CustomResource):
         $ pulumi import vault:index/namespace:Namespace example <name>
         ```
 
-         If the declared resource is imported and intends to support namespaces using a provider alias, then the name is relative to the namespace path.
+        If the declared resource is imported and intends to support namespaces using a provider alias, then the name is relative to the namespace path.
 
-         hcl
+        hcl
 
-         provider "vault" {
+        provider "vault" {
 
         # Configuration options
 
-         namespace = "example"
+          namespace = "example"
 
-         alias
+          alias     = "example"
 
-         = "example"
+        }
 
-         }
+        resource "vault_namespace" "example2" {
 
-         resource "vault_namespace" "example2" {
+          provider = vault.example
 
-         provider = vault.example
+          path     = "example2"
 
-         path
-
-         = "example2"
-
-         }
+        }
 
         ```sh
         $ pulumi import vault:index/namespace:Namespace example2 example2
         ```
 
-         $ terraform state show vault_namespace.example2
-
-         vault_namespace.example2:
-
-         resource "vault_namespace" "example2" {
-
-         id
-
-         = "example/example2/"
-
-         namespace_id = <known after import>
-
-         path
+        $ terraform state show vault_namespace.example2
 
-         = "example2"
+        vault_namespace.example2:
 
-         path_fq
+        resource "vault_namespace" "example2" {
 
-        = "example2"
+            id           = "example/example2/"
+            
+            namespace_id = <known after import>
+            
+            path         = "example2"
+            
+            path_fq      = "example2"
 
-         }
+        }
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -288,57 +278,47 @@ class Namespace(pulumi.CustomResource):
         $ pulumi import vault:index/namespace:Namespace example <name>
         ```
 
-         If the declared resource is imported and intends to support namespaces using a provider alias, then the name is relative to the namespace path.
+        If the declared resource is imported and intends to support namespaces using a provider alias, then the name is relative to the namespace path.
 
-         hcl
+        hcl
 
-         provider "vault" {
+        provider "vault" {
 
         # Configuration options
 
-         namespace = "example"
+          namespace = "example"
 
-         alias
+          alias     = "example"
 
-         = "example"
+        }
 
-         }
+        resource "vault_namespace" "example2" {
 
-         resource "vault_namespace" "example2" {
+          provider = vault.example
 
-         provider = vault.example
+          path     = "example2"
 
-         path
-
-         = "example2"
-
-         }
+        }
 
         ```sh
         $ pulumi import vault:index/namespace:Namespace example2 example2
         ```
 
-         $ terraform state show vault_namespace.example2
-
-         vault_namespace.example2:
-
-         resource "vault_namespace" "example2" {
-
-         id
-
-         = "example/example2/"
-
-         namespace_id = <known after import>
-
-         path
+        $ terraform state show vault_namespace.example2
 
-         = "example2"
+        vault_namespace.example2:
 
-         path_fq
+        resource "vault_namespace" "example2" {
 
-        = "example2"
+            id           = "example/example2/"
+            
+            namespace_id = <known after import>
+            
+            path         = "example2"
+            
+            path_fq      = "example2"
 
-         }
+        }
 
         :param str resource_name: The name of the resource.
         :param NamespaceArgs args: The arguments to use to populate this resource's properties.

pulumi_vault/nomad_secret_backend.py

@@ -571,6 +571,7 @@ class NomadSecretBackend(pulumi.CustomResource):
         """
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -585,13 +586,14 @@ class NomadSecretBackend(pulumi.CustomResource):
             token="ae20ceaa-...",
             ttl=120)
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         Nomad secret backend can be imported using the `backend`, e.g.
 
         ```sh
-         $ pulumi import vault:index/nomadSecretBackend:NomadSecretBackend nomad nomad
+        $ pulumi import vault:index/nomadSecretBackend:NomadSecretBackend nomad nomad
         ```
 
         :param str resource_name: The name of the resource.
@@ -631,6 +633,7 @@ class NomadSecretBackend(pulumi.CustomResource):
         """
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -645,13 +648,14 @@ class NomadSecretBackend(pulumi.CustomResource):
             token="ae20ceaa-...",
             ttl=120)
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         Nomad secret backend can be imported using the `backend`, e.g.
 
         ```sh
-         $ pulumi import vault:index/nomadSecretBackend:NomadSecretBackend nomad nomad
+        $ pulumi import vault:index/nomadSecretBackend:NomadSecretBackend nomad nomad
         ```
 
         :param str resource_name: The name of the resource.

pulumi_vault/nomad_secret_role.py

@@ -260,6 +260,7 @@ class NomadSecretRole(pulumi.CustomResource):
         """
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -277,13 +278,14 @@ class NomadSecretRole(pulumi.CustomResource):
             type="client",
             policies=["readonly"])
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         Nomad secret role can be imported using the `backend`, e.g.
 
         ```sh
-         $ pulumi import vault:index/nomadSecretRole:NomadSecretRole bob nomad/role/bob
+        $ pulumi import vault:index/nomadSecretRole:NomadSecretRole bob nomad/role/bob
         ```
 
         :param str resource_name: The name of the resource.
@@ -311,6 +313,7 @@ class NomadSecretRole(pulumi.CustomResource):
         """
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -328,13 +331,14 @@ class NomadSecretRole(pulumi.CustomResource):
             type="client",
             policies=["readonly"])
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         Nomad secret role can be imported using the `backend`, e.g.
 
         ```sh
-         $ pulumi import vault:index/nomadSecretRole:NomadSecretRole bob nomad/role/bob
+        $ pulumi import vault:index/nomadSecretRole:NomadSecretRole bob nomad/role/bob
         ```
 
         :param str resource_name: The name of the resource.

pulumi_vault/okta/auth_backend.py

@@ -488,6 +488,7 @@ class AuthBackend(pulumi.CustomResource):
 
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -508,13 +509,14 @@ class AuthBackend(pulumi.CustomResource):
                 username="bar",
             )])
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         Okta authentication backends can be imported using its `path`, e.g.
 
         ```sh
-         $ pulumi import vault:okta/authBackend:AuthBackend example okta
+        $ pulumi import vault:okta/authBackend:AuthBackend example okta
         ```
 
         :param str resource_name: The name of the resource.
@@ -553,6 +555,7 @@ class AuthBackend(pulumi.CustomResource):
 
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -573,13 +576,14 @@ class AuthBackend(pulumi.CustomResource):
                 username="bar",
             )])
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         Okta authentication backends can be imported using its `path`, e.g.
 
         ```sh
-         $ pulumi import vault:okta/authBackend:AuthBackend example okta
+        $ pulumi import vault:okta/authBackend:AuthBackend example okta
         ```
 
         :param str resource_name: The name of the resource.

pulumi_vault/okta/auth_backend_group.py

@@ -181,6 +181,7 @@ class AuthBackendGroup(pulumi.CustomResource):
 
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -196,13 +197,14 @@ class AuthBackendGroup(pulumi.CustomResource):
                 "two",
             ])
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         Okta authentication backend groups can be imported using the format `backend/groupName` e.g.
 
         ```sh
-         $ pulumi import vault:okta/authBackendGroup:AuthBackendGroup foo okta/foo
+        $ pulumi import vault:okta/authBackendGroup:AuthBackendGroup foo okta/foo
         ```
 
         :param str resource_name: The name of the resource.
@@ -227,6 +229,7 @@ class AuthBackendGroup(pulumi.CustomResource):
 
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -242,13 +245,14 @@ class AuthBackendGroup(pulumi.CustomResource):
                 "two",
             ])
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         Okta authentication backend groups can be imported using the format `backend/groupName` e.g.
 
         ```sh
-         $ pulumi import vault:okta/authBackendGroup:AuthBackendGroup foo okta/foo
+        $ pulumi import vault:okta/authBackendGroup:AuthBackendGroup foo okta/foo
         ```
 
         :param str resource_name: The name of the resource.

pulumi_vault/okta/auth_backend_user.py

@@ -214,6 +214,7 @@ class AuthBackendUser(pulumi.CustomResource):
 
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -229,13 +230,14 @@ class AuthBackendUser(pulumi.CustomResource):
                 "two",
             ])
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         Okta authentication backend users can be imported using its `path/user` ID format, e.g.
 
         ```sh
-         $ pulumi import vault:okta/authBackendUser:AuthBackendUser example okta/foo
+        $ pulumi import vault:okta/authBackendUser:AuthBackendUser example okta/foo
         ```
 
         :param str resource_name: The name of the resource.
@@ -261,6 +263,7 @@ class AuthBackendUser(pulumi.CustomResource):
 
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -276,13 +279,14 @@ class AuthBackendUser(pulumi.CustomResource):
                 "two",
             ])
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         Okta authentication backend users can be imported using its `path/user` ID format, e.g.
 
         ```sh
-         $ pulumi import vault:okta/authBackendUser:AuthBackendUser example okta/foo
+        $ pulumi import vault:okta/authBackendUser:AuthBackendUser example okta/foo
         ```
 
         :param str resource_name: The name of the resource.

pulumi_vault/password_policy.py

@@ -150,6 +150,7 @@ class PasswordPolicy(pulumi.CustomResource):
 
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -161,13 +162,14 @@ class PasswordPolicy(pulumi.CustomResource):
           
         \"\"\")
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         Password policies can be imported using the `name`, e.g.
 
         ```sh
-         $ pulumi import vault:index/passwordPolicy:PasswordPolicy alphanumeric alphanumeric
+        $ pulumi import vault:index/passwordPolicy:PasswordPolicy alphanumeric alphanumeric
         ```
 
         :param str resource_name: The name of the resource.
@@ -192,6 +194,7 @@ class PasswordPolicy(pulumi.CustomResource):
 
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -203,13 +206,14 @@ class PasswordPolicy(pulumi.CustomResource):
           
         \"\"\")
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         Password policies can be imported using the `name`, e.g.
 
         ```sh
-         $ pulumi import vault:index/passwordPolicy:PasswordPolicy alphanumeric alphanumeric
+        $ pulumi import vault:index/passwordPolicy:PasswordPolicy alphanumeric alphanumeric
         ```
 
         :param str resource_name: The name of the resource.

pulumi_vault/pkisecret/get_backend_issuer.py

@@ -173,7 +173,8 @@ def get_backend_issuer(backend: Optional[str] = None,
                        namespace: Optional[str] = None,
                        opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetBackendIssuerResult:
     """
-    Use this data source to access information about an existing resource.
+    ## Example Usage
+
 
     :param str backend: The path to the PKI secret backend to
            read the issuer from, with no leading or trailing `/`s.
@@ -211,7 +212,8 @@ def get_backend_issuer_output(backend: Optional[pulumi.Input[str]] = None,
                               namespace: Optional[pulumi.Input[Optional[str]]] = None,
                               opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetBackendIssuerResult]:
     """
-    Use this data source to access information about an existing resource.
+    ## Example Usage
+
 
     :param str backend: The path to the PKI secret backend to
            read the issuer from, with no leading or trailing `/`s.

pulumi_vault/pkisecret/get_backend_issuers.py

@@ -104,6 +104,7 @@ def get_backend_issuers(backend: Optional[str] = None,
     """
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vault as vault
@@ -120,6 +121,7 @@ def get_backend_issuers(backend: Optional[str] = None,
         issuer_name="example")
     test = vault.pkiSecret.get_backend_issuers_output(backend=root.backend)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str backend: The path to the PKI secret backend to
@@ -151,6 +153,7 @@ def get_backend_issuers_output(backend: Optional[pulumi.Input[str]] = None,
     """
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vault as vault
@@ -167,6 +170,7 @@ def get_backend_issuers_output(backend: Optional[pulumi.Input[str]] = None,
         issuer_name="example")
     test = vault.pkiSecret.get_backend_issuers_output(backend=root.backend)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str backend: The path to the PKI secret backend to

pulumi_vault/pkisecret/get_backend_key.py

@@ -114,6 +114,7 @@ def get_backend_key(backend: Optional[str] = None,
     """
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vault as vault
@@ -131,6 +132,7 @@ def get_backend_key(backend: Optional[str] = None,
     example = key.key_id.apply(lambda key_id: vault.pkiSecret.get_backend_key_output(backend=vault_mount["key"]["path"],
         key_ref=key_id))
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str backend: The path to the PKI secret backend to
@@ -166,6 +168,7 @@ def get_backend_key_output(backend: Optional[pulumi.Input[str]] = None,
     """
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vault as vault
@@ -183,6 +186,7 @@ def get_backend_key_output(backend: Optional[pulumi.Input[str]] = None,
     example = key.key_id.apply(lambda key_id: vault.pkiSecret.get_backend_key_output(backend=vault_mount["key"]["path"],
         key_ref=key_id))
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str backend: The path to the PKI secret backend to

pulumi_vault/pkisecret/get_backend_keys.py

@@ -104,6 +104,7 @@ def get_backend_keys(backend: Optional[str] = None,
     """
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vault as vault
@@ -120,6 +121,7 @@ def get_backend_keys(backend: Optional[str] = None,
         key_name="example")
     example = vault.pkiSecret.get_backend_keys_output(backend=root.backend)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str backend: The path to the PKI secret backend to
@@ -151,6 +153,7 @@ def get_backend_keys_output(backend: Optional[pulumi.Input[str]] = None,
     """
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vault as vault
@@ -167,6 +170,7 @@ def get_backend_keys_output(backend: Optional[pulumi.Input[str]] = None,
         key_name="example")
     example = vault.pkiSecret.get_backend_keys_output(backend=root.backend)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str backend: The path to the PKI secret backend to

pulumi_vault/pkisecret/secret_backend_cert.py

@@ -735,6 +735,7 @@ class SecretBackendCert(pulumi.CustomResource):
         """
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -744,6 +745,7 @@ class SecretBackendCert(pulumi.CustomResource):
             common_name="app.my.domain",
             opts=pulumi.ResourceOptions(depends_on=[vault_pki_secret_backend_role["admin"]]))
         ```
+        <!--End PulumiCodeChooser -->
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -777,6 +779,7 @@ class SecretBackendCert(pulumi.CustomResource):
         """
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -786,6 +789,7 @@ class SecretBackendCert(pulumi.CustomResource):
             common_name="app.my.domain",
             opts=pulumi.ResourceOptions(depends_on=[vault_pki_secret_backend_role["admin"]]))
         ```
+        <!--End PulumiCodeChooser -->
 
         :param str resource_name: The name of the resource.
         :param SecretBackendCertArgs args: The arguments to use to populate this resource's properties.

pulumi_vault/pkisecret/secret_backend_config_ca.py

@@ -145,6 +145,7 @@ class SecretBackendConfigCa(pulumi.CustomResource):
         """
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -202,6 +203,7 @@ class SecretBackendConfigCa(pulumi.CustomResource):
         \"\"\",
             opts=pulumi.ResourceOptions(depends_on=[vault_mount["intermediate"]]))
         ```
+        <!--End PulumiCodeChooser -->
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -221,6 +223,7 @@ class SecretBackendConfigCa(pulumi.CustomResource):
         """
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -278,6 +281,7 @@ class SecretBackendConfigCa(pulumi.CustomResource):
         \"\"\",
             opts=pulumi.ResourceOptions(depends_on=[vault_mount["intermediate"]]))
         ```
+        <!--End PulumiCodeChooser -->
 
         :param str resource_name: The name of the resource.
         :param SecretBackendConfigCaArgs args: The arguments to use to populate this resource's properties.

pulumi_vault/pkisecret/secret_backend_config_issuers.py

@@ -187,6 +187,7 @@ class SecretBackendConfigIssuers(pulumi.CustomResource):
         """
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -210,13 +211,14 @@ class SecretBackendConfigIssuers(pulumi.CustomResource):
             default=example.issuer_id,
             default_follows_latest_issuer=True)
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         PKI secret backend config issuers can be imported using the path, e.g.
 
         ```sh
-         $ pulumi import vault:pkiSecret/secretBackendConfigIssuers:SecretBackendConfigIssuers config pki/config/issuers
+        $ pulumi import vault:pkiSecret/secretBackendConfigIssuers:SecretBackendConfigIssuers config pki/config/issuers
         ```
 
         :param str resource_name: The name of the resource.
@@ -240,6 +242,7 @@ class SecretBackendConfigIssuers(pulumi.CustomResource):
         """
         ## Example Usage
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vault as vault
@@ -263,13 +266,14 @@ class SecretBackendConfigIssuers(pulumi.CustomResource):
             default=example.issuer_id,
             default_follows_latest_issuer=True)
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         PKI secret backend config issuers can be imported using the path, e.g.
 
         ```sh
-         $ pulumi import vault:pkiSecret/secretBackendConfigIssuers:SecretBackendConfigIssuers config pki/config/issuers
+        $ pulumi import vault:pkiSecret/secretBackendConfigIssuers:SecretBackendConfigIssuers config pki/config/issuers
         ```
 
         :param str resource_name: The name of the resource.