Docs Packages
  1. Packages
  2. Buildkite
  3. API Docs
  4. Team
  5. Team
Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse
pulumiverse/pulumi-buildkite

buildkite.Team.Team

Explore with Pulumi AI

buildkite logo
Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse
pulumiverse/pulumi-buildkite

    A Team is a group of users that can be given permissions for using Pipelines.This feature is only available to Business and Enterprise customers. You can find out more about Teams in the Buildkite documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as buildkite from "@pulumiverse/buildkite";

const everyone = new buildkite.team.Team("everyone", {
    defaultMemberRole: "MEMBER",
    defaultTeam: false,
    privacy: "VISIBLE",
});

    import pulumi
import pulumiverse_buildkite as buildkite

everyone = buildkite.team.Team("everyone",
    default_member_role="MEMBER",
    default_team=False,
    privacy="VISIBLE")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-buildkite/sdk/v3/go/buildkite/Team"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Team.NewTeam(ctx, "everyone", &Team.TeamArgs{
			DefaultMemberRole: pulumi.String("MEMBER"),
			DefaultTeam:       pulumi.Bool(false),
			Privacy:           pulumi.String("VISIBLE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Buildkite = Pulumiverse.Buildkite;

return await Deployment.RunAsync(() => 
{
    var everyone = new Buildkite.Team.Team("everyone", new()
    {
        DefaultMemberRole = "MEMBER",
        DefaultTeam = false,
        Privacy = "VISIBLE",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.buildkite.Team.Team;
import com.pulumi.buildkite.Team.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 everyone = new Team("everyone", TeamArgs.builder()        
            .defaultMemberRole("MEMBER")
            .defaultTeam(false)
            .privacy("VISIBLE")
            .build());

    }
}

    resources:
  everyone:
    type: buildkite:Team:Team
    properties:
      defaultMemberRole: MEMBER
      defaultTeam: false
      privacy: VISIBLE

    Create Team Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Team(name: string, args: TeamArgs, opts?: CustomResourceOptions);
    @overload
def Team(resource_name: str,
         args: TeamArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Team(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         default_member_role: Optional[str] = None,
         default_team: Optional[bool] = None,
         privacy: Optional[str] = None,
         description: Optional[str] = None,
         members_can_create_pipelines: Optional[bool] = None,
         name: Optional[str] = None)
    func NewTeam(ctx *Context, name string, args TeamArgs, opts ...ResourceOption) (*Team, error)
    public Team(string name, TeamArgs args, CustomResourceOptions? opts = null)
    public Team(String name, TeamArgs args)
public Team(String name, TeamArgs args, CustomResourceOptions options)

    type: buildkite:Team:Team
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TeamArgs
    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 TeamArgs
    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 TeamArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TeamArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TeamArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var buildkiteTeamResource = new Buildkite.Team.Team("buildkiteTeamResource", new()
{
    DefaultMemberRole = "string",
    DefaultTeam = false,
    Privacy = "string",
    Description = "string",
    MembersCanCreatePipelines = false,
    Name = "string",
});

    example, err := Team.NewTeam(ctx, "buildkiteTeamResource", &Team.TeamArgs{
	DefaultMemberRole:         pulumi.String("string"),
	DefaultTeam:               pulumi.Bool(false),
	Privacy:                   pulumi.String("string"),
	Description:               pulumi.String("string"),
	MembersCanCreatePipelines: pulumi.Bool(false),
	Name:                      pulumi.String("string"),
})

    var buildkiteTeamResource = new Team("buildkiteTeamResource", TeamArgs.builder()        
    .defaultMemberRole("string")
    .defaultTeam(false)
    .privacy("string")
    .description("string")
    .membersCanCreatePipelines(false)
    .name("string")
    .build());

    buildkite_team_resource = buildkite.team.Team("buildkiteTeamResource",
    default_member_role="string",
    default_team=False,
    privacy="string",
    description="string",
    members_can_create_pipelines=False,
    name="string")

    const buildkiteTeamResource = new buildkite.team.Team("buildkiteTeamResource", {
    defaultMemberRole: "string",
    defaultTeam: false,
    privacy: "string",
    description: "string",
    membersCanCreatePipelines: false,
    name: "string",
});

    type: buildkite:Team:Team
properties:
    defaultMemberRole: string
    defaultTeam: false
    description: string
    membersCanCreatePipelines: false
    name: string
    privacy: string

    Team Resource Properties

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

    Inputs

    The Team resource accepts the following input properties:

    DefaultMemberRole string
    The default role for new members of the team. This can be either MEMBER or MAINTAINER.
    DefaultTeam bool
    Whether this is the default team for the organization.
    Privacy string
    The privacy setting for the team. This can be either VISIBLE or SECRET.
    Description string
    A description for the team. This is displayed in the Buildkite UI.
    MembersCanCreatePipelines bool
    Whether members of the team can create Pipelines.
    Name string
    The name of the team.
    DefaultMemberRole string
    The default role for new members of the team. This can be either MEMBER or MAINTAINER.
    DefaultTeam bool
    Whether this is the default team for the organization.
    Privacy string
    The privacy setting for the team. This can be either VISIBLE or SECRET.
    Description string
    A description for the team. This is displayed in the Buildkite UI.
    MembersCanCreatePipelines bool
    Whether members of the team can create Pipelines.
    Name string
    The name of the team.
    defaultMemberRole String
    The default role for new members of the team. This can be either MEMBER or MAINTAINER.
    defaultTeam Boolean
    Whether this is the default team for the organization.
    privacy String
    The privacy setting for the team. This can be either VISIBLE or SECRET.
    description String
    A description for the team. This is displayed in the Buildkite UI.
    membersCanCreatePipelines Boolean
    Whether members of the team can create Pipelines.
    name String
    The name of the team.
    defaultMemberRole string
    The default role for new members of the team. This can be either MEMBER or MAINTAINER.
    defaultTeam boolean
    Whether this is the default team for the organization.
    privacy string
    The privacy setting for the team. This can be either VISIBLE or SECRET.
    description string
    A description for the team. This is displayed in the Buildkite UI.
    membersCanCreatePipelines boolean
    Whether members of the team can create Pipelines.
    name string
    The name of the team.
    default_member_role str
    The default role for new members of the team. This can be either MEMBER or MAINTAINER.
    default_team bool
    Whether this is the default team for the organization.
    privacy str
    The privacy setting for the team. This can be either VISIBLE or SECRET.
    description str
    A description for the team. This is displayed in the Buildkite UI.
    members_can_create_pipelines bool
    Whether members of the team can create Pipelines.
    name str
    The name of the team.
    defaultMemberRole String
    The default role for new members of the team. This can be either MEMBER or MAINTAINER.
    defaultTeam Boolean
    Whether this is the default team for the organization.
    privacy String
    The privacy setting for the team. This can be either VISIBLE or SECRET.
    description String
    A description for the team. This is displayed in the Buildkite UI.
    membersCanCreatePipelines Boolean
    Whether members of the team can create Pipelines.
    name String
    The name of the team.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Slug string
    The generated slug for the team.
    Uuid string
    The UUID of the team.
    Id string
    The provider-assigned unique ID for this managed resource.
    Slug string
    The generated slug for the team.
    Uuid string
    The UUID of the team.
    id String
    The provider-assigned unique ID for this managed resource.
    slug String
    The generated slug for the team.
    uuid String
    The UUID of the team.
    id string
    The provider-assigned unique ID for this managed resource.
    slug string
    The generated slug for the team.
    uuid string
    The UUID of the team.
    id str
    The provider-assigned unique ID for this managed resource.
    slug str
    The generated slug for the team.
    uuid str
    The UUID of the team.
    id String
    The provider-assigned unique ID for this managed resource.
    slug String
    The generated slug for the team.
    uuid String
    The UUID of the team.

    Look up Existing Team Resource

    Get an existing Team 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?: TeamState, opts?: CustomResourceOptions): Team
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default_member_role: Optional[str] = None,
        default_team: Optional[bool] = None,
        description: Optional[str] = None,
        members_can_create_pipelines: Optional[bool] = None,
        name: Optional[str] = None,
        privacy: Optional[str] = None,
        slug: Optional[str] = None,
        uuid: Optional[str] = None) -> Team
    func GetTeam(ctx *Context, name string, id IDInput, state *TeamState, opts ...ResourceOption) (*Team, error)
    public static Team Get(string name, Input<string> id, TeamState? state, CustomResourceOptions? opts = null)
    public static Team get(String name, Output<String> id, TeamState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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:
    DefaultMemberRole string
    The default role for new members of the team. This can be either MEMBER or MAINTAINER.
    DefaultTeam bool
    Whether this is the default team for the organization.
    Description string
    A description for the team. This is displayed in the Buildkite UI.
    MembersCanCreatePipelines bool
    Whether members of the team can create Pipelines.
    Name string
    The name of the team.
    Privacy string
    The privacy setting for the team. This can be either VISIBLE or SECRET.
    Slug string
    The generated slug for the team.
    Uuid string
    The UUID of the team.
    DefaultMemberRole string
    The default role for new members of the team. This can be either MEMBER or MAINTAINER.
    DefaultTeam bool
    Whether this is the default team for the organization.
    Description string
    A description for the team. This is displayed in the Buildkite UI.
    MembersCanCreatePipelines bool
    Whether members of the team can create Pipelines.
    Name string
    The name of the team.
    Privacy string
    The privacy setting for the team. This can be either VISIBLE or SECRET.
    Slug string
    The generated slug for the team.
    Uuid string
    The UUID of the team.
    defaultMemberRole String
    The default role for new members of the team. This can be either MEMBER or MAINTAINER.
    defaultTeam Boolean
    Whether this is the default team for the organization.
    description String
    A description for the team. This is displayed in the Buildkite UI.
    membersCanCreatePipelines Boolean
    Whether members of the team can create Pipelines.
    name String
    The name of the team.
    privacy String
    The privacy setting for the team. This can be either VISIBLE or SECRET.
    slug String
    The generated slug for the team.
    uuid String
    The UUID of the team.
    defaultMemberRole string
    The default role for new members of the team. This can be either MEMBER or MAINTAINER.
    defaultTeam boolean
    Whether this is the default team for the organization.
    description string
    A description for the team. This is displayed in the Buildkite UI.
    membersCanCreatePipelines boolean
    Whether members of the team can create Pipelines.
    name string
    The name of the team.
    privacy string
    The privacy setting for the team. This can be either VISIBLE or SECRET.
    slug string
    The generated slug for the team.
    uuid string
    The UUID of the team.
    default_member_role str
    The default role for new members of the team. This can be either MEMBER or MAINTAINER.
    default_team bool
    Whether this is the default team for the organization.
    description str
    A description for the team. This is displayed in the Buildkite UI.
    members_can_create_pipelines bool
    Whether members of the team can create Pipelines.
    name str
    The name of the team.
    privacy str
    The privacy setting for the team. This can be either VISIBLE or SECRET.
    slug str
    The generated slug for the team.
    uuid str
    The UUID of the team.
    defaultMemberRole String
    The default role for new members of the team. This can be either MEMBER or MAINTAINER.
    defaultTeam Boolean
    Whether this is the default team for the organization.
    description String
    A description for the team. This is displayed in the Buildkite UI.
    membersCanCreatePipelines Boolean
    Whether members of the team can create Pipelines.
    name String
    The name of the team.
    privacy String
    The privacy setting for the team. This can be either VISIBLE or SECRET.
    slug String
    The generated slug for the team.
    uuid String
    The UUID of the team.

    Import

    import a team resource using the GraphQL ID

    you can use this query to find the ID:

    query getTeamId {

    organization(slug: “ORGANIZATION_SLUG”) {

    teams(first: 1, search: "TEAM_SEARCH_TERM") {

  edges {

    node {

      id

      name

    }

  }

}

    }

    }

    $ pulumi import buildkite:Team/team:Team everyone UGlwZWxpbmUtLS00MzVjYWQ1OC1lODFkLTQ1YWYtODYzNy1iMWNmODA3MDIzOGQ=

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    buildkite pulumiverse/pulumi-buildkite
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the buildkite Terraform Provider.
    buildkite logo
    Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse
    pulumiverse/pulumi-buildkite