pulumi-gcp 8.23.0a1742538920__py3-none-any.whl → 8.24.0__py3-none-any.whl

pulumi_gcp/projects/__init__.py

@@ -9,6 +9,8 @@ from .access_approval_settings import *
 from .api_key import *
 from .default_service_accounts import *
 from .get_ancestry import *
+from .get_iam_custom_role import *
+from .get_iam_custom_roles import *
 from .get_iam_policy import *
 from .get_organization_policy import *
 from .get_project import *

pulumi_gcp/projects/get_iam_custom_role.py

@@ -0,0 +1,198 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+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__ = [
+    'GetIamCustomRoleResult',
+    'AwaitableGetIamCustomRoleResult',
+    'get_iam_custom_role',
+    'get_iam_custom_role_output',
+]
+
+@pulumi.output_type
+class GetIamCustomRoleResult:
+    """
+    A collection of values returned by getIamCustomRole.
+    """
+    def __init__(__self__, deleted=None, description=None, id=None, name=None, permissions=None, project=None, role_id=None, stage=None, title=None):
+        if deleted and not isinstance(deleted, bool):
+            raise TypeError("Expected argument 'deleted' to be a bool")
+        pulumi.set(__self__, "deleted", deleted)
+        if description and not isinstance(description, str):
+            raise TypeError("Expected argument 'description' to be a str")
+        pulumi.set(__self__, "description", description)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if permissions and not isinstance(permissions, list):
+            raise TypeError("Expected argument 'permissions' to be a list")
+        pulumi.set(__self__, "permissions", permissions)
+        if project and not isinstance(project, str):
+            raise TypeError("Expected argument 'project' to be a str")
+        pulumi.set(__self__, "project", project)
+        if role_id and not isinstance(role_id, str):
+            raise TypeError("Expected argument 'role_id' to be a str")
+        pulumi.set(__self__, "role_id", role_id)
+        if stage and not isinstance(stage, str):
+            raise TypeError("Expected argument 'stage' to be a str")
+        pulumi.set(__self__, "stage", stage)
+        if title and not isinstance(title, str):
+            raise TypeError("Expected argument 'title' to be a str")
+        pulumi.set(__self__, "title", title)
+
+    @property
+    @pulumi.getter
+    def deleted(self) -> bool:
+        return pulumi.get(self, "deleted")
+
+    @property
+    @pulumi.getter
+    def description(self) -> str:
+        return pulumi.get(self, "description")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def permissions(self) -> Sequence[str]:
+        return pulumi.get(self, "permissions")
+
+    @property
+    @pulumi.getter
+    def project(self) -> Optional[str]:
+        return pulumi.get(self, "project")
+
+    @property
+    @pulumi.getter(name="roleId")
+    def role_id(self) -> str:
+        return pulumi.get(self, "role_id")
+
+    @property
+    @pulumi.getter
+    def stage(self) -> str:
+        return pulumi.get(self, "stage")
+
+    @property
+    @pulumi.getter
+    def title(self) -> str:
+        return pulumi.get(self, "title")
+
+
+class AwaitableGetIamCustomRoleResult(GetIamCustomRoleResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetIamCustomRoleResult(
+            deleted=self.deleted,
+            description=self.description,
+            id=self.id,
+            name=self.name,
+            permissions=self.permissions,
+            project=self.project,
+            role_id=self.role_id,
+            stage=self.stage,
+            title=self.title)
+
+
+def get_iam_custom_role(project: Optional[str] = None,
+                        role_id: Optional[str] = None,
+                        opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetIamCustomRoleResult:
+    """
+    Get information about a Google Cloud Project IAM Custom Role. Note that you must have the `roles/iam.roleViewer` role (or equivalent permissions) at the project level to use this datasource.
+
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    example = gcp.projects.get_iam_custom_role(project="your-project-id",
+        role_id="your-role-id")
+    project = gcp.projects.IAMMember("project",
+        project="your-project-id",
+        role=example.name,
+        member="user:jane@example.com")
+    ```
+
+
+    :param str project: The project were the custom role has been created in. Defaults to the provider project configuration.
+    :param str role_id: The role id that has been used for this role.
+    """
+    __args__ = dict()
+    __args__['project'] = project
+    __args__['roleId'] = role_id
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('gcp:projects/getIamCustomRole:getIamCustomRole', __args__, opts=opts, typ=GetIamCustomRoleResult).value
+
+    return AwaitableGetIamCustomRoleResult(
+        deleted=pulumi.get(__ret__, 'deleted'),
+        description=pulumi.get(__ret__, 'description'),
+        id=pulumi.get(__ret__, 'id'),
+        name=pulumi.get(__ret__, 'name'),
+        permissions=pulumi.get(__ret__, 'permissions'),
+        project=pulumi.get(__ret__, 'project'),
+        role_id=pulumi.get(__ret__, 'role_id'),
+        stage=pulumi.get(__ret__, 'stage'),
+        title=pulumi.get(__ret__, 'title'))
+def get_iam_custom_role_output(project: Optional[pulumi.Input[Optional[str]]] = None,
+                               role_id: Optional[pulumi.Input[str]] = None,
+                               opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetIamCustomRoleResult]:
+    """
+    Get information about a Google Cloud Project IAM Custom Role. Note that you must have the `roles/iam.roleViewer` role (or equivalent permissions) at the project level to use this datasource.
+
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    example = gcp.projects.get_iam_custom_role(project="your-project-id",
+        role_id="your-role-id")
+    project = gcp.projects.IAMMember("project",
+        project="your-project-id",
+        role=example.name,
+        member="user:jane@example.com")
+    ```
+
+
+    :param str project: The project were the custom role has been created in. Defaults to the provider project configuration.
+    :param str role_id: The role id that has been used for this role.
+    """
+    __args__ = dict()
+    __args__['project'] = project
+    __args__['roleId'] = role_id
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('gcp:projects/getIamCustomRole:getIamCustomRole', __args__, opts=opts, typ=GetIamCustomRoleResult)
+    return __ret__.apply(lambda __response__: GetIamCustomRoleResult(
+        deleted=pulumi.get(__response__, 'deleted'),
+        description=pulumi.get(__response__, 'description'),
+        id=pulumi.get(__response__, 'id'),
+        name=pulumi.get(__response__, 'name'),
+        permissions=pulumi.get(__response__, 'permissions'),
+        project=pulumi.get(__response__, 'project'),
+        role_id=pulumi.get(__response__, 'role_id'),
+        stage=pulumi.get(__response__, 'stage'),
+        title=pulumi.get(__response__, 'title')))

pulumi_gcp/projects/get_iam_custom_roles.py

@@ -0,0 +1,164 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+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
+from . import outputs
+
+__all__ = [
+    'GetIamCustomRolesResult',
+    'AwaitableGetIamCustomRolesResult',
+    'get_iam_custom_roles',
+    'get_iam_custom_roles_output',
+]
+
+@pulumi.output_type
+class GetIamCustomRolesResult:
+    """
+    A collection of values returned by getIamCustomRoles.
+    """
+    def __init__(__self__, id=None, project=None, roles=None, show_deleted=None, view=None):
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if project and not isinstance(project, str):
+            raise TypeError("Expected argument 'project' to be a str")
+        pulumi.set(__self__, "project", project)
+        if roles and not isinstance(roles, list):
+            raise TypeError("Expected argument 'roles' to be a list")
+        pulumi.set(__self__, "roles", roles)
+        if show_deleted and not isinstance(show_deleted, bool):
+            raise TypeError("Expected argument 'show_deleted' to be a bool")
+        pulumi.set(__self__, "show_deleted", show_deleted)
+        if view and not isinstance(view, str):
+            raise TypeError("Expected argument 'view' to be a str")
+        pulumi.set(__self__, "view", view)
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def project(self) -> Optional[str]:
+        return pulumi.get(self, "project")
+
+    @property
+    @pulumi.getter
+    def roles(self) -> Sequence['outputs.GetIamCustomRolesRoleResult']:
+        """
+        A list of all retrieved custom roles roles. Structure is defined below.
+        """
+        return pulumi.get(self, "roles")
+
+    @property
+    @pulumi.getter(name="showDeleted")
+    def show_deleted(self) -> Optional[bool]:
+        return pulumi.get(self, "show_deleted")
+
+    @property
+    @pulumi.getter
+    def view(self) -> Optional[str]:
+        return pulumi.get(self, "view")
+
+
+class AwaitableGetIamCustomRolesResult(GetIamCustomRolesResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetIamCustomRolesResult(
+            id=self.id,
+            project=self.project,
+            roles=self.roles,
+            show_deleted=self.show_deleted,
+            view=self.view)
+
+
+def get_iam_custom_roles(project: Optional[str] = None,
+                         show_deleted: Optional[bool] = None,
+                         view: Optional[str] = None,
+                         opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetIamCustomRolesResult:
+    """
+    Get information about Google Cloud IAM Custom Roles from a project.
+    Note that you must have the `roles/iam.roleViewer`.
+    See [the official documentation](https://cloud.google.com/iam/docs/creating-custom-roles)
+    and [API](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list).
+
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    example = gcp.projects.get_iam_custom_roles(project="your-project-id",
+        show_deleted=True,
+        view="FULL")
+    ```
+
+
+    :param str project: The project were the custom role has been created in. Defaults to the provider project configuration.
+    :param bool show_deleted: Include Roles that have been deleted. Defaults to `false`.
+    :param str view: When `"FULL"` is specified, the `permissions` field is returned, which includes a list of all permissions in the role. The default value is `"BASIC"`, which does not return the `permissions`.
+    """
+    __args__ = dict()
+    __args__['project'] = project
+    __args__['showDeleted'] = show_deleted
+    __args__['view'] = view
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('gcp:projects/getIamCustomRoles:getIamCustomRoles', __args__, opts=opts, typ=GetIamCustomRolesResult).value
+
+    return AwaitableGetIamCustomRolesResult(
+        id=pulumi.get(__ret__, 'id'),
+        project=pulumi.get(__ret__, 'project'),
+        roles=pulumi.get(__ret__, 'roles'),
+        show_deleted=pulumi.get(__ret__, 'show_deleted'),
+        view=pulumi.get(__ret__, 'view'))
+def get_iam_custom_roles_output(project: Optional[pulumi.Input[Optional[str]]] = None,
+                                show_deleted: Optional[pulumi.Input[Optional[bool]]] = None,
+                                view: Optional[pulumi.Input[Optional[str]]] = None,
+                                opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetIamCustomRolesResult]:
+    """
+    Get information about Google Cloud IAM Custom Roles from a project.
+    Note that you must have the `roles/iam.roleViewer`.
+    See [the official documentation](https://cloud.google.com/iam/docs/creating-custom-roles)
+    and [API](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list).
+
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    example = gcp.projects.get_iam_custom_roles(project="your-project-id",
+        show_deleted=True,
+        view="FULL")
+    ```
+
+
+    :param str project: The project were the custom role has been created in. Defaults to the provider project configuration.
+    :param bool show_deleted: Include Roles that have been deleted. Defaults to `false`.
+    :param str view: When `"FULL"` is specified, the `permissions` field is returned, which includes a list of all permissions in the role. The default value is `"BASIC"`, which does not return the `permissions`.
+    """
+    __args__ = dict()
+    __args__['project'] = project
+    __args__['showDeleted'] = show_deleted
+    __args__['view'] = view
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('gcp:projects/getIamCustomRoles:getIamCustomRoles', __args__, opts=opts, typ=GetIamCustomRolesResult)
+    return __ret__.apply(lambda __response__: GetIamCustomRolesResult(
+        id=pulumi.get(__response__, 'id'),
+        project=pulumi.get(__response__, 'project'),
+        roles=pulumi.get(__response__, 'roles'),
+        show_deleted=pulumi.get(__response__, 'show_deleted'),
+        view=pulumi.get(__response__, 'view')))

pulumi_gcp/projects/outputs.py

@@ -33,6 +33,7 @@ __all__ = [
     'OrganizationPolicyListPolicyDeny',
     'OrganizationPolicyRestorePolicy',
     'GetAncestryAncestorResult',
+    'GetIamCustomRolesRoleResult',
     'GetOrganizationPolicyBooleanPolicyResult',
     'GetOrganizationPolicyListPolicyResult',
     'GetOrganizationPolicyListPolicyAllowResult',
@@ -786,6 +787,101 @@ class GetAncestryAncestorResult(dict):
         return pulumi.get(self, "type")
 
 
+@pulumi.output_type
+class GetIamCustomRolesRoleResult(dict):
+    def __init__(__self__, *,
+                 deleted: bool,
+                 description: str,
+                 id: str,
+                 name: str,
+                 permissions: Sequence[str],
+                 role_id: str,
+                 stage: str,
+                 title: str):
+        """
+        :param bool deleted: The current deleted state of the role.
+        :param str description: A human-readable description for the role.
+        :param str id: an identifier for the resource with the format `projects/{{project}}/roles/{{role_id}}`.
+        :param str name: The name of the role in the format `projects/{{project}}/roles/{{role_id}}`. Like `id`, this field can be used as a reference in other resources such as IAM role bindings.
+        :param Sequence[str] permissions: The names of the permissions this role grants when bound in an IAM policy.
+        :param str role_id: The camel case role id used for this role.
+        :param str stage: The current launch stage of the role. List of possible stages is [here](https://cloud.google.com/iam/reference/rest/v1/organizations.roles#Role.RoleLaunchStage).
+        :param str title: A human-readable title for the role.
+        """
+        pulumi.set(__self__, "deleted", deleted)
+        pulumi.set(__self__, "description", description)
+        pulumi.set(__self__, "id", id)
+        pulumi.set(__self__, "name", name)
+        pulumi.set(__self__, "permissions", permissions)
+        pulumi.set(__self__, "role_id", role_id)
+        pulumi.set(__self__, "stage", stage)
+        pulumi.set(__self__, "title", title)
+
+    @property
+    @pulumi.getter
+    def deleted(self) -> bool:
+        """
+        The current deleted state of the role.
+        """
+        return pulumi.get(self, "deleted")
+
+    @property
+    @pulumi.getter
+    def description(self) -> str:
+        """
+        A human-readable description for the role.
+        """
+        return pulumi.get(self, "description")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        an identifier for the resource with the format `projects/{{project}}/roles/{{role_id}}`.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        The name of the role in the format `projects/{{project}}/roles/{{role_id}}`. Like `id`, this field can be used as a reference in other resources such as IAM role bindings.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def permissions(self) -> Sequence[str]:
+        """
+        The names of the permissions this role grants when bound in an IAM policy.
+        """
+        return pulumi.get(self, "permissions")
+
+    @property
+    @pulumi.getter(name="roleId")
+    def role_id(self) -> str:
+        """
+        The camel case role id used for this role.
+        """
+        return pulumi.get(self, "role_id")
+
+    @property
+    @pulumi.getter
+    def stage(self) -> str:
+        """
+        The current launch stage of the role. List of possible stages is [here](https://cloud.google.com/iam/reference/rest/v1/organizations.roles#Role.RoleLaunchStage).
+        """
+        return pulumi.get(self, "stage")
+
+    @property
+    @pulumi.getter
+    def title(self) -> str:
+        """
+        A human-readable title for the role.
+        """
+        return pulumi.get(self, "title")
+
+
 @pulumi.output_type
 class GetOrganizationPolicyBooleanPolicyResult(dict):
     def __init__(__self__, *,