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

konnect.GatewayRouteExpression

Explore with Pulumi AI

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

    GatewayRouteExpression Resource

    Example Usage

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

const myGatewayrouteexpression = new konnect.GatewayRouteExpression("myGatewayrouteexpression", {
    controlPlaneId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
    expression: "...my_expression...",
    httpsRedirectStatusCode: 307,
    gatewayRouteExpressionId: "...my_id...",
    pathHandling: "v0",
    preserveHost: true,
    priority: 6,
    protocols: ["http"],
    requestBuffering: false,
    responseBuffering: true,
    service: {
        id: "...my_id...",
    },
    stripPath: true,
    tags: ["..."],
});

    import pulumi
import pulumi_konnect as konnect

my_gatewayrouteexpression = konnect.GatewayRouteExpression("myGatewayrouteexpression",
    control_plane_id="9524ec7d-36d9-465d-a8c5-83a3c9390458",
    expression="...my_expression...",
    https_redirect_status_code=307,
    gateway_route_expression_id="...my_id...",
    path_handling="v0",
    preserve_host=True,
    priority=6,
    protocols=["http"],
    request_buffering=False,
    response_buffering=True,
    service={
        "id": "...my_id...",
    },
    strip_path=True,
    tags=["..."])

    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.NewGatewayRouteExpression(ctx, "myGatewayrouteexpression", &konnect.GatewayRouteExpressionArgs{
			ControlPlaneId:           pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
			Expression:               pulumi.String("...my_expression..."),
			HttpsRedirectStatusCode:  pulumi.Float64(307),
			GatewayRouteExpressionId: pulumi.String("...my_id..."),
			PathHandling:             pulumi.String("v0"),
			PreserveHost:             pulumi.Bool(true),
			Priority:                 pulumi.Float64(6),
			Protocols: pulumi.StringArray{
				pulumi.String("http"),
			},
			RequestBuffering:  pulumi.Bool(false),
			ResponseBuffering: pulumi.Bool(true),
			Service: &konnect.GatewayRouteExpressionServiceArgs{
				Id: pulumi.String("...my_id..."),
			},
			StripPath: pulumi.Bool(true),
			Tags: pulumi.StringArray{
				pulumi.String("..."),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var myGatewayrouteexpression = new Konnect.GatewayRouteExpression("myGatewayrouteexpression", new()
    {
        ControlPlaneId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
        Expression = "...my_expression...",
        HttpsRedirectStatusCode = 307,
        GatewayRouteExpressionId = "...my_id...",
        PathHandling = "v0",
        PreserveHost = true,
        Priority = 6,
        Protocols = new[]
        {
            "http",
        },
        RequestBuffering = false,
        ResponseBuffering = true,
        Service = new Konnect.Inputs.GatewayRouteExpressionServiceArgs
        {
            Id = "...my_id...",
        },
        StripPath = true,
        Tags = new[]
        {
            "...",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayRouteExpression;
import com.pulumi.konnect.GatewayRouteExpressionArgs;
import com.pulumi.konnect.inputs.GatewayRouteExpressionServiceArgs;
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 myGatewayrouteexpression = new GatewayRouteExpression("myGatewayrouteexpression", GatewayRouteExpressionArgs.builder()
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .expression("...my_expression...")
            .httpsRedirectStatusCode(307)
            .gatewayRouteExpressionId("...my_id...")
            .pathHandling("v0")
            .preserveHost(true)
            .priority(6)
            .protocols("http")
            .requestBuffering(false)
            .responseBuffering(true)
            .service(GatewayRouteExpressionServiceArgs.builder()
                .id("...my_id...")
                .build())
            .stripPath(true)
            .tags("...")
            .build());

    }
}

    resources:
  myGatewayrouteexpression:
    type: konnect:GatewayRouteExpression
    properties:
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      expression: '...my_expression...'
      httpsRedirectStatusCode: 307
      gatewayRouteExpressionId: '...my_id...'
      pathHandling: v0
      preserveHost: true
      priority: 6
      protocols:
        - http
      requestBuffering: false
      responseBuffering: true
      service:
        id: '...my_id...'
      stripPath: true
      tags:
        - '...'

    Create GatewayRouteExpression Resource

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

    Constructor syntax

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

@overload
def GatewayRouteExpression(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           control_plane_id: Optional[str] = None,
                           expression: Optional[str] = None,
                           gateway_route_expression_id: Optional[str] = None,
                           https_redirect_status_code: Optional[float] = None,
                           name: Optional[str] = None,
                           path_handling: Optional[str] = None,
                           preserve_host: Optional[bool] = None,
                           priority: Optional[float] = None,
                           protocols: Optional[Sequence[str]] = None,
                           request_buffering: Optional[bool] = None,
                           response_buffering: Optional[bool] = None,
                           service: Optional[GatewayRouteExpressionServiceArgs] = None,
                           strip_path: Optional[bool] = None,
                           tags: Optional[Sequence[str]] = None)
    func NewGatewayRouteExpression(ctx *Context, name string, args GatewayRouteExpressionArgs, opts ...ResourceOption) (*GatewayRouteExpression, error)
    public GatewayRouteExpression(string name, GatewayRouteExpressionArgs args, CustomResourceOptions? opts = null)
    public GatewayRouteExpression(String name, GatewayRouteExpressionArgs args)
public GatewayRouteExpression(String name, GatewayRouteExpressionArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args GatewayRouteExpressionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GatewayRouteExpressionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GatewayRouteExpressionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayRouteExpressionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayRouteExpressionArgs
    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 gatewayRouteExpressionResource = new Konnect.GatewayRouteExpression("gatewayRouteExpressionResource", new()
{
    ControlPlaneId = "string",
    Expression = "string",
    GatewayRouteExpressionId = "string",
    HttpsRedirectStatusCode = 0,
    Name = "string",
    PathHandling = "string",
    PreserveHost = false,
    Priority = 0,
    Protocols = new[]
    {
        "string",
    },
    RequestBuffering = false,
    ResponseBuffering = false,
    Service = new Konnect.Inputs.GatewayRouteExpressionServiceArgs
    {
        Id = "string",
    },
    StripPath = false,
    Tags = new[]
    {
        "string",
    },
});

    example, err := konnect.NewGatewayRouteExpression(ctx, "gatewayRouteExpressionResource", &konnect.GatewayRouteExpressionArgs{
ControlPlaneId: pulumi.String("string"),
Expression: pulumi.String("string"),
GatewayRouteExpressionId: pulumi.String("string"),
HttpsRedirectStatusCode: pulumi.Float64(0),
Name: pulumi.String("string"),
PathHandling: pulumi.String("string"),
PreserveHost: pulumi.Bool(false),
Priority: pulumi.Float64(0),
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
RequestBuffering: pulumi.Bool(false),
ResponseBuffering: pulumi.Bool(false),
Service: &.GatewayRouteExpressionServiceArgs{
Id: pulumi.String("string"),
},
StripPath: pulumi.Bool(false),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

    var gatewayRouteExpressionResource = new GatewayRouteExpression("gatewayRouteExpressionResource", GatewayRouteExpressionArgs.builder()
    .controlPlaneId("string")
    .expression("string")
    .gatewayRouteExpressionId("string")
    .httpsRedirectStatusCode(0)
    .name("string")
    .pathHandling("string")
    .preserveHost(false)
    .priority(0)
    .protocols("string")
    .requestBuffering(false)
    .responseBuffering(false)
    .service(GatewayRouteExpressionServiceArgs.builder()
        .id("string")
        .build())
    .stripPath(false)
    .tags("string")
    .build());

    gateway_route_expression_resource = konnect.GatewayRouteExpression("gatewayRouteExpressionResource",
    control_plane_id="string",
    expression="string",
    gateway_route_expression_id="string",
    https_redirect_status_code=0,
    name="string",
    path_handling="string",
    preserve_host=False,
    priority=0,
    protocols=["string"],
    request_buffering=False,
    response_buffering=False,
    service={
        "id": "string",
    },
    strip_path=False,
    tags=["string"])

    const gatewayRouteExpressionResource = new konnect.GatewayRouteExpression("gatewayRouteExpressionResource", {
    controlPlaneId: "string",
    expression: "string",
    gatewayRouteExpressionId: "string",
    httpsRedirectStatusCode: 0,
    name: "string",
    pathHandling: "string",
    preserveHost: false,
    priority: 0,
    protocols: ["string"],
    requestBuffering: false,
    responseBuffering: false,
    service: {
        id: "string",
    },
    stripPath: false,
    tags: ["string"],
});

    type: konnect:GatewayRouteExpression
properties:
    controlPlaneId: string
    expression: string
    gatewayRouteExpressionId: string
    httpsRedirectStatusCode: 0
    name: string
    pathHandling: string
    preserveHost: false
    priority: 0
    protocols:
        - string
    requestBuffering: false
    responseBuffering: false
    service:
        id: string
    stripPath: false
    tags:
        - string

    GatewayRouteExpression 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 GatewayRouteExpression resource accepts the following input properties:

    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Expression string
    Use Router Expression to perform route match. This option is only available when router_flavor is set to expressions.
    GatewayRouteExpressionId string
    The ID of this resource.
    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"]
    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"]
    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.
    Priority double
    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.
    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 GatewayRouteExpressionService
    The Service this Route is associated to. This is where the Route proxies traffic to.
    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 string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Expression string
    Use Router Expression to perform route match. This option is only available when router_flavor is set to expressions.
    GatewayRouteExpressionId string
    The ID of this resource.
    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"]
    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"]
    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.
    Priority float64
    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.
    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 GatewayRouteExpressionServiceArgs
    The Service this Route is associated to. This is where the Route proxies traffic to.
    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 String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    expression String
    Use Router Expression to perform route match. This option is only available when router_flavor is set to expressions.
    gatewayRouteExpressionId String
    The ID of this resource.
    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"]
    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"]
    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.
    priority Double
    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.
    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 GatewayRouteExpressionService
    The Service this Route is associated to. This is where the Route proxies traffic to.
    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 string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    expression string
    Use Router Expression to perform route match. This option is only available when router_flavor is set to expressions.
    gatewayRouteExpressionId string
    The ID of this resource.
    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"]
    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"]
    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.
    priority number
    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.
    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 GatewayRouteExpressionService
    The Service this Route is associated to. This is where the Route proxies traffic to.
    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 str
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    expression str
    Use Router Expression to perform route match. This option is only available when router_flavor is set to expressions.
    gateway_route_expression_id str
    The ID of this resource.
    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"]
    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"]
    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.
    priority float
    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.
    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 GatewayRouteExpressionServiceArgs
    The Service this Route is associated to. This is where the Route proxies traffic to.
    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 String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    expression String
    Use Router Expression to perform route match. This option is only available when router_flavor is set to expressions.
    gatewayRouteExpressionId String
    The ID of this resource.
    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"]
    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"]
    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.
    priority Number
    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.
    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.
    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 GatewayRouteExpression 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 GatewayRouteExpression Resource

    Get an existing GatewayRouteExpression 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?: GatewayRouteExpressionState, opts?: CustomResourceOptions): GatewayRouteExpression
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        expression: Optional[str] = None,
        gateway_route_expression_id: Optional[str] = None,
        https_redirect_status_code: Optional[float] = None,
        name: Optional[str] = None,
        path_handling: Optional[str] = None,
        preserve_host: Optional[bool] = None,
        priority: Optional[float] = None,
        protocols: Optional[Sequence[str]] = None,
        request_buffering: Optional[bool] = None,
        response_buffering: Optional[bool] = None,
        service: Optional[GatewayRouteExpressionServiceArgs] = None,
        strip_path: Optional[bool] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayRouteExpression
    func GetGatewayRouteExpression(ctx *Context, name string, id IDInput, state *GatewayRouteExpressionState, opts ...ResourceOption) (*GatewayRouteExpression, error)
    public static GatewayRouteExpression Get(string name, Input<string> id, GatewayRouteExpressionState? state, CustomResourceOptions? opts = null)
    public static GatewayRouteExpression get(String name, Output<String> id, GatewayRouteExpressionState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayRouteExpression    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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.
    Expression string
    Use Router Expression to perform route match. This option is only available when router_flavor is set to expressions.
    GatewayRouteExpressionId string
    The ID of this resource.
    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"]
    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"]
    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.
    Priority double
    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.
    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 GatewayRouteExpressionService
    The Service this Route is associated to. This is where the Route proxies traffic to.
    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.
    Expression string
    Use Router Expression to perform route match. This option is only available when router_flavor is set to expressions.
    GatewayRouteExpressionId string
    The ID of this resource.
    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"]
    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"]
    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.
    Priority float64
    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.
    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 GatewayRouteExpressionServiceArgs
    The Service this Route is associated to. This is where the Route proxies traffic to.
    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.
    expression String
    Use Router Expression to perform route match. This option is only available when router_flavor is set to expressions.
    gatewayRouteExpressionId String
    The ID of this resource.
    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"]
    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"]
    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.
    priority Double
    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.
    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 GatewayRouteExpressionService
    The Service this Route is associated to. This is where the Route proxies traffic to.
    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.
    expression string
    Use Router Expression to perform route match. This option is only available when router_flavor is set to expressions.
    gatewayRouteExpressionId string
    The ID of this resource.
    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"]
    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"]
    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.
    priority number
    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.
    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 GatewayRouteExpressionService
    The Service this Route is associated to. This is where the Route proxies traffic to.
    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.
    expression str
    Use Router Expression to perform route match. This option is only available when router_flavor is set to expressions.
    gateway_route_expression_id str
    The ID of this resource.
    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"]
    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"]
    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.
    priority float
    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.
    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 GatewayRouteExpressionServiceArgs
    The Service this Route is associated to. This is where the Route proxies traffic to.
    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.
    expression String
    Use Router Expression to perform route match. This option is only available when router_flavor is set to expressions.
    gatewayRouteExpressionId String
    The ID of this resource.
    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"]
    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"]
    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.
    priority Number
    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.
    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.
    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

    GatewayRouteExpressionService, GatewayRouteExpressionServiceArgs

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

    Import

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

    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 logo
    konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
    kong/terraform-provider-konnect