Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. iam
  5. iam/v1
  6. getRole

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.iam/v1.getRole

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets the definition of a Role.

    Using getRole

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRole(args: GetRoleArgs, opts?: InvokeOptions): Promise<GetRoleResult>
function getRoleOutput(args: GetRoleOutputArgs, opts?: InvokeOptions): Output<GetRoleResult>
    def get_role(project: Optional[str] = None,
             role_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetRoleResult
def get_role_output(project: Optional[pulumi.Input[str]] = None,
             role_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetRoleResult]
    func LookupRole(ctx *Context, args *LookupRoleArgs, opts ...InvokeOption) (*LookupRoleResult, error)
func LookupRoleOutput(ctx *Context, args *LookupRoleOutputArgs, opts ...InvokeOption) LookupRoleResultOutput

    > Note: This function is named LookupRole in the Go SDK.

    public static class GetRole 
{
    public static Task<GetRoleResult> InvokeAsync(GetRoleArgs args, InvokeOptions? opts = null)
    public static Output<GetRoleResult> Invoke(GetRoleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRoleResult> getRole(GetRoleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:iam/v1:getRole
  arguments:
    # arguments dictionary

    The following arguments are supported:

    RoleId string
    Project string
    RoleId string
    Project string
    roleId String
    project String
    roleId string
    project string
    roleId String
    project String

    getRole Result

    The following output properties are available:

    Deleted bool
    The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
    Description string
    Optional. A human-readable description for the role.
    Etag string
    Used to perform a consistent read-modify-write.
    IncludedPermissions List<string>
    The names of the permissions this role grants when bound in an IAM policy.
    Name string
    The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path. For example, roles/logging.viewer for predefined roles, organizations/{ORGANIZATION_ID}/roles/my-role for organization-level custom roles, and projects/{PROJECT_ID}/roles/my-role for project-level custom roles.
    Stage string
    The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
    Title string
    Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
    Deleted bool
    The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
    Description string
    Optional. A human-readable description for the role.
    Etag string
    Used to perform a consistent read-modify-write.
    IncludedPermissions []string
    The names of the permissions this role grants when bound in an IAM policy.
    Name string
    The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path. For example, roles/logging.viewer for predefined roles, organizations/{ORGANIZATION_ID}/roles/my-role for organization-level custom roles, and projects/{PROJECT_ID}/roles/my-role for project-level custom roles.
    Stage string
    The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
    Title string
    Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
    deleted Boolean
    The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
    description String
    Optional. A human-readable description for the role.
    etag String
    Used to perform a consistent read-modify-write.
    includedPermissions List<String>
    The names of the permissions this role grants when bound in an IAM policy.
    name String
    The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path. For example, roles/logging.viewer for predefined roles, organizations/{ORGANIZATION_ID}/roles/my-role for organization-level custom roles, and projects/{PROJECT_ID}/roles/my-role for project-level custom roles.
    stage String
    The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
    title String
    Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
    deleted boolean
    The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
    description string
    Optional. A human-readable description for the role.
    etag string
    Used to perform a consistent read-modify-write.
    includedPermissions string[]
    The names of the permissions this role grants when bound in an IAM policy.
    name string
    The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path. For example, roles/logging.viewer for predefined roles, organizations/{ORGANIZATION_ID}/roles/my-role for organization-level custom roles, and projects/{PROJECT_ID}/roles/my-role for project-level custom roles.
    stage string
    The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
    title string
    Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
    deleted bool
    The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
    description str
    Optional. A human-readable description for the role.
    etag str
    Used to perform a consistent read-modify-write.
    included_permissions Sequence[str]
    The names of the permissions this role grants when bound in an IAM policy.
    name str
    The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path. For example, roles/logging.viewer for predefined roles, organizations/{ORGANIZATION_ID}/roles/my-role for organization-level custom roles, and projects/{PROJECT_ID}/roles/my-role for project-level custom roles.
    stage str
    The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
    title str
    Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
    deleted Boolean
    The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
    description String
    Optional. A human-readable description for the role.
    etag String
    Used to perform a consistent read-modify-write.
    includedPermissions List<String>
    The names of the permissions this role grants when bound in an IAM policy.
    name String
    The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path. For example, roles/logging.viewer for predefined roles, organizations/{ORGANIZATION_ID}/roles/my-role for organization-level custom roles, and projects/{PROJECT_ID}/roles/my-role for project-level custom roles.
    stage String
    The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
    title String
    Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native