pulumi-gitlab 9.3.0a1759182301__py3-none-any.whl → 9.8.1__py3-none-any.whl

pulumi_gitlab/get_security_policy_document.py

@@ -0,0 +1,170 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+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
+from . import outputs
+from ._inputs import *
+
+__all__ = [
+    'GetSecurityPolicyDocumentResult',
+    'AwaitableGetSecurityPolicyDocumentResult',
+    'get_security_policy_document',
+    'get_security_policy_document_output',
+]
+
+@pulumi.output_type
+class GetSecurityPolicyDocumentResult:
+    """
+    A collection of values returned by getSecurityPolicyDocument.
+    """
+    def __init__(__self__, id=None, scan_execution_policies=None, yaml=None):
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if scan_execution_policies and not isinstance(scan_execution_policies, list):
+            raise TypeError("Expected argument 'scan_execution_policies' to be a list")
+        pulumi.set(__self__, "scan_execution_policies", scan_execution_policies)
+        if yaml and not isinstance(yaml, str):
+            raise TypeError("Expected argument 'yaml' to be a str")
+        pulumi.set(__self__, "yaml", yaml)
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        Unique identifier for this policy document (hash of generated YAML).
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter(name="scanExecutionPolicies")
+    def scan_execution_policies(self) -> Optional[Sequence['outputs.GetSecurityPolicyDocumentScanExecutionPolicyResult']]:
+        """
+        Scan execution policy configuration. Multiple policies can be specified.
+        """
+        return pulumi.get(self, "scan_execution_policies")
+
+    @_builtins.property
+    @pulumi.getter
+    def yaml(self) -> _builtins.str:
+        """
+        The generated policy document in YAML format, ready to write to `.gitlab/security-policies/policy.yml`.
+        """
+        return pulumi.get(self, "yaml")
+
+
+class AwaitableGetSecurityPolicyDocumentResult(GetSecurityPolicyDocumentResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetSecurityPolicyDocumentResult(
+            id=self.id,
+            scan_execution_policies=self.scan_execution_policies,
+            yaml=self.yaml)
+
+
+def get_security_policy_document(scan_execution_policies: Optional[Sequence[Union['GetSecurityPolicyDocumentScanExecutionPolicyArgs', 'GetSecurityPolicyDocumentScanExecutionPolicyArgsDict']]] = None,
+                                 opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetSecurityPolicyDocumentResult:
+    """
+    Generates a GitLab security policy YAML document from structured configuration.
+    This data source performs pure transformation without any API calls.
+
+    **Upstream API**: [GitLab Security Policies Documentation](https://docs.gitlab.com/ee/user/application_security/policies/scan_execution_policies/)
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_gitlab as gitlab
+
+    # Use this with `gitlab_repository_file` to manage your policies using native HCL
+    scan = gitlab.get_security_policy_document(scan_execution_policies=[{
+        "name": "Basic SAST Policy",
+        "enabled": True,
+        "rules": [{
+            "type": "pipeline",
+            "branch_type": "all",
+        }],
+        "actions": [{
+            "scan": "sast",
+        }],
+    }])
+    # See `gitlab_project_security_policy_attachment` or `gitlab_group_security_policy_attachment`
+    # for how to link a security policy project to a project or group.
+    policy = gitlab.RepositoryFile("policy",
+        project="1234",
+        ref="main",
+        file_path=".gitlab/security-policies/policy.yml",
+        content=scan.yaml)
+    ```
+
+
+    :param Sequence[Union['GetSecurityPolicyDocumentScanExecutionPolicyArgs', 'GetSecurityPolicyDocumentScanExecutionPolicyArgsDict']] scan_execution_policies: Scan execution policy configuration. Multiple policies can be specified.
+    """
+    __args__ = dict()
+    __args__['scanExecutionPolicies'] = scan_execution_policies
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('gitlab:index/getSecurityPolicyDocument:getSecurityPolicyDocument', __args__, opts=opts, typ=GetSecurityPolicyDocumentResult).value
+
+    return AwaitableGetSecurityPolicyDocumentResult(
+        id=pulumi.get(__ret__, 'id'),
+        scan_execution_policies=pulumi.get(__ret__, 'scan_execution_policies'),
+        yaml=pulumi.get(__ret__, 'yaml'))
+def get_security_policy_document_output(scan_execution_policies: Optional[pulumi.Input[Optional[Sequence[Union['GetSecurityPolicyDocumentScanExecutionPolicyArgs', 'GetSecurityPolicyDocumentScanExecutionPolicyArgsDict']]]]] = None,
+                                        opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetSecurityPolicyDocumentResult]:
+    """
+    Generates a GitLab security policy YAML document from structured configuration.
+    This data source performs pure transformation without any API calls.
+
+    **Upstream API**: [GitLab Security Policies Documentation](https://docs.gitlab.com/ee/user/application_security/policies/scan_execution_policies/)
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_gitlab as gitlab
+
+    # Use this with `gitlab_repository_file` to manage your policies using native HCL
+    scan = gitlab.get_security_policy_document(scan_execution_policies=[{
+        "name": "Basic SAST Policy",
+        "enabled": True,
+        "rules": [{
+            "type": "pipeline",
+            "branch_type": "all",
+        }],
+        "actions": [{
+            "scan": "sast",
+        }],
+    }])
+    # See `gitlab_project_security_policy_attachment` or `gitlab_group_security_policy_attachment`
+    # for how to link a security policy project to a project or group.
+    policy = gitlab.RepositoryFile("policy",
+        project="1234",
+        ref="main",
+        file_path=".gitlab/security-policies/policy.yml",
+        content=scan.yaml)
+    ```
+
+
+    :param Sequence[Union['GetSecurityPolicyDocumentScanExecutionPolicyArgs', 'GetSecurityPolicyDocumentScanExecutionPolicyArgsDict']] scan_execution_policies: Scan execution policy configuration. Multiple policies can be specified.
+    """
+    __args__ = dict()
+    __args__['scanExecutionPolicies'] = scan_execution_policies
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('gitlab:index/getSecurityPolicyDocument:getSecurityPolicyDocument', __args__, opts=opts, typ=GetSecurityPolicyDocumentResult)
+    return __ret__.apply(lambda __response__: GetSecurityPolicyDocumentResult(
+        id=pulumi.get(__response__, 'id'),
+        scan_execution_policies=pulumi.get(__response__, 'scan_execution_policies'),
+        yaml=pulumi.get(__response__, 'yaml')))

pulumi_gitlab/get_user.py

@@ -213,7 +213,7 @@ class GetUserResult:
     @pulumi.getter
     def id(self) -> _builtins.str:
         """
-        The provider-assigned unique ID for this managed resource.
+        The ID of this datasource. In the format `<user-id>`.
         """
         return pulumi.get(self, "id")
 
@@ -424,6 +424,22 @@ def get_user(email: Optional[_builtins.str] = None,
 
     **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/users/#get-a-single-user)
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_gitlab as gitlab
+    import pulumi_std as std
+
+    example = gitlab.get_user(username="myuser")
+    # Example using `for_each`
+    example_two = {__key: gitlab.get_user(username=__value) for __key, __value in std.toset(input=[
+        "user1",
+        "user2",
+        "user3",
+    ]).result}
+    ```
+
 
     :param _builtins.str email: The public email address of the user.
     :param _builtins.bool email_exact_match: (Experimental) If true, returns only an exact match. Otherwise, fuzzy matching might return the closest result. If no exact match is available, the data source returns an error.
@@ -487,6 +503,22 @@ def get_user_output(email: Optional[pulumi.Input[Optional[_builtins.str]]] = Non
 
     **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/users/#get-a-single-user)
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_gitlab as gitlab
+    import pulumi_std as std
+
+    example = gitlab.get_user(username="myuser")
+    # Example using `for_each`
+    example_two = {__key: gitlab.get_user(username=__value) for __key, __value in std.toset(input=[
+        "user1",
+        "user2",
+        "user3",
+    ]).result}
+    ```
+
 
     :param _builtins.str email: The public email address of the user.
     :param _builtins.bool email_exact_match: (Experimental) If true, returns only an exact match. Otherwise, fuzzy matching might return the closest result. If no exact match is available, the data source returns an error.

pulumi_gitlab/get_users.py

@@ -27,7 +27,7 @@ class GetUsersResult:
     """
     A collection of values returned by getUsers.
     """
-    def __init__(__self__, active=None, blocked=None, created_after=None, created_before=None, exclude_external=None, exclude_internal=None, extern_provider=None, extern_uid=None, external=None, id=None, order_by=None, search=None, sort=None, username=None, users=None, without_project_bots=None):
+    def __init__(__self__, active=None, blocked=None, created_after=None, created_before=None, exclude_external=None, exclude_internal=None, extern_provider=None, extern_uid=None, external=None, humans=None, id=None, order_by=None, search=None, sort=None, username=None, users=None, without_project_bots=None):
         if active and not isinstance(active, bool):
             raise TypeError("Expected argument 'active' to be a bool")
         pulumi.set(__self__, "active", active)
@@ -55,6 +55,9 @@ class GetUsersResult:
         if external and not isinstance(external, bool):
             raise TypeError("Expected argument 'external' to be a bool")
         pulumi.set(__self__, "external", external)
+        if humans and not isinstance(humans, bool):
+            raise TypeError("Expected argument 'humans' to be a bool")
+        pulumi.set(__self__, "humans", humans)
         if id and not isinstance(id, str):
             raise TypeError("Expected argument 'id' to be a str")
         pulumi.set(__self__, "id", id)
@@ -149,11 +152,19 @@ class GetUsersResult:
         """
         return pulumi.get(self, "external")
 
+    @_builtins.property
+    @pulumi.getter
+    def humans(self) -> Optional[_builtins.bool]:
+        """
+        Filters only regular users that are not bot or internal users.
+        """
+        return pulumi.get(self, "humans")
+
     @_builtins.property
     @pulumi.getter
     def id(self) -> _builtins.str:
         """
-        The provider-assigned unique ID for this managed resource.
+        The ID of this datasource. In the format of a hash taken from the search options.
         """
         return pulumi.get(self, "id")
 
@@ -221,6 +232,7 @@ class AwaitableGetUsersResult(GetUsersResult):
             extern_provider=self.extern_provider,
             extern_uid=self.extern_uid,
             external=self.external,
+            humans=self.humans,
             id=self.id,
             order_by=self.order_by,
             search=self.search,
@@ -239,6 +251,7 @@ def get_users(active: Optional[_builtins.bool] = None,
               extern_provider: Optional[_builtins.str] = None,
               extern_uid: Optional[_builtins.str] = None,
               external: Optional[_builtins.bool] = None,
+              humans: Optional[_builtins.bool] = None,
               order_by: Optional[_builtins.str] = None,
               search: Optional[_builtins.str] = None,
               sort: Optional[_builtins.str] = None,
@@ -276,6 +289,7 @@ def get_users(active: Optional[_builtins.bool] = None,
     :param _builtins.str extern_provider: Lookup users by external provider. (Requires administrator privileges)
     :param _builtins.str extern_uid: Lookup users by external UID. (Requires administrator privileges)
     :param _builtins.bool external: Filters only external users.
+    :param _builtins.bool humans: Filters only regular users that are not bot or internal users.
     :param _builtins.str order_by: Order the users' list by `id`, `name`, `username`, `created_at` or `updated_at`. (Requires administrator privileges)
     :param _builtins.str search: Search users by username, name or email.
     :param _builtins.str sort: Sort users' list in asc or desc order. (Requires administrator privileges)
@@ -292,6 +306,7 @@ def get_users(active: Optional[_builtins.bool] = None,
     __args__['externProvider'] = extern_provider
     __args__['externUid'] = extern_uid
     __args__['external'] = external
+    __args__['humans'] = humans
     __args__['orderBy'] = order_by
     __args__['search'] = search
     __args__['sort'] = sort
@@ -310,6 +325,7 @@ def get_users(active: Optional[_builtins.bool] = None,
         extern_provider=pulumi.get(__ret__, 'extern_provider'),
         extern_uid=pulumi.get(__ret__, 'extern_uid'),
         external=pulumi.get(__ret__, 'external'),
+        humans=pulumi.get(__ret__, 'humans'),
         id=pulumi.get(__ret__, 'id'),
         order_by=pulumi.get(__ret__, 'order_by'),
         search=pulumi.get(__ret__, 'search'),
@@ -326,6 +342,7 @@ def get_users_output(active: Optional[pulumi.Input[Optional[_builtins.bool]]] =
                      extern_provider: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                      extern_uid: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                      external: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
+                     humans: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
                      order_by: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                      search: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                      sort: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
@@ -363,6 +380,7 @@ def get_users_output(active: Optional[pulumi.Input[Optional[_builtins.bool]]] =
     :param _builtins.str extern_provider: Lookup users by external provider. (Requires administrator privileges)
     :param _builtins.str extern_uid: Lookup users by external UID. (Requires administrator privileges)
     :param _builtins.bool external: Filters only external users.
+    :param _builtins.bool humans: Filters only regular users that are not bot or internal users.
     :param _builtins.str order_by: Order the users' list by `id`, `name`, `username`, `created_at` or `updated_at`. (Requires administrator privileges)
     :param _builtins.str search: Search users by username, name or email.
     :param _builtins.str sort: Sort users' list in asc or desc order. (Requires administrator privileges)
@@ -379,6 +397,7 @@ def get_users_output(active: Optional[pulumi.Input[Optional[_builtins.bool]]] =
     __args__['externProvider'] = extern_provider
     __args__['externUid'] = extern_uid
     __args__['external'] = external
+    __args__['humans'] = humans
     __args__['orderBy'] = order_by
     __args__['search'] = search
     __args__['sort'] = sort
@@ -396,6 +415,7 @@ def get_users_output(active: Optional[pulumi.Input[Optional[_builtins.bool]]] =
         extern_provider=pulumi.get(__response__, 'extern_provider'),
         extern_uid=pulumi.get(__response__, 'extern_uid'),
         external=pulumi.get(__response__, 'external'),
+        humans=pulumi.get(__response__, 'humans'),
         id=pulumi.get(__response__, 'id'),
         order_by=pulumi.get(__response__, 'order_by'),
         search=pulumi.get(__response__, 'search'),

pulumi_gitlab/global_level_notifications.py

@@ -636,7 +636,7 @@ class GlobalLevelNotifications(pulumi.CustomResource):
         """
         The `GlobalLevelNotifications` resource allows to manage global notifications.
 
-        **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/notification_settings/#group--project-level-notification-settings)
+        **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/notification_settings/#get-group-or-project-notification-settings)
 
         ## Import
 
@@ -694,7 +694,7 @@ class GlobalLevelNotifications(pulumi.CustomResource):
         """
         The `GlobalLevelNotifications` resource allows to manage global notifications.
 
-        **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/notification_settings/#group--project-level-notification-settings)
+        **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/notification_settings/#get-group-or-project-notification-settings)
 
         ## Import