Package org.cdk8s.plus24

Interface IngressRule

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IngressRule.Jsii$Proxy

@Generated(value="jsii-pacmak/1.75.0 (build 63bb957)",
           date="2023-02-20T02:42:01.880Z")
@Stability(Stable)
public interface IngressRule
extends software.amazon.jsii.JsiiSerializable

Represents the rules mapping the paths under a specified host to the related backend services.

Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching path.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static IngressRule.Builder	builder()
IngressBackend	getBackend()	Backend defines the referenced service endpoint to which the traffic will be forwarded to.
default String	getHost()	Host is the fully qualified domain name of a network host, as defined by RFC 3986.
default String	getPath()	Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request.
default HttpIngressPathType	getPathType()	Specify how the path is matched against request paths.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBackend

@Stability(Stable)
@NotNull
IngressBackend getBackend()

Backend defines the referenced service endpoint to which the traffic will be forwarded to.

getHost

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

Host is the fully qualified domain name of a network host, as defined by RFC 3986.

Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the IP in the Spec of the parent Ingress. 2. The : delimiter is not respected because ports are not allowed. Currently the port of an Ingress is implicitly :80 for http and :443 for https. Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue.

Default: - If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue.

getPath

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

Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'.

Default: - If unspecified, the path defaults to a catch all sending traffic to the backend.

getPathType

@Stability(Stable)
@Nullable
default HttpIngressPathType getPathType()

Specify how the path is matched against request paths.

By default, path types will be matched by prefix.

See Also:

https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types

builder

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

Returns:

a IngressRule.Builder of IngressRule