pulumi-github-kotlin/com.pulumi.github.kotlin/Membership

Membership

class Membership : KotlinCustomResource

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

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) {
        var membershipForSomeUser = new Membership("membershipForSomeUser", MembershipArgs.builder()
            .role("member")
            .username("SomeUser")
            .build());
    }
}

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

Properties

downgradeOnDestroy

val downgradeOnDestroy: Output<Boolean>?

Defaults to false. If set to true, when this resource is destroyed, the member will not be removed from the organization. Instead, the member's role will be downgraded to 'member'.

etag

val etag: Output<String>

val id: Output<String>

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

role

val role: Output<String>?

The role of the user within the organization. Must be one of member or admin. Defaults to member. admin role represents the owner role available via GitHub UI.

urn

val urn: Output<String>

username

val username: Output<String>

The user to add to the organization.