Service

# kong.Service

The service resource maps directly onto the json for the service endpoint in Kong. For more information on the parameters see the Kong Service create documentation.

Argument reference

  • name - (Required) Service name
  • protocol - (Required) Protocol to use
  • host - (Optional) Host to map to
  • port - (Optional, int) Port to map to. Default: 80
  • path - (Optional) Path to map to
  • retries - (Optional, int) Number of retries. Default: 5
  • connect_timeout - (Optional, int) Connection timeout. Default(ms): 60000
  • write_timeout - (Optional, int) Write timout. Default(ms): 60000
  • read_timeout - (Optional, int) Read timeout. Default(ms): 60000
  • tags - (Optional) A list of strings associated with the Service for grouping and filtering.
  • client_certificate_id - (Optional) ID of Certificate to be used as client certificate while TLS handshaking to the upstream server. Use ID from kong.Certificate resource
  • tls_verify - (Optional) Whether to enable verification of upstream server TLS certificate. If not set then the nginx default is respected.
  • tls_verify_depth - (Optional) Maximum depth of chain while verifying Upstream server’s TLS certificate.
  • ca_certificate_ids - (Optional) A of CA Certificate IDs (created from the certificate resource). that are used to build the trust store while verifying upstream server’s TLS certificate.

Example Usage

using Pulumi;
using Kong = Pulumi.Kong;

class MyStack : Stack
{
    public MyStack()
    {
        var service = new Kong.Service("service", new Kong.ServiceArgs
        {
            ConnectTimeout = 1000,
            Host = "test.org",
            Path = "/mypath",
            Port = 8080,
            Protocol = "http",
            ReadTimeout = 3000,
            Retries = 5,
            WriteTimeout = 2000,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-kong/sdk/v4/go/kong"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kong.NewService(ctx, "service", &kong.ServiceArgs{
			ConnectTimeout: pulumi.Int(1000),
			Host:           pulumi.String("test.org"),
			Path:           pulumi.String("/mypath"),
			Port:           pulumi.Int(8080),
			Protocol:       pulumi.String("http"),
			ReadTimeout:    pulumi.Int(3000),
			Retries:        pulumi.Int(5),
			WriteTimeout:   pulumi.Int(2000),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_kong as kong

service = kong.Service("service",
    connect_timeout=1000,
    host="test.org",
    path="/mypath",
    port=8080,
    protocol="http",
    read_timeout=3000,
    retries=5,
    write_timeout=2000)
import * as pulumi from "@pulumi/pulumi";
import * as kong from "@pulumi/kong";

const service = new kong.Service("service", {
    connectTimeout: 1000,
    host: "test.org",
    path: "/mypath",
    port: 8080,
    protocol: "http",
    readTimeout: 3000,
    retries: 5,
    writeTimeout: 2000,
});

Create a Service Resource

new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            ca_certificate_ids: Optional[Sequence[str]] = None,
            client_certificate_id: Optional[str] = None,
            connect_timeout: Optional[int] = None,
            host: Optional[str] = None,
            name: Optional[str] = None,
            path: Optional[str] = None,
            port: Optional[int] = None,
            protocol: Optional[str] = None,
            read_timeout: Optional[int] = None,
            retries: Optional[int] = None,
            tags: Optional[Sequence[str]] = None,
            tls_verify: Optional[bool] = None,
            tls_verify_depth: Optional[int] = None,
            write_timeout: Optional[int] = None)
@overload
def Service(resource_name: str,
            args: ServiceArgs,
            opts: Optional[ResourceOptions] = None)
func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ServiceArgs
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 ServiceArgs
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 ServiceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Service Resource Properties

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

Inputs

The Service resource accepts the following input properties:

Protocol string
CaCertificateIds List<string>
ClientCertificateId string
ConnectTimeout int
Host string
Name string
Path string
Port int
ReadTimeout int
Retries int
Tags List<string>
TlsVerify bool
TlsVerifyDepth int
WriteTimeout int
Protocol string
CaCertificateIds []string
ClientCertificateId string
ConnectTimeout int
Host string
Name string
Path string
Port int
ReadTimeout int
Retries int
Tags []string
TlsVerify bool
TlsVerifyDepth int
WriteTimeout int
protocol string
caCertificateIds string[]
clientCertificateId string
connectTimeout number
host string
name string
path string
port number
readTimeout number
retries number
tags string[]
tlsVerify boolean
tlsVerifyDepth number
writeTimeout number

Outputs

All input properties are implicitly available as output properties. Additionally, the Service 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing Service Resource

Get an existing Service 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?: ServiceState, opts?: CustomResourceOptions): Service
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ca_certificate_ids: Optional[Sequence[str]] = None,
        client_certificate_id: Optional[str] = None,
        connect_timeout: Optional[int] = None,
        host: Optional[str] = None,
        name: Optional[str] = None,
        path: Optional[str] = None,
        port: Optional[int] = None,
        protocol: Optional[str] = None,
        read_timeout: Optional[int] = None,
        retries: Optional[int] = None,
        tags: Optional[Sequence[str]] = None,
        tls_verify: Optional[bool] = None,
        tls_verify_depth: Optional[int] = None,
        write_timeout: Optional[int] = None) -> Service
func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

CaCertificateIds List<string>
ClientCertificateId string
ConnectTimeout int
Host string
Name string
Path string
Port int
Protocol string
ReadTimeout int
Retries int
Tags List<string>
TlsVerify bool
TlsVerifyDepth int
WriteTimeout int
CaCertificateIds []string
ClientCertificateId string
ConnectTimeout int
Host string
Name string
Path string
Port int
Protocol string
ReadTimeout int
Retries int
Tags []string
TlsVerify bool
TlsVerifyDepth int
WriteTimeout int
caCertificateIds string[]
clientCertificateId string
connectTimeout number
host string
name string
path string
port number
protocol string
readTimeout number
retries number
tags string[]
tlsVerify boolean
tlsVerifyDepth number
writeTimeout number

Import

To import a service

 $ pulumi import kong:index/service:Service <service_identifier> <service_id>

Package Details

Repository
https://github.com/pulumi/pulumi-kong
License
Apache-2.0
Notes
This Pulumi package is based on the kong Terraform Provider.