1. Packages
  2. Vantage
  3. API Docs
  4. Team
Vantage v0.0.3 published on Wednesday, Jan 31, 2024 by lbrlabs

vantage.Team

Explore with Pulumi AI

vantage logo
Vantage v0.0.3 published on Wednesday, Jan 31, 2024 by lbrlabs

    Manages a Team.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vantage = Lbrlabs.PulumiPackage.Vantage;
    
    return await Deployment.RunAsync(() => 
    {
        var demoTeam = new Vantage.Team("demoTeam", new()
        {
            Description = "Demo Team Description",
            Name = "Demo Team",
            UserEmails = new[]
            {
                "support@vantage.sh",
            },
            WorkspaceTokens = new[]
            {
                "wrkspc_47c3254c790e9351",
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-vantage/sdk/go/vantage"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vantage.NewTeam(ctx, "demoTeam", &vantage.TeamArgs{
    			Description: pulumi.String("Demo Team Description"),
    			Name:        pulumi.String("Demo Team"),
    			UserEmails: pulumi.StringArray{
    				pulumi.String("support@vantage.sh"),
    			},
    			WorkspaceTokens: pulumi.StringArray{
    				pulumi.String("wrkspc_47c3254c790e9351"),
    			},
    		})
    		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.vantage.Team;
    import com.pulumi.vantage.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 demoTeam = new Team("demoTeam", TeamArgs.builder()        
                .description("Demo Team Description")
                .name("Demo Team")
                .userEmails("support@vantage.sh")
                .workspaceTokens("wrkspc_47c3254c790e9351")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_vantage as vantage
    
    demo_team = vantage.Team("demoTeam",
        description="Demo Team Description",
        name="Demo Team",
        user_emails=["support@vantage.sh"],
        workspace_tokens=["wrkspc_47c3254c790e9351"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as vantage from "@lbrlabs/pulumi-vantage";
    
    const demoTeam = new vantage.Team("demoTeam", {
        description: "Demo Team Description",
        name: "Demo Team",
        userEmails: ["support@vantage.sh"],
        workspaceTokens: ["wrkspc_47c3254c790e9351"],
    });
    
    resources:
      demoTeam:
        type: vantage:Team
        properties:
          description: Demo Team Description
          name: Demo Team
          userEmails:
            - support@vantage.sh
          workspaceTokens:
            - wrkspc_47c3254c790e9351
    

    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,
             name: Optional[str] = None,
             description: Optional[str] = None,
             user_emails: Optional[Sequence[str]] = None,
             user_tokens: Optional[Sequence[str]] = None,
             workspace_tokens: Optional[Sequence[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: vantage: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 Vantage.Team("teamResource", new()
    {
        Name = "string",
        Description = "string",
        UserEmails = new[]
        {
            "string",
        },
        UserTokens = new[]
        {
            "string",
        },
        WorkspaceTokens = new[]
        {
            "string",
        },
    });
    
    example, err := vantage.NewTeam(ctx, "teamResource", &vantage.TeamArgs{
    	Name:        pulumi.String("string"),
    	Description: pulumi.String("string"),
    	UserEmails: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	UserTokens: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	WorkspaceTokens: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var teamResource = new Team("teamResource", TeamArgs.builder()
        .name("string")
        .description("string")
        .userEmails("string")
        .userTokens("string")
        .workspaceTokens("string")
        .build());
    
    team_resource = vantage.Team("teamResource",
        name="string",
        description="string",
        user_emails=["string"],
        user_tokens=["string"],
        workspace_tokens=["string"])
    
    const teamResource = new vantage.Team("teamResource", {
        name: "string",
        description: "string",
        userEmails: ["string"],
        userTokens: ["string"],
        workspaceTokens: ["string"],
    });
    
    type: vantage:Team
    properties:
        description: string
        name: string
        userEmails:
            - string
        userTokens:
            - string
        workspaceTokens:
            - 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Team resource accepts the following input properties:

    Name string
    Name of the team.
    Description string
    Description of the team.
    UserEmails List<string>
    User emails.
    UserTokens List<string>
    User tokens.
    WorkspaceTokens List<string>
    Workspace tokens to add the team to.
    Name string
    Name of the team.
    Description string
    Description of the team.
    UserEmails []string
    User emails.
    UserTokens []string
    User tokens.
    WorkspaceTokens []string
    Workspace tokens to add the team to.
    name String
    Name of the team.
    description String
    Description of the team.
    userEmails List<String>
    User emails.
    userTokens List<String>
    User tokens.
    workspaceTokens List<String>
    Workspace tokens to add the team to.
    name string
    Name of the team.
    description string
    Description of the team.
    userEmails string[]
    User emails.
    userTokens string[]
    User tokens.
    workspaceTokens string[]
    Workspace tokens to add the team to.
    name str
    Name of the team.
    description str
    Description of the team.
    user_emails Sequence[str]
    User emails.
    user_tokens Sequence[str]
    User tokens.
    workspace_tokens Sequence[str]
    Workspace tokens to add the team to.
    name String
    Name of the team.
    description String
    Description of the team.
    userEmails List<String>
    User emails.
    userTokens List<String>
    User tokens.
    workspaceTokens List<String>
    Workspace tokens to add the team to.

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

    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,
            description: Optional[str] = None,
            name: Optional[str] = None,
            token: Optional[str] = None,
            user_emails: Optional[Sequence[str]] = None,
            user_tokens: Optional[Sequence[str]] = None,
            workspace_tokens: Optional[Sequence[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:
    Description string
    Description of the team.
    Name string
    Name of the team.
    Token string
    Unique team identifier.
    UserEmails List<string>
    User emails.
    UserTokens List<string>
    User tokens.
    WorkspaceTokens List<string>
    Workspace tokens to add the team to.
    Description string
    Description of the team.
    Name string
    Name of the team.
    Token string
    Unique team identifier.
    UserEmails []string
    User emails.
    UserTokens []string
    User tokens.
    WorkspaceTokens []string
    Workspace tokens to add the team to.
    description String
    Description of the team.
    name String
    Name of the team.
    token String
    Unique team identifier.
    userEmails List<String>
    User emails.
    userTokens List<String>
    User tokens.
    workspaceTokens List<String>
    Workspace tokens to add the team to.
    description string
    Description of the team.
    name string
    Name of the team.
    token string
    Unique team identifier.
    userEmails string[]
    User emails.
    userTokens string[]
    User tokens.
    workspaceTokens string[]
    Workspace tokens to add the team to.
    description str
    Description of the team.
    name str
    Name of the team.
    token str
    Unique team identifier.
    user_emails Sequence[str]
    User emails.
    user_tokens Sequence[str]
    User tokens.
    workspace_tokens Sequence[str]
    Workspace tokens to add the team to.
    description String
    Description of the team.
    name String
    Name of the team.
    token String
    Unique team identifier.
    userEmails List<String>
    User emails.
    userTokens List<String>
    User tokens.
    workspaceTokens List<String>
    Workspace tokens to add the team to.

    Package Details

    Repository
    vantage lbrlabs/pulumi-vantage
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    vantage logo
    Vantage v0.0.3 published on Wednesday, Jan 31, 2024 by lbrlabs