Package org.cdk8s.plus24

Class Ingress

  • All Implemented Interfaces:
    IApiEndpoint, IApiResource, IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-08T02:54:19.236Z")
@Stability(Stable)
public class Ingress
extends Resource
    Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend.

    An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

    • Constructor Detail

      • Ingress

        protected Ingress​(software.amazon.jsii.JsiiObjectRef objRef)

      • Ingress

        protected Ingress​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • Ingress

        @Stability(Stable)
public Ingress​(@NotNull
               software.constructs.Construct scope,
               @NotNull
               String id,
               @Nullable
               IngressProps props)
        Parameters:
        scope - This parameter is required.
        id - This parameter is required.
        props -

      • Ingress

        @Stability(Stable)
public Ingress​(@NotNull
               software.constructs.Construct scope,
               @NotNull
               String id)
        Parameters:
        scope - This parameter is required.
        id - This parameter is required.

    • Method Detail

      • addDefaultBackend

        @Stability(Stable)
public void addDefaultBackend​(@NotNull
                              IngressBackend backend)
        Defines the default backend for this ingress.

        A default backend capable of servicing requests that don't match any rule.

        Parameters:
        backend - The backend to use for requests that do not match any rule. This parameter is required.

      • addHostDefaultBackend

        @Stability(Stable)
public void addHostDefaultBackend​(@NotNull
                                  String host,
                                  @NotNull
                                  IngressBackend backend)
        Specify a default backend for a specific host name.

        This backend will be used as a catch-all for requests targeted to this host name (the Host header matches this value).

        Parameters:
        host - The host name to match. This parameter is required.
        backend - The backend to route to. This parameter is required.

      • addHostRule

        @Stability(Stable)
public void addHostRule​(@NotNull
                        String host,
                        @NotNull
                        String path,
                        @NotNull
                        IngressBackend backend,
                        @Nullable
                        HttpIngressPathType pathType)
        Adds an ingress rule applied to requests to a specific host and a specific HTTP path (the `Host` header matches this value).

        Parameters:
        host - The host name. This parameter is required.
        path - The HTTP path. This parameter is required.
        backend - The backend to route requests to. This parameter is required.
        pathType - How the path is matched against request paths.

      • addHostRule

        @Stability(Stable)
public void addHostRule​(@NotNull
                        String host,
                        @NotNull
                        String path,
                        @NotNull
                        IngressBackend backend)
        Adds an ingress rule applied to requests to a specific host and a specific HTTP path (the `Host` header matches this value).

        Parameters:
        host - The host name. This parameter is required.
        path - The HTTP path. This parameter is required.
        backend - The backend to route requests to. This parameter is required.

      • addRule

        @Stability(Stable)
public void addRule​(@NotNull
                    String path,
                    @NotNull
                    IngressBackend backend,
                    @Nullable
                    HttpIngressPathType pathType)
        Adds an ingress rule applied to requests sent to a specific HTTP path.

        Parameters:
        path - The HTTP path. This parameter is required.
        backend - The backend to route requests to. This parameter is required.
        pathType - How the path is matched against request paths.

      • addRule

        @Stability(Stable)
public void addRule​(@NotNull
                    String path,
                    @NotNull
                    IngressBackend backend)
        Adds an ingress rule applied to requests sent to a specific HTTP path.

        Parameters:
        path - The HTTP path. This parameter is required.
        backend - The backend to route requests to. This parameter is required.

      • addRules

        @Stability(Stable)
public void addRules​(@NotNull
                     @NotNull IngressRule... rules)
        Adds rules to this ingress.

        Parameters:
        rules - The rules to add. This parameter is required.

      • addTls

        @Stability(Stable)
public void addTls​(@NotNull
                   List<IngressTls> tls)
        Parameters:
        tls - This parameter is required.