Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayRoute
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

konnect.GatewayRoute

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

GatewayRoute Resource

Example Usage

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

const myGatewayroute = new konnect.GatewayRoute("myGatewayroute", {
    controlPlaneId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
    destinations: [{
        ip: "...my_ip...",
        port: 8,
    }],
    headers: {
        key: [],
    },
    hosts: ["..."],
    httpsRedirectStatusCode: 307,
    gatewayRouteId: "...my_id...",
    methods: ["..."],
    pathHandling: "v0",
    paths: ["..."],
    preserveHost: false,
    protocols: ["tcp"],
    regexPriority: 9,
    requestBuffering: true,
    responseBuffering: false,
    service: {
        id: "...my_id...",
    },
    snis: ["..."],
    sources: [{
        ip: "...my_ip...",
        port: 0,
    }],
    stripPath: true,
    tags: ["..."],
});
Copy
import pulumi
import pulumi_konnect as konnect

my_gatewayroute = konnect.GatewayRoute("myGatewayroute",
    control_plane_id="9524ec7d-36d9-465d-a8c5-83a3c9390458",
    destinations=[{
        "ip": "...my_ip...",
        "port": 8,
    }],
    headers={
        "key": [],
    },
    hosts=["..."],
    https_redirect_status_code=307,
    gateway_route_id="...my_id...",
    methods=["..."],
    path_handling="v0",
    paths=["..."],
    preserve_host=False,
    protocols=["tcp"],
    regex_priority=9,
    request_buffering=True,
    response_buffering=False,
    service={
        "id": "...my_id...",
    },
    snis=["..."],
    sources=[{
        "ip": "...my_ip...",
        "port": 0,
    }],
    strip_path=True,
    tags=["..."])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v2/konnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := konnect.NewGatewayRoute(ctx, "myGatewayroute", &konnect.GatewayRouteArgs{
			ControlPlaneId: pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
			Destinations: konnect.GatewayRouteDestinationArray{
				&konnect.GatewayRouteDestinationArgs{
					Ip:   pulumi.String("...my_ip..."),
					Port: pulumi.Float64(8),
				},
			},
			Headers: pulumi.StringArrayMap{
				"key": pulumi.StringArray{},
			},
			Hosts: pulumi.StringArray{
				pulumi.String("..."),
			},
			HttpsRedirectStatusCode: pulumi.Float64(307),
			GatewayRouteId:          pulumi.String("...my_id..."),
			Methods: pulumi.StringArray{
				pulumi.String("..."),
			},
			PathHandling: pulumi.String("v0"),
			Paths: pulumi.StringArray{
				pulumi.String("..."),
			},
			PreserveHost: pulumi.Bool(false),
			Protocols: pulumi.StringArray{
				pulumi.String("tcp"),
			},
			RegexPriority:     pulumi.Float64(9),
			RequestBuffering:  pulumi.Bool(true),
			ResponseBuffering: pulumi.Bool(false),
			Service: &konnect.GatewayRouteServiceArgs{
				Id: pulumi.String("...my_id..."),
			},
			Snis: pulumi.StringArray{
				pulumi.String("..."),
			},
			Sources: konnect.GatewayRouteSourceArray{
				&konnect.GatewayRouteSourceArgs{
					Ip:   pulumi.String("...my_ip..."),
					Port: pulumi.Float64(0),
				},
			},
			StripPath: pulumi.Bool(true),
			Tags: pulumi.StringArray{
				pulumi.String("..."),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var myGatewayroute = new Konnect.GatewayRoute("myGatewayroute", new()
    {
        ControlPlaneId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
        Destinations = new[]
        {
            new Konnect.Inputs.GatewayRouteDestinationArgs
            {
                Ip = "...my_ip...",
                Port = 8,
            },
        },
        Headers = 
        {
            { "key", new[] {} },
        },
        Hosts = new[]
        {
            "...",
        },
        HttpsRedirectStatusCode = 307,
        GatewayRouteId = "...my_id...",
        Methods = new[]
        {
            "...",
        },
        PathHandling = "v0",
        Paths = new[]
        {
            "...",
        },
        PreserveHost = false,
        Protocols = new[]
        {
            "tcp",
        },
        RegexPriority = 9,
        RequestBuffering = true,
        ResponseBuffering = false,
        Service = new Konnect.Inputs.GatewayRouteServiceArgs
        {
            Id = "...my_id...",
        },
        Snis = new[]
        {
            "...",
        },
        Sources = new[]
        {
            new Konnect.Inputs.GatewayRouteSourceArgs
            {
                Ip = "...my_ip...",
                Port = 0,
            },
        },
        StripPath = true,
        Tags = new[]
        {
            "...",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayRoute;
import com.pulumi.konnect.GatewayRouteArgs;
import com.pulumi.konnect.inputs.GatewayRouteDestinationArgs;
import com.pulumi.konnect.inputs.GatewayRouteServiceArgs;
import com.pulumi.konnect.inputs.GatewayRouteSourceArgs;
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) {
        var myGatewayroute = new GatewayRoute("myGatewayroute", GatewayRouteArgs.builder()
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .destinations(GatewayRouteDestinationArgs.builder()
                .ip("...my_ip...")
                .port(8)
                .build())
            .headers(Map.of("key", ))
            .hosts("...")
            .httpsRedirectStatusCode(307)
            .gatewayRouteId("...my_id...")
            .methods("...")
            .pathHandling("v0")
            .paths("...")
            .preserveHost(false)
            .protocols("tcp")
            .regexPriority(9)
            .requestBuffering(true)
            .responseBuffering(false)
            .service(GatewayRouteServiceArgs.builder()
                .id("...my_id...")
                .build())
            .snis("...")
            .sources(GatewayRouteSourceArgs.builder()
                .ip("...my_ip...")
                .port(0)
                .build())
            .stripPath(true)
            .tags("...")
            .build());

    }
}
Copy
resources:
  myGatewayroute:
    type: konnect:GatewayRoute
    properties:
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      destinations:
        - ip: '...my_ip...'
          port: 8
      headers:
        key: []
      hosts:
        - '...'
      httpsRedirectStatusCode: 307
      gatewayRouteId: '...my_id...'
      methods:
        - '...'
      pathHandling: v0
      paths:
        - '...'
      preserveHost: false
      protocols:
        - tcp
      regexPriority: 9
      requestBuffering: true
      responseBuffering: false
      service:
        id: '...my_id...'
      snis:
        - '...'
      sources:
        - ip: '...my_ip...'
          port: 0
      stripPath: true
      tags:
        - '...'
Copy

Create GatewayRoute Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new GatewayRoute(name: string, args: GatewayRouteArgs, opts?: CustomResourceOptions);
@overload
def GatewayRoute(resource_name: str,
                 args: GatewayRouteArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def GatewayRoute(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 control_plane_id: Optional[str] = None,
                 destinations: Optional[Sequence[GatewayRouteDestinationArgs]] = None,
                 gateway_route_id: Optional[str] = None,
                 headers: Optional[Mapping[str, Sequence[str]]] = None,
                 hosts: Optional[Sequence[str]] = None,
                 https_redirect_status_code: Optional[float] = None,
                 methods: Optional[Sequence[str]] = None,
                 name: Optional[str] = None,
                 path_handling: Optional[str] = None,
                 paths: Optional[Sequence[str]] = None,
                 preserve_host: Optional[bool] = None,
                 protocols: Optional[Sequence[str]] = None,
                 regex_priority: Optional[float] = None,
                 request_buffering: Optional[bool] = None,
                 response_buffering: Optional[bool] = None,
                 service: Optional[GatewayRouteServiceArgs] = None,
                 snis: Optional[Sequence[str]] = None,
                 sources: Optional[Sequence[GatewayRouteSourceArgs]] = None,
                 strip_path: Optional[bool] = None,
                 tags: Optional[Sequence[str]] = None)
func NewGatewayRoute(ctx *Context, name string, args GatewayRouteArgs, opts ...ResourceOption) (*GatewayRoute, error)
public GatewayRoute(string name, GatewayRouteArgs args, CustomResourceOptions? opts = null)
public GatewayRoute(String name, GatewayRouteArgs args)
public GatewayRoute(String name, GatewayRouteArgs args, CustomResourceOptions options)

type: konnect:GatewayRoute
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayRouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayRouteArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayRouteArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayRouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayRouteArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var gatewayRouteResource = new Konnect.GatewayRoute("gatewayRouteResource", new()
{
    ControlPlaneId = "string",
    Destinations = new[]
    {
        new Konnect.Inputs.GatewayRouteDestinationArgs
        {
            Ip = "string",
            Port = 0,
        },
    },
    GatewayRouteId = "string",
    Headers = 
    {
        { "string", new[]
        {
            "string",
        } },
    },
    Hosts = new[]
    {
        "string",
    },
    HttpsRedirectStatusCode = 0,
    Methods = new[]
    {
        "string",
    },
    Name = "string",
    PathHandling = "string",
    Paths = new[]
    {
        "string",
    },
    PreserveHost = false,
    Protocols = new[]
    {
        "string",
    },
    RegexPriority = 0,
    RequestBuffering = false,
    ResponseBuffering = false,
    Service = new Konnect.Inputs.GatewayRouteServiceArgs
    {
        Id = "string",
    },
    Snis = new[]
    {
        "string",
    },
    Sources = new[]
    {
        new Konnect.Inputs.GatewayRouteSourceArgs
        {
            Ip = "string",
            Port = 0,
        },
    },
    StripPath = false,
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := konnect.NewGatewayRoute(ctx, "gatewayRouteResource", &konnect.GatewayRouteArgs{
ControlPlaneId: pulumi.String("string"),
Destinations: .GatewayRouteDestinationArray{
&.GatewayRouteDestinationArgs{
Ip: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
GatewayRouteId: pulumi.String("string"),
Headers: pulumi.StringArrayMap{
"string": pulumi.StringArray{
pulumi.String("string"),
},
},
Hosts: pulumi.StringArray{
pulumi.String("string"),
},
HttpsRedirectStatusCode: pulumi.Float64(0),
Methods: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
PathHandling: pulumi.String("string"),
Paths: pulumi.StringArray{
pulumi.String("string"),
},
PreserveHost: pulumi.Bool(false),
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
RegexPriority: pulumi.Float64(0),
RequestBuffering: pulumi.Bool(false),
ResponseBuffering: pulumi.Bool(false),
Service: &.GatewayRouteServiceArgs{
Id: pulumi.String("string"),
},
Snis: pulumi.StringArray{
pulumi.String("string"),
},
Sources: .GatewayRouteSourceArray{
&.GatewayRouteSourceArgs{
Ip: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
StripPath: pulumi.Bool(false),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var gatewayRouteResource = new GatewayRoute("gatewayRouteResource", GatewayRouteArgs.builder()
    .controlPlaneId("string")
    .destinations(GatewayRouteDestinationArgs.builder()
        .ip("string")
        .port(0)
        .build())
    .gatewayRouteId("string")
    .headers(Map.of("string", "string"))
    .hosts("string")
    .httpsRedirectStatusCode(0)
    .methods("string")
    .name("string")
    .pathHandling("string")
    .paths("string")
    .preserveHost(false)
    .protocols("string")
    .regexPriority(0)
    .requestBuffering(false)
    .responseBuffering(false)
    .service(GatewayRouteServiceArgs.builder()
        .id("string")
        .build())
    .snis("string")
    .sources(GatewayRouteSourceArgs.builder()
        .ip("string")
        .port(0)
        .build())
    .stripPath(false)
    .tags("string")
    .build());
Copy
gateway_route_resource = konnect.GatewayRoute("gatewayRouteResource",
    control_plane_id="string",
    destinations=[{
        "ip": "string",
        "port": 0,
    }],
    gateway_route_id="string",
    headers={
        "string": ["string"],
    },
    hosts=["string"],
    https_redirect_status_code=0,
    methods=["string"],
    name="string",
    path_handling="string",
    paths=["string"],
    preserve_host=False,
    protocols=["string"],
    regex_priority=0,
    request_buffering=False,
    response_buffering=False,
    service={
        "id": "string",
    },
    snis=["string"],
    sources=[{
        "ip": "string",
        "port": 0,
    }],
    strip_path=False,
    tags=["string"])
Copy
const gatewayRouteResource = new konnect.GatewayRoute("gatewayRouteResource", {
    controlPlaneId: "string",
    destinations: [{
        ip: "string",
        port: 0,
    }],
    gatewayRouteId: "string",
    headers: {
        string: ["string"],
    },
    hosts: ["string"],
    httpsRedirectStatusCode: 0,
    methods: ["string"],
    name: "string",
    pathHandling: "string",
    paths: ["string"],
    preserveHost: false,
    protocols: ["string"],
    regexPriority: 0,
    requestBuffering: false,
    responseBuffering: false,
    service: {
        id: "string",
    },
    snis: ["string"],
    sources: [{
        ip: "string",
        port: 0,
    }],
    stripPath: false,
    tags: ["string"],
});
Copy
type: konnect:GatewayRoute
properties:
    controlPlaneId: string
    destinations:
        - ip: string
          port: 0
    gatewayRouteId: string
    headers:
        string:
            - string
    hosts:
        - string
    httpsRedirectStatusCode: 0
    methods:
        - string
    name: string
    pathHandling: string
    paths:
        - string
    preserveHost: false
    protocols:
        - string
    regexPriority: 0
    requestBuffering: false
    responseBuffering: false
    service:
        id: string
    snis:
        - string
    sources:
        - ip: string
          port: 0
    stripPath: false
    tags:
        - string
Copy

GatewayRoute Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The GatewayRoute resource accepts the following input properties:

ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Destinations List<GatewayRouteDestination>
A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
GatewayRouteId string
The ID of this resource.
Headers Dictionary<string, ImmutableArray<string>>
One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.
Hosts List<string>
A list of domain names that match this Route. Note that the hosts value is case sensitive.
HttpsRedirectStatusCode double
The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol. must be one of ["426", "301", "302", "307", "308"]
Methods List<string>
A list of HTTP methods that match this Route.
Name string
The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".
PathHandling string
Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior. must be one of ["v0", "v1"]
Paths List<string>
A list of paths that match this Route.
PreserveHost bool
When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.
Protocols List<string>
An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.
RegexPriority double
A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).
RequestBuffering bool
Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.
ResponseBuffering bool
Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.
Service GatewayRouteService
The Service this Route is associated to. This is where the Route proxies traffic to.
Snis List<string>
A list of SNIs that match this Route when using stream routing.
Sources List<GatewayRouteSource>
A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
StripPath bool
When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.
Tags List<string>
An optional set of strings associated with the Route for grouping and filtering.
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Destinations []GatewayRouteDestinationArgs
A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
GatewayRouteId string
The ID of this resource.
Headers map[string][]string
One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.
Hosts []string
A list of domain names that match this Route. Note that the hosts value is case sensitive.
HttpsRedirectStatusCode float64
The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol. must be one of ["426", "301", "302", "307", "308"]
Methods []string
A list of HTTP methods that match this Route.
Name string
The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".
PathHandling string
Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior. must be one of ["v0", "v1"]
Paths []string
A list of paths that match this Route.
PreserveHost bool
When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.
Protocols []string
An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.
RegexPriority float64
A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).
RequestBuffering bool
Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.
ResponseBuffering bool
Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.
Service GatewayRouteServiceArgs
The Service this Route is associated to. This is where the Route proxies traffic to.
Snis []string
A list of SNIs that match this Route when using stream routing.
Sources []GatewayRouteSourceArgs
A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
StripPath bool
When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.
Tags []string
An optional set of strings associated with the Route for grouping and filtering.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
destinations List<GatewayRouteDestination>
A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
gatewayRouteId String
The ID of this resource.
headers Map<String,List<String>>
One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.
hosts List<String>
A list of domain names that match this Route. Note that the hosts value is case sensitive.
httpsRedirectStatusCode Double
The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol. must be one of ["426", "301", "302", "307", "308"]
methods List<String>
A list of HTTP methods that match this Route.
name String
The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".
pathHandling String
Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior. must be one of ["v0", "v1"]
paths List<String>
A list of paths that match this Route.
preserveHost Boolean
When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.
protocols List<String>
An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.
regexPriority Double
A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).
requestBuffering Boolean
Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.
responseBuffering Boolean
Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.
service GatewayRouteService
The Service this Route is associated to. This is where the Route proxies traffic to.
snis List<String>
A list of SNIs that match this Route when using stream routing.
sources List<GatewayRouteSource>
A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
stripPath Boolean
When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.
tags List<String>
An optional set of strings associated with the Route for grouping and filtering.
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
destinations GatewayRouteDestination[]
A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
gatewayRouteId string
The ID of this resource.
headers {[key: string]: string[]}
One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.
hosts string[]
A list of domain names that match this Route. Note that the hosts value is case sensitive.
httpsRedirectStatusCode number
The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol. must be one of ["426", "301", "302", "307", "308"]
methods string[]
A list of HTTP methods that match this Route.
name string
The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".
pathHandling string
Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior. must be one of ["v0", "v1"]
paths string[]
A list of paths that match this Route.
preserveHost boolean
When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.
protocols string[]
An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.
regexPriority number
A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).
requestBuffering boolean
Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.
responseBuffering boolean
Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.
service GatewayRouteService
The Service this Route is associated to. This is where the Route proxies traffic to.
snis string[]
A list of SNIs that match this Route when using stream routing.
sources GatewayRouteSource[]
A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
stripPath boolean
When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.
tags string[]
An optional set of strings associated with the Route for grouping and filtering.
control_plane_id This property is required. str
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
destinations Sequence[GatewayRouteDestinationArgs]
A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
gateway_route_id str
The ID of this resource.
headers Mapping[str, Sequence[str]]
One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.
hosts Sequence[str]
A list of domain names that match this Route. Note that the hosts value is case sensitive.
https_redirect_status_code float
The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol. must be one of ["426", "301", "302", "307", "308"]
methods Sequence[str]
A list of HTTP methods that match this Route.
name str
The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".
path_handling str
Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior. must be one of ["v0", "v1"]
paths Sequence[str]
A list of paths that match this Route.
preserve_host bool
When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.
protocols Sequence[str]
An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.
regex_priority float
A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).
request_buffering bool
Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.
response_buffering bool
Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.
service GatewayRouteServiceArgs
The Service this Route is associated to. This is where the Route proxies traffic to.
snis Sequence[str]
A list of SNIs that match this Route when using stream routing.
sources Sequence[GatewayRouteSourceArgs]
A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
strip_path bool
When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.
tags Sequence[str]
An optional set of strings associated with the Route for grouping and filtering.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
destinations List<Property Map>
A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
gatewayRouteId String
The ID of this resource.
headers Map<List<String>>
One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.
hosts List<String>
A list of domain names that match this Route. Note that the hosts value is case sensitive.
httpsRedirectStatusCode Number
The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol. must be one of ["426", "301", "302", "307", "308"]
methods List<String>
A list of HTTP methods that match this Route.
name String
The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".
pathHandling String
Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior. must be one of ["v0", "v1"]
paths List<String>
A list of paths that match this Route.
preserveHost Boolean
When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.
protocols List<String>
An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.
regexPriority Number
A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).
requestBuffering Boolean
Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.
responseBuffering Boolean
Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.
service Property Map
The Service this Route is associated to. This is where the Route proxies traffic to.
snis List<String>
A list of SNIs that match this Route when using stream routing.
sources List<Property Map>
A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
stripPath Boolean
When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.
tags List<String>
An optional set of strings associated with the Route for grouping and filtering.

Outputs

All input properties are implicitly available as output properties. Additionally, the GatewayRoute resource produces the following output properties:

CreatedAt double
Unix epoch when the resource was created.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt double
Unix epoch when the resource was last updated.
CreatedAt float64
Unix epoch when the resource was created.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt float64
Unix epoch when the resource was last updated.
createdAt Double
Unix epoch when the resource was created.
id String
The provider-assigned unique ID for this managed resource.
updatedAt Double
Unix epoch when the resource was last updated.
createdAt number
Unix epoch when the resource was created.
id string
The provider-assigned unique ID for this managed resource.
updatedAt number
Unix epoch when the resource was last updated.
created_at float
Unix epoch when the resource was created.
id str
The provider-assigned unique ID for this managed resource.
updated_at float
Unix epoch when the resource was last updated.
createdAt Number
Unix epoch when the resource was created.
id String
The provider-assigned unique ID for this managed resource.
updatedAt Number
Unix epoch when the resource was last updated.

Look up Existing GatewayRoute Resource

Get an existing GatewayRoute resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GatewayRouteState, opts?: CustomResourceOptions): GatewayRoute
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        destinations: Optional[Sequence[GatewayRouteDestinationArgs]] = None,
        gateway_route_id: Optional[str] = None,
        headers: Optional[Mapping[str, Sequence[str]]] = None,
        hosts: Optional[Sequence[str]] = None,
        https_redirect_status_code: Optional[float] = None,
        methods: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        path_handling: Optional[str] = None,
        paths: Optional[Sequence[str]] = None,
        preserve_host: Optional[bool] = None,
        protocols: Optional[Sequence[str]] = None,
        regex_priority: Optional[float] = None,
        request_buffering: Optional[bool] = None,
        response_buffering: Optional[bool] = None,
        service: Optional[GatewayRouteServiceArgs] = None,
        snis: Optional[Sequence[str]] = None,
        sources: Optional[Sequence[GatewayRouteSourceArgs]] = None,
        strip_path: Optional[bool] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayRoute
func GetGatewayRoute(ctx *Context, name string, id IDInput, state *GatewayRouteState, opts ...ResourceOption) (*GatewayRoute, error)
public static GatewayRoute Get(string name, Input<string> id, GatewayRouteState? state, CustomResourceOptions? opts = null)
public static GatewayRoute get(String name, Output<String> id, GatewayRouteState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayRoute    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ControlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt double
Unix epoch when the resource was created.
Destinations List<GatewayRouteDestination>
A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
GatewayRouteId string
The ID of this resource.
Headers Dictionary<string, ImmutableArray<string>>
One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.
Hosts List<string>
A list of domain names that match this Route. Note that the hosts value is case sensitive.
HttpsRedirectStatusCode double
The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol. must be one of ["426", "301", "302", "307", "308"]
Methods List<string>
A list of HTTP methods that match this Route.
Name string
The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".
PathHandling string
Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior. must be one of ["v0", "v1"]
Paths List<string>
A list of paths that match this Route.
PreserveHost bool
When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.
Protocols List<string>
An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.
RegexPriority double
A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).
RequestBuffering bool
Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.
ResponseBuffering bool
Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.
Service GatewayRouteService
The Service this Route is associated to. This is where the Route proxies traffic to.
Snis List<string>
A list of SNIs that match this Route when using stream routing.
Sources List<GatewayRouteSource>
A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
StripPath bool
When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.
Tags List<string>
An optional set of strings associated with the Route for grouping and filtering.
UpdatedAt double
Unix epoch when the resource was last updated.
ControlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt float64
Unix epoch when the resource was created.
Destinations []GatewayRouteDestinationArgs
A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
GatewayRouteId string
The ID of this resource.
Headers map[string][]string
One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.
Hosts []string
A list of domain names that match this Route. Note that the hosts value is case sensitive.
HttpsRedirectStatusCode float64
The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol. must be one of ["426", "301", "302", "307", "308"]
Methods []string
A list of HTTP methods that match this Route.
Name string
The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".
PathHandling string
Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior. must be one of ["v0", "v1"]
Paths []string
A list of paths that match this Route.
PreserveHost bool
When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.
Protocols []string
An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.
RegexPriority float64
A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).
RequestBuffering bool
Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.
ResponseBuffering bool
Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.
Service GatewayRouteServiceArgs
The Service this Route is associated to. This is where the Route proxies traffic to.
Snis []string
A list of SNIs that match this Route when using stream routing.
Sources []GatewayRouteSourceArgs
A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
StripPath bool
When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.
Tags []string
An optional set of strings associated with the Route for grouping and filtering.
UpdatedAt float64
Unix epoch when the resource was last updated.
controlPlaneId String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Double
Unix epoch when the resource was created.
destinations List<GatewayRouteDestination>
A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
gatewayRouteId String
The ID of this resource.
headers Map<String,List<String>>
One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.
hosts List<String>
A list of domain names that match this Route. Note that the hosts value is case sensitive.
httpsRedirectStatusCode Double
The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol. must be one of ["426", "301", "302", "307", "308"]
methods List<String>
A list of HTTP methods that match this Route.
name String
The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".
pathHandling String
Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior. must be one of ["v0", "v1"]
paths List<String>
A list of paths that match this Route.
preserveHost Boolean
When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.
protocols List<String>
An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.
regexPriority Double
A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).
requestBuffering Boolean
Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.
responseBuffering Boolean
Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.
service GatewayRouteService
The Service this Route is associated to. This is where the Route proxies traffic to.
snis List<String>
A list of SNIs that match this Route when using stream routing.
sources List<GatewayRouteSource>
A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
stripPath Boolean
When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.
tags List<String>
An optional set of strings associated with the Route for grouping and filtering.
updatedAt Double
Unix epoch when the resource was last updated.
controlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt number
Unix epoch when the resource was created.
destinations GatewayRouteDestination[]
A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
gatewayRouteId string
The ID of this resource.
headers {[key: string]: string[]}
One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.
hosts string[]
A list of domain names that match this Route. Note that the hosts value is case sensitive.
httpsRedirectStatusCode number
The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol. must be one of ["426", "301", "302", "307", "308"]
methods string[]
A list of HTTP methods that match this Route.
name string
The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".
pathHandling string
Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior. must be one of ["v0", "v1"]
paths string[]
A list of paths that match this Route.
preserveHost boolean
When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.
protocols string[]
An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.
regexPriority number
A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).
requestBuffering boolean
Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.
responseBuffering boolean
Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.
service GatewayRouteService
The Service this Route is associated to. This is where the Route proxies traffic to.
snis string[]
A list of SNIs that match this Route when using stream routing.
sources GatewayRouteSource[]
A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
stripPath boolean
When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.
tags string[]
An optional set of strings associated with the Route for grouping and filtering.
updatedAt number
Unix epoch when the resource was last updated.
control_plane_id str
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
created_at float
Unix epoch when the resource was created.
destinations Sequence[GatewayRouteDestinationArgs]
A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
gateway_route_id str
The ID of this resource.
headers Mapping[str, Sequence[str]]
One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.
hosts Sequence[str]
A list of domain names that match this Route. Note that the hosts value is case sensitive.
https_redirect_status_code float
The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol. must be one of ["426", "301", "302", "307", "308"]
methods Sequence[str]
A list of HTTP methods that match this Route.
name str
The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".
path_handling str
Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior. must be one of ["v0", "v1"]
paths Sequence[str]
A list of paths that match this Route.
preserve_host bool
When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.
protocols Sequence[str]
An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.
regex_priority float
A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).
request_buffering bool
Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.
response_buffering bool
Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.
service GatewayRouteServiceArgs
The Service this Route is associated to. This is where the Route proxies traffic to.
snis Sequence[str]
A list of SNIs that match this Route when using stream routing.
sources Sequence[GatewayRouteSourceArgs]
A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
strip_path bool
When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.
tags Sequence[str]
An optional set of strings associated with the Route for grouping and filtering.
updated_at float
Unix epoch when the resource was last updated.
controlPlaneId String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Number
Unix epoch when the resource was created.
destinations List<Property Map>
A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
gatewayRouteId String
The ID of this resource.
headers Map<List<String>>
One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.
hosts List<String>
A list of domain names that match this Route. Note that the hosts value is case sensitive.
httpsRedirectStatusCode Number
The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol. must be one of ["426", "301", "302", "307", "308"]
methods List<String>
A list of HTTP methods that match this Route.
name String
The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".
pathHandling String
Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior. must be one of ["v0", "v1"]
paths List<String>
A list of paths that match this Route.
preserveHost Boolean
When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.
protocols List<String>
An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.
regexPriority Number
A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).
requestBuffering Boolean
Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.
responseBuffering Boolean
Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.
service Property Map
The Service this Route is associated to. This is where the Route proxies traffic to.
snis List<String>
A list of SNIs that match this Route when using stream routing.
sources List<Property Map>
A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".
stripPath Boolean
When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.
tags List<String>
An optional set of strings associated with the Route for grouping and filtering.
updatedAt Number
Unix epoch when the resource was last updated.

Supporting Types

GatewayRouteDestination
, GatewayRouteDestinationArgs

Ip string
Port double
Ip string
Port float64
ip String
port Double
ip string
port number
ip str
port float
ip String
port Number

GatewayRouteService
, GatewayRouteServiceArgs

Id string
Id string
id String
id string
id str
id String

GatewayRouteSource
, GatewayRouteSourceArgs

Ip string
Port double
Ip string
Port float64
ip String
port Double
ip string
port number
ip str
port float
ip String
port Number

Import

$ pulumi import konnect:index/gatewayRoute:GatewayRoute my_konnect_gateway_route "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"route_id\": \"a4326a41-aa12-44e3-93e4-6b6e58bfb9d7\"}"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect