1. Packages
  2. Kong Provider
  3. API Docs
  4. Provider
Kong v4.5.8 published on Wednesday, Feb 12, 2025 by Pulumi

kong.Provider

Explore with Pulumi AI

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.

Create Provider Resource

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

Constructor syntax

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

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             kong_admin_password: Optional[str] = None,
             kong_admin_token: Optional[str] = None,
             kong_admin_uri: Optional[str] = None,
             kong_admin_username: Optional[str] = None,
             kong_api_key: Optional[str] = None,
             kong_workspace: Optional[str] = None,
             strict_plugins_match: Optional[bool] = None,
             tls_skip_verify: Optional[bool] = None)
func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)
type: pulumi:providers:kong
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Provider 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 Provider resource accepts the following input properties:

KongAdminUri This property is required. string
The address of the kong admin url e.g. http://localhost:8001
KongAdminPassword string
An basic auth password for kong admin
KongAdminToken string
API key for the kong api (Enterprise Edition)
KongAdminUsername string
An basic auth user for kong admin
KongApiKey string
API key for the kong api (if you have locked it down)
KongWorkspace string
Workspace context (Enterprise Edition)
StrictPluginsMatch bool
Should plugins config_json field strictly match plugin configuration It can also be sourced from the following environment variable: STRICT_PLUGINS_MATCH
TlsSkipVerify bool
Whether to skip tls verify for https kong api endpoint using self signed or untrusted certs It can also be sourced from the following environment variable: TLS_SKIP_VERIFY
KongAdminUri This property is required. string
The address of the kong admin url e.g. http://localhost:8001
KongAdminPassword string
An basic auth password for kong admin
KongAdminToken string
API key for the kong api (Enterprise Edition)
KongAdminUsername string
An basic auth user for kong admin
KongApiKey string
API key for the kong api (if you have locked it down)
KongWorkspace string
Workspace context (Enterprise Edition)
StrictPluginsMatch bool
Should plugins config_json field strictly match plugin configuration It can also be sourced from the following environment variable: STRICT_PLUGINS_MATCH
TlsSkipVerify bool
Whether to skip tls verify for https kong api endpoint using self signed or untrusted certs It can also be sourced from the following environment variable: TLS_SKIP_VERIFY
kongAdminUri This property is required. String
The address of the kong admin url e.g. http://localhost:8001
kongAdminPassword String
An basic auth password for kong admin
kongAdminToken String
API key for the kong api (Enterprise Edition)
kongAdminUsername String
An basic auth user for kong admin
kongApiKey String
API key for the kong api (if you have locked it down)
kongWorkspace String
Workspace context (Enterprise Edition)
strictPluginsMatch Boolean
Should plugins config_json field strictly match plugin configuration It can also be sourced from the following environment variable: STRICT_PLUGINS_MATCH
tlsSkipVerify Boolean
Whether to skip tls verify for https kong api endpoint using self signed or untrusted certs It can also be sourced from the following environment variable: TLS_SKIP_VERIFY
kongAdminUri This property is required. string
The address of the kong admin url e.g. http://localhost:8001
kongAdminPassword string
An basic auth password for kong admin
kongAdminToken string
API key for the kong api (Enterprise Edition)
kongAdminUsername string
An basic auth user for kong admin
kongApiKey string
API key for the kong api (if you have locked it down)
kongWorkspace string
Workspace context (Enterprise Edition)
strictPluginsMatch boolean
Should plugins config_json field strictly match plugin configuration It can also be sourced from the following environment variable: STRICT_PLUGINS_MATCH
tlsSkipVerify boolean
Whether to skip tls verify for https kong api endpoint using self signed or untrusted certs It can also be sourced from the following environment variable: TLS_SKIP_VERIFY
kong_admin_uri This property is required. str
The address of the kong admin url e.g. http://localhost:8001
kong_admin_password str
An basic auth password for kong admin
kong_admin_token str
API key for the kong api (Enterprise Edition)
kong_admin_username str
An basic auth user for kong admin
kong_api_key str
API key for the kong api (if you have locked it down)
kong_workspace str
Workspace context (Enterprise Edition)
strict_plugins_match bool
Should plugins config_json field strictly match plugin configuration It can also be sourced from the following environment variable: STRICT_PLUGINS_MATCH
tls_skip_verify bool
Whether to skip tls verify for https kong api endpoint using self signed or untrusted certs It can also be sourced from the following environment variable: TLS_SKIP_VERIFY
kongAdminUri This property is required. String
The address of the kong admin url e.g. http://localhost:8001
kongAdminPassword String
An basic auth password for kong admin
kongAdminToken String
API key for the kong api (Enterprise Edition)
kongAdminUsername String
An basic auth user for kong admin
kongApiKey String
API key for the kong api (if you have locked it down)
kongWorkspace String
Workspace context (Enterprise Edition)
strictPluginsMatch Boolean
Should plugins config_json field strictly match plugin configuration It can also be sourced from the following environment variable: STRICT_PLUGINS_MATCH
tlsSkipVerify Boolean
Whether to skip tls verify for https kong api endpoint using self signed or untrusted certs It can also be sourced from the following environment variable: TLS_SKIP_VERIFY

Outputs

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

Package Details

Repository
Kong pulumi/pulumi-kong
License
Apache-2.0
Notes
This Pulumi package is based on the kong Terraform Provider.