TeamArgs

data class TeamArgs(val createDefaultMaintainer: Output<Boolean>? = null, val description: Output<String>? = null, val ldapDn: Output<String>? = null, val name: Output<String>? = null, val parentTeamId: Output<String>? = null, val parentTeamReadId: Output<String>? = null, val parentTeamReadSlug: Output<String>? = null, val privacy: Output<String>? = null) : ConvertibleToJava<TeamArgs>

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

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
// Add a team to the organization
const someTeam = new github.Team("some_team", {
name: "some-team",
description: "Some cool team",
privacy: "closed",
});
import pulumi
import pulumi_github as github
# Add a team to the organization
some_team = github.Team("some_team",
name="some-team",
description="Some cool team",
privacy="closed")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
// Add a team to the organization
var someTeam = new Github.Team("some_team", new()
{
Name = "some-team",
Description = "Some cool team",
Privacy = "closed",
});
});
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 team to the organization
_, err := github.NewTeam(ctx, "some_team", &github.TeamArgs{
Name: pulumi.String("some-team"),
Description: pulumi.String("Some cool team"),
Privacy: pulumi.String("closed"),
})
if err != nil {
return err
}
return nil
})
}
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) {
// Add a team to the organization
var someTeam = new Team("someTeam", TeamArgs.builder()
.name("some-team")
.description("Some cool team")
.privacy("closed")
.build());
}
}
resources:
# Add a team to the organization
someTeam:
type: github:Team
name: some_team
properties:
name: some-team
description: Some cool team
privacy: closed

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

Constructors

Link copied to clipboard
constructor(createDefaultMaintainer: Output<Boolean>? = null, description: Output<String>? = null, ldapDn: Output<String>? = null, name: Output<String>? = null, parentTeamId: Output<String>? = null, parentTeamReadId: Output<String>? = null, parentTeamReadSlug: Output<String>? = null, privacy: Output<String>? = null)

Properties

Link copied to clipboard
val createDefaultMaintainer: Output<Boolean>? = null

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

Link copied to clipboard
val description: Output<String>? = null

A description of the team.

Link copied to clipboard
val ldapDn: Output<String>? = null

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

Link copied to clipboard
val name: Output<String>? = null

The name of the team.

Link copied to clipboard
val parentTeamId: Output<String>? = null

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

Link copied to clipboard
val parentTeamReadId: Output<String>? = null

The id of the parent team read in Github.

Link copied to clipboard
val parentTeamReadSlug: Output<String>? = null

The id of the parent team read in Github.

Link copied to clipboard
val privacy: Output<String>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): TeamArgs