Package org.cdk8s.plus24.k8s

Interface IngressSpec

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IngressSpec.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-26T02:32:35.053Z")
@Stability(Stable)
public interface IngressSpec
extends software.amazon.jsii.JsiiSerializable

IngressSpec describes the Ingress the user wishes to exist.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static IngressSpec.Builder	builder()
default IngressBackend	getDefaultBackend()	DefaultBackend is the backend that should handle requests that don't match any rule.
default String	getIngressClassName()	IngressClassName is the name of the IngressClass cluster resource.
default List<IngressRule>	getRules()	A list of host rules used to configure the Ingress.
default List<IngressTls>	getTls()	TLS configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDefaultBackend

@Stability(Stable)
@Nullable
default IngressBackend getDefaultBackend()

DefaultBackend is the backend that should handle requests that don't match any rule.

If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller.

getIngressClassName

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

IngressClassName is the name of the IngressClass cluster resource.

The associated IngressClass defines which controller will implement the resource. This replaces the deprecated kubernetes.io/ingress.class annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation.

getRules

@Stability(Stable)
@Nullable
default List<IngressRule> getRules()

A list of host rules used to configure the Ingress.

If unspecified, or no rule matches, all traffic is sent to the default backend.

getTls

@Stability(Stable)
@Nullable
default List<IngressTls> getTls()

TLS configuration.

Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.

builder

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

Returns:

a IngressSpec.Builder of IngressSpec