GroupMembership

# gitlab_group_membership

This resource allows you to add a user to an existing group.

Example Usage

using Pulumi;
using GitLab = Pulumi.GitLab;

class MyStack : Stack
{
    public MyStack()
    {
        var test = new GitLab.GroupMembership("test", new GitLab.GroupMembershipArgs
        {
            AccessLevel = "guest",
            ExpiresAt = "2020-12-31",
            GroupId = "12345",
            UserId = 1337,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v4/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.NewGroupMembership(ctx, "test", &gitlab.GroupMembershipArgs{
			AccessLevel: pulumi.String("guest"),
			ExpiresAt:   pulumi.String("2020-12-31"),
			GroupId:     pulumi.String("12345"),
			UserId:      pulumi.Int(1337),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_gitlab as gitlab

test = gitlab.GroupMembership("test",
    access_level="guest",
    expires_at="2020-12-31",
    group_id="12345",
    user_id=1337)
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const test = new gitlab.GroupMembership("test", {
    accessLevel: "guest",
    expiresAt: "2020-12-31",
    groupId: "12345",
    userId: 1337,
});

Create a GroupMembership Resource

new GroupMembership(name: string, args: GroupMembershipArgs, opts?: CustomResourceOptions);
@overload
def GroupMembership(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    access_level: Optional[str] = None,
                    expires_at: Optional[str] = None,
                    group_id: Optional[str] = None,
                    user_id: Optional[int] = None)
@overload
def GroupMembership(resource_name: str,
                    args: GroupMembershipArgs,
                    opts: Optional[ResourceOptions] = None)
func NewGroupMembership(ctx *Context, name string, args GroupMembershipArgs, opts ...ResourceOption) (*GroupMembership, error)
public GroupMembership(string name, GroupMembershipArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args GroupMembershipArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args GroupMembershipArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args GroupMembershipArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GroupMembershipArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

GroupMembership Resource Properties

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

Inputs

The GroupMembership resource accepts the following input properties:

AccessLevel string
Acceptable values are: guest, reporter, developer, maintainer, owner.
GroupId string
The id of the group.
UserId int
The id of the user.
ExpiresAt string
Expiration date for the group membership. Format: YYYY-MM-DD
AccessLevel string
Acceptable values are: guest, reporter, developer, maintainer, owner.
GroupId string
The id of the group.
UserId int
The id of the user.
ExpiresAt string
Expiration date for the group membership. Format: YYYY-MM-DD
accessLevel string
Acceptable values are: guest, reporter, developer, maintainer, owner.
groupId string
The id of the group.
userId number
The id of the user.
expiresAt string
Expiration date for the group membership. Format: YYYY-MM-DD
access_level str
Acceptable values are: guest, reporter, developer, maintainer, owner.
group_id str
The id of the group.
user_id int
The id of the user.
expires_at str
Expiration date for the group membership. Format: YYYY-MM-DD

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing GroupMembership Resource

Get an existing GroupMembership 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?: GroupMembershipState, opts?: CustomResourceOptions): GroupMembership
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_level: Optional[str] = None,
        expires_at: Optional[str] = None,
        group_id: Optional[str] = None,
        user_id: Optional[int] = None) -> GroupMembership
func GetGroupMembership(ctx *Context, name string, id IDInput, state *GroupMembershipState, opts ...ResourceOption) (*GroupMembership, error)
public static GroupMembership Get(string name, Input<string> id, GroupMembershipState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AccessLevel string
Acceptable values are: guest, reporter, developer, maintainer, owner.
ExpiresAt string
Expiration date for the group membership. Format: YYYY-MM-DD
GroupId string
The id of the group.
UserId int
The id of the user.
AccessLevel string
Acceptable values are: guest, reporter, developer, maintainer, owner.
ExpiresAt string
Expiration date for the group membership. Format: YYYY-MM-DD
GroupId string
The id of the group.
UserId int
The id of the user.
accessLevel string
Acceptable values are: guest, reporter, developer, maintainer, owner.
expiresAt string
Expiration date for the group membership. Format: YYYY-MM-DD
groupId string
The id of the group.
userId number
The id of the user.
access_level str
Acceptable values are: guest, reporter, developer, maintainer, owner.
expires_at str
Expiration date for the group membership. Format: YYYY-MM-DD
group_id str
The id of the group.
user_id int
The id of the user.

Import

GitLab group membership can be imported using an id made up of group_id:user_id, e.g.

 $ pulumi import gitlab:index/groupMembership:GroupMembership test "12345:1337"

Package Details

Repository
https://github.com/pulumi/pulumi-gitlab
License
Apache-2.0
Notes
This Pulumi package is based on the gitlab Terraform Provider.