Membership Args
data class MembershipArgs(val downgradeOnDestroy: Output<Boolean>? = null, val role: Output<String>? = null, val username: Output<String>? = null) : ConvertibleToJava<MembershipArgs>
Provides a GitHub membership resource. This resource allows you to add/remove users from your organization. When applied, an invitation will be sent to the user to become part of the organization. When destroyed, either the invitation will be cancelled or the user will be removed.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
// Add a user to the organization
const membershipForSomeUser = new github.Membership("membership_for_some_user", {
username: "SomeUser",
role: "member",
});
Content copied to clipboard
import pulumi
import pulumi_github as github
# Add a user to the organization
membership_for_some_user = github.Membership("membership_for_some_user",
username="SomeUser",
role="member")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
// Add a user to the organization
var membershipForSomeUser = new Github.Membership("membership_for_some_user", new()
{
Username = "SomeUser",
Role = "member",
});
});
Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-github/sdk/v6/go/github"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Add a user to the organization
_, err := github.NewMembership(ctx, "membership_for_some_user", &github.MembershipArgs{
Username: pulumi.String("SomeUser"),
Role: pulumi.String("member"),
})
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.Membership;
import com.pulumi.github.MembershipArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// Add a user to the organization
var membershipForSomeUser = new Membership("membershipForSomeUser", MembershipArgs.builder()
.username("SomeUser")
.role("member")
.build());
}
}
Content copied to clipboard
resources:
# Add a user to the organization
membershipForSomeUser:
type: github:Membership
name: membership_for_some_user
properties:
username: SomeUser
role: member
Content copied to clipboard
Import
GitHub Membership can be imported using an ID made up of organization:username
, e.g.
$ pulumi import github:index/membership:Membership member hashicorp:someuser
Content copied to clipboard