gitlab.MemberRole

The gitlab.MemberRole resource allows to manage the lifecycle of a custom member role.

Custom roles allow an organization to create user roles with the precise privileges and permissions required for that organization’s needs.

This resource requires an Ultimate license.

Most custom roles are considered billable users that use a seat. Custom roles billing and seat usage

There can be only 10 custom roles on your instance or namespace. See issue 450929 for more details.

Upstream API: GitLab GraphQL API docs

Create MemberRole Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new MemberRole(name: string, args: MemberRoleArgs, opts?: CustomResourceOptions);

@overload
def MemberRole(resource_name: str,
               args: MemberRoleArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def MemberRole(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               base_access_level: Optional[str] = None,
               enabled_permissions: Optional[Sequence[str]] = None,
               description: Optional[str] = None,
               group_path: Optional[str] = None,
               name: Optional[str] = None)

func NewMemberRole(ctx *Context, name string, args MemberRoleArgs, opts ...ResourceOption) (*MemberRole, error)

public MemberRole(string name, MemberRoleArgs args, CustomResourceOptions? opts = null)

public MemberRole(String name, MemberRoleArgs args)
public MemberRole(String name, MemberRoleArgs args, CustomResourceOptions options)

type: gitlab:MemberRole
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

The following reference example uses placeholder values for all input properties.

var memberRoleResource = new GitLab.MemberRole("memberRoleResource", new()
{
    BaseAccessLevel = "string",
    EnabledPermissions = new[]
    {
        "string",
    },
    Description = "string",
    GroupPath = "string",
    Name = "string",
});

example, err := gitlab.NewMemberRole(ctx, "memberRoleResource", &gitlab.MemberRoleArgs{
	BaseAccessLevel: pulumi.String("string"),
	EnabledPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	GroupPath:   pulumi.String("string"),
	Name:        pulumi.String("string"),
})

var memberRoleResource = new MemberRole("memberRoleResource", MemberRoleArgs.builder()
    .baseAccessLevel("string")
    .enabledPermissions("string")
    .description("string")
    .groupPath("string")
    .name("string")
    .build());

member_role_resource = gitlab.MemberRole("memberRoleResource",
    base_access_level="string",
    enabled_permissions=["string"],
    description="string",
    group_path="string",
    name="string")

const memberRoleResource = new gitlab.MemberRole("memberRoleResource", {
    baseAccessLevel: "string",
    enabledPermissions: ["string"],
    description: "string",
    groupPath: "string",
    name: "string",
});

type: gitlab:MemberRole
properties:
    baseAccessLevel: string
    description: string
    enabledPermissions:
        - string
    groupPath: string
    name: string

MemberRole Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The MemberRole resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the MemberRole resource produces the following output properties:

Look up Existing MemberRole Resource

Get an existing MemberRole resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MemberRoleState, opts?: CustomResourceOptions): MemberRole

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        base_access_level: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        edit_path: Optional[str] = None,
        enabled_permissions: Optional[Sequence[str]] = None,
        group_path: Optional[str] = None,
        iid: Optional[int] = None,
        name: Optional[str] = None) -> MemberRole

func GetMemberRole(ctx *Context, name string, id IDInput, state *MemberRoleState, opts ...ResourceOption) (*MemberRole, error)

public static MemberRole Get(string name, Input<string> id, MemberRoleState? state, CustomResourceOptions? opts = null)

public static MemberRole get(String name, Output<String> id, MemberRoleState state, CustomResourceOptions options)

resources:  _:    type: gitlab:MemberRole    get:      id: ${id}

Import

Starting in Terraform v1.5.0 you can use an import block to import gitlab_member_role. For example:

terraform

import {

to = gitlab_member_role.example

id = “see CLI command below for ID”

}

Import using the CLI is supported using the following syntax:

GitLab member role can be imported using the id made up of gid://gitlab/MemberRole/<ID> e.g.

$ pulumi import gitlab:index/memberRole:MemberRole example 'gid://gitlab/MemberRole/123'

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository

GitLab pulumi/pulumi-gitlab

License

Apache-2.0

Notes

This Pulumi package is based on the gitlab Terraform Provider.