1. Docs
2. Reference
3. API
4. @pulumi/kong

Package @pulumi/kong

This provider is a derived work of the Terraform Provider distributed under MIT. If you encounter a bug or missing feature, first check the pulumi/pulumi-kong repo; however, if that doesn’t turn up anything, please consult the source kevholditch/terraform-provider-Kong repo.

var kong = require("@pulumi/kong");

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

Modules

• config
• types

Resources

• Certificate
• Consumer
• ConsumerPluginConfig
• Plugin
• Provider
• Route
• Service
• Sni
• Target
• Upstream

Others

• CertificateArgs
• CertificateState
• ConsumerArgs
• ConsumerPluginConfigArgs
• ConsumerPluginConfigState
• ConsumerState
• getEnv
• getEnvBoolean
• getEnvNumber
• getVersion
• PluginArgs
• PluginState
• ProviderArgs
• RouteArgs
• RouteState
• ServiceArgs
• ServiceState
• SniArgs
• SniState
• TargetArgs
• TargetState
• UpstreamArgs
• UpstreamState

Resources

Resource Certificate

class Certificate extends CustomResource

constructor

new Certificate(name: string, args: CertificateArgs, opts?: pulumi.CustomResourceOptions)

Create a Certificate resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CertificateState, opts?: pulumi.CustomResourceOptions): Certificate

Get an existing Certificate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Certificate

Returns true if the given object is an instance of Certificate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property certificate

public certificate: pulumi.Output<string>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property privateKey

public privateKey: pulumi.Output<string | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Consumer

class Consumer extends CustomResource

constructor

new Consumer(name: string, args: ConsumerArgs, opts?: pulumi.CustomResourceOptions)

Create a Consumer resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConsumerState, opts?: pulumi.CustomResourceOptions): Consumer

Get an existing Consumer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Consumer

Returns true if the given object is an instance of Consumer. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property customId

public customId: pulumi.Output<string | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string>;

Resource ConsumerPluginConfig

class ConsumerPluginConfig extends CustomResource

constructor

new ConsumerPluginConfig(name: string, args: ConsumerPluginConfigArgs, opts?: pulumi.CustomResourceOptions)

Create a ConsumerPluginConfig resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConsumerPluginConfigState, opts?: pulumi.CustomResourceOptions): ConsumerPluginConfig

Get an existing ConsumerPluginConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ConsumerPluginConfig

Returns true if the given object is an instance of ConsumerPluginConfig. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property computedConfig

public computedConfig: pulumi.Output<string>;

property configJson

public configJson: pulumi.Output<string | undefined>;

JSON format of plugin config

property consumerId

public consumerId: pulumi.Output<string>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property pluginName

public pluginName: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Plugin

class Plugin extends CustomResource

constructor

new Plugin(name: string, args?: PluginArgs, opts?: pulumi.CustomResourceOptions)

Create a Plugin resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PluginState, opts?: pulumi.CustomResourceOptions): Plugin

Get an existing Plugin resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Plugin

Returns true if the given object is an instance of Plugin. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property computedConfig

public computedConfig: pulumi.Output<string>;

property configJson

public configJson: pulumi.Output<string | undefined>;

plugin configuration in JSON format, configuration must be a valid JSON object.

property consumerId

public consumerId: pulumi.Output<string | undefined>;

property enabled

public enabled: pulumi.Output<boolean | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

property routeId

public routeId: pulumi.Output<string | undefined>;

property serviceId

public serviceId: pulumi.Output<string | undefined>;

property strictMatch

public strictMatch: pulumi.Output<boolean | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Provider

class Provider extends ProviderResource

The provider type for the kong package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Route

class Route extends CustomResource

constructor

new Route(name: string, args: RouteArgs, opts?: pulumi.CustomResourceOptions)

Create a Route resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RouteState, opts?: pulumi.CustomResourceOptions): Route

Get an existing Route resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Route

Returns true if the given object is an instance of Route. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property destinations

public destinations: pulumi.Output<RouteDestination[] | undefined>;

property hosts

public hosts: pulumi.Output<string[] | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property methods

public methods: pulumi.Output<string[] | undefined>;

property name

public name: pulumi.Output<string>;

property paths

public paths: pulumi.Output<string[] | undefined>;

property preserveHost

public preserveHost: pulumi.Output<boolean | undefined>;

property protocols

public protocols: pulumi.Output<string[]>;

property regexPriority

public regexPriority: pulumi.Output<number | undefined>;

property serviceId

public serviceId: pulumi.Output<string>;

property snis

public snis: pulumi.Output<string[] | undefined>;

property sources

public sources: pulumi.Output<RouteSource[] | undefined>;

property stripPath

public stripPath: pulumi.Output<boolean | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Service

class Service extends CustomResource

constructor

new Service(name: string, args: ServiceArgs, opts?: pulumi.CustomResourceOptions)

Create a Service resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service

Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Service

Returns true if the given object is an instance of Service. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property connectTimeout

public connectTimeout: pulumi.Output<number | undefined>;

property host

public host: pulumi.Output<string | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

property path

public path: pulumi.Output<string | undefined>;

property port

public port: pulumi.Output<number | undefined>;

property protocol

public protocol: pulumi.Output<string>;

property readTimeout

public readTimeout: pulumi.Output<number | undefined>;

property retries

public retries: pulumi.Output<number | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property writeTimeout

public writeTimeout: pulumi.Output<number | undefined>;

Resource Sni

class Sni extends CustomResource

constructor

new Sni(name: string, args: SniArgs, opts?: pulumi.CustomResourceOptions)

Create a Sni resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SniState, opts?: pulumi.CustomResourceOptions): Sni

Get an existing Sni resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Sni

Returns true if the given object is an instance of Sni. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property certificateId

public certificateId: pulumi.Output<string>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Target

class Target extends CustomResource

constructor

new Target(name: string, args: TargetArgs, opts?: pulumi.CustomResourceOptions)

Create a Target resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TargetState, opts?: pulumi.CustomResourceOptions): Target

Get an existing Target resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Target

Returns true if the given object is an instance of Target. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property target

public target: pulumi.Output<string>;

property upstreamId

public upstreamId: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property weight

public weight: pulumi.Output<number>;

Resource Upstream

class Upstream extends CustomResource

constructor

new Upstream(name: string, args?: UpstreamArgs, opts?: pulumi.CustomResourceOptions)

Create a Upstream resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UpstreamState, opts?: pulumi.CustomResourceOptions): Upstream

Get an existing Upstream resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Upstream

Returns true if the given object is an instance of Upstream. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property hashFallback

public hashFallback: pulumi.Output<string | undefined>;

property hashFallbackHeader

public hashFallbackHeader: pulumi.Output<string | undefined>;

property hashOn

public hashOn: pulumi.Output<string | undefined>;

property hashOnCookie

public hashOnCookie: pulumi.Output<string | undefined>;

property hashOnCookiePath

public hashOnCookiePath: pulumi.Output<string | undefined>;

property hashOnHeader

public hashOnHeader: pulumi.Output<string | undefined>;

property healthchecks

public healthchecks: pulumi.Output<UpstreamHealthchecks>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

property slots

public slots: pulumi.Output<number | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface CertificateArgs

interface CertificateArgs

The set of arguments for constructing a Certificate resource.

property certificate

certificate: pulumi.Input<string>;

property privateKey

privateKey?: pulumi.Input<string>;

interface CertificateState

interface CertificateState

Input properties used for looking up and filtering Certificate resources.

property certificate

certificate?: pulumi.Input<string>;

property privateKey

privateKey?: pulumi.Input<string>;

interface ConsumerArgs

interface ConsumerArgs

The set of arguments for constructing a Consumer resource.

property customId

customId?: pulumi.Input<string>;

property username

username: pulumi.Input<string>;

interface ConsumerPluginConfigArgs

interface ConsumerPluginConfigArgs

The set of arguments for constructing a ConsumerPluginConfig resource.

property configJson

configJson?: pulumi.Input<string>;

JSON format of plugin config

property consumerId

consumerId: pulumi.Input<string>;

property pluginName

pluginName: pulumi.Input<string>;

interface ConsumerPluginConfigState

interface ConsumerPluginConfigState

Input properties used for looking up and filtering ConsumerPluginConfig resources.

property computedConfig

computedConfig?: pulumi.Input<string>;

property configJson

configJson?: pulumi.Input<string>;

JSON format of plugin config

property consumerId

consumerId?: pulumi.Input<string>;

property pluginName

pluginName?: pulumi.Input<string>;

interface ConsumerState

interface ConsumerState

Input properties used for looking up and filtering Consumer resources.

property customId

customId?: pulumi.Input<string>;

property username

username?: pulumi.Input<string>;

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

function getVersion

getVersion(): string

interface PluginArgs

interface PluginArgs

The set of arguments for constructing a Plugin resource.

property configJson

configJson?: pulumi.Input<string>;

plugin configuration in JSON format, configuration must be a valid JSON object.

property consumerId

consumerId?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

property name

name?: pulumi.Input<string>;

property routeId

routeId?: pulumi.Input<string>;

property serviceId

serviceId?: pulumi.Input<string>;

property strictMatch

strictMatch?: pulumi.Input<boolean>;

interface PluginState

interface PluginState

Input properties used for looking up and filtering Plugin resources.

property computedConfig

computedConfig?: pulumi.Input<string>;

property configJson

configJson?: pulumi.Input<string>;

plugin configuration in JSON format, configuration must be a valid JSON object.

property consumerId

consumerId?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

property name

name?: pulumi.Input<string>;

property routeId

routeId?: pulumi.Input<string>;

property serviceId

serviceId?: pulumi.Input<string>;

property strictMatch

strictMatch?: pulumi.Input<boolean>;

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property kongAdminPassword

kongAdminPassword?: pulumi.Input<string>;

An basic auth password for kong admin

property kongAdminToken

kongAdminToken?: pulumi.Input<string>;

API key for the kong api (Enterprise Edition)

property kongAdminUri

kongAdminUri?: pulumi.Input<string>;

The address of the kong admin url e.g. http://localhost:8001

property kongAdminUsername

kongAdminUsername?: pulumi.Input<string>;

An basic auth user for kong admin

property kongApiKey

kongApiKey?: pulumi.Input<string>;

API key for the kong api (if you have locked it down)

property strictPluginsMatch

strictPluginsMatch?: pulumi.Input<boolean>;

Should plugins config_json field strictly match plugin configuration

property tlsSkipVerify

tlsSkipVerify?: pulumi.Input<boolean>;

Whether to skip tls verify for https kong api endpoint using self signed or untrusted certs

interface RouteArgs

interface RouteArgs

The set of arguments for constructing a Route resource.

property destinations

destinations?: pulumi.Input<pulumi.Input<RouteDestination>[]>;

property hosts

hosts?: pulumi.Input<pulumi.Input<string>[]>;

property methods

methods?: pulumi.Input<pulumi.Input<string>[]>;

property name

name?: pulumi.Input<string>;

property paths

paths?: pulumi.Input<pulumi.Input<string>[]>;

property preserveHost

preserveHost?: pulumi.Input<boolean>;

property protocols

protocols: pulumi.Input<pulumi.Input<string>[]>;

property regexPriority

regexPriority?: pulumi.Input<number>;

property serviceId

serviceId: pulumi.Input<string>;

property snis

snis?: pulumi.Input<pulumi.Input<string>[]>;

property sources

sources?: pulumi.Input<pulumi.Input<RouteSource>[]>;

property stripPath

stripPath?: pulumi.Input<boolean>;

interface RouteState

interface RouteState

Input properties used for looking up and filtering Route resources.

property destinations

destinations?: pulumi.Input<pulumi.Input<RouteDestination>[]>;

property hosts

hosts?: pulumi.Input<pulumi.Input<string>[]>;

property methods

methods?: pulumi.Input<pulumi.Input<string>[]>;

property name

name?: pulumi.Input<string>;

property paths

paths?: pulumi.Input<pulumi.Input<string>[]>;

property preserveHost

preserveHost?: pulumi.Input<boolean>;

property protocols

protocols?: pulumi.Input<pulumi.Input<string>[]>;

property regexPriority

regexPriority?: pulumi.Input<number>;

property serviceId

serviceId?: pulumi.Input<string>;

property snis

snis?: pulumi.Input<pulumi.Input<string>[]>;

property sources

sources?: pulumi.Input<pulumi.Input<RouteSource>[]>;

property stripPath

stripPath?: pulumi.Input<boolean>;

interface ServiceArgs

interface ServiceArgs

The set of arguments for constructing a Service resource.

property connectTimeout

connectTimeout?: pulumi.Input<number>;

property host

host?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

property path

path?: pulumi.Input<string>;

property port

port?: pulumi.Input<number>;

property protocol

protocol: pulumi.Input<string>;

property readTimeout

readTimeout?: pulumi.Input<number>;

property retries

retries?: pulumi.Input<number>;

property writeTimeout

writeTimeout?: pulumi.Input<number>;

interface ServiceState

interface ServiceState

Input properties used for looking up and filtering Service resources.

property connectTimeout

connectTimeout?: pulumi.Input<number>;

property host

host?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

property path

path?: pulumi.Input<string>;

property port

port?: pulumi.Input<number>;

property protocol

protocol?: pulumi.Input<string>;

property readTimeout

readTimeout?: pulumi.Input<number>;

property retries

retries?: pulumi.Input<number>;

property writeTimeout

writeTimeout?: pulumi.Input<number>;

interface SniArgs

interface SniArgs

The set of arguments for constructing a Sni resource.

property certificateId

certificateId: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

interface SniState

interface SniState

Input properties used for looking up and filtering Sni resources.

property certificateId

certificateId?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

interface TargetArgs

interface TargetArgs

The set of arguments for constructing a Target resource.

property target

target: pulumi.Input<string>;

property upstreamId

upstreamId: pulumi.Input<string>;

property weight

weight: pulumi.Input<number>;

interface TargetState

interface TargetState

Input properties used for looking up and filtering Target resources.

property target

target?: pulumi.Input<string>;

property upstreamId

upstreamId?: pulumi.Input<string>;

property weight

weight?: pulumi.Input<number>;

interface UpstreamArgs

interface UpstreamArgs

The set of arguments for constructing a Upstream resource.

property hashFallback

hashFallback?: pulumi.Input<string>;

property hashFallbackHeader

hashFallbackHeader?: pulumi.Input<string>;

property hashOn

hashOn?: pulumi.Input<string>;

property hashOnCookie

hashOnCookie?: pulumi.Input<string>;

property hashOnCookiePath

hashOnCookiePath?: pulumi.Input<string>;

property hashOnHeader

hashOnHeader?: pulumi.Input<string>;

property healthchecks

healthchecks?: pulumi.Input<UpstreamHealthchecks>;

property name

name?: pulumi.Input<string>;

property slots

slots?: pulumi.Input<number>;

interface UpstreamState

interface UpstreamState

Input properties used for looking up and filtering Upstream resources.

property hashFallback

hashFallback?: pulumi.Input<string>;

property hashFallbackHeader

hashFallbackHeader?: pulumi.Input<string>;

property hashOn

hashOn?: pulumi.Input<string>;

property hashOnCookie

hashOnCookie?: pulumi.Input<string>;

property hashOnCookiePath

hashOnCookiePath?: pulumi.Input<string>;

property hashOnHeader

hashOnHeader?: pulumi.Input<string>;

property healthchecks

healthchecks?: pulumi.Input<UpstreamHealthchecks>;

property name

name?: pulumi.Input<string>;

property slots

slots?: pulumi.Input<number>;