Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. TeamRole
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

konnect.TeamRole

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

TeamRole Resource

Example Usage

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

const myTeamrole = new konnect.TeamRole("myTeamrole", {
    entityId: "e67490ce-44dc-4cbd-b65e-b52c746fc26a",
    entityRegion: "eu",
    entityTypeName: "Control Planes",
    roleName: "Viewer",
    teamId: "e81bc3e5-e9db-4764-b7dd-e81e39072cbe",
});
Copy
import pulumi
import pulumi_konnect as konnect

my_teamrole = konnect.TeamRole("myTeamrole",
    entity_id="e67490ce-44dc-4cbd-b65e-b52c746fc26a",
    entity_region="eu",
    entity_type_name="Control Planes",
    role_name="Viewer",
    team_id="e81bc3e5-e9db-4764-b7dd-e81e39072cbe")
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.NewTeamRole(ctx, "myTeamrole", &konnect.TeamRoleArgs{
			EntityId:       pulumi.String("e67490ce-44dc-4cbd-b65e-b52c746fc26a"),
			EntityRegion:   pulumi.String("eu"),
			EntityTypeName: pulumi.String("Control Planes"),
			RoleName:       pulumi.String("Viewer"),
			TeamId:         pulumi.String("e81bc3e5-e9db-4764-b7dd-e81e39072cbe"),
		})
		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 myTeamrole = new Konnect.TeamRole("myTeamrole", new()
    {
        EntityId = "e67490ce-44dc-4cbd-b65e-b52c746fc26a",
        EntityRegion = "eu",
        EntityTypeName = "Control Planes",
        RoleName = "Viewer",
        TeamId = "e81bc3e5-e9db-4764-b7dd-e81e39072cbe",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.TeamRole;
import com.pulumi.konnect.TeamRoleArgs;
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 myTeamrole = new TeamRole("myTeamrole", TeamRoleArgs.builder()
            .entityId("e67490ce-44dc-4cbd-b65e-b52c746fc26a")
            .entityRegion("eu")
            .entityTypeName("Control Planes")
            .roleName("Viewer")
            .teamId("e81bc3e5-e9db-4764-b7dd-e81e39072cbe")
            .build());

    }
}
Copy
resources:
  myTeamrole:
    type: konnect:TeamRole
    properties:
      entityId: e67490ce-44dc-4cbd-b65e-b52c746fc26a
      entityRegion: eu
      entityTypeName: Control Planes
      roleName: Viewer
      teamId: e81bc3e5-e9db-4764-b7dd-e81e39072cbe
Copy

Create TeamRole Resource

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

Constructor syntax

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

@overload
def TeamRole(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             team_id: Optional[str] = None,
             entity_id: Optional[str] = None,
             entity_region: Optional[str] = None,
             entity_type_name: Optional[str] = None,
             role_name: Optional[str] = None)
func NewTeamRole(ctx *Context, name string, args TeamRoleArgs, opts ...ResourceOption) (*TeamRole, error)
public TeamRole(string name, TeamRoleArgs args, CustomResourceOptions? opts = null)
public TeamRole(String name, TeamRoleArgs args)
public TeamRole(String name, TeamRoleArgs args, CustomResourceOptions options)

type: konnect:TeamRole
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 This property is required. TeamRoleArgs
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 This property is required. TeamRoleArgs
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 This property is required. TeamRoleArgs
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 This property is required. TeamRoleArgs
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. TeamRoleArgs
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 teamRoleResource = new Konnect.TeamRole("teamRoleResource", new()
{
    TeamId = "string",
    EntityId = "string",
    EntityRegion = "string",
    EntityTypeName = "string",
    RoleName = "string",
});
Copy
example, err := konnect.NewTeamRole(ctx, "teamRoleResource", &konnect.TeamRoleArgs{
TeamId: pulumi.String("string"),
EntityId: pulumi.String("string"),
EntityRegion: pulumi.String("string"),
EntityTypeName: pulumi.String("string"),
RoleName: pulumi.String("string"),
})
Copy
var teamRoleResource = new TeamRole("teamRoleResource", TeamRoleArgs.builder()
    .teamId("string")
    .entityId("string")
    .entityRegion("string")
    .entityTypeName("string")
    .roleName("string")
    .build());
Copy
team_role_resource = konnect.TeamRole("teamRoleResource",
    team_id="string",
    entity_id="string",
    entity_region="string",
    entity_type_name="string",
    role_name="string")
Copy
const teamRoleResource = new konnect.TeamRole("teamRoleResource", {
    teamId: "string",
    entityId: "string",
    entityRegion: "string",
    entityTypeName: "string",
    roleName: "string",
});
Copy
type: konnect:TeamRole
properties:
    entityId: string
    entityRegion: string
    entityTypeName: string
    roleName: string
    teamId: string
Copy

TeamRole 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 TeamRole resource accepts the following input properties:

TeamId This property is required. string
The team ID. Requires replacement if changed.
EntityId string
The ID of the entity. Requires replacement if changed.
EntityRegion string
Region of the team. must be one of ["us", "eu", "au", "me", "in", "*"]; Requires replacement if changed.
EntityTypeName string
The type of entity. must be one of ["APIs", "API Products", "Application Auth Strategies", "Audit Logs", "Control Planes", "DCR Providers", "Identity", "Mesh Control Planes", "Networks", "Portals", "Service Hub"]; Requires replacement if changed.
RoleName string
The desired role. must be one of ["Admin", "Appearance Maintainer", "Application Registration", "Certificate Admin", "Cloud Gateway Cluster Admin", "Cloud Gateway Cluster Viewer", "Consumer Admin", "Connector", "Creator", "Deployer", "Discovery Admin", "Discovery Viewer", "Gateway Service Admin", "Integration Admin", "Integration Viewer", "Key Admin", "Maintainer", "Network Admin", "Network Creator", "Network Viewer", "Plugin Admin", "Plugins Admin", "Product Publisher", "Publisher", "Route Admin", "SNI Admin", "Service Admin", "Service Creator", "Service Viewer", "Upstream Admin", "Vault Admin", "Viewer"]; Requires replacement if changed.
TeamId This property is required. string
The team ID. Requires replacement if changed.
EntityId string
The ID of the entity. Requires replacement if changed.
EntityRegion string
Region of the team. must be one of ["us", "eu", "au", "me", "in", "*"]; Requires replacement if changed.
EntityTypeName string
The type of entity. must be one of ["APIs", "API Products", "Application Auth Strategies", "Audit Logs", "Control Planes", "DCR Providers", "Identity", "Mesh Control Planes", "Networks", "Portals", "Service Hub"]; Requires replacement if changed.
RoleName string
The desired role. must be one of ["Admin", "Appearance Maintainer", "Application Registration", "Certificate Admin", "Cloud Gateway Cluster Admin", "Cloud Gateway Cluster Viewer", "Consumer Admin", "Connector", "Creator", "Deployer", "Discovery Admin", "Discovery Viewer", "Gateway Service Admin", "Integration Admin", "Integration Viewer", "Key Admin", "Maintainer", "Network Admin", "Network Creator", "Network Viewer", "Plugin Admin", "Plugins Admin", "Product Publisher", "Publisher", "Route Admin", "SNI Admin", "Service Admin", "Service Creator", "Service Viewer", "Upstream Admin", "Vault Admin", "Viewer"]; Requires replacement if changed.
teamId This property is required. String
The team ID. Requires replacement if changed.
entityId String
The ID of the entity. Requires replacement if changed.
entityRegion String
Region of the team. must be one of ["us", "eu", "au", "me", "in", "*"]; Requires replacement if changed.
entityTypeName String
The type of entity. must be one of ["APIs", "API Products", "Application Auth Strategies", "Audit Logs", "Control Planes", "DCR Providers", "Identity", "Mesh Control Planes", "Networks", "Portals", "Service Hub"]; Requires replacement if changed.
roleName String
The desired role. must be one of ["Admin", "Appearance Maintainer", "Application Registration", "Certificate Admin", "Cloud Gateway Cluster Admin", "Cloud Gateway Cluster Viewer", "Consumer Admin", "Connector", "Creator", "Deployer", "Discovery Admin", "Discovery Viewer", "Gateway Service Admin", "Integration Admin", "Integration Viewer", "Key Admin", "Maintainer", "Network Admin", "Network Creator", "Network Viewer", "Plugin Admin", "Plugins Admin", "Product Publisher", "Publisher", "Route Admin", "SNI Admin", "Service Admin", "Service Creator", "Service Viewer", "Upstream Admin", "Vault Admin", "Viewer"]; Requires replacement if changed.
teamId This property is required. string
The team ID. Requires replacement if changed.
entityId string
The ID of the entity. Requires replacement if changed.
entityRegion string
Region of the team. must be one of ["us", "eu", "au", "me", "in", "*"]; Requires replacement if changed.
entityTypeName string
The type of entity. must be one of ["APIs", "API Products", "Application Auth Strategies", "Audit Logs", "Control Planes", "DCR Providers", "Identity", "Mesh Control Planes", "Networks", "Portals", "Service Hub"]; Requires replacement if changed.
roleName string
The desired role. must be one of ["Admin", "Appearance Maintainer", "Application Registration", "Certificate Admin", "Cloud Gateway Cluster Admin", "Cloud Gateway Cluster Viewer", "Consumer Admin", "Connector", "Creator", "Deployer", "Discovery Admin", "Discovery Viewer", "Gateway Service Admin", "Integration Admin", "Integration Viewer", "Key Admin", "Maintainer", "Network Admin", "Network Creator", "Network Viewer", "Plugin Admin", "Plugins Admin", "Product Publisher", "Publisher", "Route Admin", "SNI Admin", "Service Admin", "Service Creator", "Service Viewer", "Upstream Admin", "Vault Admin", "Viewer"]; Requires replacement if changed.
team_id This property is required. str
The team ID. Requires replacement if changed.
entity_id str
The ID of the entity. Requires replacement if changed.
entity_region str
Region of the team. must be one of ["us", "eu", "au", "me", "in", "*"]; Requires replacement if changed.
entity_type_name str
The type of entity. must be one of ["APIs", "API Products", "Application Auth Strategies", "Audit Logs", "Control Planes", "DCR Providers", "Identity", "Mesh Control Planes", "Networks", "Portals", "Service Hub"]; Requires replacement if changed.
role_name str
The desired role. must be one of ["Admin", "Appearance Maintainer", "Application Registration", "Certificate Admin", "Cloud Gateway Cluster Admin", "Cloud Gateway Cluster Viewer", "Consumer Admin", "Connector", "Creator", "Deployer", "Discovery Admin", "Discovery Viewer", "Gateway Service Admin", "Integration Admin", "Integration Viewer", "Key Admin", "Maintainer", "Network Admin", "Network Creator", "Network Viewer", "Plugin Admin", "Plugins Admin", "Product Publisher", "Publisher", "Route Admin", "SNI Admin", "Service Admin", "Service Creator", "Service Viewer", "Upstream Admin", "Vault Admin", "Viewer"]; Requires replacement if changed.
teamId This property is required. String
The team ID. Requires replacement if changed.
entityId String
The ID of the entity. Requires replacement if changed.
entityRegion String
Region of the team. must be one of ["us", "eu", "au", "me", "in", "*"]; Requires replacement if changed.
entityTypeName String
The type of entity. must be one of ["APIs", "API Products", "Application Auth Strategies", "Audit Logs", "Control Planes", "DCR Providers", "Identity", "Mesh Control Planes", "Networks", "Portals", "Service Hub"]; Requires replacement if changed.
roleName String
The desired role. must be one of ["Admin", "Appearance Maintainer", "Application Registration", "Certificate Admin", "Cloud Gateway Cluster Admin", "Cloud Gateway Cluster Viewer", "Consumer Admin", "Connector", "Creator", "Deployer", "Discovery Admin", "Discovery Viewer", "Gateway Service Admin", "Integration Admin", "Integration Viewer", "Key Admin", "Maintainer", "Network Admin", "Network Creator", "Network Viewer", "Plugin Admin", "Plugins Admin", "Product Publisher", "Publisher", "Route Admin", "SNI Admin", "Service Admin", "Service Creator", "Service Viewer", "Upstream Admin", "Vault Admin", "Viewer"]; Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the TeamRole 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.

Look up Existing TeamRole Resource

Get an existing TeamRole 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?: TeamRoleState, opts?: CustomResourceOptions): TeamRole
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        entity_id: Optional[str] = None,
        entity_region: Optional[str] = None,
        entity_type_name: Optional[str] = None,
        role_name: Optional[str] = None,
        team_id: Optional[str] = None) -> TeamRole
func GetTeamRole(ctx *Context, name string, id IDInput, state *TeamRoleState, opts ...ResourceOption) (*TeamRole, error)
public static TeamRole Get(string name, Input<string> id, TeamRoleState? state, CustomResourceOptions? opts = null)
public static TeamRole get(String name, Output<String> id, TeamRoleState state, CustomResourceOptions options)
resources:  _:    type: konnect:TeamRole    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:
EntityId string
The ID of the entity. Requires replacement if changed.
EntityRegion string
Region of the team. must be one of ["us", "eu", "au", "me", "in", "*"]; Requires replacement if changed.
EntityTypeName string
The type of entity. must be one of ["APIs", "API Products", "Application Auth Strategies", "Audit Logs", "Control Planes", "DCR Providers", "Identity", "Mesh Control Planes", "Networks", "Portals", "Service Hub"]; Requires replacement if changed.
RoleName string
The desired role. must be one of ["Admin", "Appearance Maintainer", "Application Registration", "Certificate Admin", "Cloud Gateway Cluster Admin", "Cloud Gateway Cluster Viewer", "Consumer Admin", "Connector", "Creator", "Deployer", "Discovery Admin", "Discovery Viewer", "Gateway Service Admin", "Integration Admin", "Integration Viewer", "Key Admin", "Maintainer", "Network Admin", "Network Creator", "Network Viewer", "Plugin Admin", "Plugins Admin", "Product Publisher", "Publisher", "Route Admin", "SNI Admin", "Service Admin", "Service Creator", "Service Viewer", "Upstream Admin", "Vault Admin", "Viewer"]; Requires replacement if changed.
TeamId string
The team ID. Requires replacement if changed.
EntityId string
The ID of the entity. Requires replacement if changed.
EntityRegion string
Region of the team. must be one of ["us", "eu", "au", "me", "in", "*"]; Requires replacement if changed.
EntityTypeName string
The type of entity. must be one of ["APIs", "API Products", "Application Auth Strategies", "Audit Logs", "Control Planes", "DCR Providers", "Identity", "Mesh Control Planes", "Networks", "Portals", "Service Hub"]; Requires replacement if changed.
RoleName string
The desired role. must be one of ["Admin", "Appearance Maintainer", "Application Registration", "Certificate Admin", "Cloud Gateway Cluster Admin", "Cloud Gateway Cluster Viewer", "Consumer Admin", "Connector", "Creator", "Deployer", "Discovery Admin", "Discovery Viewer", "Gateway Service Admin", "Integration Admin", "Integration Viewer", "Key Admin", "Maintainer", "Network Admin", "Network Creator", "Network Viewer", "Plugin Admin", "Plugins Admin", "Product Publisher", "Publisher", "Route Admin", "SNI Admin", "Service Admin", "Service Creator", "Service Viewer", "Upstream Admin", "Vault Admin", "Viewer"]; Requires replacement if changed.
TeamId string
The team ID. Requires replacement if changed.
entityId String
The ID of the entity. Requires replacement if changed.
entityRegion String
Region of the team. must be one of ["us", "eu", "au", "me", "in", "*"]; Requires replacement if changed.
entityTypeName String
The type of entity. must be one of ["APIs", "API Products", "Application Auth Strategies", "Audit Logs", "Control Planes", "DCR Providers", "Identity", "Mesh Control Planes", "Networks", "Portals", "Service Hub"]; Requires replacement if changed.
roleName String
The desired role. must be one of ["Admin", "Appearance Maintainer", "Application Registration", "Certificate Admin", "Cloud Gateway Cluster Admin", "Cloud Gateway Cluster Viewer", "Consumer Admin", "Connector", "Creator", "Deployer", "Discovery Admin", "Discovery Viewer", "Gateway Service Admin", "Integration Admin", "Integration Viewer", "Key Admin", "Maintainer", "Network Admin", "Network Creator", "Network Viewer", "Plugin Admin", "Plugins Admin", "Product Publisher", "Publisher", "Route Admin", "SNI Admin", "Service Admin", "Service Creator", "Service Viewer", "Upstream Admin", "Vault Admin", "Viewer"]; Requires replacement if changed.
teamId String
The team ID. Requires replacement if changed.
entityId string
The ID of the entity. Requires replacement if changed.
entityRegion string
Region of the team. must be one of ["us", "eu", "au", "me", "in", "*"]; Requires replacement if changed.
entityTypeName string
The type of entity. must be one of ["APIs", "API Products", "Application Auth Strategies", "Audit Logs", "Control Planes", "DCR Providers", "Identity", "Mesh Control Planes", "Networks", "Portals", "Service Hub"]; Requires replacement if changed.
roleName string
The desired role. must be one of ["Admin", "Appearance Maintainer", "Application Registration", "Certificate Admin", "Cloud Gateway Cluster Admin", "Cloud Gateway Cluster Viewer", "Consumer Admin", "Connector", "Creator", "Deployer", "Discovery Admin", "Discovery Viewer", "Gateway Service Admin", "Integration Admin", "Integration Viewer", "Key Admin", "Maintainer", "Network Admin", "Network Creator", "Network Viewer", "Plugin Admin", "Plugins Admin", "Product Publisher", "Publisher", "Route Admin", "SNI Admin", "Service Admin", "Service Creator", "Service Viewer", "Upstream Admin", "Vault Admin", "Viewer"]; Requires replacement if changed.
teamId string
The team ID. Requires replacement if changed.
entity_id str
The ID of the entity. Requires replacement if changed.
entity_region str
Region of the team. must be one of ["us", "eu", "au", "me", "in", "*"]; Requires replacement if changed.
entity_type_name str
The type of entity. must be one of ["APIs", "API Products", "Application Auth Strategies", "Audit Logs", "Control Planes", "DCR Providers", "Identity", "Mesh Control Planes", "Networks", "Portals", "Service Hub"]; Requires replacement if changed.
role_name str
The desired role. must be one of ["Admin", "Appearance Maintainer", "Application Registration", "Certificate Admin", "Cloud Gateway Cluster Admin", "Cloud Gateway Cluster Viewer", "Consumer Admin", "Connector", "Creator", "Deployer", "Discovery Admin", "Discovery Viewer", "Gateway Service Admin", "Integration Admin", "Integration Viewer", "Key Admin", "Maintainer", "Network Admin", "Network Creator", "Network Viewer", "Plugin Admin", "Plugins Admin", "Product Publisher", "Publisher", "Route Admin", "SNI Admin", "Service Admin", "Service Creator", "Service Viewer", "Upstream Admin", "Vault Admin", "Viewer"]; Requires replacement if changed.
team_id str
The team ID. Requires replacement if changed.
entityId String
The ID of the entity. Requires replacement if changed.
entityRegion String
Region of the team. must be one of ["us", "eu", "au", "me", "in", "*"]; Requires replacement if changed.
entityTypeName String
The type of entity. must be one of ["APIs", "API Products", "Application Auth Strategies", "Audit Logs", "Control Planes", "DCR Providers", "Identity", "Mesh Control Planes", "Networks", "Portals", "Service Hub"]; Requires replacement if changed.
roleName String
The desired role. must be one of ["Admin", "Appearance Maintainer", "Application Registration", "Certificate Admin", "Cloud Gateway Cluster Admin", "Cloud Gateway Cluster Viewer", "Consumer Admin", "Connector", "Creator", "Deployer", "Discovery Admin", "Discovery Viewer", "Gateway Service Admin", "Integration Admin", "Integration Viewer", "Key Admin", "Maintainer", "Network Admin", "Network Creator", "Network Viewer", "Plugin Admin", "Plugins Admin", "Product Publisher", "Publisher", "Route Admin", "SNI Admin", "Service Admin", "Service Creator", "Service Viewer", "Upstream Admin", "Vault Admin", "Viewer"]; Requires replacement if changed.
teamId String
The team ID. Requires replacement if changed.

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect