1. Packages
  2. Konnect Provider
  3. API Docs
  4. Team
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.Team

Explore with Pulumi AI

Team Resource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as konnect from "@pulumi/konnect";

const myTeam = new konnect.Team("myTeam", {
    description: "The Identity Management (IDM) team.",
    labels: {
        key: "value",
    },
});
Copy
import pulumi
import pulumi_konnect as konnect

my_team = konnect.Team("myTeam",
    description="The Identity Management (IDM) team.",
    labels={
        "key": "value",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v2/konnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := konnect.NewTeam(ctx, "myTeam", &konnect.TeamArgs{
			Description: pulumi.String("The Identity Management (IDM) team."),
			Labels: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var myTeam = new Konnect.Team("myTeam", new()
    {
        Description = "The Identity Management (IDM) team.",
        Labels = 
        {
            { "key", "value" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.Team;
import com.pulumi.konnect.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 myTeam = new Team("myTeam", TeamArgs.builder()
            .description("The Identity Management (IDM) team.")
            .labels(Map.of("key", "value"))
            .build());

    }
}
Copy
resources:
  myTeam:
    type: konnect:Team
    properties:
      description: The Identity Management (IDM) team.
      labels:
        key: value
Copy

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: Optional[TeamArgs] = None,
         opts: Optional[ResourceOptions] = None)

@overload
def Team(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         description: Optional[str] = None,
         labels: Optional[Mapping[str, str]] = None,
         name: Optional[str] = None)
func NewTeam(ctx *Context, name string, args *TeamArgs, opts ...ResourceOption) (*Team, error)
public Team(string name, TeamArgs? args = null, CustomResourceOptions? opts = null)
public Team(String name, TeamArgs args)
public Team(String name, TeamArgs args, CustomResourceOptions options)
type: konnect:Team
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. 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 Konnect.Team("teamResource", new()
{
    Description = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
});
Copy
example, err := konnect.NewTeam(ctx, "teamResource", &konnect.TeamArgs{
Description: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
})
Copy
var teamResource = new Team("teamResource", TeamArgs.builder()
    .description("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .build());
Copy
team_resource = konnect.Team("teamResource",
    description="string",
    labels={
        "string": "string",
    },
    name="string")
Copy
const teamResource = new konnect.Team("teamResource", {
    description: "string",
    labels: {
        string: "string",
    },
    name: "string",
});
Copy
type: konnect:Team
properties:
    description: string
    labels:
        string: string
    name: string
Copy

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:

Description string
The description of the new team.
Labels Dictionary<string, string>
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Name string
A name for the team being created.
Description string
The description of the new team.
Labels map[string]string
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Name string
A name for the team being created.
description String
The description of the new team.
labels Map<String,String>
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name String
A name for the team being created.
description string
The description of the new team.
labels {[key: string]: string}
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name string
A name for the team being created.
description str
The description of the new team.
labels Mapping[str, str]
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name str
A name for the team being created.
description String
The description of the new team.
labels Map<String>
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name String
A name for the team being created.

Outputs

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

CreatedAt string
A Unix timestamp representation of team creation.
Id string
The provider-assigned unique ID for this managed resource.
SystemTeam bool
Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"
UpdatedAt string
A Unix timestamp representation of the most recent change to the team object in Konnect.
CreatedAt string
A Unix timestamp representation of team creation.
Id string
The provider-assigned unique ID for this managed resource.
SystemTeam bool
Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"
UpdatedAt string
A Unix timestamp representation of the most recent change to the team object in Konnect.
createdAt String
A Unix timestamp representation of team creation.
id String
The provider-assigned unique ID for this managed resource.
systemTeam Boolean
Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"
updatedAt String
A Unix timestamp representation of the most recent change to the team object in Konnect.
createdAt string
A Unix timestamp representation of team creation.
id string
The provider-assigned unique ID for this managed resource.
systemTeam boolean
Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"
updatedAt string
A Unix timestamp representation of the most recent change to the team object in Konnect.
created_at str
A Unix timestamp representation of team creation.
id str
The provider-assigned unique ID for this managed resource.
system_team bool
Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"
updated_at str
A Unix timestamp representation of the most recent change to the team object in Konnect.
createdAt String
A Unix timestamp representation of team creation.
id String
The provider-assigned unique ID for this managed resource.
systemTeam Boolean
Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"
updatedAt String
A Unix timestamp representation of the most recent change to the team object in Konnect.

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,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        system_team: Optional[bool] = None,
        updated_at: 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)
resources:  _:    type: konnect:Team    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CreatedAt string
A Unix timestamp representation of team creation.
Description string
The description of the new team.
Labels Dictionary<string, string>
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Name string
A name for the team being created.
SystemTeam bool
Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"
UpdatedAt string
A Unix timestamp representation of the most recent change to the team object in Konnect.
CreatedAt string
A Unix timestamp representation of team creation.
Description string
The description of the new team.
Labels map[string]string
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Name string
A name for the team being created.
SystemTeam bool
Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"
UpdatedAt string
A Unix timestamp representation of the most recent change to the team object in Konnect.
createdAt String
A Unix timestamp representation of team creation.
description String
The description of the new team.
labels Map<String,String>
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name String
A name for the team being created.
systemTeam Boolean
Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"
updatedAt String
A Unix timestamp representation of the most recent change to the team object in Konnect.
createdAt string
A Unix timestamp representation of team creation.
description string
The description of the new team.
labels {[key: string]: string}
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name string
A name for the team being created.
systemTeam boolean
Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"
updatedAt string
A Unix timestamp representation of the most recent change to the team object in Konnect.
created_at str
A Unix timestamp representation of team creation.
description str
The description of the new team.
labels Mapping[str, str]
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name str
A name for the team being created.
system_team bool
Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"
updated_at str
A Unix timestamp representation of the most recent change to the team object in Konnect.
createdAt String
A Unix timestamp representation of team creation.
description String
The description of the new team.
labels Map<String>
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name String
A name for the team being created.
systemTeam Boolean
Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"
updatedAt String
A Unix timestamp representation of the most recent change to the team object in Konnect.

Import

$ pulumi import konnect:index/team:Team my_konnect_team "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"
Copy

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

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.