Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayUpstream
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

konnect.GatewayUpstream

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

GatewayUpstream Resource

Example Usage

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

const myGatewayupstream = new konnect.GatewayUpstream("myGatewayupstream", {
    algorithm: "latency",
    clientCertificate: {
        id: "...my_id...",
    },
    controlPlaneId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
    createdAt: 5,
    hashFallback: "path",
    hashFallbackHeader: "...my_hash_fallback_header...",
    hashFallbackQueryArg: "...my_hash_fallback_query_arg...",
    hashFallbackUriCapture: "...my_hash_fallback_uri_capture...",
    hashOn: "header",
    hashOnCookie: "...my_hash_on_cookie...",
    hashOnCookiePath: "...my_hash_on_cookie_path...",
    hashOnHeader: "...my_hash_on_header...",
    hashOnQueryArg: "...my_hash_on_query_arg...",
    hashOnUriCapture: "...my_hash_on_uri_capture...",
    healthchecks: {
        active: {
            concurrency: 6,
            headers: {
                key: "value",
            },
            healthy: {
                httpStatuses: [0],
                interval: 8.45,
                successes: 8,
            },
            httpPath: "...my_http_path...",
            httpsSni: "...my_https_sni...",
            httpsVerifyCertificate: true,
            timeout: 9.02,
            type: "https",
            unhealthy: {
                httpFailures: 8,
                httpStatuses: [3],
                interval: 4.15,
                tcpFailures: 3,
                timeouts: 7,
            },
        },
        passive: {
            healthy: {
                httpStatuses: [0],
                successes: 8,
            },
            type: "grpcs",
            unhealthy: {
                httpFailures: 10,
                httpStatuses: [9],
                tcpFailures: 10,
                timeouts: 0,
            },
        },
        threshold: 3.63,
    },
    hostHeader: "...my_host_header...",
    gatewayUpstreamId: "...my_id...",
    slots: 0,
    tags: ["..."],
    updatedAt: 1,
    useSrvName: true,
});
Copy
import pulumi
import pulumi_konnect as konnect

my_gatewayupstream = konnect.GatewayUpstream("myGatewayupstream",
    algorithm="latency",
    client_certificate={
        "id": "...my_id...",
    },
    control_plane_id="9524ec7d-36d9-465d-a8c5-83a3c9390458",
    created_at=5,
    hash_fallback="path",
    hash_fallback_header="...my_hash_fallback_header...",
    hash_fallback_query_arg="...my_hash_fallback_query_arg...",
    hash_fallback_uri_capture="...my_hash_fallback_uri_capture...",
    hash_on="header",
    hash_on_cookie="...my_hash_on_cookie...",
    hash_on_cookie_path="...my_hash_on_cookie_path...",
    hash_on_header="...my_hash_on_header...",
    hash_on_query_arg="...my_hash_on_query_arg...",
    hash_on_uri_capture="...my_hash_on_uri_capture...",
    healthchecks={
        "active": {
            "concurrency": 6,
            "headers": {
                "key": "value",
            },
            "healthy": {
                "http_statuses": [0],
                "interval": 8.45,
                "successes": 8,
            },
            "http_path": "...my_http_path...",
            "https_sni": "...my_https_sni...",
            "https_verify_certificate": True,
            "timeout": 9.02,
            "type": "https",
            "unhealthy": {
                "http_failures": 8,
                "http_statuses": [3],
                "interval": 4.15,
                "tcp_failures": 3,
                "timeouts": 7,
            },
        },
        "passive": {
            "healthy": {
                "http_statuses": [0],
                "successes": 8,
            },
            "type": "grpcs",
            "unhealthy": {
                "http_failures": 10,
                "http_statuses": [9],
                "tcp_failures": 10,
                "timeouts": 0,
            },
        },
        "threshold": 3.63,
    },
    host_header="...my_host_header...",
    gateway_upstream_id="...my_id...",
    slots=0,
    tags=["..."],
    updated_at=1,
    use_srv_name=True)
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.NewGatewayUpstream(ctx, "myGatewayupstream", &konnect.GatewayUpstreamArgs{
			Algorithm: pulumi.String("latency"),
			ClientCertificate: &konnect.GatewayUpstreamClientCertificateArgs{
				Id: pulumi.String("...my_id..."),
			},
			ControlPlaneId:         pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
			CreatedAt:              pulumi.Float64(5),
			HashFallback:           pulumi.String("path"),
			HashFallbackHeader:     pulumi.String("...my_hash_fallback_header..."),
			HashFallbackQueryArg:   pulumi.String("...my_hash_fallback_query_arg..."),
			HashFallbackUriCapture: pulumi.String("...my_hash_fallback_uri_capture..."),
			HashOn:                 pulumi.String("header"),
			HashOnCookie:           pulumi.String("...my_hash_on_cookie..."),
			HashOnCookiePath:       pulumi.String("...my_hash_on_cookie_path..."),
			HashOnHeader:           pulumi.String("...my_hash_on_header..."),
			HashOnQueryArg:         pulumi.String("...my_hash_on_query_arg..."),
			HashOnUriCapture:       pulumi.String("...my_hash_on_uri_capture..."),
			Healthchecks: &konnect.GatewayUpstreamHealthchecksArgs{
				Active: &konnect.GatewayUpstreamHealthchecksActiveArgs{
					Concurrency: pulumi.Float64(6),
					Headers: pulumi.StringMap{
						"key": pulumi.String("value"),
					},
					Healthy: &konnect.GatewayUpstreamHealthchecksActiveHealthyArgs{
						HttpStatuses: pulumi.Float64Array{
							pulumi.Float64(0),
						},
						Interval:  pulumi.Float64(8.45),
						Successes: pulumi.Float64(8),
					},
					HttpPath:               pulumi.String("...my_http_path..."),
					HttpsSni:               pulumi.String("...my_https_sni..."),
					HttpsVerifyCertificate: pulumi.Bool(true),
					Timeout:                pulumi.Float64(9.02),
					Type:                   pulumi.String("https"),
					Unhealthy: &konnect.GatewayUpstreamHealthchecksActiveUnhealthyArgs{
						HttpFailures: pulumi.Float64(8),
						HttpStatuses: pulumi.Float64Array{
							pulumi.Float64(3),
						},
						Interval:    pulumi.Float64(4.15),
						TcpFailures: pulumi.Float64(3),
						Timeouts:    pulumi.Float64(7),
					},
				},
				Passive: &konnect.GatewayUpstreamHealthchecksPassiveArgs{
					Healthy: &konnect.GatewayUpstreamHealthchecksPassiveHealthyArgs{
						HttpStatuses: pulumi.Float64Array{
							pulumi.Float64(0),
						},
						Successes: pulumi.Float64(8),
					},
					Type: pulumi.String("grpcs"),
					Unhealthy: &konnect.GatewayUpstreamHealthchecksPassiveUnhealthyArgs{
						HttpFailures: pulumi.Float64(10),
						HttpStatuses: pulumi.Float64Array{
							pulumi.Float64(9),
						},
						TcpFailures: pulumi.Float64(10),
						Timeouts:    pulumi.Float64(0),
					},
				},
				Threshold: pulumi.Float64(3.63),
			},
			HostHeader:        pulumi.String("...my_host_header..."),
			GatewayUpstreamId: pulumi.String("...my_id..."),
			Slots:             pulumi.Float64(0),
			Tags: pulumi.StringArray{
				pulumi.String("..."),
			},
			UpdatedAt:  pulumi.Float64(1),
			UseSrvName: pulumi.Bool(true),
		})
		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 myGatewayupstream = new Konnect.GatewayUpstream("myGatewayupstream", new()
    {
        Algorithm = "latency",
        ClientCertificate = new Konnect.Inputs.GatewayUpstreamClientCertificateArgs
        {
            Id = "...my_id...",
        },
        ControlPlaneId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
        CreatedAt = 5,
        HashFallback = "path",
        HashFallbackHeader = "...my_hash_fallback_header...",
        HashFallbackQueryArg = "...my_hash_fallback_query_arg...",
        HashFallbackUriCapture = "...my_hash_fallback_uri_capture...",
        HashOn = "header",
        HashOnCookie = "...my_hash_on_cookie...",
        HashOnCookiePath = "...my_hash_on_cookie_path...",
        HashOnHeader = "...my_hash_on_header...",
        HashOnQueryArg = "...my_hash_on_query_arg...",
        HashOnUriCapture = "...my_hash_on_uri_capture...",
        Healthchecks = new Konnect.Inputs.GatewayUpstreamHealthchecksArgs
        {
            Active = new Konnect.Inputs.GatewayUpstreamHealthchecksActiveArgs
            {
                Concurrency = 6,
                Headers = 
                {
                    { "key", "value" },
                },
                Healthy = new Konnect.Inputs.GatewayUpstreamHealthchecksActiveHealthyArgs
                {
                    HttpStatuses = new[]
                    {
                        0,
                    },
                    Interval = 8.45,
                    Successes = 8,
                },
                HttpPath = "...my_http_path...",
                HttpsSni = "...my_https_sni...",
                HttpsVerifyCertificate = true,
                Timeout = 9.02,
                Type = "https",
                Unhealthy = new Konnect.Inputs.GatewayUpstreamHealthchecksActiveUnhealthyArgs
                {
                    HttpFailures = 8,
                    HttpStatuses = new[]
                    {
                        3,
                    },
                    Interval = 4.15,
                    TcpFailures = 3,
                    Timeouts = 7,
                },
            },
            Passive = new Konnect.Inputs.GatewayUpstreamHealthchecksPassiveArgs
            {
                Healthy = new Konnect.Inputs.GatewayUpstreamHealthchecksPassiveHealthyArgs
                {
                    HttpStatuses = new[]
                    {
                        0,
                    },
                    Successes = 8,
                },
                Type = "grpcs",
                Unhealthy = new Konnect.Inputs.GatewayUpstreamHealthchecksPassiveUnhealthyArgs
                {
                    HttpFailures = 10,
                    HttpStatuses = new[]
                    {
                        9,
                    },
                    TcpFailures = 10,
                    Timeouts = 0,
                },
            },
            Threshold = 3.63,
        },
        HostHeader = "...my_host_header...",
        GatewayUpstreamId = "...my_id...",
        Slots = 0,
        Tags = new[]
        {
            "...",
        },
        UpdatedAt = 1,
        UseSrvName = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayUpstream;
import com.pulumi.konnect.GatewayUpstreamArgs;
import com.pulumi.konnect.inputs.GatewayUpstreamClientCertificateArgs;
import com.pulumi.konnect.inputs.GatewayUpstreamHealthchecksArgs;
import com.pulumi.konnect.inputs.GatewayUpstreamHealthchecksActiveArgs;
import com.pulumi.konnect.inputs.GatewayUpstreamHealthchecksActiveHealthyArgs;
import com.pulumi.konnect.inputs.GatewayUpstreamHealthchecksActiveUnhealthyArgs;
import com.pulumi.konnect.inputs.GatewayUpstreamHealthchecksPassiveArgs;
import com.pulumi.konnect.inputs.GatewayUpstreamHealthchecksPassiveHealthyArgs;
import com.pulumi.konnect.inputs.GatewayUpstreamHealthchecksPassiveUnhealthyArgs;
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 myGatewayupstream = new GatewayUpstream("myGatewayupstream", GatewayUpstreamArgs.builder()
            .algorithm("latency")
            .clientCertificate(GatewayUpstreamClientCertificateArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .createdAt(5)
            .hashFallback("path")
            .hashFallbackHeader("...my_hash_fallback_header...")
            .hashFallbackQueryArg("...my_hash_fallback_query_arg...")
            .hashFallbackUriCapture("...my_hash_fallback_uri_capture...")
            .hashOn("header")
            .hashOnCookie("...my_hash_on_cookie...")
            .hashOnCookiePath("...my_hash_on_cookie_path...")
            .hashOnHeader("...my_hash_on_header...")
            .hashOnQueryArg("...my_hash_on_query_arg...")
            .hashOnUriCapture("...my_hash_on_uri_capture...")
            .healthchecks(GatewayUpstreamHealthchecksArgs.builder()
                .active(GatewayUpstreamHealthchecksActiveArgs.builder()
                    .concurrency(6)
                    .headers(Map.of("key", "value"))
                    .healthy(GatewayUpstreamHealthchecksActiveHealthyArgs.builder()
                        .httpStatuses(0)
                        .interval(8.45)
                        .successes(8)
                        .build())
                    .httpPath("...my_http_path...")
                    .httpsSni("...my_https_sni...")
                    .httpsVerifyCertificate(true)
                    .timeout(9.02)
                    .type("https")
                    .unhealthy(GatewayUpstreamHealthchecksActiveUnhealthyArgs.builder()
                        .httpFailures(8)
                        .httpStatuses(3)
                        .interval(4.15)
                        .tcpFailures(3)
                        .timeouts(7)
                        .build())
                    .build())
                .passive(GatewayUpstreamHealthchecksPassiveArgs.builder()
                    .healthy(GatewayUpstreamHealthchecksPassiveHealthyArgs.builder()
                        .httpStatuses(0)
                        .successes(8)
                        .build())
                    .type("grpcs")
                    .unhealthy(GatewayUpstreamHealthchecksPassiveUnhealthyArgs.builder()
                        .httpFailures(10)
                        .httpStatuses(9)
                        .tcpFailures(10)
                        .timeouts(0)
                        .build())
                    .build())
                .threshold(3.63)
                .build())
            .hostHeader("...my_host_header...")
            .gatewayUpstreamId("...my_id...")
            .slots(0)
            .tags("...")
            .updatedAt(1)
            .useSrvName(true)
            .build());

    }
}
Copy
resources:
  myGatewayupstream:
    type: konnect:GatewayUpstream
    properties:
      algorithm: latency
      clientCertificate:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      createdAt: 5
      hashFallback: path
      hashFallbackHeader: '...my_hash_fallback_header...'
      hashFallbackQueryArg: '...my_hash_fallback_query_arg...'
      hashFallbackUriCapture: '...my_hash_fallback_uri_capture...'
      hashOn: header
      hashOnCookie: '...my_hash_on_cookie...'
      hashOnCookiePath: '...my_hash_on_cookie_path...'
      hashOnHeader: '...my_hash_on_header...'
      hashOnQueryArg: '...my_hash_on_query_arg...'
      hashOnUriCapture: '...my_hash_on_uri_capture...'
      healthchecks:
        active:
          concurrency: 6
          headers:
            key: value
          healthy:
            httpStatuses:
              - 0
            interval: 8.45
            successes: 8
          httpPath: '...my_http_path...'
          httpsSni: '...my_https_sni...'
          httpsVerifyCertificate: true
          timeout: 9.02
          type: https
          unhealthy:
            httpFailures: 8
            httpStatuses:
              - 3
            interval: 4.15
            tcpFailures: 3
            timeouts: 7
        passive:
          healthy:
            httpStatuses:
              - 0
            successes: 8
          type: grpcs
          unhealthy:
            httpFailures: 10
            httpStatuses:
              - 9
            tcpFailures: 10
            timeouts: 0
        threshold: 3.63
      hostHeader: '...my_host_header...'
      gatewayUpstreamId: '...my_id...'
      slots: 0
      tags:
        - '...'
      updatedAt: 1
      useSrvName: true
Copy

Create GatewayUpstream Resource

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

Constructor syntax

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

@overload
def GatewayUpstream(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    control_plane_id: Optional[str] = None,
                    hash_on_cookie: Optional[str] = None,
                    hash_on_header: Optional[str] = None,
                    created_at: Optional[float] = None,
                    gateway_upstream_id: Optional[str] = None,
                    hash_fallback: Optional[str] = None,
                    hash_fallback_header: Optional[str] = None,
                    hash_fallback_query_arg: Optional[str] = None,
                    hash_fallback_uri_capture: Optional[str] = None,
                    hash_on: Optional[str] = None,
                    algorithm: Optional[str] = None,
                    client_certificate: Optional[GatewayUpstreamClientCertificateArgs] = None,
                    hash_on_query_arg: Optional[str] = None,
                    hash_on_cookie_path: Optional[str] = None,
                    hash_on_uri_capture: Optional[str] = None,
                    healthchecks: Optional[GatewayUpstreamHealthchecksArgs] = None,
                    host_header: Optional[str] = None,
                    name: Optional[str] = None,
                    slots: Optional[float] = None,
                    tags: Optional[Sequence[str]] = None,
                    updated_at: Optional[float] = None,
                    use_srv_name: Optional[bool] = None)
func NewGatewayUpstream(ctx *Context, name string, args GatewayUpstreamArgs, opts ...ResourceOption) (*GatewayUpstream, error)
public GatewayUpstream(string name, GatewayUpstreamArgs args, CustomResourceOptions? opts = null)
public GatewayUpstream(String name, GatewayUpstreamArgs args)
public GatewayUpstream(String name, GatewayUpstreamArgs args, CustomResourceOptions options)

type: konnect:GatewayUpstream
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. GatewayUpstreamArgs
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. GatewayUpstreamArgs
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. GatewayUpstreamArgs
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. GatewayUpstreamArgs
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. GatewayUpstreamArgs
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 gatewayUpstreamResource = new Konnect.GatewayUpstream("gatewayUpstreamResource", new()
{
    ControlPlaneId = "string",
    HashOnCookie = "string",
    HashOnHeader = "string",
    CreatedAt = 0,
    GatewayUpstreamId = "string",
    HashFallback = "string",
    HashFallbackHeader = "string",
    HashFallbackQueryArg = "string",
    HashFallbackUriCapture = "string",
    HashOn = "string",
    Algorithm = "string",
    ClientCertificate = new Konnect.Inputs.GatewayUpstreamClientCertificateArgs
    {
        Id = "string",
    },
    HashOnQueryArg = "string",
    HashOnCookiePath = "string",
    HashOnUriCapture = "string",
    Healthchecks = new Konnect.Inputs.GatewayUpstreamHealthchecksArgs
    {
        Active = new Konnect.Inputs.GatewayUpstreamHealthchecksActiveArgs
        {
            Concurrency = 0,
            Headers = 
            {
                { "string", "string" },
            },
            Healthy = new Konnect.Inputs.GatewayUpstreamHealthchecksActiveHealthyArgs
            {
                HttpStatuses = new[]
                {
                    0,
                },
                Interval = 0,
                Successes = 0,
            },
            HttpPath = "string",
            HttpsSni = "string",
            HttpsVerifyCertificate = false,
            Timeout = 0,
            Type = "string",
            Unhealthy = new Konnect.Inputs.GatewayUpstreamHealthchecksActiveUnhealthyArgs
            {
                HttpFailures = 0,
                HttpStatuses = new[]
                {
                    0,
                },
                Interval = 0,
                TcpFailures = 0,
                Timeouts = 0,
            },
        },
        Passive = new Konnect.Inputs.GatewayUpstreamHealthchecksPassiveArgs
        {
            Healthy = new Konnect.Inputs.GatewayUpstreamHealthchecksPassiveHealthyArgs
            {
                HttpStatuses = new[]
                {
                    0,
                },
                Successes = 0,
            },
            Type = "string",
            Unhealthy = new Konnect.Inputs.GatewayUpstreamHealthchecksPassiveUnhealthyArgs
            {
                HttpFailures = 0,
                HttpStatuses = new[]
                {
                    0,
                },
                TcpFailures = 0,
                Timeouts = 0,
            },
        },
        Threshold = 0,
    },
    HostHeader = "string",
    Name = "string",
    Slots = 0,
    Tags = new[]
    {
        "string",
    },
    UpdatedAt = 0,
    UseSrvName = false,
});
Copy
example, err := konnect.NewGatewayUpstream(ctx, "gatewayUpstreamResource", &konnect.GatewayUpstreamArgs{
ControlPlaneId: pulumi.String("string"),
HashOnCookie: pulumi.String("string"),
HashOnHeader: pulumi.String("string"),
CreatedAt: pulumi.Float64(0),
GatewayUpstreamId: pulumi.String("string"),
HashFallback: pulumi.String("string"),
HashFallbackHeader: pulumi.String("string"),
HashFallbackQueryArg: pulumi.String("string"),
HashFallbackUriCapture: pulumi.String("string"),
HashOn: pulumi.String("string"),
Algorithm: pulumi.String("string"),
ClientCertificate: &.GatewayUpstreamClientCertificateArgs{
Id: pulumi.String("string"),
},
HashOnQueryArg: pulumi.String("string"),
HashOnCookiePath: pulumi.String("string"),
HashOnUriCapture: pulumi.String("string"),
Healthchecks: &.GatewayUpstreamHealthchecksArgs{
Active: &.GatewayUpstreamHealthchecksActiveArgs{
Concurrency: pulumi.Float64(0),
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
Healthy: &.GatewayUpstreamHealthchecksActiveHealthyArgs{
HttpStatuses: pulumi.Float64Array{
pulumi.Float64(0),
},
Interval: pulumi.Float64(0),
Successes: pulumi.Float64(0),
},
HttpPath: pulumi.String("string"),
HttpsSni: pulumi.String("string"),
HttpsVerifyCertificate: pulumi.Bool(false),
Timeout: pulumi.Float64(0),
Type: pulumi.String("string"),
Unhealthy: &.GatewayUpstreamHealthchecksActiveUnhealthyArgs{
HttpFailures: pulumi.Float64(0),
HttpStatuses: pulumi.Float64Array{
pulumi.Float64(0),
},
Interval: pulumi.Float64(0),
TcpFailures: pulumi.Float64(0),
Timeouts: pulumi.Float64(0),
},
},
Passive: &.GatewayUpstreamHealthchecksPassiveArgs{
Healthy: &.GatewayUpstreamHealthchecksPassiveHealthyArgs{
HttpStatuses: pulumi.Float64Array{
pulumi.Float64(0),
},
Successes: pulumi.Float64(0),
},
Type: pulumi.String("string"),
Unhealthy: &.GatewayUpstreamHealthchecksPassiveUnhealthyArgs{
HttpFailures: pulumi.Float64(0),
HttpStatuses: pulumi.Float64Array{
pulumi.Float64(0),
},
TcpFailures: pulumi.Float64(0),
Timeouts: pulumi.Float64(0),
},
},
Threshold: pulumi.Float64(0),
},
HostHeader: pulumi.String("string"),
Name: pulumi.String("string"),
Slots: pulumi.Float64(0),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
UpdatedAt: pulumi.Float64(0),
UseSrvName: pulumi.Bool(false),
})
Copy
var gatewayUpstreamResource = new GatewayUpstream("gatewayUpstreamResource", GatewayUpstreamArgs.builder()
    .controlPlaneId("string")
    .hashOnCookie("string")
    .hashOnHeader("string")
    .createdAt(0)
    .gatewayUpstreamId("string")
    .hashFallback("string")
    .hashFallbackHeader("string")
    .hashFallbackQueryArg("string")
    .hashFallbackUriCapture("string")
    .hashOn("string")
    .algorithm("string")
    .clientCertificate(GatewayUpstreamClientCertificateArgs.builder()
        .id("string")
        .build())
    .hashOnQueryArg("string")
    .hashOnCookiePath("string")
    .hashOnUriCapture("string")
    .healthchecks(GatewayUpstreamHealthchecksArgs.builder()
        .active(GatewayUpstreamHealthchecksActiveArgs.builder()
            .concurrency(0)
            .headers(Map.of("string", "string"))
            .healthy(GatewayUpstreamHealthchecksActiveHealthyArgs.builder()
                .httpStatuses(0)
                .interval(0)
                .successes(0)
                .build())
            .httpPath("string")
            .httpsSni("string")
            .httpsVerifyCertificate(false)
            .timeout(0)
            .type("string")
            .unhealthy(GatewayUpstreamHealthchecksActiveUnhealthyArgs.builder()
                .httpFailures(0)
                .httpStatuses(0)
                .interval(0)
                .tcpFailures(0)
                .timeouts(0)
                .build())
            .build())
        .passive(GatewayUpstreamHealthchecksPassiveArgs.builder()
            .healthy(GatewayUpstreamHealthchecksPassiveHealthyArgs.builder()
                .httpStatuses(0)
                .successes(0)
                .build())
            .type("string")
            .unhealthy(GatewayUpstreamHealthchecksPassiveUnhealthyArgs.builder()
                .httpFailures(0)
                .httpStatuses(0)
                .tcpFailures(0)
                .timeouts(0)
                .build())
            .build())
        .threshold(0)
        .build())
    .hostHeader("string")
    .name("string")
    .slots(0)
    .tags("string")
    .updatedAt(0)
    .useSrvName(false)
    .build());
Copy
gateway_upstream_resource = konnect.GatewayUpstream("gatewayUpstreamResource",
    control_plane_id="string",
    hash_on_cookie="string",
    hash_on_header="string",
    created_at=0,
    gateway_upstream_id="string",
    hash_fallback="string",
    hash_fallback_header="string",
    hash_fallback_query_arg="string",
    hash_fallback_uri_capture="string",
    hash_on="string",
    algorithm="string",
    client_certificate={
        "id": "string",
    },
    hash_on_query_arg="string",
    hash_on_cookie_path="string",
    hash_on_uri_capture="string",
    healthchecks={
        "active": {
            "concurrency": 0,
            "headers": {
                "string": "string",
            },
            "healthy": {
                "http_statuses": [0],
                "interval": 0,
                "successes": 0,
            },
            "http_path": "string",
            "https_sni": "string",
            "https_verify_certificate": False,
            "timeout": 0,
            "type": "string",
            "unhealthy": {
                "http_failures": 0,
                "http_statuses": [0],
                "interval": 0,
                "tcp_failures": 0,
                "timeouts": 0,
            },
        },
        "passive": {
            "healthy": {
                "http_statuses": [0],
                "successes": 0,
            },
            "type": "string",
            "unhealthy": {
                "http_failures": 0,
                "http_statuses": [0],
                "tcp_failures": 0,
                "timeouts": 0,
            },
        },
        "threshold": 0,
    },
    host_header="string",
    name="string",
    slots=0,
    tags=["string"],
    updated_at=0,
    use_srv_name=False)
Copy
const gatewayUpstreamResource = new konnect.GatewayUpstream("gatewayUpstreamResource", {
    controlPlaneId: "string",
    hashOnCookie: "string",
    hashOnHeader: "string",
    createdAt: 0,
    gatewayUpstreamId: "string",
    hashFallback: "string",
    hashFallbackHeader: "string",
    hashFallbackQueryArg: "string",
    hashFallbackUriCapture: "string",
    hashOn: "string",
    algorithm: "string",
    clientCertificate: {
        id: "string",
    },
    hashOnQueryArg: "string",
    hashOnCookiePath: "string",
    hashOnUriCapture: "string",
    healthchecks: {
        active: {
            concurrency: 0,
            headers: {
                string: "string",
            },
            healthy: {
                httpStatuses: [0],
                interval: 0,
                successes: 0,
            },
            httpPath: "string",
            httpsSni: "string",
            httpsVerifyCertificate: false,
            timeout: 0,
            type: "string",
            unhealthy: {
                httpFailures: 0,
                httpStatuses: [0],
                interval: 0,
                tcpFailures: 0,
                timeouts: 0,
            },
        },
        passive: {
            healthy: {
                httpStatuses: [0],
                successes: 0,
            },
            type: "string",
            unhealthy: {
                httpFailures: 0,
                httpStatuses: [0],
                tcpFailures: 0,
                timeouts: 0,
            },
        },
        threshold: 0,
    },
    hostHeader: "string",
    name: "string",
    slots: 0,
    tags: ["string"],
    updatedAt: 0,
    useSrvName: false,
});
Copy
type: konnect:GatewayUpstream
properties:
    algorithm: string
    clientCertificate:
        id: string
    controlPlaneId: string
    createdAt: 0
    gatewayUpstreamId: string
    hashFallback: string
    hashFallbackHeader: string
    hashFallbackQueryArg: string
    hashFallbackUriCapture: string
    hashOn: string
    hashOnCookie: string
    hashOnCookiePath: string
    hashOnHeader: string
    hashOnQueryArg: string
    hashOnUriCapture: string
    healthchecks:
        active:
            concurrency: 0
            headers:
                string: string
            healthy:
                httpStatuses:
                    - 0
                interval: 0
                successes: 0
            httpPath: string
            httpsSni: string
            httpsVerifyCertificate: false
            timeout: 0
            type: string
            unhealthy:
                httpFailures: 0
                httpStatuses:
                    - 0
                interval: 0
                tcpFailures: 0
                timeouts: 0
        passive:
            healthy:
                httpStatuses:
                    - 0
                successes: 0
            type: string
            unhealthy:
                httpFailures: 0
                httpStatuses:
                    - 0
                tcpFailures: 0
                timeouts: 0
        threshold: 0
    hostHeader: string
    name: string
    slots: 0
    tags:
        - string
    updatedAt: 0
    useSrvName: false
Copy

GatewayUpstream 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 GatewayUpstream 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.
Algorithm string
Which load balancing algorithm to use. must be one of ["consistent-hashing", "least-connections", "round-robin", "latency"]
ClientCertificate GatewayUpstreamClientCertificate
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
CreatedAt double
Unix epoch when the resource was created.
GatewayUpstreamId string
The ID of this resource.
HashFallback string
What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
HashFallbackHeader string
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
HashFallbackQueryArg string
The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.
HashFallbackUriCapture string
The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.
HashOn string
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
HashOnCookie string
The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
HashOnCookiePath string
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.
HashOnHeader string
The header name to take the value from as hash input. Only required when hash_on is set to header.
HashOnQueryArg string
The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.
HashOnUriCapture string
The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.
Healthchecks GatewayUpstreamHealthchecks
HostHeader string
The hostname to be used as Host header when proxying requests through Kong.
Name string
This is a hostname, which must be equal to the host of a Service.
Slots double
The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.
Tags List<string>
An optional set of strings associated with the Upstream for grouping and filtering.
UpdatedAt double
Unix epoch when the resource was last updated.
UseSrvName bool
If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Algorithm string
Which load balancing algorithm to use. must be one of ["consistent-hashing", "least-connections", "round-robin", "latency"]
ClientCertificate GatewayUpstreamClientCertificateArgs
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
CreatedAt float64
Unix epoch when the resource was created.
GatewayUpstreamId string
The ID of this resource.
HashFallback string
What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
HashFallbackHeader string
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
HashFallbackQueryArg string
The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.
HashFallbackUriCapture string
The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.
HashOn string
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
HashOnCookie string
The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
HashOnCookiePath string
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.
HashOnHeader string
The header name to take the value from as hash input. Only required when hash_on is set to header.
HashOnQueryArg string
The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.
HashOnUriCapture string
The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.
Healthchecks GatewayUpstreamHealthchecksArgs
HostHeader string
The hostname to be used as Host header when proxying requests through Kong.
Name string
This is a hostname, which must be equal to the host of a Service.
Slots float64
The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.
Tags []string
An optional set of strings associated with the Upstream for grouping and filtering.
UpdatedAt float64
Unix epoch when the resource was last updated.
UseSrvName bool
If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
algorithm String
Which load balancing algorithm to use. must be one of ["consistent-hashing", "least-connections", "round-robin", "latency"]
clientCertificate GatewayUpstreamClientCertificate
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
createdAt Double
Unix epoch when the resource was created.
gatewayUpstreamId String
The ID of this resource.
hashFallback String
What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hashFallbackHeader String
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
hashFallbackQueryArg String
The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.
hashFallbackUriCapture String
The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.
hashOn String
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hashOnCookie String
The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
hashOnCookiePath String
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.
hashOnHeader String
The header name to take the value from as hash input. Only required when hash_on is set to header.
hashOnQueryArg String
The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.
hashOnUriCapture String
The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.
healthchecks GatewayUpstreamHealthchecks
hostHeader String
The hostname to be used as Host header when proxying requests through Kong.
name String
This is a hostname, which must be equal to the host of a Service.
slots Double
The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.
tags List<String>
An optional set of strings associated with the Upstream for grouping and filtering.
updatedAt Double
Unix epoch when the resource was last updated.
useSrvName Boolean
If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
algorithm string
Which load balancing algorithm to use. must be one of ["consistent-hashing", "least-connections", "round-robin", "latency"]
clientCertificate GatewayUpstreamClientCertificate
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
createdAt number
Unix epoch when the resource was created.
gatewayUpstreamId string
The ID of this resource.
hashFallback string
What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hashFallbackHeader string
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
hashFallbackQueryArg string
The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.
hashFallbackUriCapture string
The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.
hashOn string
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hashOnCookie string
The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
hashOnCookiePath string
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.
hashOnHeader string
The header name to take the value from as hash input. Only required when hash_on is set to header.
hashOnQueryArg string
The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.
hashOnUriCapture string
The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.
healthchecks GatewayUpstreamHealthchecks
hostHeader string
The hostname to be used as Host header when proxying requests through Kong.
name string
This is a hostname, which must be equal to the host of a Service.
slots number
The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.
tags string[]
An optional set of strings associated with the Upstream for grouping and filtering.
updatedAt number
Unix epoch when the resource was last updated.
useSrvName boolean
If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.
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.
algorithm str
Which load balancing algorithm to use. must be one of ["consistent-hashing", "least-connections", "round-robin", "latency"]
client_certificate GatewayUpstreamClientCertificateArgs
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
created_at float
Unix epoch when the resource was created.
gateway_upstream_id str
The ID of this resource.
hash_fallback str
What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hash_fallback_header str
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
hash_fallback_query_arg str
The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.
hash_fallback_uri_capture str
The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.
hash_on str
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hash_on_cookie str
The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
hash_on_cookie_path str
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.
hash_on_header str
The header name to take the value from as hash input. Only required when hash_on is set to header.
hash_on_query_arg str
The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.
hash_on_uri_capture str
The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.
healthchecks GatewayUpstreamHealthchecksArgs
host_header str
The hostname to be used as Host header when proxying requests through Kong.
name str
This is a hostname, which must be equal to the host of a Service.
slots float
The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.
tags Sequence[str]
An optional set of strings associated with the Upstream for grouping and filtering.
updated_at float
Unix epoch when the resource was last updated.
use_srv_name bool
If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
algorithm String
Which load balancing algorithm to use. must be one of ["consistent-hashing", "least-connections", "round-robin", "latency"]
clientCertificate Property Map
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
createdAt Number
Unix epoch when the resource was created.
gatewayUpstreamId String
The ID of this resource.
hashFallback String
What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hashFallbackHeader String
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
hashFallbackQueryArg String
The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.
hashFallbackUriCapture String
The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.
hashOn String
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hashOnCookie String
The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
hashOnCookiePath String
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.
hashOnHeader String
The header name to take the value from as hash input. Only required when hash_on is set to header.
hashOnQueryArg String
The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.
hashOnUriCapture String
The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.
healthchecks Property Map
hostHeader String
The hostname to be used as Host header when proxying requests through Kong.
name String
This is a hostname, which must be equal to the host of a Service.
slots Number
The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.
tags List<String>
An optional set of strings associated with the Upstream for grouping and filtering.
updatedAt Number
Unix epoch when the resource was last updated.
useSrvName Boolean
If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing GatewayUpstream Resource

Get an existing GatewayUpstream 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?: GatewayUpstreamState, opts?: CustomResourceOptions): GatewayUpstream
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        algorithm: Optional[str] = None,
        client_certificate: Optional[GatewayUpstreamClientCertificateArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        gateway_upstream_id: Optional[str] = None,
        hash_fallback: Optional[str] = None,
        hash_fallback_header: Optional[str] = None,
        hash_fallback_query_arg: Optional[str] = None,
        hash_fallback_uri_capture: Optional[str] = None,
        hash_on: Optional[str] = None,
        hash_on_cookie: Optional[str] = None,
        hash_on_cookie_path: Optional[str] = None,
        hash_on_header: Optional[str] = None,
        hash_on_query_arg: Optional[str] = None,
        hash_on_uri_capture: Optional[str] = None,
        healthchecks: Optional[GatewayUpstreamHealthchecksArgs] = None,
        host_header: Optional[str] = None,
        name: Optional[str] = None,
        slots: Optional[float] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None,
        use_srv_name: Optional[bool] = None) -> GatewayUpstream
func GetGatewayUpstream(ctx *Context, name string, id IDInput, state *GatewayUpstreamState, opts ...ResourceOption) (*GatewayUpstream, error)
public static GatewayUpstream Get(string name, Input<string> id, GatewayUpstreamState? state, CustomResourceOptions? opts = null)
public static GatewayUpstream get(String name, Output<String> id, GatewayUpstreamState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayUpstream    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:
Algorithm string
Which load balancing algorithm to use. must be one of ["consistent-hashing", "least-connections", "round-robin", "latency"]
ClientCertificate GatewayUpstreamClientCertificate
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
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.
GatewayUpstreamId string
The ID of this resource.
HashFallback string
What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
HashFallbackHeader string
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
HashFallbackQueryArg string
The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.
HashFallbackUriCapture string
The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.
HashOn string
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
HashOnCookie string
The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
HashOnCookiePath string
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.
HashOnHeader string
The header name to take the value from as hash input. Only required when hash_on is set to header.
HashOnQueryArg string
The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.
HashOnUriCapture string
The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.
Healthchecks GatewayUpstreamHealthchecks
HostHeader string
The hostname to be used as Host header when proxying requests through Kong.
Name string
This is a hostname, which must be equal to the host of a Service.
Slots double
The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.
Tags List<string>
An optional set of strings associated with the Upstream for grouping and filtering.
UpdatedAt double
Unix epoch when the resource was last updated.
UseSrvName bool
If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.
Algorithm string
Which load balancing algorithm to use. must be one of ["consistent-hashing", "least-connections", "round-robin", "latency"]
ClientCertificate GatewayUpstreamClientCertificateArgs
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
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.
GatewayUpstreamId string
The ID of this resource.
HashFallback string
What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
HashFallbackHeader string
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
HashFallbackQueryArg string
The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.
HashFallbackUriCapture string
The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.
HashOn string
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
HashOnCookie string
The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
HashOnCookiePath string
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.
HashOnHeader string
The header name to take the value from as hash input. Only required when hash_on is set to header.
HashOnQueryArg string
The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.
HashOnUriCapture string
The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.
Healthchecks GatewayUpstreamHealthchecksArgs
HostHeader string
The hostname to be used as Host header when proxying requests through Kong.
Name string
This is a hostname, which must be equal to the host of a Service.
Slots float64
The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.
Tags []string
An optional set of strings associated with the Upstream for grouping and filtering.
UpdatedAt float64
Unix epoch when the resource was last updated.
UseSrvName bool
If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.
algorithm String
Which load balancing algorithm to use. must be one of ["consistent-hashing", "least-connections", "round-robin", "latency"]
clientCertificate GatewayUpstreamClientCertificate
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
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.
gatewayUpstreamId String
The ID of this resource.
hashFallback String
What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hashFallbackHeader String
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
hashFallbackQueryArg String
The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.
hashFallbackUriCapture String
The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.
hashOn String
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hashOnCookie String
The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
hashOnCookiePath String
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.
hashOnHeader String
The header name to take the value from as hash input. Only required when hash_on is set to header.
hashOnQueryArg String
The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.
hashOnUriCapture String
The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.
healthchecks GatewayUpstreamHealthchecks
hostHeader String
The hostname to be used as Host header when proxying requests through Kong.
name String
This is a hostname, which must be equal to the host of a Service.
slots Double
The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.
tags List<String>
An optional set of strings associated with the Upstream for grouping and filtering.
updatedAt Double
Unix epoch when the resource was last updated.
useSrvName Boolean
If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.
algorithm string
Which load balancing algorithm to use. must be one of ["consistent-hashing", "least-connections", "round-robin", "latency"]
clientCertificate GatewayUpstreamClientCertificate
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
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.
gatewayUpstreamId string
The ID of this resource.
hashFallback string
What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hashFallbackHeader string
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
hashFallbackQueryArg string
The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.
hashFallbackUriCapture string
The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.
hashOn string
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hashOnCookie string
The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
hashOnCookiePath string
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.
hashOnHeader string
The header name to take the value from as hash input. Only required when hash_on is set to header.
hashOnQueryArg string
The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.
hashOnUriCapture string
The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.
healthchecks GatewayUpstreamHealthchecks
hostHeader string
The hostname to be used as Host header when proxying requests through Kong.
name string
This is a hostname, which must be equal to the host of a Service.
slots number
The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.
tags string[]
An optional set of strings associated with the Upstream for grouping and filtering.
updatedAt number
Unix epoch when the resource was last updated.
useSrvName boolean
If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.
algorithm str
Which load balancing algorithm to use. must be one of ["consistent-hashing", "least-connections", "round-robin", "latency"]
client_certificate GatewayUpstreamClientCertificateArgs
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
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.
gateway_upstream_id str
The ID of this resource.
hash_fallback str
What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hash_fallback_header str
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
hash_fallback_query_arg str
The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.
hash_fallback_uri_capture str
The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.
hash_on str
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hash_on_cookie str
The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
hash_on_cookie_path str
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.
hash_on_header str
The header name to take the value from as hash input. Only required when hash_on is set to header.
hash_on_query_arg str
The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.
hash_on_uri_capture str
The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.
healthchecks GatewayUpstreamHealthchecksArgs
host_header str
The hostname to be used as Host header when proxying requests through Kong.
name str
This is a hostname, which must be equal to the host of a Service.
slots float
The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.
tags Sequence[str]
An optional set of strings associated with the Upstream for grouping and filtering.
updated_at float
Unix epoch when the resource was last updated.
use_srv_name bool
If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.
algorithm String
Which load balancing algorithm to use. must be one of ["consistent-hashing", "least-connections", "round-robin", "latency"]
clientCertificate Property Map
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
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.
gatewayUpstreamId String
The ID of this resource.
hashFallback String
What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hashFallbackHeader String
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
hashFallbackQueryArg String
The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.
hashFallbackUriCapture String
The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.
hashOn String
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing. must be one of ["none", "consumer", "ip", "header", "cookie", "path", "queryarg", "uricapture"]
hashOnCookie String
The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
hashOnCookiePath String
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.
hashOnHeader String
The header name to take the value from as hash input. Only required when hash_on is set to header.
hashOnQueryArg String
The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.
hashOnUriCapture String
The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.
healthchecks Property Map
hostHeader String
The hostname to be used as Host header when proxying requests through Kong.
name String
This is a hostname, which must be equal to the host of a Service.
slots Number
The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.
tags List<String>
An optional set of strings associated with the Upstream for grouping and filtering.
updatedAt Number
Unix epoch when the resource was last updated.
useSrvName Boolean
If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.

Supporting Types

GatewayUpstreamClientCertificate
, GatewayUpstreamClientCertificateArgs

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

GatewayUpstreamHealthchecks
, GatewayUpstreamHealthchecksArgs

GatewayUpstreamHealthchecksActive
, GatewayUpstreamHealthchecksActiveArgs

Concurrency double
Headers Dictionary<string, string>
Healthy GatewayUpstreamHealthchecksActiveHealthy
HttpPath string
HttpsSni string
HttpsVerifyCertificate bool
Timeout double
Type string
must be one of ["tcp", "http", "https", "grpc", "grpcs"]
Unhealthy GatewayUpstreamHealthchecksActiveUnhealthy
Concurrency float64
Headers map[string]string
Healthy GatewayUpstreamHealthchecksActiveHealthy
HttpPath string
HttpsSni string
HttpsVerifyCertificate bool
Timeout float64
Type string
must be one of ["tcp", "http", "https", "grpc", "grpcs"]
Unhealthy GatewayUpstreamHealthchecksActiveUnhealthy
concurrency Double
headers Map<String,String>
healthy GatewayUpstreamHealthchecksActiveHealthy
httpPath String
httpsSni String
httpsVerifyCertificate Boolean
timeout Double
type String
must be one of ["tcp", "http", "https", "grpc", "grpcs"]
unhealthy GatewayUpstreamHealthchecksActiveUnhealthy
concurrency number
headers {[key: string]: string}
healthy GatewayUpstreamHealthchecksActiveHealthy
httpPath string
httpsSni string
httpsVerifyCertificate boolean
timeout number
type string
must be one of ["tcp", "http", "https", "grpc", "grpcs"]
unhealthy GatewayUpstreamHealthchecksActiveUnhealthy
concurrency Number
headers Map<String>
healthy Property Map
httpPath String
httpsSni String
httpsVerifyCertificate Boolean
timeout Number
type String
must be one of ["tcp", "http", "https", "grpc", "grpcs"]
unhealthy Property Map

GatewayUpstreamHealthchecksActiveHealthy
, GatewayUpstreamHealthchecksActiveHealthyArgs

HttpStatuses List<double>
Interval double
Successes double
HttpStatuses []float64
Interval float64
Successes float64
httpStatuses List<Double>
interval Double
successes Double
httpStatuses number[]
interval number
successes number
http_statuses Sequence[float]
interval float
successes float
httpStatuses List<Number>
interval Number
successes Number

GatewayUpstreamHealthchecksActiveUnhealthy
, GatewayUpstreamHealthchecksActiveUnhealthyArgs

HttpFailures double
HttpStatuses List<double>
Interval double
TcpFailures double
Timeouts double
HttpFailures float64
HttpStatuses []float64
Interval float64
TcpFailures float64
Timeouts float64
httpFailures Double
httpStatuses List<Double>
interval Double
tcpFailures Double
timeouts Double
httpFailures number
httpStatuses number[]
interval number
tcpFailures number
timeouts number
http_failures float
http_statuses Sequence[float]
interval float
tcp_failures float
timeouts float
httpFailures Number
httpStatuses List<Number>
interval Number
tcpFailures Number
timeouts Number

GatewayUpstreamHealthchecksPassive
, GatewayUpstreamHealthchecksPassiveArgs

healthy Property Map
type String
must be one of ["tcp", "http", "https", "grpc", "grpcs"]
unhealthy Property Map

GatewayUpstreamHealthchecksPassiveHealthy
, GatewayUpstreamHealthchecksPassiveHealthyArgs

HttpStatuses List<double>
Successes double
HttpStatuses []float64
Successes float64
httpStatuses List<Double>
successes Double
httpStatuses number[]
successes number
http_statuses Sequence[float]
successes float
httpStatuses List<Number>
successes Number

GatewayUpstreamHealthchecksPassiveUnhealthy
, GatewayUpstreamHealthchecksPassiveUnhealthyArgs

HttpFailures double
HttpStatuses List<double>
TcpFailures double
Timeouts double
HttpFailures float64
HttpStatuses []float64
TcpFailures float64
Timeouts float64
httpFailures Double
httpStatuses List<Double>
tcpFailures Double
timeouts Double
httpFailures number
httpStatuses number[]
tcpFailures number
timeouts number
http_failures float
http_statuses Sequence[float]
tcp_failures float
timeouts float
httpFailures Number
httpStatuses List<Number>
tcpFailures Number
timeouts Number

Import

$ pulumi import konnect:index/gatewayUpstream:GatewayUpstream my_konnect_gateway_upstream "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"id\": \"426d620c-7058-4ae6-aacc-f85a3204a2c5\"}"
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.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect