konnect 3.0.0, Aug 22 25

konnect 3.0.0 published on Friday, Aug 22, 2025 by kong

konnect.getGatewayControlPlane

Explore with Pulumi AI

konnect 3.0.0 published on Friday, Aug 22, 2025 by kong

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

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.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()
                .cloud_gateway(true)
                .cluster_type(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .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")
            .pageNumber(1)
            .pageSize(10)
            .sort("created_at desc")
            .build());

    }
}

variables:
  myGatewaycontrolplane:
    fn::invoke:
      function: konnect:getGatewayControlPlane
      arguments:
        filter:
          cloud_gateway: true
          cluster_type:
            eq: '...my_eq...'
            neq: '...my_neq...'
          id:
            eq: '...my_eq...'
            oeq: '...my_oeq...'
          name:
            contains: '...my_contains...'
            eq: '...my_eq...'
            neq: '...my_neq...'
        filterLabels: key:value,existCheck
        pageNumber: 1
        pageSize: 10
        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,
                              page_number: Optional[float] = None,
                              page_size: Optional[float] = 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,
                              page_number: Optional[pulumi.Input[float]] = None,
                              page_size: Optional[pulumi.Input[float]] = 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 dictionary

The following arguments are supported:

Filter GetGatewayControlPlaneFilter
FilterLabels string
PageNumber double
PageSize double
Sort string

Filter GetGatewayControlPlaneFilter
FilterLabels string
PageNumber float64
PageSize float64
Sort string

filter GetGatewayControlPlaneFilter
filterLabels String
pageNumber Double
pageSize Double
sort String

filter GetGatewayControlPlaneFilter
filterLabels string
pageNumber number
pageSize number
sort string

filter GetGatewayControlPlaneFilter
filter_labels str
page_number float
page_size float
sort str

filter Property Map
filterLabels String
pageNumber Number
pageSize Number
sort String

getGatewayControlPlane Result

The following output properties are available:

Config GetGatewayControlPlaneConfig
Description string
Id string
Labels Dictionary<string, string>
Name string
Number double
Size double
Total double
Filter GetGatewayControlPlaneFilter
FilterLabels string
PageNumber double
PageSize double
Sort string

Config GetGatewayControlPlaneConfig
Description string
Id string
Labels map[string]string
Name string
Number float64
Size float64
Total float64
Filter GetGatewayControlPlaneFilter
FilterLabels string
PageNumber float64
PageSize float64
Sort string

config GetGatewayControlPlaneConfig
description String
id String
labels Map<String,String>
name String
number Double
size Double
total Double
filter GetGatewayControlPlaneFilter
filterLabels String
pageNumber Double
pageSize Double
sort String

config GetGatewayControlPlaneConfig
description string
id string
labels {[key: string]: string}
name string
number number
size number
total number
filter GetGatewayControlPlaneFilter
filterLabels string
pageNumber number
pageSize number
sort string

config GetGatewayControlPlaneConfig
description str
id str
labels Mapping[str, str]
name str
number float
size float
total float
filter GetGatewayControlPlaneFilter
filter_labels str
page_number float
page_size float
sort str

config Property Map
description String
id String
labels Map<String>
name String
number Number
size Number
total Number
filter Property Map
filterLabels String
pageNumber Number
pageSize Number
sort String

Supporting Types

GetGatewayControlPlaneConfig

AuthType string: The auth type value of the cluster associated with the Runtime Group.
CloudGateway bool: Whether the Control Plane can be used for cloud-gateways.
ClusterType string: The ClusterType value of the cluster associated with the Control Plane.
ControlPlaneEndpoint string: Control Plane Endpoint.
ProxyUrls List<GetGatewayControlPlaneConfigProxyUrl>: Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
TelemetryEndpoint string: Telemetry Endpoint.

AuthType string: The auth type value of the cluster associated with the Runtime Group.
CloudGateway bool: Whether the Control Plane can be used for cloud-gateways.
ClusterType string: The ClusterType value of the cluster associated with the Control Plane.
ControlPlaneEndpoint string: Control Plane Endpoint.
ProxyUrls []GetGatewayControlPlaneConfigProxyUrl: Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
TelemetryEndpoint string: Telemetry Endpoint.

authType String: The auth type value of the cluster associated with the Runtime Group.
cloudGateway Boolean: Whether the Control Plane can be used for cloud-gateways.
clusterType String: The ClusterType value of the cluster associated with the Control Plane.
controlPlaneEndpoint String: Control Plane Endpoint.
proxyUrls List<GetGatewayControlPlaneConfigProxyUrl>: Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
telemetryEndpoint String: Telemetry Endpoint.

authType string: The auth type value of the cluster associated with the Runtime Group.
cloudGateway boolean: Whether the Control Plane can be used for cloud-gateways.
clusterType string: The ClusterType value of the cluster associated with the Control Plane.
controlPlaneEndpoint string: Control Plane Endpoint.
proxyUrls GetGatewayControlPlaneConfigProxyUrl[]: Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
telemetryEndpoint 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_endpoint str: Control Plane Endpoint.
proxy_urls Sequence[GetGatewayControlPlaneConfigProxyUrl]: Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
telemetry_endpoint str: Telemetry Endpoint.

authType String: The auth type value of the cluster associated with the Runtime Group.
cloudGateway Boolean: Whether the Control Plane can be used for cloud-gateways.
clusterType String: The ClusterType value of the cluster associated with the Control Plane.
controlPlaneEndpoint String: Control Plane Endpoint.
proxyUrls List<Property Map>: Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
telemetryEndpoint String: Telemetry Endpoint.

GetGatewayControlPlaneConfigProxyUrl

Host string: Hostname of the proxy URL.
Port double: Port of the proxy URL.
Protocol string: Protocol of the proxy URL.

Host string: Hostname of the proxy URL.
Port float64: Port of the proxy URL.
Protocol string: Protocol of the proxy URL.

host String: Hostname of the proxy URL.
port Double: Port of the proxy URL.
protocol String: Protocol of the proxy URL.

host string: Hostname of the proxy URL.
port number: Port of the proxy URL.
protocol string: Protocol of the proxy URL.

host str: Hostname of the proxy URL.
port float: Port of the proxy URL.
protocol str: Protocol of the proxy URL.

host String: Hostname of the proxy URL.
port Number: Port of the proxy URL.
protocol String: Protocol of the proxy URL.

GetGatewayControlPlaneFilter

CloudGateway bool: Filter by a boolean value (true/false).
ClusterType GetGatewayControlPlaneFilterClusterType: Filters on the given string field value by exact match inequality.
Id GetGatewayControlPlaneFilterId: Returns entities that exact match any of the comma-delimited phrases in the filter string.
Name GetGatewayControlPlaneFilterName: Filters on the given string field value by exact match inequality.

CloudGateway bool: Filter by a boolean value (true/false).
ClusterType GetGatewayControlPlaneFilterClusterType: Filters on the given string field value by exact match inequality.
Id GetGatewayControlPlaneFilterId: Returns entities that exact match any of the comma-delimited phrases in the filter string.
Name GetGatewayControlPlaneFilterName: Filters on the given string field value by exact match inequality.

cloudGateway Boolean: Filter by a boolean value (true/false).
clusterType GetGatewayControlPlaneFilterClusterType: Filters on the given string field value by exact match inequality.
id GetGatewayControlPlaneFilterId: Returns entities that exact match any of the comma-delimited phrases in the filter string.
name GetGatewayControlPlaneFilterName: Filters on the given string field value by exact match inequality.

cloudGateway boolean: Filter by a boolean value (true/false).
clusterType GetGatewayControlPlaneFilterClusterType: Filters on the given string field value by exact match inequality.
id GetGatewayControlPlaneFilterId: Returns entities that exact match any of the comma-delimited phrases in the filter string.
name GetGatewayControlPlaneFilterName: Filters on the given string field value by exact match inequality.

cloud_gateway bool: Filter by a boolean value (true/false).
cluster_type GetGatewayControlPlaneFilterClusterType: Filters on the given string field value by exact match inequality.
id GetGatewayControlPlaneFilterId: Returns entities that exact match any of the comma-delimited phrases in the filter string.
name GetGatewayControlPlaneFilterName: Filters on the given string field value by exact match inequality.

cloudGateway Boolean: Filter by a boolean value (true/false).
clusterType Property Map: Filters on the given string field value by exact match inequality.
id Property Map: Returns entities that exact match any of the comma-delimited phrases in the filter string.
name Property Map: Filters on the given string field value by exact match inequality.

GetGatewayControlPlaneFilterClusterType

Eq string
Neq string

Eq string
Neq string

eq String
neq String

eq string
neq string

eq str
neq str

eq String
neq String

GetGatewayControlPlaneFilterId

Eq string
Oeq string

Eq string
Oeq string

eq String
oeq String

eq string
oeq string

eq str
oeq str

eq String
oeq String

GetGatewayControlPlaneFilterName

Contains string
Eq string
Neq string

Contains string
Eq string
Neq string

contains String
eq String
neq String

contains string
eq string
neq string

contains str
eq str
neq str

contains String
eq String
neq String

Package Details

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

konnect 3.0.0 published on Friday, Aug 22, 2025 by kong

kong/terraform-provider-konnect

konnect.getGatewayControlPlane

On this page

On this page

Example Usage

Using getGatewayControlPlane

getGatewayControlPlane Result

Supporting Types

GetGatewayControlPlaneConfig

GetGatewayControlPlaneConfigProxyUrl

GetGatewayControlPlaneFilter

GetGatewayControlPlaneFilterClusterType

GetGatewayControlPlaneFilterId

GetGatewayControlPlaneFilterName

Package Details

On this page

On this page