pulumi-github-kotlin/com.pulumi.github.kotlin/Team

Team

class Team : KotlinCustomResource

Provides a GitHub team resource. This resource allows you to add/remove teams from your organization. When applied, a new team will be created. When destroyed, that team 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.Team;
import com.pulumi.github.TeamArgs;
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 someTeam = new Team("someTeam", TeamArgs.builder()
            .description("Some cool team")
            .privacy("closed")
            .build());
    }
}

Import

GitHub Teams can be imported using the GitHub team ID or name e.g.

$ pulumi import github:index/team:Team core 1234567

$ pulumi import github:index/team:Team core Administrators

Properties

createDefaultMaintainer

val createDefaultMaintainer: Output<Boolean>?

Adds a default maintainer to the team. Defaults to false and adds the creating user to the team when true.

description

val description: Output<String>?

A description of the team.

etag

val etag: Output<String>

val id: Output<String>

ldapDn

val ldapDn: Output<String>?

The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise Server.

membersCount

val membersCount: Output<Int>

name

val name: Output<String>

The name of the team.

nodeId

val nodeId: Output<String>

The Node ID of the created team.

parentTeamId

val parentTeamId: Output<String>?

The ID or slug of the parent team, if this is a nested team.

parentTeamReadId

val parentTeamReadId: Output<String>

The id of the parent team read in Github.

parentTeamReadSlug

val parentTeamReadSlug: Output<String>

The id of the parent team read in Github.

privacy

val privacy: Output<String>?

The level of privacy for the team. Must be one of secret or closed. Defaults to secret.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

slug

val slug: Output<String>

The slug of the created team, which may or may not differ from name, depending on whether name contains "URL-unsafe" characters. Useful when referencing the team in github.BranchProtection.

urn

val urn: Output<String>