Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Pulumi Cloud (Pulumi Service provider)
  3. API Docs
  4. Team
Pulumi Cloud v0.26.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-pulumiservice

pulumiservice.Team

Explore with Pulumi AI

pulumiservice logo
Pulumi Cloud v0.26.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-pulumiservice

    The Pulumi Cloud offers role-based access control (RBAC) using teams. Teams allow organization admins to assign a set of stack permissions to a group of users.

    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,
         organization_name: Optional[str] = None,
         team_type: Optional[str] = None,
         description: Optional[str] = None,
         display_name: Optional[str] = None,
         github_team_id: Optional[float] = None,
         members: Optional[Sequence[str]] = 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: pulumiservice: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.

    Constructor example

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

    var teamResource = new PulumiService.Team("teamResource", new()
{
    OrganizationName = "string",
    TeamType = "string",
    Description = "string",
    DisplayName = "string",
    GithubTeamId = 0,
    Members = new[]
    {
        "string",
    },
    Name = "string",
});

    example, err := pulumiservice.NewTeam(ctx, "teamResource", &pulumiservice.TeamArgs{
	OrganizationName: pulumi.String("string"),
	TeamType:         pulumi.String("string"),
	Description:      pulumi.String("string"),
	DisplayName:      pulumi.String("string"),
	GithubTeamId:     pulumi.Float64(0),
	Members: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var teamResource = new Team("teamResource", TeamArgs.builder()
    .organizationName("string")
    .teamType("string")
    .description("string")
    .displayName("string")
    .githubTeamId(0)
    .members("string")
    .name("string")
    .build());

    team_resource = pulumiservice.Team("teamResource",
    organization_name="string",
    team_type="string",
    description="string",
    display_name="string",
    github_team_id=0,
    members=["string"],
    name="string")

    const teamResource = new pulumiservice.Team("teamResource", {
    organizationName: "string",
    teamType: "string",
    description: "string",
    displayName: "string",
    githubTeamId: 0,
    members: ["string"],
    name: "string",
});

    type: pulumiservice:Team
properties:
    description: string
    displayName: string
    githubTeamId: 0
    members:
        - string
    name: string
    organizationName: string
    teamType: 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:

    OrganizationName string
    The name of the Pulumi organization the team belongs to.
    TeamType string
    The type of team. Must be either pulumi or github.
    Description string
    Optional. Team description.
    DisplayName string
    Optional. Team display name.
    GithubTeamId double
    The GitHub ID of the team to mirror. Must be in the same GitHub organization that the Pulumi org is backed by. Required for "github" teams.
    Members List<string>
    List of team members.
    Name string
    The team's name. Required for "pulumi" teams.
    OrganizationName string
    The name of the Pulumi organization the team belongs to.
    TeamType string
    The type of team. Must be either pulumi or github.
    Description string
    Optional. Team description.
    DisplayName string
    Optional. Team display name.
    GithubTeamId float64
    The GitHub ID of the team to mirror. Must be in the same GitHub organization that the Pulumi org is backed by. Required for "github" teams.
    Members []string
    List of team members.
    Name string
    The team's name. Required for "pulumi" teams.
    organizationName String
    The name of the Pulumi organization the team belongs to.
    teamType String
    The type of team. Must be either pulumi or github.
    description String
    Optional. Team description.
    displayName String
    Optional. Team display name.
    githubTeamId Double
    The GitHub ID of the team to mirror. Must be in the same GitHub organization that the Pulumi org is backed by. Required for "github" teams.
    members List<String>
    List of team members.
    name String
    The team's name. Required for "pulumi" teams.
    organizationName string
    The name of the Pulumi organization the team belongs to.
    teamType string
    The type of team. Must be either pulumi or github.
    description string
    Optional. Team description.
    displayName string
    Optional. Team display name.
    githubTeamId number
    The GitHub ID of the team to mirror. Must be in the same GitHub organization that the Pulumi org is backed by. Required for "github" teams.
    members string[]
    List of team members.
    name string
    The team's name. Required for "pulumi" teams.
    organization_name str
    The name of the Pulumi organization the team belongs to.
    team_type str
    The type of team. Must be either pulumi or github.
    description str
    Optional. Team description.
    display_name str
    Optional. Team display name.
    github_team_id float
    The GitHub ID of the team to mirror. Must be in the same GitHub organization that the Pulumi org is backed by. Required for "github" teams.
    members Sequence[str]
    List of team members.
    name str
    The team's name. Required for "pulumi" teams.
    organizationName String
    The name of the Pulumi organization the team belongs to.
    teamType String
    The type of team. Must be either pulumi or github.
    description String
    Optional. Team description.
    displayName String
    Optional. Team display name.
    githubTeamId Number
    The GitHub ID of the team to mirror. Must be in the same GitHub organization that the Pulumi org is backed by. Required for "github" teams.
    members List<String>
    List of team members.
    name String
    The team's name. Required for "pulumi" teams.

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo
    Pulumi Cloud v0.26.1 published on Wednesday, Sep 25, 2024 by Pulumi
    pulumi/pulumi-pulumiservice