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

konnect.getGatewayWorkspace

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

    GatewayWorkspace DataSource

    Example Usage

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

const myGatewayworkspace = konnect.getGatewayWorkspace({
    controlPlaneId: "cb4ca5b5-c0ad-4659-ac3b-9b4f1a9cb687",
    filter: {
        name: {
            contains: "...my_contains...",
            eq: "...my_eq...",
        },
    },
});

    import pulumi
import pulumi_konnect as konnect

my_gatewayworkspace = konnect.get_gateway_workspace(control_plane_id="cb4ca5b5-c0ad-4659-ac3b-9b4f1a9cb687",
    filter={
        "name": {
            "contains": "...my_contains...",
            "eq": "...my_eq...",
        },
    })

    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.LookupGatewayWorkspace(ctx, &konnect.LookupGatewayWorkspaceArgs{
			ControlPlaneId: "cb4ca5b5-c0ad-4659-ac3b-9b4f1a9cb687",
			Filter: konnect.GetGatewayWorkspaceFilter{
				Name: konnect.GetGatewayWorkspaceFilterName{
					Contains: pulumi.StringRef("...my_contains..."),
					Eq:       pulumi.StringRef("...my_eq..."),
				},
			},
		}, nil)
		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 = Konnect.GetGatewayWorkspace.Invoke(new()
    {
        ControlPlaneId = "cb4ca5b5-c0ad-4659-ac3b-9b4f1a9cb687",
        Filter = new Konnect.Inputs.GetGatewayWorkspaceFilterInputArgs
        {
            Name = new Konnect.Inputs.GetGatewayWorkspaceFilterNameInputArgs
            {
                Contains = "...my_contains...",
                Eq = "...my_eq...",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.KonnectFunctions;
import com.pulumi.konnect.inputs.GetGatewayWorkspaceArgs;
import com.pulumi.konnect.inputs.GetGatewayWorkspaceFilterArgs;
import com.pulumi.konnect.inputs.GetGatewayWorkspaceFilterNameArgs;
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) {
        final var myGatewayworkspace = KonnectFunctions.getGatewayWorkspace(GetGatewayWorkspaceArgs.builder()
            .controlPlaneId("cb4ca5b5-c0ad-4659-ac3b-9b4f1a9cb687")
            .filter(GetGatewayWorkspaceFilterArgs.builder()
                .name(GetGatewayWorkspaceFilterNameArgs.builder()
                    .contains("...my_contains...")
                    .eq("...my_eq...")
                    .build())
                .build())
            .build());

    }
}

    variables:
  myGatewayworkspace:
    fn::invoke:
      function: konnect:getGatewayWorkspace
      arguments:
        controlPlaneId: cb4ca5b5-c0ad-4659-ac3b-9b4f1a9cb687
        filter:
          name:
            contains: '...my_contains...'
            eq: '...my_eq...'

    Example coming soon!

    Using getGatewayWorkspace

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGatewayWorkspace(args: GetGatewayWorkspaceArgs, opts?: InvokeOptions): Promise<GetGatewayWorkspaceResult>
function getGatewayWorkspaceOutput(args: GetGatewayWorkspaceOutputArgs, opts?: InvokeOutputOptions): Output<GetGatewayWorkspaceResult>
    def get_gateway_workspace(control_plane_id: Optional[str] = None,
                          filter: Optional[GetGatewayWorkspaceFilter] = None,
                          opts: Optional[InvokeOptions] = None) -> GetGatewayWorkspaceResult
def get_gateway_workspace_output(control_plane_id: pulumi.Input[Optional[str]] = None,
                          filter: pulumi.Input[Optional[GetGatewayWorkspaceFilterArgs]] = None,
                          opts: Optional[InvokeOutputOptions] = None) -> Output[GetGatewayWorkspaceResult]
    func LookupGatewayWorkspace(ctx *Context, args *LookupGatewayWorkspaceArgs, opts ...InvokeOption) (*LookupGatewayWorkspaceResult, error)
func LookupGatewayWorkspaceOutput(ctx *Context, args *LookupGatewayWorkspaceOutputArgs, opts ...InvokeOption) LookupGatewayWorkspaceResultOutput

    > Note: This function is named LookupGatewayWorkspace in the Go SDK.

    public static class GetGatewayWorkspace 
{
    public static Task<GetGatewayWorkspaceResult> InvokeAsync(GetGatewayWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayWorkspaceResult> Invoke(GetGatewayWorkspaceInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayWorkspaceResult> Invoke(GetGatewayWorkspaceInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetGatewayWorkspaceResult> getGatewayWorkspace(GetGatewayWorkspaceArgs args, InvokeOptions options)
public static Output<GetGatewayWorkspaceResult> getGatewayWorkspace(GetGatewayWorkspaceArgs args, InvokeOptions options)
public static Output<GetGatewayWorkspaceResult> getGatewayWorkspace(GetGatewayWorkspaceArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: konnect:index/getGatewayWorkspace:getGatewayWorkspace
  arguments:
    # arguments dictionary
    data "konnect_get_gateway_workspace" "name" {
    # arguments
}

    The following arguments are supported:

    ControlPlaneId string
    ID of a control plane
    Filter GetGatewayWorkspaceFilter
    Filters a collection of workspaces.
    ControlPlaneId string
    ID of a control plane
    Filter GetGatewayWorkspaceFilter
    Filters a collection of workspaces.
    control_plane_id string
    ID of a control plane
    filter object
    Filters a collection of workspaces.
    controlPlaneId String
    ID of a control plane
    filter GetGatewayWorkspaceFilter
    Filters a collection of workspaces.
    controlPlaneId string
    ID of a control plane
    filter GetGatewayWorkspaceFilter
    Filters a collection of workspaces.
    control_plane_id str
    ID of a control plane
    filter GetGatewayWorkspaceFilter
    Filters a collection of workspaces.
    controlPlaneId String
    ID of a control plane
    filter Property Map
    Filters a collection of workspaces.

    getGatewayWorkspace Result

    The following output properties are available:

    Comment string
    ControlPlaneId string
    ID of a control plane
    CreatedAt double
    Unix epoch when the resource was created.
    Description string
    Id string
    The unique UUID for this resource.
    ManagedBy Dictionary<string, string>
    Name string
    Next string
    Offset string
    UpdatedAt double
    Filter GetGatewayWorkspaceFilter
    Filters a collection of workspaces.
    Comment string
    ControlPlaneId string
    ID of a control plane
    CreatedAt float64
    Unix epoch when the resource was created.
    Description string
    Id string
    The unique UUID for this resource.
    ManagedBy map[string]string
    Name string
    Next string
    Offset string
    UpdatedAt float64
    Filter GetGatewayWorkspaceFilter
    Filters a collection of workspaces.
    comment string
    control_plane_id string
    ID of a control plane
    created_at number
    Unix epoch when the resource was created.
    description string
    id string
    The unique UUID for this resource.
    managed_by map(string)
    name string
    next string
    offset string
    updated_at number
    filter object
    Filters a collection of workspaces.
    comment String
    controlPlaneId String
    ID of a control plane
    createdAt Double
    Unix epoch when the resource was created.
    description String
    id String
    The unique UUID for this resource.
    managedBy Map<String,String>
    name String
    next String
    offset String
    updatedAt Double
    filter GetGatewayWorkspaceFilter
    Filters a collection of workspaces.
    comment string
    controlPlaneId string
    ID of a control plane
    createdAt number
    Unix epoch when the resource was created.
    description string
    id string
    The unique UUID for this resource.
    managedBy {[key: string]: string}
    name string
    next string
    offset string
    updatedAt number
    filter GetGatewayWorkspaceFilter
    Filters a collection of workspaces.
    comment str
    control_plane_id str
    ID of a control plane
    created_at float
    Unix epoch when the resource was created.
    description str
    id str
    The unique UUID for this resource.
    managed_by Mapping[str, str]
    name str
    next str
    offset str
    updated_at float
    filter GetGatewayWorkspaceFilter
    Filters a collection of workspaces.
    comment String
    controlPlaneId String
    ID of a control plane
    createdAt Number
    Unix epoch when the resource was created.
    description String
    id String
    The unique UUID for this resource.
    managedBy Map<String>
    name String
    next String
    offset String
    updatedAt Number
    filter Property Map
    Filters a collection of workspaces.

    Supporting Types

    GetGatewayWorkspaceFilter

    Name GetGatewayWorkspaceFilterName
    Filter using one of the following operators: eq, contains
    Name GetGatewayWorkspaceFilterName
    Filter using one of the following operators: eq, contains
    name object
    Filter using one of the following operators: eq, contains
    name GetGatewayWorkspaceFilterName
    Filter using one of the following operators: eq, contains
    name GetGatewayWorkspaceFilterName
    Filter using one of the following operators: eq, contains
    name GetGatewayWorkspaceFilterName
    Filter using one of the following operators: eq, contains
    name Property Map
    Filter using one of the following operators: eq, contains

    GetGatewayWorkspaceFilterName

    Contains string
    The field contains the provided value.
    Eq string
    The field exactly matches the provided value.
    Contains string
    The field contains the provided value.
    Eq string
    The field exactly matches the provided value.
    contains string
    The field contains the provided value.
    eq string
    The field exactly matches the provided value.
    contains String
    The field contains the provided value.
    eq String
    The field exactly matches the provided value.
    contains string
    The field contains the provided value.
    eq string
    The field exactly matches the provided value.
    contains str
    The field contains the provided value.
    eq str
    The field exactly matches the provided value.
    contains String
    The field contains the provided value.
    eq String
    The field exactly matches the provided value.

    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