1. Packages
  2. Kong Provider
  3. API Docs
  4. Service
Kong v4.5.6 published on Wednesday, Oct 16, 2024 by Pulumi

kong.Service

Explore with Pulumi AI

kong logo
Kong v4.5.6 published on Wednesday, Oct 16, 2024 by Pulumi

    # 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.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as kong from "@pulumi/kong";
    
    const service = new kong.Service("service", {
        name: "test",
        protocol: "http",
        host: "test.org",
        port: 8080,
        path: "/mypath",
        retries: 5,
        connectTimeout: 1000,
        writeTimeout: 2000,
        readTimeout: 3000,
    });
    
    import pulumi
    import pulumi_kong as kong
    
    service = kong.Service("service",
        name="test",
        protocol="http",
        host="test.org",
        port=8080,
        path="/mypath",
        retries=5,
        connect_timeout=1000,
        write_timeout=2000,
        read_timeout=3000)
    
    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{
    			Name:           pulumi.String("test"),
    			Protocol:       pulumi.String("http"),
    			Host:           pulumi.String("test.org"),
    			Port:           pulumi.Int(8080),
    			Path:           pulumi.String("/mypath"),
    			Retries:        pulumi.Int(5),
    			ConnectTimeout: pulumi.Int(1000),
    			WriteTimeout:   pulumi.Int(2000),
    			ReadTimeout:    pulumi.Int(3000),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Kong = Pulumi.Kong;
    
    return await Deployment.RunAsync(() => 
    {
        var service = new Kong.Service("service", new()
        {
            Name = "test",
            Protocol = "http",
            Host = "test.org",
            Port = 8080,
            Path = "/mypath",
            Retries = 5,
            ConnectTimeout = 1000,
            WriteTimeout = 2000,
            ReadTimeout = 3000,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.kong.Service;
    import com.pulumi.kong.ServiceArgs;
    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 service = new Service("service", ServiceArgs.builder()
                .name("test")
                .protocol("http")
                .host("test.org")
                .port(8080)
                .path("/mypath")
                .retries(5)
                .connectTimeout(1000)
                .writeTimeout(2000)
                .readTimeout(3000)
                .build());
    
        }
    }
    
    resources:
      service:
        type: kong:Service
        properties:
          name: test
          protocol: http
          host: test.org
          port: 8080
          path: /mypath
          retries: 5
          connectTimeout: 1000
          writeTimeout: 2000
          readTimeout: 3000
    

    To use a client certificate and ca certificates combine with certificate resource (note protocol must be https):

    import * as pulumi from "@pulumi/pulumi";
    import * as kong from "@pulumi/kong";
    
    const certificate = new kong.Certificate("certificate", {
        certificate: `    -----BEGIN CERTIFICATE-----
        ......
        -----END CERTIFICATE-----
    `,
        privateKey: `    -----BEGIN PRIVATE KEY-----
        .....
        -----END PRIVATE KEY-----
    `,
        snis: ["foo.com"],
    });
    const ca = new kong.Certificate("ca", {
        certificate: `    -----BEGIN CERTIFICATE-----
        ......
        -----END CERTIFICATE-----
    `,
        privateKey: `    -----BEGIN PRIVATE KEY-----
        .....
        -----END PRIVATE KEY-----
    `,
        snis: ["ca.com"],
    });
    const service = new kong.Service("service", {
        name: "test",
        protocol: "https",
        host: "test.org",
        tlsVerify: true,
        tlsVerifyDepth: 2,
        clientCertificateId: certificate.id,
        caCertificateIds: [ca.id],
    });
    
    import pulumi
    import pulumi_kong as kong
    
    certificate = kong.Certificate("certificate",
        certificate="""    -----BEGIN CERTIFICATE-----
        ......
        -----END CERTIFICATE-----
    """,
        private_key="""    -----BEGIN PRIVATE KEY-----
        .....
        -----END PRIVATE KEY-----
    """,
        snis=["foo.com"])
    ca = kong.Certificate("ca",
        certificate="""    -----BEGIN CERTIFICATE-----
        ......
        -----END CERTIFICATE-----
    """,
        private_key="""    -----BEGIN PRIVATE KEY-----
        .....
        -----END PRIVATE KEY-----
    """,
        snis=["ca.com"])
    service = kong.Service("service",
        name="test",
        protocol="https",
        host="test.org",
        tls_verify=True,
        tls_verify_depth=2,
        client_certificate_id=certificate.id,
        ca_certificate_ids=[ca.id])
    
    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 {
    		certificate, err := kong.NewCertificate(ctx, "certificate", &kong.CertificateArgs{
    			Certificate: pulumi.String("    -----BEGIN CERTIFICATE-----\n    ......\n    -----END CERTIFICATE-----\n"),
    			PrivateKey:  pulumi.String("    -----BEGIN PRIVATE KEY-----\n    .....\n    -----END PRIVATE KEY-----\n"),
    			Snis: pulumi.StringArray{
    				pulumi.String("foo.com"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		ca, err := kong.NewCertificate(ctx, "ca", &kong.CertificateArgs{
    			Certificate: pulumi.String("    -----BEGIN CERTIFICATE-----\n    ......\n    -----END CERTIFICATE-----\n"),
    			PrivateKey:  pulumi.String("    -----BEGIN PRIVATE KEY-----\n    .....\n    -----END PRIVATE KEY-----\n"),
    			Snis: pulumi.StringArray{
    				pulumi.String("ca.com"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = kong.NewService(ctx, "service", &kong.ServiceArgs{
    			Name:                pulumi.String("test"),
    			Protocol:            pulumi.String("https"),
    			Host:                pulumi.String("test.org"),
    			TlsVerify:           pulumi.Bool(true),
    			TlsVerifyDepth:      pulumi.Int(2),
    			ClientCertificateId: certificate.ID(),
    			CaCertificateIds: pulumi.StringArray{
    				ca.ID(),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Kong = Pulumi.Kong;
    
    return await Deployment.RunAsync(() => 
    {
        var certificate = new Kong.Certificate("certificate", new()
        {
            Cert = @"    -----BEGIN CERTIFICATE-----
        ......
        -----END CERTIFICATE-----
    ",
            PrivateKey = @"    -----BEGIN PRIVATE KEY-----
        .....
        -----END PRIVATE KEY-----
    ",
            Snis = new[]
            {
                "foo.com",
            },
        });
    
        var ca = new Kong.Certificate("ca", new()
        {
            Cert = @"    -----BEGIN CERTIFICATE-----
        ......
        -----END CERTIFICATE-----
    ",
            PrivateKey = @"    -----BEGIN PRIVATE KEY-----
        .....
        -----END PRIVATE KEY-----
    ",
            Snis = new[]
            {
                "ca.com",
            },
        });
    
        var service = new Kong.Service("service", new()
        {
            Name = "test",
            Protocol = "https",
            Host = "test.org",
            TlsVerify = true,
            TlsVerifyDepth = 2,
            ClientCertificateId = certificate.Id,
            CaCertificateIds = new[]
            {
                ca.Id,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.kong.Certificate;
    import com.pulumi.kong.CertificateArgs;
    import com.pulumi.kong.Service;
    import com.pulumi.kong.ServiceArgs;
    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 certificate = new Certificate("certificate", CertificateArgs.builder()
                .certificate("""
        -----BEGIN CERTIFICATE-----
        ......
        -----END CERTIFICATE-----
                """)
                .privateKey("""
        -----BEGIN PRIVATE KEY-----
        .....
        -----END PRIVATE KEY-----
                """)
                .snis("foo.com")
                .build());
    
            var ca = new Certificate("ca", CertificateArgs.builder()
                .certificate("""
        -----BEGIN CERTIFICATE-----
        ......
        -----END CERTIFICATE-----
                """)
                .privateKey("""
        -----BEGIN PRIVATE KEY-----
        .....
        -----END PRIVATE KEY-----
                """)
                .snis("ca.com")
                .build());
    
            var service = new Service("service", ServiceArgs.builder()
                .name("test")
                .protocol("https")
                .host("test.org")
                .tlsVerify(true)
                .tlsVerifyDepth(2)
                .clientCertificateId(certificate.id())
                .caCertificateIds(ca.id())
                .build());
    
        }
    }
    
    resources:
      certificate:
        type: kong:Certificate
        properties:
          certificate: |2
                -----BEGIN CERTIFICATE-----
                ......
                -----END CERTIFICATE-----
          privateKey: |2
                -----BEGIN PRIVATE KEY-----
                .....
                -----END PRIVATE KEY-----
          snis:
            - foo.com
      ca:
        type: kong:Certificate
        properties:
          certificate: |2
                -----BEGIN CERTIFICATE-----
                ......
                -----END CERTIFICATE-----
          privateKey: |2
                -----BEGIN PRIVATE KEY-----
                .....
                -----END PRIVATE KEY-----
          snis:
            - ca.com
      service:
        type: kong:Service
        properties:
          name: test
          protocol: https
          host: test.org
          tlsVerify: true
          tlsVerifyDepth: 2
          clientCertificateId: ${certificate.id}
          caCertificateIds:
            - ${ca.id}
    

    Create Service Resource

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

    Constructor syntax

    new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
    @overload
    def Service(resource_name: str,
                args: ServiceArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Service(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                protocol: Optional[str] = None,
                port: Optional[int] = None,
                connect_timeout: Optional[int] = None,
                host: Optional[str] = None,
                name: Optional[str] = None,
                path: Optional[str] = None,
                ca_certificate_ids: Optional[Sequence[str]] = None,
                client_certificate_id: 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)
    func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
    public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
    public Service(String name, ServiceArgs args)
    public Service(String name, ServiceArgs args, CustomResourceOptions options)
    
    type: kong:Service
    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 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.
    name String
    The unique name of the resource.
    args ServiceArgs
    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 serviceResource = new Kong.Service("serviceResource", new()
    {
        Protocol = "string",
        Port = 0,
        ConnectTimeout = 0,
        Host = "string",
        Name = "string",
        Path = "string",
        CaCertificateIds = new[]
        {
            "string",
        },
        ClientCertificateId = "string",
        ReadTimeout = 0,
        Retries = 0,
        Tags = new[]
        {
            "string",
        },
        TlsVerify = false,
        TlsVerifyDepth = 0,
        WriteTimeout = 0,
    });
    
    example, err := kong.NewService(ctx, "serviceResource", &kong.ServiceArgs{
    	Protocol:       pulumi.String("string"),
    	Port:           pulumi.Int(0),
    	ConnectTimeout: pulumi.Int(0),
    	Host:           pulumi.String("string"),
    	Name:           pulumi.String("string"),
    	Path:           pulumi.String("string"),
    	CaCertificateIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ClientCertificateId: pulumi.String("string"),
    	ReadTimeout:         pulumi.Int(0),
    	Retries:             pulumi.Int(0),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TlsVerify:      pulumi.Bool(false),
    	TlsVerifyDepth: pulumi.Int(0),
    	WriteTimeout:   pulumi.Int(0),
    })
    
    var serviceResource = new Service("serviceResource", ServiceArgs.builder()
        .protocol("string")
        .port(0)
        .connectTimeout(0)
        .host("string")
        .name("string")
        .path("string")
        .caCertificateIds("string")
        .clientCertificateId("string")
        .readTimeout(0)
        .retries(0)
        .tags("string")
        .tlsVerify(false)
        .tlsVerifyDepth(0)
        .writeTimeout(0)
        .build());
    
    service_resource = kong.Service("serviceResource",
        protocol="string",
        port=0,
        connect_timeout=0,
        host="string",
        name="string",
        path="string",
        ca_certificate_ids=["string"],
        client_certificate_id="string",
        read_timeout=0,
        retries=0,
        tags=["string"],
        tls_verify=False,
        tls_verify_depth=0,
        write_timeout=0)
    
    const serviceResource = new kong.Service("serviceResource", {
        protocol: "string",
        port: 0,
        connectTimeout: 0,
        host: "string",
        name: "string",
        path: "string",
        caCertificateIds: ["string"],
        clientCertificateId: "string",
        readTimeout: 0,
        retries: 0,
        tags: ["string"],
        tlsVerify: false,
        tlsVerifyDepth: 0,
        writeTimeout: 0,
    });
    
    type: kong:Service
    properties:
        caCertificateIds:
            - string
        clientCertificateId: string
        connectTimeout: 0
        host: string
        name: string
        path: string
        port: 0
        protocol: string
        readTimeout: 0
        retries: 0
        tags:
            - string
        tlsVerify: false
        tlsVerifyDepth: 0
        writeTimeout: 0
    

    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

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

    The Service resource accepts the following input properties:

    Protocol string
    Protocol to use
    CaCertificateIds List<string>
    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.
    ClientCertificateId string
    ID of Certificate to be used as client certificate while TLS handshaking to the upstream server. Use ID from kong.Certificate resource
    ConnectTimeout int
    Connection timeout. Default(ms): 60000
    Host string
    Host to map to
    Name string
    Service name
    Path string
    Path to map to
    Port int
    Port to map to. Default: 80
    ReadTimeout int
    Read timeout. Default(ms): 60000
    Retries int
    Number of retries. Default: 5
    Tags List<string>
    A list of strings associated with the Service for grouping and filtering.
    TlsVerify bool
    Whether to enable verification of upstream server TLS certificate. If not set then the nginx default is respected.
    TlsVerifyDepth int
    Maximum depth of chain while verifying Upstream server’s TLS certificate.
    WriteTimeout int
    Write timout. Default(ms): 60000
    Protocol string
    Protocol to use
    CaCertificateIds []string
    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.
    ClientCertificateId string
    ID of Certificate to be used as client certificate while TLS handshaking to the upstream server. Use ID from kong.Certificate resource
    ConnectTimeout int
    Connection timeout. Default(ms): 60000
    Host string
    Host to map to
    Name string
    Service name
    Path string
    Path to map to
    Port int
    Port to map to. Default: 80
    ReadTimeout int
    Read timeout. Default(ms): 60000
    Retries int
    Number of retries. Default: 5
    Tags []string
    A list of strings associated with the Service for grouping and filtering.
    TlsVerify bool
    Whether to enable verification of upstream server TLS certificate. If not set then the nginx default is respected.
    TlsVerifyDepth int
    Maximum depth of chain while verifying Upstream server’s TLS certificate.
    WriteTimeout int
    Write timout. Default(ms): 60000
    protocol String
    Protocol to use
    caCertificateIds List<String>
    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.
    clientCertificateId String
    ID of Certificate to be used as client certificate while TLS handshaking to the upstream server. Use ID from kong.Certificate resource
    connectTimeout Integer
    Connection timeout. Default(ms): 60000
    host String
    Host to map to
    name String
    Service name
    path String
    Path to map to
    port Integer
    Port to map to. Default: 80
    readTimeout Integer
    Read timeout. Default(ms): 60000
    retries Integer
    Number of retries. Default: 5
    tags List<String>
    A list of strings associated with the Service for grouping and filtering.
    tlsVerify Boolean
    Whether to enable verification of upstream server TLS certificate. If not set then the nginx default is respected.
    tlsVerifyDepth Integer
    Maximum depth of chain while verifying Upstream server’s TLS certificate.
    writeTimeout Integer
    Write timout. Default(ms): 60000
    protocol string
    Protocol to use
    caCertificateIds string[]
    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.
    clientCertificateId string
    ID of Certificate to be used as client certificate while TLS handshaking to the upstream server. Use ID from kong.Certificate resource
    connectTimeout number
    Connection timeout. Default(ms): 60000
    host string
    Host to map to
    name string
    Service name
    path string
    Path to map to
    port number
    Port to map to. Default: 80
    readTimeout number
    Read timeout. Default(ms): 60000
    retries number
    Number of retries. Default: 5
    tags string[]
    A list of strings associated with the Service for grouping and filtering.
    tlsVerify boolean
    Whether to enable verification of upstream server TLS certificate. If not set then the nginx default is respected.
    tlsVerifyDepth number
    Maximum depth of chain while verifying Upstream server’s TLS certificate.
    writeTimeout number
    Write timout. Default(ms): 60000
    protocol str
    Protocol to use
    ca_certificate_ids Sequence[str]
    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.
    client_certificate_id str
    ID of Certificate to be used as client certificate while TLS handshaking to the upstream server. Use ID from kong.Certificate resource
    connect_timeout int
    Connection timeout. Default(ms): 60000
    host str
    Host to map to
    name str
    Service name
    path str
    Path to map to
    port int
    Port to map to. Default: 80
    read_timeout int
    Read timeout. Default(ms): 60000
    retries int
    Number of retries. Default: 5
    tags Sequence[str]
    A list of strings associated with the Service for grouping and filtering.
    tls_verify bool
    Whether to enable verification of upstream server TLS certificate. If not set then the nginx default is respected.
    tls_verify_depth int
    Maximum depth of chain while verifying Upstream server’s TLS certificate.
    write_timeout int
    Write timout. Default(ms): 60000
    protocol String
    Protocol to use
    caCertificateIds List<String>
    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.
    clientCertificateId String
    ID of Certificate to be used as client certificate while TLS handshaking to the upstream server. Use ID from kong.Certificate resource
    connectTimeout Number
    Connection timeout. Default(ms): 60000
    host String
    Host to map to
    name String
    Service name
    path String
    Path to map to
    port Number
    Port to map to. Default: 80
    readTimeout Number
    Read timeout. Default(ms): 60000
    retries Number
    Number of retries. Default: 5
    tags List<String>
    A list of strings associated with the Service for grouping and filtering.
    tlsVerify Boolean
    Whether to enable verification of upstream server TLS certificate. If not set then the nginx default is respected.
    tlsVerifyDepth Number
    Maximum depth of chain while verifying Upstream server’s TLS certificate.
    writeTimeout Number
    Write timout. Default(ms): 60000

    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 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 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)
    public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    CaCertificateIds List<string>
    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.
    ClientCertificateId string
    ID of Certificate to be used as client certificate while TLS handshaking to the upstream server. Use ID from kong.Certificate resource
    ConnectTimeout int
    Connection timeout. Default(ms): 60000
    Host string
    Host to map to
    Name string
    Service name
    Path string
    Path to map to
    Port int
    Port to map to. Default: 80
    Protocol string
    Protocol to use
    ReadTimeout int
    Read timeout. Default(ms): 60000
    Retries int
    Number of retries. Default: 5
    Tags List<string>
    A list of strings associated with the Service for grouping and filtering.
    TlsVerify bool
    Whether to enable verification of upstream server TLS certificate. If not set then the nginx default is respected.
    TlsVerifyDepth int
    Maximum depth of chain while verifying Upstream server’s TLS certificate.
    WriteTimeout int
    Write timout. Default(ms): 60000
    CaCertificateIds []string
    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.
    ClientCertificateId string
    ID of Certificate to be used as client certificate while TLS handshaking to the upstream server. Use ID from kong.Certificate resource
    ConnectTimeout int
    Connection timeout. Default(ms): 60000
    Host string
    Host to map to
    Name string
    Service name
    Path string
    Path to map to
    Port int
    Port to map to. Default: 80
    Protocol string
    Protocol to use
    ReadTimeout int
    Read timeout. Default(ms): 60000
    Retries int
    Number of retries. Default: 5
    Tags []string
    A list of strings associated with the Service for grouping and filtering.
    TlsVerify bool
    Whether to enable verification of upstream server TLS certificate. If not set then the nginx default is respected.
    TlsVerifyDepth int
    Maximum depth of chain while verifying Upstream server’s TLS certificate.
    WriteTimeout int
    Write timout. Default(ms): 60000
    caCertificateIds List<String>
    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.
    clientCertificateId String
    ID of Certificate to be used as client certificate while TLS handshaking to the upstream server. Use ID from kong.Certificate resource
    connectTimeout Integer
    Connection timeout. Default(ms): 60000
    host String
    Host to map to
    name String
    Service name
    path String
    Path to map to
    port Integer
    Port to map to. Default: 80
    protocol String
    Protocol to use
    readTimeout Integer
    Read timeout. Default(ms): 60000
    retries Integer
    Number of retries. Default: 5
    tags List<String>
    A list of strings associated with the Service for grouping and filtering.
    tlsVerify Boolean
    Whether to enable verification of upstream server TLS certificate. If not set then the nginx default is respected.
    tlsVerifyDepth Integer
    Maximum depth of chain while verifying Upstream server’s TLS certificate.
    writeTimeout Integer
    Write timout. Default(ms): 60000
    caCertificateIds string[]
    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.
    clientCertificateId string
    ID of Certificate to be used as client certificate while TLS handshaking to the upstream server. Use ID from kong.Certificate resource
    connectTimeout number
    Connection timeout. Default(ms): 60000
    host string
    Host to map to
    name string
    Service name
    path string
    Path to map to
    port number
    Port to map to. Default: 80
    protocol string
    Protocol to use
    readTimeout number
    Read timeout. Default(ms): 60000
    retries number
    Number of retries. Default: 5
    tags string[]
    A list of strings associated with the Service for grouping and filtering.
    tlsVerify boolean
    Whether to enable verification of upstream server TLS certificate. If not set then the nginx default is respected.
    tlsVerifyDepth number
    Maximum depth of chain while verifying Upstream server’s TLS certificate.
    writeTimeout number
    Write timout. Default(ms): 60000
    ca_certificate_ids Sequence[str]
    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.
    client_certificate_id str
    ID of Certificate to be used as client certificate while TLS handshaking to the upstream server. Use ID from kong.Certificate resource
    connect_timeout int
    Connection timeout. Default(ms): 60000
    host str
    Host to map to
    name str
    Service name
    path str
    Path to map to
    port int
    Port to map to. Default: 80
    protocol str
    Protocol to use
    read_timeout int
    Read timeout. Default(ms): 60000
    retries int
    Number of retries. Default: 5
    tags Sequence[str]
    A list of strings associated with the Service for grouping and filtering.
    tls_verify bool
    Whether to enable verification of upstream server TLS certificate. If not set then the nginx default is respected.
    tls_verify_depth int
    Maximum depth of chain while verifying Upstream server’s TLS certificate.
    write_timeout int
    Write timout. Default(ms): 60000
    caCertificateIds List<String>
    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.
    clientCertificateId String
    ID of Certificate to be used as client certificate while TLS handshaking to the upstream server. Use ID from kong.Certificate resource
    connectTimeout Number
    Connection timeout. Default(ms): 60000
    host String
    Host to map to
    name String
    Service name
    path String
    Path to map to
    port Number
    Port to map to. Default: 80
    protocol String
    Protocol to use
    readTimeout Number
    Read timeout. Default(ms): 60000
    retries Number
    Number of retries. Default: 5
    tags List<String>
    A list of strings associated with the Service for grouping and filtering.
    tlsVerify Boolean
    Whether to enable verification of upstream server TLS certificate. If not set then the nginx default is respected.
    tlsVerifyDepth Number
    Maximum depth of chain while verifying Upstream server’s TLS certificate.
    writeTimeout Number
    Write timout. Default(ms): 60000

    Import

    To import a service:

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

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

    Package Details

    Repository
    Kong pulumi/pulumi-kong
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the kong Terraform Provider.
    kong logo
    Kong v4.5.6 published on Wednesday, Oct 16, 2024 by Pulumi