Package org.cdk8s.plus25.k8s

Interface WebhookClientConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WebhookClientConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.88.0 (build eaabd08)",
           date="2023-09-11T06:17:58.852Z")
@Stability(Stable)
public interface WebhookClientConfig
extends software.amazon.jsii.JsiiSerializable

WebhookClientConfig contains the information to make a TLS connection with the webhook.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WebhookClientConfig.Builder	A builder for WebhookClientConfig
static class	WebhookClientConfig.Jsii$Proxy	An implementation for WebhookClientConfig

Method Summary

Modifier and Type	Method	Description
static WebhookClientConfig.Builder	builder()
default String	getCaBundle()	caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.
default ServiceReference	getService()	service is a reference to the service for this webhook.
default String	getUrl()	url gives the location of the webhook, in standard URL form (scheme://host:port/path).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCaBundle

@Stability(Stable)
@Nullable
default String getCaBundle()

caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.

If unspecified, system trust roots on the apiserver are used.

getService

@Stability(Stable)
@Nullable
default ServiceReference getService()

service is a reference to the service for this webhook. Either service or url must be specified.

If the webhook is running within the cluster, then you should use service.

getUrl

@Stability(Stable)
@Nullable
default String getUrl()

url gives the location of the webhook, in standard URL form (scheme://host:port/path).

Exactly one of url or service must be specified.

The host should not refer to a service running in the cluster; use the service field instead. The host might be resolved via external DNS in some apiservers (e.g., kube-apiserver cannot resolve in-cluster DNS as that would be a layering violation). host may also be an IP address.

Please note that using localhost or 127.0.0.1 as a host is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.

The scheme must be "https"; the URL must begin with "https://".

A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.

Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.

builder

@Stability(Stable)
static WebhookClientConfig.Builder builder()

Returns:

a WebhookClientConfig.Builder of WebhookClientConfig