Pulumi Kong¶

class pulumi_kong.Certificate(resource_name, opts=None, certificate=None, private_key=None, __props__=None, __name__=None, __opts__=None)¶

Create a Certificate resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource.

static get(resource_name, id, opts=None, certificate=None, private_key=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kong.Consumer(resource_name, opts=None, custom_id=None, username=None, __props__=None, __name__=None, __opts__=None)¶

Create a Consumer resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource.

static get(resource_name, id, opts=None, custom_id=None, username=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kong.ConsumerPluginConfig(resource_name, opts=None, config_json=None, consumer_id=None, plugin_name=None, __props__=None, __name__=None, __opts__=None)¶

Create a ConsumerPluginConfig resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] config_json: JSON format of plugin config

config_json: pulumi.Output[str] = None¶

JSON format of plugin config

static get(resource_name, id, opts=None, computed_config=None, config_json=None, consumer_id=None, plugin_name=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• config_json (pulumi.Input[str]) – JSON format of plugin config

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kong.Plugin(resource_name, opts=None, config_json=None, consumer_id=None, enabled=None, name=None, route_id=None, service_id=None, strict_match=None, __props__=None, __name__=None, __opts__=None)¶

Create a Plugin resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] config_json: plugin configuration in JSON format, configuration must be a valid JSON object.

config_json: pulumi.Output[str] = None¶

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

static get(resource_name, id, opts=None, computed_config=None, config_json=None, consumer_id=None, enabled=None, name=None, route_id=None, service_id=None, strict_match=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• config_json (pulumi.Input[str]) – plugin configuration in JSON format, configuration must be a valid JSON object.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kong.Provider(resource_name, opts=None, kong_admin_password=None, kong_admin_token=None, kong_admin_uri=None, kong_admin_username=None, kong_api_key=None, strict_plugins_match=None, tls_skip_verify=None, __props__=None, __name__=None, __opts__=None)¶

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.

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• kong_admin_password (pulumi.Input[str]) – An basic auth password for kong admin

• kong_admin_token (pulumi.Input[str]) – API key for the kong api (Enterprise Edition)

• kong_admin_uri (pulumi.Input[str]) – The address of the kong admin url e.g. http://localhost:8001

• kong_admin_username (pulumi.Input[str]) – An basic auth user for kong admin

• kong_api_key (pulumi.Input[str]) – API key for the kong api (if you have locked it down)

• strict_plugins_match (pulumi.Input[bool]) – Should plugins config_json field strictly match plugin configuration

• tls_skip_verify (pulumi.Input[bool]) – Whether to skip tls verify for https kong api endpoint using self signed or untrusted certs

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kong.Route(resource_name, opts=None, destinations=None, hosts=None, methods=None, name=None, paths=None, preserve_host=None, protocols=None, regex_priority=None, service_id=None, snis=None, sources=None, strip_path=None, __props__=None, __name__=None, __opts__=None)¶

Create a Route resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource.

The destinations object supports the following:

• ip (pulumi.Input[str])

• port (pulumi.Input[float])

The sources object supports the following:

• ip (pulumi.Input[str])

• port (pulumi.Input[float])

static get(resource_name, id, opts=None, destinations=None, hosts=None, methods=None, name=None, paths=None, preserve_host=None, protocols=None, regex_priority=None, service_id=None, snis=None, sources=None, strip_path=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

The destinations object supports the following:

• ip (pulumi.Input[str])

• port (pulumi.Input[float])

The sources object supports the following:

• ip (pulumi.Input[str])

• port (pulumi.Input[float])

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kong.Service(resource_name, opts=None, connect_timeout=None, host=None, name=None, path=None, port=None, protocol=None, read_timeout=None, retries=None, write_timeout=None, __props__=None, __name__=None, __opts__=None)¶

Create a Service resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource.

static get(resource_name, id, opts=None, connect_timeout=None, host=None, name=None, path=None, port=None, protocol=None, read_timeout=None, retries=None, write_timeout=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kong.Sni(resource_name, opts=None, certificate_id=None, name=None, __props__=None, __name__=None, __opts__=None)¶

Create a Sni resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource.

static get(resource_name, id, opts=None, certificate_id=None, name=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kong.Target(resource_name, opts=None, target=None, upstream_id=None, weight=None, __props__=None, __name__=None, __opts__=None)¶

Create a Target resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource.

static get(resource_name, id, opts=None, target=None, upstream_id=None, weight=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kong.Upstream(resource_name, opts=None, hash_fallback=None, hash_fallback_header=None, hash_on=None, hash_on_cookie=None, hash_on_cookie_path=None, hash_on_header=None, healthchecks=None, name=None, slots=None, __props__=None, __name__=None, __opts__=None)¶

Create a Upstream resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource.

The healthchecks object supports the following:

• active (pulumi.Input[dict])

  • concurrency (pulumi.Input[float])

  • healthy (pulumi.Input[dict])

    • httpStatuses (pulumi.Input[list])

    • interval (pulumi.Input[float])

    • successes (pulumi.Input[float])

  • httpPath (pulumi.Input[str])

  • httpsSni (pulumi.Input[str])

  • httpsVerifyCertificate (pulumi.Input[bool])

  • timeout (pulumi.Input[float])

  • type (pulumi.Input[str])

  • unhealthy (pulumi.Input[dict])

    • httpFailures (pulumi.Input[float])

    • httpStatuses (pulumi.Input[list])

    • interval (pulumi.Input[float])

    • tcpFailures (pulumi.Input[float])

    • timeouts (pulumi.Input[float])

• passive (pulumi.Input[dict])

  • healthy (pulumi.Input[dict])

    • httpStatuses (pulumi.Input[list])

    • successes (pulumi.Input[float])

  • type (pulumi.Input[str])

  • unhealthy (pulumi.Input[dict])

    • httpFailures (pulumi.Input[float])

    • httpStatuses (pulumi.Input[list])

    • tcpFailures (pulumi.Input[float])

    • timeouts (pulumi.Input[float])

static get(resource_name, id, opts=None, hash_fallback=None, hash_fallback_header=None, hash_on=None, hash_on_cookie=None, hash_on_cookie_path=None, hash_on_header=None, healthchecks=None, name=None, slots=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

The healthchecks object supports the following:

• active (pulumi.Input[dict])

  • concurrency (pulumi.Input[float])

  • healthy (pulumi.Input[dict])

    • httpStatuses (pulumi.Input[list])

    • interval (pulumi.Input[float])

    • successes (pulumi.Input[float])

  • httpPath (pulumi.Input[str])

  • httpsSni (pulumi.Input[str])

  • httpsVerifyCertificate (pulumi.Input[bool])

  • timeout (pulumi.Input[float])

  • type (pulumi.Input[str])

  • unhealthy (pulumi.Input[dict])

    • httpFailures (pulumi.Input[float])

    • httpStatuses (pulumi.Input[list])

    • interval (pulumi.Input[float])

    • tcpFailures (pulumi.Input[float])

    • timeouts (pulumi.Input[float])

• passive (pulumi.Input[dict])

  • healthy (pulumi.Input[dict])

    • httpStatuses (pulumi.Input[list])

    • successes (pulumi.Input[float])

  • type (pulumi.Input[str])

  • unhealthy (pulumi.Input[dict])

    • httpFailures (pulumi.Input[float])

    • httpStatuses (pulumi.Input[list])

    • tcpFailures (pulumi.Input[float])

    • timeouts (pulumi.Input[float])

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str