Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Konnect Provider
  4. API Docs
  5. GatewayWorkspace
Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong
Schema (JSON)
kong/terraform-provider-konnect

konnect.GatewayWorkspace

konnect
Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong
Schema (JSON)
kong/terraform-provider-konnect

    GatewayWorkspace Resource

    Example Usage

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

const myGatewayworkspace = new konnect.GatewayWorkspace("my_gatewayworkspace", {
    comment: "A test workspace for team 1",
    controlPlaneId: "cb4ca5b5-c0ad-4659-ac3b-9b4f1a9cb687",
    description: "A test workspace for team 1",
    managedBy: {
        key: "value",
    },
    name: "team-1",
});

    import pulumi
import pulumi_konnect as konnect

my_gatewayworkspace = konnect.GatewayWorkspace("my_gatewayworkspace",
    comment="A test workspace for team 1",
    control_plane_id="cb4ca5b5-c0ad-4659-ac3b-9b4f1a9cb687",
    description="A test workspace for team 1",
    managed_by={
        "key": "value",
    },
    name="team-1")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := konnect.NewGatewayWorkspace(ctx, "my_gatewayworkspace", &konnect.GatewayWorkspaceArgs{
			Comment:        pulumi.String("A test workspace for team 1"),
			ControlPlaneId: pulumi.String("cb4ca5b5-c0ad-4659-ac3b-9b4f1a9cb687"),
			Description:    pulumi.String("A test workspace for team 1"),
			ManagedBy: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			Name: pulumi.String("team-1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var myGatewayworkspace = new Konnect.GatewayWorkspace("my_gatewayworkspace", new()
    {
        Comment = "A test workspace for team 1",
        ControlPlaneId = "cb4ca5b5-c0ad-4659-ac3b-9b4f1a9cb687",
        Description = "A test workspace for team 1",
        ManagedBy = 
        {
            { "key", "value" },
        },
        Name = "team-1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayWorkspace;
import com.pulumi.konnect.GatewayWorkspaceArgs;
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 myGatewayworkspace = new GatewayWorkspace("myGatewayworkspace", GatewayWorkspaceArgs.builder()
            .comment("A test workspace for team 1")
            .controlPlaneId("cb4ca5b5-c0ad-4659-ac3b-9b4f1a9cb687")
            .description("A test workspace for team 1")
            .managedBy(Map.of("key", "value"))
            .name("team-1")
            .build());

    }
}

    resources:
  myGatewayworkspace:
    type: konnect:GatewayWorkspace
    name: my_gatewayworkspace
    properties:
      comment: A test workspace for team 1
      controlPlaneId: cb4ca5b5-c0ad-4659-ac3b-9b4f1a9cb687
      description: A test workspace for team 1
      managedBy:
        key: value
      name: team-1

    Example coming soon!

    Create GatewayWorkspace Resource

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

    Constructor syntax

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

@overload
def GatewayWorkspace(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     control_plane_id: Optional[str] = None,
                     comment: Optional[str] = None,
                     description: Optional[str] = None,
                     managed_by: Optional[Mapping[str, str]] = None,
                     name: Optional[str] = None)
    func NewGatewayWorkspace(ctx *Context, name string, args GatewayWorkspaceArgs, opts ...ResourceOption) (*GatewayWorkspace, error)
    public GatewayWorkspace(string name, GatewayWorkspaceArgs args, CustomResourceOptions? opts = null)
    public GatewayWorkspace(String name, GatewayWorkspaceArgs args)
public GatewayWorkspace(String name, GatewayWorkspaceArgs args, CustomResourceOptions options)

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


    resource "konnect_gateway_workspace" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args GatewayWorkspaceArgs
    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 GatewayWorkspaceArgs
    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 GatewayWorkspaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayWorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayWorkspaceArgs
    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 gatewayWorkspaceResource = new Konnect.GatewayWorkspace("gatewayWorkspaceResource", new()
{
    ControlPlaneId = "string",
    Comment = "string",
    Description = "string",
    ManagedBy = 
    {
        { "string", "string" },
    },
    Name = "string",
});

    example, err := konnect.NewGatewayWorkspace(ctx, "gatewayWorkspaceResource", &konnect.GatewayWorkspaceArgs{
	ControlPlaneId: pulumi.String("string"),
	Comment:        pulumi.String("string"),
	Description:    pulumi.String("string"),
	ManagedBy: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    resource "konnect_gateway_workspace" "gatewayWorkspaceResource" {
  lifecycle {
    create_before_destroy = true
  }
  control_plane_id = "string"
  comment          = "string"
  description      = "string"
  managed_by = {
    "string" = "string"
  }
  name = "string"
}

    var gatewayWorkspaceResource = new GatewayWorkspace("gatewayWorkspaceResource", GatewayWorkspaceArgs.builder()
    .controlPlaneId("string")
    .comment("string")
    .description("string")
    .managedBy(Map.of("string", "string"))
    .name("string")
    .build());

    gateway_workspace_resource = konnect.GatewayWorkspace("gatewayWorkspaceResource",
    control_plane_id="string",
    comment="string",
    description="string",
    managed_by={
        "string": "string",
    },
    name="string")

    const gatewayWorkspaceResource = new konnect.GatewayWorkspace("gatewayWorkspaceResource", {
    controlPlaneId: "string",
    comment: "string",
    description: "string",
    managedBy: {
        string: "string",
    },
    name: "string",
});

    type: konnect:GatewayWorkspace
properties:
    comment: string
    controlPlaneId: string
    description: string
    managedBy:
        string: string
    name: string

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

    ControlPlaneId string
    ID of a control plane. Requires replacement if changed.
    Comment string
    The description of the workspace.
    Description string
    The description of the workspace.
    ManagedBy Dictionary<string, string>
    Name string
    The name of the workspace. Requires replacement if changed.
    ControlPlaneId string
    ID of a control plane. Requires replacement if changed.
    Comment string
    The description of the workspace.
    Description string
    The description of the workspace.
    ManagedBy map[string]string
    Name string
    The name of the workspace. Requires replacement if changed.
    control_plane_id string
    ID of a control plane. Requires replacement if changed.
    comment string
    The description of the workspace.
    description string
    The description of the workspace.
    managed_by map(string)
    name string
    The name of the workspace. Requires replacement if changed.
    controlPlaneId String
    ID of a control plane. Requires replacement if changed.
    comment String
    The description of the workspace.
    description String
    The description of the workspace.
    managedBy Map<String,String>
    name String
    The name of the workspace. Requires replacement if changed.
    controlPlaneId string
    ID of a control plane. Requires replacement if changed.
    comment string
    The description of the workspace.
    description string
    The description of the workspace.
    managedBy {[key: string]: string}
    name string
    The name of the workspace. Requires replacement if changed.
    control_plane_id str
    ID of a control plane. Requires replacement if changed.
    comment str
    The description of the workspace.
    description str
    The description of the workspace.
    managed_by Mapping[str, str]
    name str
    The name of the workspace. Requires replacement if changed.
    controlPlaneId String
    ID of a control plane. Requires replacement if changed.
    comment String
    The description of the workspace.
    description String
    The description of the workspace.
    managedBy Map<String>
    name String
    The name of the workspace. Requires replacement if changed.

    Outputs

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

    CreatedAt double
    Unix epoch when the resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt double
    Unix epoch when the resource was last updated.
    CreatedAt float64
    Unix epoch when the resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt float64
    Unix epoch when the resource was last updated.
    created_at number
    Unix epoch when the resource was created.
    id string
    The provider-assigned unique ID for this managed resource.
    updated_at number
    Unix epoch when the resource was last updated.
    createdAt Double
    Unix epoch when the resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt Double
    Unix epoch when the resource was last updated.
    createdAt number
    Unix epoch when the resource was created.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt number
    Unix epoch when the resource was last updated.
    created_at float
    Unix epoch when the resource was created.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at float
    Unix epoch when the resource was last updated.
    createdAt Number
    Unix epoch when the resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt Number
    Unix epoch when the resource was last updated.

    Look up Existing GatewayWorkspace Resource

    Get an existing GatewayWorkspace 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?: GatewayWorkspaceState, opts?: CustomResourceOptions): GatewayWorkspace
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        description: Optional[str] = None,
        managed_by: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        updated_at: Optional[float] = None) -> GatewayWorkspace
    func GetGatewayWorkspace(ctx *Context, name string, id IDInput, state *GatewayWorkspaceState, opts ...ResourceOption) (*GatewayWorkspace, error)
    public static GatewayWorkspace Get(string name, Input<string> id, GatewayWorkspaceState? state, CustomResourceOptions? opts = null)
    public static GatewayWorkspace get(String name, Output<String> id, GatewayWorkspaceState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayWorkspace    get:      id: ${id}
    import {
  to = konnect_gateway_workspace.example
  id = "${id}"
}
    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:
    Comment string
    The description of the workspace.
    ControlPlaneId string
    ID of a control plane. Requires replacement if changed.
    CreatedAt double
    Unix epoch when the resource was created.
    Description string
    The description of the workspace.
    ManagedBy Dictionary<string, string>
    Name string
    The name of the workspace. Requires replacement if changed.
    UpdatedAt double
    Unix epoch when the resource was last updated.
    Comment string
    The description of the workspace.
    ControlPlaneId string
    ID of a control plane. Requires replacement if changed.
    CreatedAt float64
    Unix epoch when the resource was created.
    Description string
    The description of the workspace.
    ManagedBy map[string]string
    Name string
    The name of the workspace. Requires replacement if changed.
    UpdatedAt float64
    Unix epoch when the resource was last updated.
    comment string
    The description of the workspace.
    control_plane_id string
    ID of a control plane. Requires replacement if changed.
    created_at number
    Unix epoch when the resource was created.
    description string
    The description of the workspace.
    managed_by map(string)
    name string
    The name of the workspace. Requires replacement if changed.
    updated_at number
    Unix epoch when the resource was last updated.
    comment String
    The description of the workspace.
    controlPlaneId String
    ID of a control plane. Requires replacement if changed.
    createdAt Double
    Unix epoch when the resource was created.
    description String
    The description of the workspace.
    managedBy Map<String,String>
    name String
    The name of the workspace. Requires replacement if changed.
    updatedAt Double
    Unix epoch when the resource was last updated.
    comment string
    The description of the workspace.
    controlPlaneId string
    ID of a control plane. Requires replacement if changed.
    createdAt number
    Unix epoch when the resource was created.
    description string
    The description of the workspace.
    managedBy {[key: string]: string}
    name string
    The name of the workspace. Requires replacement if changed.
    updatedAt number
    Unix epoch when the resource was last updated.
    comment str
    The description of the workspace.
    control_plane_id str
    ID of a control plane. Requires replacement if changed.
    created_at float
    Unix epoch when the resource was created.
    description str
    The description of the workspace.
    managed_by Mapping[str, str]
    name str
    The name of the workspace. Requires replacement if changed.
    updated_at float
    Unix epoch when the resource was last updated.
    comment String
    The description of the workspace.
    controlPlaneId String
    ID of a control plane. Requires replacement if changed.
    createdAt Number
    Unix epoch when the resource was created.
    description String
    The description of the workspace.
    managedBy Map<String>
    name String
    The name of the workspace. Requires replacement if changed.
    updatedAt Number
    Unix epoch when the resource was last updated.

    Import

    In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

    terraform

    import {

    to = konnect_gateway_workspace.my_konnect_gateway_workspace

    id = jsonencode({

    control_plane_id = "..."

id               = "2747d1e5-8246-4f65-a939-b392f1ee17f8"

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import konnect:index/gatewayWorkspace:GatewayWorkspace my_konnect_gateway_workspace '{"control_plane_id": "...", "id": "2747d1e5-8246-4f65-a939-b392f1ee17f8"}'

    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.
    konnect
    Viewing docs for konnect 3.28.0
    published on Friday, Nov 6, 2026 by kong
    Schema (JSON)
    kong/terraform-provider-konnect

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial