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

konnect.GatewayService

Explore with Pulumi AI

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

    GatewayService Resource

    Example Usage

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

const myGatewayservice = new konnect.GatewayService("myGatewayservice", {
    caCertificates: ["..."],
    clientCertificate: {
        id: "...my_id...",
    },
    connectTimeout: 9,
    controlPlaneId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
    enabled: true,
    host: "...my_host...",
    gatewayServiceId: "...my_id...",
    path: "...my_path...",
    port: 2,
    protocol: "tls",
    readTimeout: 5,
    retries: 3,
    tags: ["..."],
    tlsVerify: true,
    tlsVerifyDepth: 8,
    writeTimeout: 9,
});

    import pulumi
import pulumi_konnect as konnect

my_gatewayservice = konnect.GatewayService("myGatewayservice",
    ca_certificates=["..."],
    client_certificate={
        "id": "...my_id...",
    },
    connect_timeout=9,
    control_plane_id="9524ec7d-36d9-465d-a8c5-83a3c9390458",
    enabled=True,
    host="...my_host...",
    gateway_service_id="...my_id...",
    path="...my_path...",
    port=2,
    protocol="tls",
    read_timeout=5,
    retries=3,
    tags=["..."],
    tls_verify=True,
    tls_verify_depth=8,
    write_timeout=9)

    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.NewGatewayService(ctx, "myGatewayservice", &konnect.GatewayServiceArgs{
			CaCertificates: pulumi.StringArray{
				pulumi.String("..."),
			},
			ClientCertificate: &konnect.GatewayServiceClientCertificateArgs{
				Id: pulumi.String("...my_id..."),
			},
			ConnectTimeout:   pulumi.Float64(9),
			ControlPlaneId:   pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
			Enabled:          pulumi.Bool(true),
			Host:             pulumi.String("...my_host..."),
			GatewayServiceId: pulumi.String("...my_id..."),
			Path:             pulumi.String("...my_path..."),
			Port:             pulumi.Float64(2),
			Protocol:         pulumi.String("tls"),
			ReadTimeout:      pulumi.Float64(5),
			Retries:          pulumi.Float64(3),
			Tags: pulumi.StringArray{
				pulumi.String("..."),
			},
			TlsVerify:      pulumi.Bool(true),
			TlsVerifyDepth: pulumi.Float64(8),
			WriteTimeout:   pulumi.Float64(9),
		})
		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 myGatewayservice = new Konnect.GatewayService("myGatewayservice", new()
    {
        CaCertificates = new[]
        {
            "...",
        },
        ClientCertificate = new Konnect.Inputs.GatewayServiceClientCertificateArgs
        {
            Id = "...my_id...",
        },
        ConnectTimeout = 9,
        ControlPlaneId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
        Enabled = true,
        Host = "...my_host...",
        GatewayServiceId = "...my_id...",
        Path = "...my_path...",
        Port = 2,
        Protocol = "tls",
        ReadTimeout = 5,
        Retries = 3,
        Tags = new[]
        {
            "...",
        },
        TlsVerify = true,
        TlsVerifyDepth = 8,
        WriteTimeout = 9,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayService;
import com.pulumi.konnect.GatewayServiceArgs;
import com.pulumi.konnect.inputs.GatewayServiceClientCertificateArgs;
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 myGatewayservice = new GatewayService("myGatewayservice", GatewayServiceArgs.builder()
            .caCertificates("...")
            .clientCertificate(GatewayServiceClientCertificateArgs.builder()
                .id("...my_id...")
                .build())
            .connectTimeout(9)
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(true)
            .host("...my_host...")
            .gatewayServiceId("...my_id...")
            .path("...my_path...")
            .port(2)
            .protocol("tls")
            .readTimeout(5)
            .retries(3)
            .tags("...")
            .tlsVerify(true)
            .tlsVerifyDepth(8)
            .writeTimeout(9)
            .build());

    }
}

    resources:
  myGatewayservice:
    type: konnect:GatewayService
    properties:
      caCertificates:
        - '...'
      clientCertificate:
        id: '...my_id...'
      connectTimeout: 9
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: true
      host: '...my_host...'
      gatewayServiceId: '...my_id...'
      path: '...my_path...'
      port: 2
      protocol: tls
      readTimeout: 5
      retries: 3
      tags:
        - '...'
      tlsVerify: true
      tlsVerifyDepth: 8
      writeTimeout: 9

    Create GatewayService Resource

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

    Constructor syntax

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

@overload
def GatewayService(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   host: Optional[str] = None,
                   protocol: Optional[str] = None,
                   port: Optional[float] = None,
                   control_plane_id: Optional[str] = None,
                   path: Optional[str] = None,
                   gateway_service_id: Optional[str] = None,
                   enabled: Optional[bool] = None,
                   name: Optional[str] = None,
                   ca_certificates: Optional[Sequence[str]] = None,
                   connect_timeout: Optional[float] = None,
                   client_certificate: Optional[GatewayServiceClientCertificateArgs] = None,
                   read_timeout: Optional[float] = None,
                   retries: Optional[float] = None,
                   tags: Optional[Sequence[str]] = None,
                   tls_verify: Optional[bool] = None,
                   tls_verify_depth: Optional[float] = None,
                   write_timeout: Optional[float] = None)
    func NewGatewayService(ctx *Context, name string, args GatewayServiceArgs, opts ...ResourceOption) (*GatewayService, error)
    public GatewayService(string name, GatewayServiceArgs args, CustomResourceOptions? opts = null)
    public GatewayService(String name, GatewayServiceArgs args)
public GatewayService(String name, GatewayServiceArgs args, CustomResourceOptions options)

    type: konnect:GatewayService
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 GatewayServiceArgs
    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 GatewayServiceArgs
    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 GatewayServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayServiceArgs
    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 gatewayServiceResource = new Konnect.GatewayService("gatewayServiceResource", new()
{
    Host = "string",
    Protocol = "string",
    Port = 0,
    ControlPlaneId = "string",
    Path = "string",
    GatewayServiceId = "string",
    Enabled = false,
    Name = "string",
    CaCertificates = new[]
    {
        "string",
    },
    ConnectTimeout = 0,
    ClientCertificate = new Konnect.Inputs.GatewayServiceClientCertificateArgs
    {
        Id = "string",
    },
    ReadTimeout = 0,
    Retries = 0,
    Tags = new[]
    {
        "string",
    },
    TlsVerify = false,
    TlsVerifyDepth = 0,
    WriteTimeout = 0,
});

    example, err := konnect.NewGatewayService(ctx, "gatewayServiceResource", &konnect.GatewayServiceArgs{
Host: pulumi.String("string"),
Protocol: pulumi.String("string"),
Port: pulumi.Float64(0),
ControlPlaneId: pulumi.String("string"),
Path: pulumi.String("string"),
GatewayServiceId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
Name: pulumi.String("string"),
CaCertificates: pulumi.StringArray{
pulumi.String("string"),
},
ConnectTimeout: pulumi.Float64(0),
ClientCertificate: &.GatewayServiceClientCertificateArgs{
Id: pulumi.String("string"),
},
ReadTimeout: pulumi.Float64(0),
Retries: pulumi.Float64(0),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
TlsVerify: pulumi.Bool(false),
TlsVerifyDepth: pulumi.Float64(0),
WriteTimeout: pulumi.Float64(0),
})

    var gatewayServiceResource = new GatewayService("gatewayServiceResource", GatewayServiceArgs.builder()
    .host("string")
    .protocol("string")
    .port(0)
    .controlPlaneId("string")
    .path("string")
    .gatewayServiceId("string")
    .enabled(false)
    .name("string")
    .caCertificates("string")
    .connectTimeout(0)
    .clientCertificate(GatewayServiceClientCertificateArgs.builder()
        .id("string")
        .build())
    .readTimeout(0)
    .retries(0)
    .tags("string")
    .tlsVerify(false)
    .tlsVerifyDepth(0)
    .writeTimeout(0)
    .build());

    gateway_service_resource = konnect.GatewayService("gatewayServiceResource",
    host="string",
    protocol="string",
    port=0,
    control_plane_id="string",
    path="string",
    gateway_service_id="string",
    enabled=False,
    name="string",
    ca_certificates=["string"],
    connect_timeout=0,
    client_certificate={
        "id": "string",
    },
    read_timeout=0,
    retries=0,
    tags=["string"],
    tls_verify=False,
    tls_verify_depth=0,
    write_timeout=0)

    const gatewayServiceResource = new konnect.GatewayService("gatewayServiceResource", {
    host: "string",
    protocol: "string",
    port: 0,
    controlPlaneId: "string",
    path: "string",
    gatewayServiceId: "string",
    enabled: false,
    name: "string",
    caCertificates: ["string"],
    connectTimeout: 0,
    clientCertificate: {
        id: "string",
    },
    readTimeout: 0,
    retries: 0,
    tags: ["string"],
    tlsVerify: false,
    tlsVerifyDepth: 0,
    writeTimeout: 0,
});

    type: konnect:GatewayService
properties:
    caCertificates:
        - string
    clientCertificate:
        id: string
    connectTimeout: 0
    controlPlaneId: string
    enabled: false
    gatewayServiceId: string
    host: string
    name: string
    path: string
    port: 0
    protocol: string
    readTimeout: 0
    retries: 0
    tags:
        - string
    tlsVerify: false
    tlsVerifyDepth: 0
    writeTimeout: 0

    GatewayService 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 GatewayService 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.
    Host string
    The host of the upstream server. Note that the host value is case sensitive.
    Port double
    The upstream server port.
    Protocol string
    The protocol used to communicate with the upstream. must be one of ["grpc", "grpcs", "http", "https", "tcp", "tls", "tls_passthrough", "udp", "ws", "wss"]
    CaCertificates List<string>
    Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
    ClientCertificate GatewayServiceClientCertificate
    Certificate to be used as client certificate while TLS handshaking to the upstream server.
    ConnectTimeout double
    The timeout in milliseconds for establishing a connection to the upstream server.
    Enabled bool
    Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
    GatewayServiceId string
    The ID of this resource.
    Name string
    The Service name.
    Path string
    The path to be used in requests to the upstream server.
    ReadTimeout double
    The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
    Retries double
    The number of retries to execute upon failure to proxy.
    Tags List<string>
    An optional set of strings associated with the Service for grouping and filtering.
    TlsVerify bool
    Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
    TlsVerifyDepth double
    Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.
    WriteTimeout double
    The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Host string
    The host of the upstream server. Note that the host value is case sensitive.
    Port float64
    The upstream server port.
    Protocol string
    The protocol used to communicate with the upstream. must be one of ["grpc", "grpcs", "http", "https", "tcp", "tls", "tls_passthrough", "udp", "ws", "wss"]
    CaCertificates []string
    Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
    ClientCertificate GatewayServiceClientCertificateArgs
    Certificate to be used as client certificate while TLS handshaking to the upstream server.
    ConnectTimeout float64
    The timeout in milliseconds for establishing a connection to the upstream server.
    Enabled bool
    Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
    GatewayServiceId string
    The ID of this resource.
    Name string
    The Service name.
    Path string
    The path to be used in requests to the upstream server.
    ReadTimeout float64
    The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
    Retries float64
    The number of retries to execute upon failure to proxy.
    Tags []string
    An optional set of strings associated with the Service for grouping and filtering.
    TlsVerify bool
    Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
    TlsVerifyDepth float64
    Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.
    WriteTimeout float64
    The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    host String
    The host of the upstream server. Note that the host value is case sensitive.
    port Double
    The upstream server port.
    protocol String
    The protocol used to communicate with the upstream. must be one of ["grpc", "grpcs", "http", "https", "tcp", "tls", "tls_passthrough", "udp", "ws", "wss"]
    caCertificates List<String>
    Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
    clientCertificate GatewayServiceClientCertificate
    Certificate to be used as client certificate while TLS handshaking to the upstream server.
    connectTimeout Double
    The timeout in milliseconds for establishing a connection to the upstream server.
    enabled Boolean
    Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
    gatewayServiceId String
    The ID of this resource.
    name String
    The Service name.
    path String
    The path to be used in requests to the upstream server.
    readTimeout Double
    The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
    retries Double
    The number of retries to execute upon failure to proxy.
    tags List<String>
    An optional set of strings associated with the Service for grouping and filtering.
    tlsVerify Boolean
    Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
    tlsVerifyDepth Double
    Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.
    writeTimeout Double
    The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.
    controlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    host string
    The host of the upstream server. Note that the host value is case sensitive.
    port number
    The upstream server port.
    protocol string
    The protocol used to communicate with the upstream. must be one of ["grpc", "grpcs", "http", "https", "tcp", "tls", "tls_passthrough", "udp", "ws", "wss"]
    caCertificates string[]
    Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
    clientCertificate GatewayServiceClientCertificate
    Certificate to be used as client certificate while TLS handshaking to the upstream server.
    connectTimeout number
    The timeout in milliseconds for establishing a connection to the upstream server.
    enabled boolean
    Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
    gatewayServiceId string
    The ID of this resource.
    name string
    The Service name.
    path string
    The path to be used in requests to the upstream server.
    readTimeout number
    The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
    retries number
    The number of retries to execute upon failure to proxy.
    tags string[]
    An optional set of strings associated with the Service for grouping and filtering.
    tlsVerify boolean
    Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
    tlsVerifyDepth number
    Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.
    writeTimeout number
    The timeout in milliseconds between two successive write operations for transmitting a request 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.
    host str
    The host of the upstream server. Note that the host value is case sensitive.
    port float
    The upstream server port.
    protocol str
    The protocol used to communicate with the upstream. must be one of ["grpc", "grpcs", "http", "https", "tcp", "tls", "tls_passthrough", "udp", "ws", "wss"]
    ca_certificates Sequence[str]
    Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
    client_certificate GatewayServiceClientCertificateArgs
    Certificate to be used as client certificate while TLS handshaking to the upstream server.
    connect_timeout float
    The timeout in milliseconds for establishing a connection to the upstream server.
    enabled bool
    Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
    gateway_service_id str
    The ID of this resource.
    name str
    The Service name.
    path str
    The path to be used in requests to the upstream server.
    read_timeout float
    The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
    retries float
    The number of retries to execute upon failure to proxy.
    tags Sequence[str]
    An optional set of strings associated with the Service for grouping and filtering.
    tls_verify bool
    Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
    tls_verify_depth float
    Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.
    write_timeout float
    The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    host String
    The host of the upstream server. Note that the host value is case sensitive.
    port Number
    The upstream server port.
    protocol String
    The protocol used to communicate with the upstream. must be one of ["grpc", "grpcs", "http", "https", "tcp", "tls", "tls_passthrough", "udp", "ws", "wss"]
    caCertificates List<String>
    Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
    clientCertificate Property Map
    Certificate to be used as client certificate while TLS handshaking to the upstream server.
    connectTimeout Number
    The timeout in milliseconds for establishing a connection to the upstream server.
    enabled Boolean
    Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
    gatewayServiceId String
    The ID of this resource.
    name String
    The Service name.
    path String
    The path to be used in requests to the upstream server.
    readTimeout Number
    The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
    retries Number
    The number of retries to execute upon failure to proxy.
    tags List<String>
    An optional set of strings associated with the Service for grouping and filtering.
    tlsVerify Boolean
    Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
    tlsVerifyDepth Number
    Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.
    writeTimeout Number
    The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GatewayService 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 GatewayService Resource

    Get an existing GatewayService 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?: GatewayServiceState, opts?: CustomResourceOptions): GatewayService
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ca_certificates: Optional[Sequence[str]] = None,
        client_certificate: Optional[GatewayServiceClientCertificateArgs] = None,
        connect_timeout: Optional[float] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_service_id: Optional[str] = None,
        host: Optional[str] = None,
        name: Optional[str] = None,
        path: Optional[str] = None,
        port: Optional[float] = None,
        protocol: Optional[str] = None,
        read_timeout: Optional[float] = None,
        retries: Optional[float] = None,
        tags: Optional[Sequence[str]] = None,
        tls_verify: Optional[bool] = None,
        tls_verify_depth: Optional[float] = None,
        updated_at: Optional[float] = None,
        write_timeout: Optional[float] = None) -> GatewayService
    func GetGatewayService(ctx *Context, name string, id IDInput, state *GatewayServiceState, opts ...ResourceOption) (*GatewayService, error)
    public static GatewayService Get(string name, Input<string> id, GatewayServiceState? state, CustomResourceOptions? opts = null)
    public static GatewayService get(String name, Output<String> id, GatewayServiceState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayService    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:
    CaCertificates List<string>
    Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
    ClientCertificate GatewayServiceClientCertificate
    Certificate to be used as client certificate while TLS handshaking to the upstream server.
    ConnectTimeout double
    The timeout in milliseconds for establishing a connection 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.
    Enabled bool
    Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
    GatewayServiceId string
    The ID of this resource.
    Host string
    The host of the upstream server. Note that the host value is case sensitive.
    Name string
    The Service name.
    Path string
    The path to be used in requests to the upstream server.
    Port double
    The upstream server port.
    Protocol string
    The protocol used to communicate with the upstream. must be one of ["grpc", "grpcs", "http", "https", "tcp", "tls", "tls_passthrough", "udp", "ws", "wss"]
    ReadTimeout double
    The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
    Retries double
    The number of retries to execute upon failure to proxy.
    Tags List<string>
    An optional set of strings associated with the Service for grouping and filtering.
    TlsVerify bool
    Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
    TlsVerifyDepth double
    Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.
    UpdatedAt double
    Unix epoch when the resource was last updated.
    WriteTimeout double
    The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.
    CaCertificates []string
    Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
    ClientCertificate GatewayServiceClientCertificateArgs
    Certificate to be used as client certificate while TLS handshaking to the upstream server.
    ConnectTimeout float64
    The timeout in milliseconds for establishing a connection 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.
    Enabled bool
    Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
    GatewayServiceId string
    The ID of this resource.
    Host string
    The host of the upstream server. Note that the host value is case sensitive.
    Name string
    The Service name.
    Path string
    The path to be used in requests to the upstream server.
    Port float64
    The upstream server port.
    Protocol string
    The protocol used to communicate with the upstream. must be one of ["grpc", "grpcs", "http", "https", "tcp", "tls", "tls_passthrough", "udp", "ws", "wss"]
    ReadTimeout float64
    The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
    Retries float64
    The number of retries to execute upon failure to proxy.
    Tags []string
    An optional set of strings associated with the Service for grouping and filtering.
    TlsVerify bool
    Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
    TlsVerifyDepth float64
    Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.
    UpdatedAt float64
    Unix epoch when the resource was last updated.
    WriteTimeout float64
    The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.
    caCertificates List<String>
    Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
    clientCertificate GatewayServiceClientCertificate
    Certificate to be used as client certificate while TLS handshaking to the upstream server.
    connectTimeout Double
    The timeout in milliseconds for establishing a connection 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.
    enabled Boolean
    Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
    gatewayServiceId String
    The ID of this resource.
    host String
    The host of the upstream server. Note that the host value is case sensitive.
    name String
    The Service name.
    path String
    The path to be used in requests to the upstream server.
    port Double
    The upstream server port.
    protocol String
    The protocol used to communicate with the upstream. must be one of ["grpc", "grpcs", "http", "https", "tcp", "tls", "tls_passthrough", "udp", "ws", "wss"]
    readTimeout Double
    The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
    retries Double
    The number of retries to execute upon failure to proxy.
    tags List<String>
    An optional set of strings associated with the Service for grouping and filtering.
    tlsVerify Boolean
    Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
    tlsVerifyDepth Double
    Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.
    updatedAt Double
    Unix epoch when the resource was last updated.
    writeTimeout Double
    The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.
    caCertificates string[]
    Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
    clientCertificate GatewayServiceClientCertificate
    Certificate to be used as client certificate while TLS handshaking to the upstream server.
    connectTimeout number
    The timeout in milliseconds for establishing a connection 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.
    enabled boolean
    Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
    gatewayServiceId string
    The ID of this resource.
    host string
    The host of the upstream server. Note that the host value is case sensitive.
    name string
    The Service name.
    path string
    The path to be used in requests to the upstream server.
    port number
    The upstream server port.
    protocol string
    The protocol used to communicate with the upstream. must be one of ["grpc", "grpcs", "http", "https", "tcp", "tls", "tls_passthrough", "udp", "ws", "wss"]
    readTimeout number
    The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
    retries number
    The number of retries to execute upon failure to proxy.
    tags string[]
    An optional set of strings associated with the Service for grouping and filtering.
    tlsVerify boolean
    Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
    tlsVerifyDepth number
    Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.
    updatedAt number
    Unix epoch when the resource was last updated.
    writeTimeout number
    The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.
    ca_certificates Sequence[str]
    Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
    client_certificate GatewayServiceClientCertificateArgs
    Certificate to be used as client certificate while TLS handshaking to the upstream server.
    connect_timeout float
    The timeout in milliseconds for establishing a connection 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.
    enabled bool
    Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
    gateway_service_id str
    The ID of this resource.
    host str
    The host of the upstream server. Note that the host value is case sensitive.
    name str
    The Service name.
    path str
    The path to be used in requests to the upstream server.
    port float
    The upstream server port.
    protocol str
    The protocol used to communicate with the upstream. must be one of ["grpc", "grpcs", "http", "https", "tcp", "tls", "tls_passthrough", "udp", "ws", "wss"]
    read_timeout float
    The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
    retries float
    The number of retries to execute upon failure to proxy.
    tags Sequence[str]
    An optional set of strings associated with the Service for grouping and filtering.
    tls_verify bool
    Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
    tls_verify_depth float
    Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.
    updated_at float
    Unix epoch when the resource was last updated.
    write_timeout float
    The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.
    caCertificates List<String>
    Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
    clientCertificate Property Map
    Certificate to be used as client certificate while TLS handshaking to the upstream server.
    connectTimeout Number
    The timeout in milliseconds for establishing a connection 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.
    enabled Boolean
    Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
    gatewayServiceId String
    The ID of this resource.
    host String
    The host of the upstream server. Note that the host value is case sensitive.
    name String
    The Service name.
    path String
    The path to be used in requests to the upstream server.
    port Number
    The upstream server port.
    protocol String
    The protocol used to communicate with the upstream. must be one of ["grpc", "grpcs", "http", "https", "tcp", "tls", "tls_passthrough", "udp", "ws", "wss"]
    readTimeout Number
    The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
    retries Number
    The number of retries to execute upon failure to proxy.
    tags List<String>
    An optional set of strings associated with the Service for grouping and filtering.
    tlsVerify Boolean
    Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
    tlsVerifyDepth Number
    Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.
    updatedAt Number
    Unix epoch when the resource was last updated.
    writeTimeout Number
    The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.

    Supporting Types

    GatewayServiceClientCertificate, GatewayServiceClientCertificateArgs

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

    Import

    $ pulumi import konnect:index/gatewayService:GatewayService my_konnect_gateway_service "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"service_id\": \"7fca84d6-7d37-4a74-a7b0-93e576089a41\"}"

    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