pulumi-vault 5.21.0a1709368526__py3-none-any.whl → 6.5.0a1736836139__py3-none-any.whl

pulumi_vault/secrets/sync_gh_destination.py

@@ -4,9 +4,14 @@
 
 import copy
 import warnings
+import sys
 import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
 from .. import _utilities
 
 __all__ = ['SyncGhDestinationArgs', 'SyncGhDestination']
@@ -15,6 +20,9 @@ __all__ = ['SyncGhDestinationArgs', 'SyncGhDestination']
 class SyncGhDestinationArgs:
     def __init__(__self__, *,
                  access_token: Optional[pulumi.Input[str]] = None,
+                 app_name: Optional[pulumi.Input[str]] = None,
+                 granularity: Optional[pulumi.Input[str]] = None,
+                 installation_id: Optional[pulumi.Input[int]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  namespace: Optional[pulumi.Input[str]] = None,
                  repository_name: Optional[pulumi.Input[str]] = None,
@@ -25,10 +33,17 @@ class SyncGhDestinationArgs:
         :param pulumi.Input[str] access_token: Fine-grained or personal access token.
                Can be omitted and directly provided to Vault using the `GITHUB_ACCESS_TOKEN` environment
                variable.
+        :param pulumi.Input[str] app_name: The user-defined name of the GitHub App configuration. This is a reference to the name used   
+               on the new endpoint when configuring the GitHub app on the Vault Server. Can be modified.
+               Takes precedence over the `access_token` field.
+        :param pulumi.Input[str] granularity: Determines what level of information is synced as a distinct resource
+               at the destination. Supports `secret-path` and `secret-key`.
+        :param pulumi.Input[int] installation_id: The ID of the installation generated by GitHub when the app referenced by the `app_name` 
+               was installed in the user’s GitHub account. Can be modified. Necessary if the `app_name` field is also provided.
         :param pulumi.Input[str] name: Unique name of the GitHub destination.
         :param pulumi.Input[str] namespace: The namespace to provision the resource in.
                The value should not contain leading or trailing forward slashes.
-               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
+               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
         :param pulumi.Input[str] repository_name: Name of the repository.
                Can be omitted and directly provided to Vault using the `GITHUB_REPOSITORY_NAME` environment
                variable.
@@ -40,6 +55,12 @@ class SyncGhDestinationArgs:
         """
         if access_token is not None:
             pulumi.set(__self__, "access_token", access_token)
+        if app_name is not None:
+            pulumi.set(__self__, "app_name", app_name)
+        if granularity is not None:
+            pulumi.set(__self__, "granularity", granularity)
+        if installation_id is not None:
+            pulumi.set(__self__, "installation_id", installation_id)
         if name is not None:
             pulumi.set(__self__, "name", name)
         if namespace is not None:
@@ -65,6 +86,46 @@ class SyncGhDestinationArgs:
     def access_token(self, value: Optional[pulumi.Input[str]]):
         pulumi.set(self, "access_token", value)
 
+    @property
+    @pulumi.getter(name="appName")
+    def app_name(self) -> Optional[pulumi.Input[str]]:
+        """
+        The user-defined name of the GitHub App configuration. This is a reference to the name used   
+        on the new endpoint when configuring the GitHub app on the Vault Server. Can be modified.
+        Takes precedence over the `access_token` field.
+        """
+        return pulumi.get(self, "app_name")
+
+    @app_name.setter
+    def app_name(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "app_name", value)
+
+    @property
+    @pulumi.getter
+    def granularity(self) -> Optional[pulumi.Input[str]]:
+        """
+        Determines what level of information is synced as a distinct resource
+        at the destination. Supports `secret-path` and `secret-key`.
+        """
+        return pulumi.get(self, "granularity")
+
+    @granularity.setter
+    def granularity(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "granularity", value)
+
+    @property
+    @pulumi.getter(name="installationId")
+    def installation_id(self) -> Optional[pulumi.Input[int]]:
+        """
+        The ID of the installation generated by GitHub when the app referenced by the `app_name` 
+        was installed in the user’s GitHub account. Can be modified. Necessary if the `app_name` field is also provided.
+        """
+        return pulumi.get(self, "installation_id")
+
+    @installation_id.setter
+    def installation_id(self, value: Optional[pulumi.Input[int]]):
+        pulumi.set(self, "installation_id", value)
+
     @property
     @pulumi.getter
     def name(self) -> Optional[pulumi.Input[str]]:
@@ -83,7 +144,7 @@ class SyncGhDestinationArgs:
         """
         The namespace to provision the resource in.
         The value should not contain leading or trailing forward slashes.
-        The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
+        The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
         """
         return pulumi.get(self, "namespace")
 
@@ -137,6 +198,9 @@ class SyncGhDestinationArgs:
 class _SyncGhDestinationState:
     def __init__(__self__, *,
                  access_token: Optional[pulumi.Input[str]] = None,
+                 app_name: Optional[pulumi.Input[str]] = None,
+                 granularity: Optional[pulumi.Input[str]] = None,
+                 installation_id: Optional[pulumi.Input[int]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  namespace: Optional[pulumi.Input[str]] = None,
                  repository_name: Optional[pulumi.Input[str]] = None,
@@ -148,10 +212,17 @@ class _SyncGhDestinationState:
         :param pulumi.Input[str] access_token: Fine-grained or personal access token.
                Can be omitted and directly provided to Vault using the `GITHUB_ACCESS_TOKEN` environment
                variable.
+        :param pulumi.Input[str] app_name: The user-defined name of the GitHub App configuration. This is a reference to the name used   
+               on the new endpoint when configuring the GitHub app on the Vault Server. Can be modified.
+               Takes precedence over the `access_token` field.
+        :param pulumi.Input[str] granularity: Determines what level of information is synced as a distinct resource
+               at the destination. Supports `secret-path` and `secret-key`.
+        :param pulumi.Input[int] installation_id: The ID of the installation generated by GitHub when the app referenced by the `app_name` 
+               was installed in the user’s GitHub account. Can be modified. Necessary if the `app_name` field is also provided.
         :param pulumi.Input[str] name: Unique name of the GitHub destination.
         :param pulumi.Input[str] namespace: The namespace to provision the resource in.
                The value should not contain leading or trailing forward slashes.
-               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
+               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
         :param pulumi.Input[str] repository_name: Name of the repository.
                Can be omitted and directly provided to Vault using the `GITHUB_REPOSITORY_NAME` environment
                variable.
@@ -164,6 +235,12 @@ class _SyncGhDestinationState:
         """
         if access_token is not None:
             pulumi.set(__self__, "access_token", access_token)
+        if app_name is not None:
+            pulumi.set(__self__, "app_name", app_name)
+        if granularity is not None:
+            pulumi.set(__self__, "granularity", granularity)
+        if installation_id is not None:
+            pulumi.set(__self__, "installation_id", installation_id)
         if name is not None:
             pulumi.set(__self__, "name", name)
         if namespace is not None:
@@ -191,6 +268,46 @@ class _SyncGhDestinationState:
     def access_token(self, value: Optional[pulumi.Input[str]]):
         pulumi.set(self, "access_token", value)
 
+    @property
+    @pulumi.getter(name="appName")
+    def app_name(self) -> Optional[pulumi.Input[str]]:
+        """
+        The user-defined name of the GitHub App configuration. This is a reference to the name used   
+        on the new endpoint when configuring the GitHub app on the Vault Server. Can be modified.
+        Takes precedence over the `access_token` field.
+        """
+        return pulumi.get(self, "app_name")
+
+    @app_name.setter
+    def app_name(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "app_name", value)
+
+    @property
+    @pulumi.getter
+    def granularity(self) -> Optional[pulumi.Input[str]]:
+        """
+        Determines what level of information is synced as a distinct resource
+        at the destination. Supports `secret-path` and `secret-key`.
+        """
+        return pulumi.get(self, "granularity")
+
+    @granularity.setter
+    def granularity(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "granularity", value)
+
+    @property
+    @pulumi.getter(name="installationId")
+    def installation_id(self) -> Optional[pulumi.Input[int]]:
+        """
+        The ID of the installation generated by GitHub when the app referenced by the `app_name` 
+        was installed in the user’s GitHub account. Can be modified. Necessary if the `app_name` field is also provided.
+        """
+        return pulumi.get(self, "installation_id")
+
+    @installation_id.setter
+    def installation_id(self, value: Optional[pulumi.Input[int]]):
+        pulumi.set(self, "installation_id", value)
+
     @property
     @pulumi.getter
     def name(self) -> Optional[pulumi.Input[str]]:
@@ -209,7 +326,7 @@ class _SyncGhDestinationState:
         """
         The namespace to provision the resource in.
         The value should not contain leading or trailing forward slashes.
-        The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
+        The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
         """
         return pulumi.get(self, "namespace")
 
@@ -277,6 +394,9 @@ class SyncGhDestination(pulumi.CustomResource):
                  resource_name: str,
                  opts: Optional[pulumi.ResourceOptions] = None,
                  access_token: Optional[pulumi.Input[str]] = None,
+                 app_name: Optional[pulumi.Input[str]] = None,
+                 granularity: Optional[pulumi.Input[str]] = None,
+                 installation_id: Optional[pulumi.Input[int]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  namespace: Optional[pulumi.Input[str]] = None,
                  repository_name: Optional[pulumi.Input[str]] = None,
@@ -291,8 +411,9 @@ class SyncGhDestination(pulumi.CustomResource):
         import pulumi_vault as vault
 
         gh = vault.secrets.SyncGhDestination("gh",
-            access_token=var["access_token"],
-            repository_owner=var["repo_owner"],
+            name="gh-dest",
+            access_token=access_token,
+            repository_owner=repo_owner,
             repository_name="repo-name-example",
             secret_name_template="vault_{{ .MountAccessor | lowercase }}_{{ .SecretPath | lowercase }}")
         ```
@@ -302,7 +423,7 @@ class SyncGhDestination(pulumi.CustomResource):
         GitHub Secrets sync destinations can be imported using the `name`, e.g.
 
         ```sh
-         $ pulumi import vault:secrets/syncGhDestination:SyncGhDestination gh gh-dest
+        $ pulumi import vault:secrets/syncGhDestination:SyncGhDestination gh gh-dest
         ```
 
         :param str resource_name: The name of the resource.
@@ -310,10 +431,17 @@ class SyncGhDestination(pulumi.CustomResource):
         :param pulumi.Input[str] access_token: Fine-grained or personal access token.
                Can be omitted and directly provided to Vault using the `GITHUB_ACCESS_TOKEN` environment
                variable.
+        :param pulumi.Input[str] app_name: The user-defined name of the GitHub App configuration. This is a reference to the name used   
+               on the new endpoint when configuring the GitHub app on the Vault Server. Can be modified.
+               Takes precedence over the `access_token` field.
+        :param pulumi.Input[str] granularity: Determines what level of information is synced as a distinct resource
+               at the destination. Supports `secret-path` and `secret-key`.
+        :param pulumi.Input[int] installation_id: The ID of the installation generated by GitHub when the app referenced by the `app_name` 
+               was installed in the user’s GitHub account. Can be modified. Necessary if the `app_name` field is also provided.
         :param pulumi.Input[str] name: Unique name of the GitHub destination.
         :param pulumi.Input[str] namespace: The namespace to provision the resource in.
                The value should not contain leading or trailing forward slashes.
-               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
+               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
         :param pulumi.Input[str] repository_name: Name of the repository.
                Can be omitted and directly provided to Vault using the `GITHUB_REPOSITORY_NAME` environment
                variable.
@@ -337,8 +465,9 @@ class SyncGhDestination(pulumi.CustomResource):
         import pulumi_vault as vault
 
         gh = vault.secrets.SyncGhDestination("gh",
-            access_token=var["access_token"],
-            repository_owner=var["repo_owner"],
+            name="gh-dest",
+            access_token=access_token,
+            repository_owner=repo_owner,
             repository_name="repo-name-example",
             secret_name_template="vault_{{ .MountAccessor | lowercase }}_{{ .SecretPath | lowercase }}")
         ```
@@ -348,7 +477,7 @@ class SyncGhDestination(pulumi.CustomResource):
         GitHub Secrets sync destinations can be imported using the `name`, e.g.
 
         ```sh
-         $ pulumi import vault:secrets/syncGhDestination:SyncGhDestination gh gh-dest
+        $ pulumi import vault:secrets/syncGhDestination:SyncGhDestination gh gh-dest
         ```
 
         :param str resource_name: The name of the resource.
@@ -367,6 +496,9 @@ class SyncGhDestination(pulumi.CustomResource):
                  resource_name: str,
                  opts: Optional[pulumi.ResourceOptions] = None,
                  access_token: Optional[pulumi.Input[str]] = None,
+                 app_name: Optional[pulumi.Input[str]] = None,
+                 granularity: Optional[pulumi.Input[str]] = None,
+                 installation_id: Optional[pulumi.Input[int]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  namespace: Optional[pulumi.Input[str]] = None,
                  repository_name: Optional[pulumi.Input[str]] = None,
@@ -382,6 +514,9 @@ class SyncGhDestination(pulumi.CustomResource):
             __props__ = SyncGhDestinationArgs.__new__(SyncGhDestinationArgs)
 
             __props__.__dict__["access_token"] = None if access_token is None else pulumi.Output.secret(access_token)
+            __props__.__dict__["app_name"] = app_name
+            __props__.__dict__["granularity"] = granularity
+            __props__.__dict__["installation_id"] = installation_id
             __props__.__dict__["name"] = name
             __props__.__dict__["namespace"] = namespace
             __props__.__dict__["repository_name"] = repository_name
@@ -401,6 +536,9 @@ class SyncGhDestination(pulumi.CustomResource):
             id: pulumi.Input[str],
             opts: Optional[pulumi.ResourceOptions] = None,
             access_token: Optional[pulumi.Input[str]] = None,
+            app_name: Optional[pulumi.Input[str]] = None,
+            granularity: Optional[pulumi.Input[str]] = None,
+            installation_id: Optional[pulumi.Input[int]] = None,
             name: Optional[pulumi.Input[str]] = None,
             namespace: Optional[pulumi.Input[str]] = None,
             repository_name: Optional[pulumi.Input[str]] = None,
@@ -417,10 +555,17 @@ class SyncGhDestination(pulumi.CustomResource):
         :param pulumi.Input[str] access_token: Fine-grained or personal access token.
                Can be omitted and directly provided to Vault using the `GITHUB_ACCESS_TOKEN` environment
                variable.
+        :param pulumi.Input[str] app_name: The user-defined name of the GitHub App configuration. This is a reference to the name used   
+               on the new endpoint when configuring the GitHub app on the Vault Server. Can be modified.
+               Takes precedence over the `access_token` field.
+        :param pulumi.Input[str] granularity: Determines what level of information is synced as a distinct resource
+               at the destination. Supports `secret-path` and `secret-key`.
+        :param pulumi.Input[int] installation_id: The ID of the installation generated by GitHub when the app referenced by the `app_name` 
+               was installed in the user’s GitHub account. Can be modified. Necessary if the `app_name` field is also provided.
         :param pulumi.Input[str] name: Unique name of the GitHub destination.
         :param pulumi.Input[str] namespace: The namespace to provision the resource in.
                The value should not contain leading or trailing forward slashes.
-               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
+               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
         :param pulumi.Input[str] repository_name: Name of the repository.
                Can be omitted and directly provided to Vault using the `GITHUB_REPOSITORY_NAME` environment
                variable.
@@ -436,6 +581,9 @@ class SyncGhDestination(pulumi.CustomResource):
         __props__ = _SyncGhDestinationState.__new__(_SyncGhDestinationState)
 
         __props__.__dict__["access_token"] = access_token
+        __props__.__dict__["app_name"] = app_name
+        __props__.__dict__["granularity"] = granularity
+        __props__.__dict__["installation_id"] = installation_id
         __props__.__dict__["name"] = name
         __props__.__dict__["namespace"] = namespace
         __props__.__dict__["repository_name"] = repository_name
@@ -454,6 +602,34 @@ class SyncGhDestination(pulumi.CustomResource):
         """
         return pulumi.get(self, "access_token")
 
+    @property
+    @pulumi.getter(name="appName")
+    def app_name(self) -> pulumi.Output[Optional[str]]:
+        """
+        The user-defined name of the GitHub App configuration. This is a reference to the name used   
+        on the new endpoint when configuring the GitHub app on the Vault Server. Can be modified.
+        Takes precedence over the `access_token` field.
+        """
+        return pulumi.get(self, "app_name")
+
+    @property
+    @pulumi.getter
+    def granularity(self) -> pulumi.Output[Optional[str]]:
+        """
+        Determines what level of information is synced as a distinct resource
+        at the destination. Supports `secret-path` and `secret-key`.
+        """
+        return pulumi.get(self, "granularity")
+
+    @property
+    @pulumi.getter(name="installationId")
+    def installation_id(self) -> pulumi.Output[Optional[int]]:
+        """
+        The ID of the installation generated by GitHub when the app referenced by the `app_name` 
+        was installed in the user’s GitHub account. Can be modified. Necessary if the `app_name` field is also provided.
+        """
+        return pulumi.get(self, "installation_id")
+
     @property
     @pulumi.getter
     def name(self) -> pulumi.Output[str]:
@@ -468,7 +644,7 @@ class SyncGhDestination(pulumi.CustomResource):
         """
         The namespace to provision the resource in.
         The value should not contain leading or trailing forward slashes.
-        The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
+        The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
         """
         return pulumi.get(self, "namespace")