konnect 2.7.1, May 1 25

konnect 2.7.1 published on Thursday, May 1, 2025 by kong

konnect.getGatewayControlPlaneList

Explore with Pulumi AI

konnect 2.7.1 published on Thursday, May 1, 2025 by kong

Example Usage

Coming soon!

Coming soon!

Coming soon!

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.GetGatewayControlPlaneListArgs;
import com.pulumi.konnect.inputs.GetGatewayControlPlaneListFilterArgs;
import com.pulumi.konnect.inputs.GetGatewayControlPlaneListFilterIdArgs;
import com.pulumi.konnect.inputs.GetGatewayControlPlaneListFilterNameArgs;
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 myGatewaycontrolplanelist = KonnectFunctions.getGatewayControlPlaneList(GetGatewayControlPlaneListArgs.builder()
            .filter(GetGatewayControlPlaneListFilterArgs.builder()
                .cloud_gateway(true)
                .cluster_type(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .id(GetGatewayControlPlaneListFilterIdArgs.builder()
                    .eq("...my_eq...")
                    .oeq("...my_oeq...")
                    .build())
                .name(GetGatewayControlPlaneListFilterNameArgs.builder()
                    .contains("...my_contains...")
                    .eq("...my_eq...")
                    .neq("...my_neq...")
                    .build())
                .build())
            .labels("key:value,existCheck")
            .pageNumber(1)
            .pageSize(10)
            .sort("created_at desc")
            .build());

    }
}

variables:
  myGatewaycontrolplanelist:
    fn::invoke:
      function: konnect:getGatewayControlPlaneList
      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...'
        labels: key:value,existCheck
        pageNumber: 1
        pageSize: 10
        sort: created_at desc

Using getGatewayControlPlaneList

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 getGatewayControlPlaneList(args: GetGatewayControlPlaneListArgs, opts?: InvokeOptions): Promise<GetGatewayControlPlaneListResult>
function getGatewayControlPlaneListOutput(args: GetGatewayControlPlaneListOutputArgs, opts?: InvokeOptions): Output<GetGatewayControlPlaneListResult>

def get_gateway_control_plane_list(filter: Optional[GetGatewayControlPlaneListFilter] = None,
                                   labels: Optional[str] = None,
                                   page_number: Optional[float] = None,
                                   page_size: Optional[float] = None,
                                   sort: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetGatewayControlPlaneListResult
def get_gateway_control_plane_list_output(filter: Optional[pulumi.Input[GetGatewayControlPlaneListFilterArgs]] = None,
                                   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[GetGatewayControlPlaneListResult]

func GetGatewayControlPlaneList(ctx *Context, args *GetGatewayControlPlaneListArgs, opts ...InvokeOption) (*GetGatewayControlPlaneListResult, error)
func GetGatewayControlPlaneListOutput(ctx *Context, args *GetGatewayControlPlaneListOutputArgs, opts ...InvokeOption) GetGatewayControlPlaneListResultOutput

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

public static class GetGatewayControlPlaneList 
{
    public static Task<GetGatewayControlPlaneListResult> InvokeAsync(GetGatewayControlPlaneListArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayControlPlaneListResult> Invoke(GetGatewayControlPlaneListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewayControlPlaneListResult> getGatewayControlPlaneList(GetGatewayControlPlaneListArgs args, InvokeOptions options)
public static Output<GetGatewayControlPlaneListResult> getGatewayControlPlaneList(GetGatewayControlPlaneListArgs args, InvokeOptions options)

fn::invoke:
  function: konnect:index/getGatewayControlPlaneList:getGatewayControlPlaneList
  arguments:
    # arguments dictionary

The following arguments are supported:

Filter GetGatewayControlPlaneListFilter
Labels string
PageNumber double
PageSize double
Sort string

Filter GetGatewayControlPlaneListFilter
Labels string
PageNumber float64
PageSize float64
Sort string

filter GetGatewayControlPlaneListFilter
labels String
pageNumber Double
pageSize Double
sort String

filter GetGatewayControlPlaneListFilter
labels string
pageNumber number
pageSize number
sort string

filter GetGatewayControlPlaneListFilter
labels str
page_number float
page_size float
sort str

filter Property Map
labels String
pageNumber Number
pageSize Number
sort String

getGatewayControlPlaneList Result

The following output properties are available:

Datas List<GetGatewayControlPlaneListData>
Id string: The provider-assigned unique ID for this managed resource.
Meta GetGatewayControlPlaneListMeta
Filter GetGatewayControlPlaneListFilter
Labels string
PageNumber double
PageSize double
Sort string

Datas []GetGatewayControlPlaneListData
Id string: The provider-assigned unique ID for this managed resource.
Meta GetGatewayControlPlaneListMeta
Filter GetGatewayControlPlaneListFilter
Labels string
PageNumber float64
PageSize float64
Sort string

datas List<GetGatewayControlPlaneListData>
id String: The provider-assigned unique ID for this managed resource.
meta GetGatewayControlPlaneListMeta
filter GetGatewayControlPlaneListFilter
labels String
pageNumber Double
pageSize Double
sort String

datas GetGatewayControlPlaneListData[]
id string: The provider-assigned unique ID for this managed resource.
meta GetGatewayControlPlaneListMeta
filter GetGatewayControlPlaneListFilter
labels string
pageNumber number
pageSize number
sort string

datas Sequence[GetGatewayControlPlaneListData]
id str: The provider-assigned unique ID for this managed resource.
meta GetGatewayControlPlaneListMeta
filter GetGatewayControlPlaneListFilter
labels str
page_number float
page_size float
sort str

datas List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
meta Property Map
filter Property Map
labels String
pageNumber Number
pageSize Number
sort String

Supporting Types

GetGatewayControlPlaneListData

Config GetGatewayControlPlaneListDataConfig

CP configuration object for related access endpoints.

Description string

The description of the control plane in Konnect.

Id string

The control plane ID.

Labels Dictionary<string, string>

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Name string

The name of the control plane.

Config GetGatewayControlPlaneListDataConfig

CP configuration object for related access endpoints.

Description string

The description of the control plane in Konnect.

Id string

The control plane ID.

Labels map[string]string

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Name string

The name of the control plane.

config GetGatewayControlPlaneListDataConfig

CP configuration object for related access endpoints.

description String

The description of the control plane in Konnect.

id String

The control plane ID.

labels Map<String,String>

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

name String

The name of the control plane.

config GetGatewayControlPlaneListDataConfig

CP configuration object for related access endpoints.

description string

The description of the control plane in Konnect.

id string

The control plane ID.

labels {[key: string]: string}

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

name string

The name of the control plane.

config GetGatewayControlPlaneListDataConfig

CP configuration object for related access endpoints.

description str

The description of the control plane in Konnect.

id str

The control plane ID.

labels Mapping[str, str]

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

name str

The name of the control plane.

config Property Map

CP configuration object for related access endpoints.

description String

The description of the control plane in Konnect.

id String

The control plane ID.

labels Map<String>

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

name String

The name of the control plane.

GetGatewayControlPlaneListDataConfig

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<GetGatewayControlPlaneListDataConfigProxyUrl>: 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 []GetGatewayControlPlaneListDataConfigProxyUrl: 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<GetGatewayControlPlaneListDataConfigProxyUrl>: 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 GetGatewayControlPlaneListDataConfigProxyUrl[]: 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[GetGatewayControlPlaneListDataConfigProxyUrl]: 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.

GetGatewayControlPlaneListDataConfigProxyUrl

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.

GetGatewayControlPlaneListFilter

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

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

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

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

cloud_gateway bool: Filter by a boolean value (true/false).
cluster_type GetGatewayControlPlaneListFilterClusterType: Filters on the given string field value by exact match inequality.
id GetGatewayControlPlaneListFilterId: Returns entities that exact match any of the comma-delimited phrases in the filter string.
name GetGatewayControlPlaneListFilterName: 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.

GetGatewayControlPlaneListFilterClusterType

Eq string
Neq string

Eq string
Neq string

eq String
neq String

eq string
neq string

eq str
neq str

eq String
neq String

GetGatewayControlPlaneListFilterId

Eq string
Oeq string

Eq string
Oeq string

eq String
oeq String

eq string
oeq string

eq str
oeq str

eq String
oeq String

GetGatewayControlPlaneListFilterName

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

GetGatewayControlPlaneListMeta

Page GetGatewayControlPlaneListMetaPage: Contains pagination query parameters and the total number of objects returned.

Page GetGatewayControlPlaneListMetaPage: Contains pagination query parameters and the total number of objects returned.

page GetGatewayControlPlaneListMetaPage: Contains pagination query parameters and the total number of objects returned.

page GetGatewayControlPlaneListMetaPage: Contains pagination query parameters and the total number of objects returned.

page GetGatewayControlPlaneListMetaPage: Contains pagination query parameters and the total number of objects returned.

page Property Map: Contains pagination query parameters and the total number of objects returned.

GetGatewayControlPlaneListMetaPage

Number double
Size double
Total double

Number float64
Size float64
Total float64

number Double
size Double
total Double

number number
size number
total number

number float
size float
total float

number Number
size Number
total Number

Package Details

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

konnect 2.7.1 published on Thursday, May 1, 2025 by kong

kong/terraform-provider-konnect

konnect.getGatewayControlPlaneList

On this page

On this page

Example Usage

Using getGatewayControlPlaneList

getGatewayControlPlaneList Result

Supporting Types

GetGatewayControlPlaneListData

GetGatewayControlPlaneListDataConfig

GetGatewayControlPlaneListDataConfigProxyUrl

GetGatewayControlPlaneListFilter

GetGatewayControlPlaneListFilterClusterType

GetGatewayControlPlaneListFilterId

GetGatewayControlPlaneListFilterName

GetGatewayControlPlaneListMeta

GetGatewayControlPlaneListMetaPage

Package Details

On this page

On this page