1. Packages
  2. Konnect Provider
  3. API Docs
  4. getGatewayControlPlane
konnect 2.6.0 published on Tuesday, Apr 22, 2025 by kong

konnect.getGatewayControlPlane

Explore with Pulumi AI

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>
Copy
def get_gateway_control_plane(id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetGatewayControlPlaneResult
def get_gateway_control_plane_output(id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetGatewayControlPlaneResult]
Copy
func LookupGatewayControlPlane(ctx *Context, args *LookupGatewayControlPlaneArgs, opts ...InvokeOption) (*LookupGatewayControlPlaneResult, error)
func LookupGatewayControlPlaneOutput(ctx *Context, args *LookupGatewayControlPlaneOutputArgs, opts ...InvokeOption) LookupGatewayControlPlaneResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetGatewayControlPlaneResult> getGatewayControlPlane(GetGatewayControlPlaneArgs args, InvokeOptions options)
public static Output<GetGatewayControlPlaneResult> getGatewayControlPlane(GetGatewayControlPlaneArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: konnect:index/getGatewayControlPlane:getGatewayControlPlane
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

getGatewayControlPlane Result

The following output properties are available:

Config GetGatewayControlPlaneConfig
Description string
Id string
Labels Dictionary<string, string>
Name string
Config GetGatewayControlPlaneConfig
Description string
Id string
Labels map[string]string
Name string
config GetGatewayControlPlaneConfig
description String
id String
labels Map<String,String>
name String
config GetGatewayControlPlaneConfig
description string
id string
labels {[key: string]: string}
name string
config Property Map
description String
id String
labels Map<String>
name String

Supporting Types

GetGatewayControlPlaneConfig

AuthType This property is required. string
The auth type value of the cluster associated with the Runtime Group.
CloudGateway This property is required. bool
Whether the Control Plane can be used for cloud-gateways.
ClusterType This property is required. string
The ClusterType value of the cluster associated with the Control Plane.
ControlPlaneEndpoint This property is required. string
Control Plane Endpoint.
ProxyUrls This property is required. List<GetGatewayControlPlaneConfigProxyUrl>
Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
TelemetryEndpoint This property is required. string
Telemetry Endpoint.
AuthType This property is required. string
The auth type value of the cluster associated with the Runtime Group.
CloudGateway This property is required. bool
Whether the Control Plane can be used for cloud-gateways.
ClusterType This property is required. string
The ClusterType value of the cluster associated with the Control Plane.
ControlPlaneEndpoint This property is required. string
Control Plane Endpoint.
ProxyUrls This property is required. []GetGatewayControlPlaneConfigProxyUrl
Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
TelemetryEndpoint This property is required. string
Telemetry Endpoint.
authType This property is required. String
The auth type value of the cluster associated with the Runtime Group.
cloudGateway This property is required. Boolean
Whether the Control Plane can be used for cloud-gateways.
clusterType This property is required. String
The ClusterType value of the cluster associated with the Control Plane.
controlPlaneEndpoint This property is required. String
Control Plane Endpoint.
proxyUrls This property is required. List<GetGatewayControlPlaneConfigProxyUrl>
Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
telemetryEndpoint This property is required. String
Telemetry Endpoint.
authType This property is required. string
The auth type value of the cluster associated with the Runtime Group.
cloudGateway This property is required. boolean
Whether the Control Plane can be used for cloud-gateways.
clusterType This property is required. string
The ClusterType value of the cluster associated with the Control Plane.
controlPlaneEndpoint This property is required. string
Control Plane Endpoint.
proxyUrls This property is required. GetGatewayControlPlaneConfigProxyUrl[]
Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
telemetryEndpoint This property is required. string
Telemetry Endpoint.
auth_type This property is required. str
The auth type value of the cluster associated with the Runtime Group.
cloud_gateway This property is required. bool
Whether the Control Plane can be used for cloud-gateways.
cluster_type This property is required. str
The ClusterType value of the cluster associated with the Control Plane.
control_plane_endpoint This property is required. str
Control Plane Endpoint.
proxy_urls This property is required. Sequence[GetGatewayControlPlaneConfigProxyUrl]
Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
telemetry_endpoint This property is required. str
Telemetry Endpoint.
authType This property is required. String
The auth type value of the cluster associated with the Runtime Group.
cloudGateway This property is required. Boolean
Whether the Control Plane can be used for cloud-gateways.
clusterType This property is required. String
The ClusterType value of the cluster associated with the Control Plane.
controlPlaneEndpoint This property is required. String
Control Plane Endpoint.
proxyUrls This property is required. List<Property Map>
Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
telemetryEndpoint This property is required. String
Telemetry Endpoint.

GetGatewayControlPlaneConfigProxyUrl

Host This property is required. string
Hostname of the proxy URL.
Port This property is required. double
Port of the proxy URL.
Protocol This property is required. string
Protocol of the proxy URL.
Host This property is required. string
Hostname of the proxy URL.
Port This property is required. float64
Port of the proxy URL.
Protocol This property is required. string
Protocol of the proxy URL.
host This property is required. String
Hostname of the proxy URL.
port This property is required. Double
Port of the proxy URL.
protocol This property is required. String
Protocol of the proxy URL.
host This property is required. string
Hostname of the proxy URL.
port This property is required. number
Port of the proxy URL.
protocol This property is required. string
Protocol of the proxy URL.
host This property is required. str
Hostname of the proxy URL.
port This property is required. float
Port of the proxy URL.
protocol This property is required. str
Protocol of the proxy URL.
host This property is required. String
Hostname of the proxy URL.
port This property is required. Number
Port of the proxy URL.
protocol This property is required. String
Protocol of the proxy URL.

Package Details

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