Viewing docs for konnect 3.11.0
published on Thursday, Mar 12, 2026 by kong
published on Thursday, Mar 12, 2026 by kong
Viewing docs for konnect 3.11.0
published on Thursday, Mar 12, 2026 by kong
published on Thursday, Mar 12, 2026 by kong
GatewayControlPlane DataSource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as konnect from "@pulumi/konnect";
const myGatewaycontrolplane = konnect.getGatewayControlPlane({
filter: {
cloudGateway: true,
clusterType: {
eq: "...my_eq...",
neq: "...my_neq...",
oeq: "...my_oeq...",
},
id: {
eq: "...my_eq...",
oeq: "...my_oeq...",
},
name: {
contains: "...my_contains...",
eq: "...my_eq...",
neq: "...my_neq...",
},
},
filterLabels: "key:value,existCheck",
sort: "created_at desc",
});
import pulumi
import pulumi_konnect as konnect
my_gatewaycontrolplane = konnect.get_gateway_control_plane(filter={
"cloud_gateway": True,
"cluster_type": {
"eq": "...my_eq...",
"neq": "...my_neq...",
"oeq": "...my_oeq...",
},
"id": {
"eq": "...my_eq...",
"oeq": "...my_oeq...",
},
"name": {
"contains": "...my_contains...",
"eq": "...my_eq...",
"neq": "...my_neq...",
},
},
filter_labels="key:value,existCheck",
sort="created_at desc")
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.LookupGatewayControlPlane(ctx, &konnect.LookupGatewayControlPlaneArgs{
Filter: konnect.GetGatewayControlPlaneFilter{
CloudGateway: pulumi.BoolRef(true),
ClusterType: konnect.GetGatewayControlPlaneFilterClusterType{
Eq: pulumi.StringRef("...my_eq..."),
Neq: pulumi.StringRef("...my_neq..."),
Oeq: pulumi.StringRef("...my_oeq..."),
},
Id: konnect.GetGatewayControlPlaneFilterId{
Eq: pulumi.StringRef("...my_eq..."),
Oeq: pulumi.StringRef("...my_oeq..."),
},
Name: konnect.GetGatewayControlPlaneFilterName{
Contains: pulumi.StringRef("...my_contains..."),
Eq: pulumi.StringRef("...my_eq..."),
Neq: pulumi.StringRef("...my_neq..."),
},
},
FilterLabels: pulumi.StringRef("key:value,existCheck"),
Sort: pulumi.StringRef("created_at desc"),
}, 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 myGatewaycontrolplane = Konnect.GetGatewayControlPlane.Invoke(new()
{
Filter = new Konnect.Inputs.GetGatewayControlPlaneFilterInputArgs
{
CloudGateway = true,
ClusterType = new Konnect.Inputs.GetGatewayControlPlaneFilterClusterTypeInputArgs
{
Eq = "...my_eq...",
Neq = "...my_neq...",
Oeq = "...my_oeq...",
},
Id = new Konnect.Inputs.GetGatewayControlPlaneFilterIdInputArgs
{
Eq = "...my_eq...",
Oeq = "...my_oeq...",
},
Name = new Konnect.Inputs.GetGatewayControlPlaneFilterNameInputArgs
{
Contains = "...my_contains...",
Eq = "...my_eq...",
Neq = "...my_neq...",
},
},
FilterLabels = "key:value,existCheck",
Sort = "created_at desc",
});
});
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.GetGatewayControlPlaneArgs;
import com.pulumi.konnect.inputs.GetGatewayControlPlaneFilterArgs;
import com.pulumi.konnect.inputs.GetGatewayControlPlaneFilterClusterTypeArgs;
import com.pulumi.konnect.inputs.GetGatewayControlPlaneFilterIdArgs;
import com.pulumi.konnect.inputs.GetGatewayControlPlaneFilterNameArgs;
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 myGatewaycontrolplane = KonnectFunctions.getGatewayControlPlane(GetGatewayControlPlaneArgs.builder()
.filter(GetGatewayControlPlaneFilterArgs.builder()
.cloudGateway(true)
.clusterType(GetGatewayControlPlaneFilterClusterTypeArgs.builder()
.eq("...my_eq...")
.neq("...my_neq...")
.oeq("...my_oeq...")
.build())
.id(GetGatewayControlPlaneFilterIdArgs.builder()
.eq("...my_eq...")
.oeq("...my_oeq...")
.build())
.name(GetGatewayControlPlaneFilterNameArgs.builder()
.contains("...my_contains...")
.eq("...my_eq...")
.neq("...my_neq...")
.build())
.build())
.filterLabels("key:value,existCheck")
.sort("created_at desc")
.build());
}
}
variables:
myGatewaycontrolplane:
fn::invoke:
function: konnect:getGatewayControlPlane
arguments:
filter:
cloudGateway: true
clusterType:
eq: '...my_eq...'
neq: '...my_neq...'
oeq: '...my_oeq...'
id:
eq: '...my_eq...'
oeq: '...my_oeq...'
name:
contains: '...my_contains...'
eq: '...my_eq...'
neq: '...my_neq...'
filterLabels: key:value,existCheck
sort: created_at desc
Using getGatewayControlPlane
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 getGatewayControlPlane(args: GetGatewayControlPlaneArgs, opts?: InvokeOptions): Promise<GetGatewayControlPlaneResult>
function getGatewayControlPlaneOutput(args: GetGatewayControlPlaneOutputArgs, opts?: InvokeOptions): Output<GetGatewayControlPlaneResult>def get_gateway_control_plane(filter: Optional[GetGatewayControlPlaneFilter] = None,
filter_labels: Optional[str] = None,
sort: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGatewayControlPlaneResult
def get_gateway_control_plane_output(filter: Optional[pulumi.Input[GetGatewayControlPlaneFilterArgs]] = None,
filter_labels: Optional[pulumi.Input[str]] = None,
sort: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGatewayControlPlaneResult]func LookupGatewayControlPlane(ctx *Context, args *LookupGatewayControlPlaneArgs, opts ...InvokeOption) (*LookupGatewayControlPlaneResult, error)
func LookupGatewayControlPlaneOutput(ctx *Context, args *LookupGatewayControlPlaneOutputArgs, opts ...InvokeOption) LookupGatewayControlPlaneResultOutput> Note: This function is named LookupGatewayControlPlane in the Go SDK.
public static class GetGatewayControlPlane
{
public static Task<GetGatewayControlPlaneResult> InvokeAsync(GetGatewayControlPlaneArgs args, InvokeOptions? opts = null)
public static Output<GetGatewayControlPlaneResult> Invoke(GetGatewayControlPlaneInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetGatewayControlPlaneResult> getGatewayControlPlane(GetGatewayControlPlaneArgs args, InvokeOptions options)
public static Output<GetGatewayControlPlaneResult> getGatewayControlPlane(GetGatewayControlPlaneArgs args, InvokeOptions options)
fn::invoke:
function: konnect:index/getGatewayControlPlane:getGatewayControlPlane
arguments:
# arguments dictionaryThe following arguments are supported:
- Filter
Get
Gateway Control Plane Filter - Filter
Labels string - Sort string
- Filter
Get
Gateway Control Plane Filter - Filter
Labels string - Sort string
- filter
Get
Gateway Control Plane Filter - filter
Labels String - sort String
- filter
Get
Gateway Control Plane Filter - filter
Labels string - sort string
- filter Property Map
- filter
Labels String - sort String
getGatewayControlPlane Result
The following output properties are available:
- Config
Get
Gateway Control Plane Config - Description string
- Id string
- Labels Dictionary<string, string>
- Name string
- Filter
Get
Gateway Control Plane Filter - Filter
Labels string - Sort string
- Config
Get
Gateway Control Plane Config - Description string
- Id string
- Labels map[string]string
- Name string
- Filter
Get
Gateway Control Plane Filter - Filter
Labels string - Sort string
- config
Get
Gateway Control Plane Config - description String
- id String
- labels Map<String,String>
- name String
- filter
Get
Gateway Control Plane Filter - filter
Labels String - sort String
- config
Get
Gateway Control Plane Config - description string
- id string
- labels {[key: string]: string}
- name string
- filter
Get
Gateway Control Plane Filter - filter
Labels string - sort string
- config
Get
Gateway Control Plane Config - description str
- id str
- labels Mapping[str, str]
- name str
- filter
Get
Gateway Control Plane Filter - filter_
labels str - sort str
- config Property Map
- description String
- id String
- labels Map<String>
- name String
- filter Property Map
- filter
Labels String - sort String
Supporting Types
GetGatewayControlPlaneConfig
- Auth
Type string - The auth type value of the cluster associated with the Runtime Group.
- Cloud
Gateway bool - Whether the Control Plane can be used for cloud-gateways.
- Cluster
Type string - The ClusterType value of the cluster associated with the Control Plane.
- Control
Plane stringEndpoint - Control Plane Endpoint.
- Proxy
Urls List<GetGateway Control Plane Config Proxy Url> - Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
- Telemetry
Endpoint string - Telemetry Endpoint.
- Auth
Type string - The auth type value of the cluster associated with the Runtime Group.
- Cloud
Gateway bool - Whether the Control Plane can be used for cloud-gateways.
- Cluster
Type string - The ClusterType value of the cluster associated with the Control Plane.
- Control
Plane stringEndpoint - Control Plane Endpoint.
- Proxy
Urls []GetGateway Control Plane Config Proxy Url - Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
- Telemetry
Endpoint string - Telemetry Endpoint.
- auth
Type String - The auth type value of the cluster associated with the Runtime Group.
- cloud
Gateway Boolean - Whether the Control Plane can be used for cloud-gateways.
- cluster
Type String - The ClusterType value of the cluster associated with the Control Plane.
- control
Plane StringEndpoint - Control Plane Endpoint.
- proxy
Urls List<GetGateway Control Plane Config Proxy Url> - Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
- telemetry
Endpoint String - Telemetry Endpoint.
- auth
Type string - The auth type value of the cluster associated with the Runtime Group.
- cloud
Gateway boolean - Whether the Control Plane can be used for cloud-gateways.
- cluster
Type string - The ClusterType value of the cluster associated with the Control Plane.
- control
Plane stringEndpoint - Control Plane Endpoint.
- proxy
Urls GetGateway Control Plane Config Proxy Url[] - Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
- telemetry
Endpoint string - Telemetry Endpoint.
- auth_
type str - The auth type value of the cluster associated with the Runtime Group.
- cloud_
gateway bool - Whether the Control Plane can be used for cloud-gateways.
- cluster_
type str - The ClusterType value of the cluster associated with the Control Plane.
- control_
plane_ strendpoint - Control Plane Endpoint.
- proxy_
urls Sequence[GetGateway Control Plane Config Proxy Url] - Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
- telemetry_
endpoint str - Telemetry Endpoint.
- auth
Type String - The auth type value of the cluster associated with the Runtime Group.
- cloud
Gateway Boolean - Whether the Control Plane can be used for cloud-gateways.
- cluster
Type String - The ClusterType value of the cluster associated with the Control Plane.
- control
Plane StringEndpoint - Control Plane Endpoint.
- proxy
Urls List<Property Map> - Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
- telemetry
Endpoint String - Telemetry Endpoint.
GetGatewayControlPlaneConfigProxyUrl
GetGatewayControlPlaneFilter
- Cloud
Gateway bool - Filter by a boolean value (true/false).
- Cluster
Type GetGateway Control Plane Filter Cluster Type - Filter using one of the following operators:
eq,oeq,neq - Id
Get
Gateway Control Plane Filter Id - Filter using one of the following operators:
eq,oeq - Name
Get
Gateway Control Plane Filter Name - Filter using one of the following operators:
eq,neq,contains
- Cloud
Gateway bool - Filter by a boolean value (true/false).
- Cluster
Type GetGateway Control Plane Filter Cluster Type - Filter using one of the following operators:
eq,oeq,neq - Id
Get
Gateway Control Plane Filter Id - Filter using one of the following operators:
eq,oeq - Name
Get
Gateway Control Plane Filter Name - Filter using one of the following operators:
eq,neq,contains
- cloud
Gateway Boolean - Filter by a boolean value (true/false).
- cluster
Type GetGateway Control Plane Filter Cluster Type - Filter using one of the following operators:
eq,oeq,neq - id
Get
Gateway Control Plane Filter Id - Filter using one of the following operators:
eq,oeq - name
Get
Gateway Control Plane Filter Name - Filter using one of the following operators:
eq,neq,contains
- cloud
Gateway boolean - Filter by a boolean value (true/false).
- cluster
Type GetGateway Control Plane Filter Cluster Type - Filter using one of the following operators:
eq,oeq,neq - id
Get
Gateway Control Plane Filter Id - Filter using one of the following operators:
eq,oeq - name
Get
Gateway Control Plane Filter Name - Filter using one of the following operators:
eq,neq,contains
- cloud_
gateway bool - Filter by a boolean value (true/false).
- cluster_
type GetGateway Control Plane Filter Cluster Type - Filter using one of the following operators:
eq,oeq,neq - id
Get
Gateway Control Plane Filter Id - Filter using one of the following operators:
eq,oeq - name
Get
Gateway Control Plane Filter Name - Filter using one of the following operators:
eq,neq,contains
- cloud
Gateway Boolean - Filter by a boolean value (true/false).
- cluster
Type Property Map - Filter using one of the following operators:
eq,oeq,neq - id Property Map
- Filter using one of the following operators:
eq,oeq - name Property Map
- Filter using one of the following operators:
eq,neq,contains
GetGatewayControlPlaneFilterClusterType
GetGatewayControlPlaneFilterId
GetGatewayControlPlaneFilterName
Package Details
- Repository
- konnect kong/terraform-provider-konnect
- License
- Notes
- This Pulumi package is based on the
konnectTerraform Provider.
Viewing docs for konnect 3.11.0
published on Thursday, Mar 12, 2026 by kong
published on Thursday, Mar 12, 2026 by kong
