Package org.cdk8s.plus24

Interface PodDnsProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PodDnsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-04T02:31:04.966Z")
@Stability(Stable)
public interface PodDnsProps
extends software.amazon.jsii.JsiiSerializable

Properties for `PodDns`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PodDnsProps.Builder	builder()
default String	getHostname()	Specifies the hostname of the Pod.
default Boolean	getHostnameAsFQDN()	If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).
default List<String>	getNameservers()	A list of IP addresses that will be used as DNS servers for the Pod.
default List<DnsOption>	getOptions()	List of objects where each object may have a name property (required) and a value property (optional).
default DnsPolicy	getPolicy()	Set DNS policy for the pod.
default List<String>	getSearches()	A list of DNS search domains for hostname lookup in the Pod.
default String	getSubdomain()	If specified, the fully qualified Pod hostname will be "...svc.".

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHostname

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

Specifies the hostname of the Pod.

Default: - Set to a system-defined value.

getHostnameAsFQDN

@Stability(Stable)
@Nullable
default Boolean getHostnameAsFQDN()

If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).

In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect.

Default: false

getNameservers

@Stability(Stable)
@Nullable
default List<String> getNameservers()

A list of IP addresses that will be used as DNS servers for the Pod.

There can be at most 3 IP addresses specified. When the policy is set to "NONE", the list must contain at least one IP address, otherwise this property is optional. The servers listed will be combined to the base nameservers generated from the specified DNS policy with duplicate addresses removed.

getOptions

@Stability(Stable)
@Nullable
default List<DnsOption> getOptions()

List of objects where each object may have a name property (required) and a value property (optional).

The contents in this property will be merged to the options generated from the specified DNS policy. Duplicate entries are removed.

getPolicy

@Stability(Stable)
@Nullable
default DnsPolicy getPolicy()

Set DNS policy for the pod.

If policy is set to None, other configuration must be supplied.

Default: DnsPolicy.CLUSTER_FIRST

getSearches

@Stability(Stable)
@Nullable
default List<String> getSearches()

A list of DNS search domains for hostname lookup in the Pod.

When specified, the provided list will be merged into the base search domain names generated from the chosen DNS policy. Duplicate domain names are removed.

Kubernetes allows for at most 6 search domains.

getSubdomain

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

If specified, the fully qualified Pod hostname will be "...svc.".

Default: - No subdomain.

builder

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

Returns:

a PodDnsProps.Builder of PodDnsProps