org.cdk8s.plus

Class Ingress

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

org.cdk8s.plus.Resource

org.cdk8s.plus.Ingress

All Implemented Interfaces:

IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.13.0 (build 385c325)",
           date="2020-10-21T06:58:44.663Z")
 @Stability(value=Experimental)
public class Ingress
extends Resource

(experimental) 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Ingress.Builder (experimental) A fluent builder for Ingress.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	Ingress(software.constructs.Construct scope, String id)
	Ingress(software.constructs.Construct scope, String id, IngressProps props)
protected	Ingress(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Ingress(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addDefaultBackend(IngressBackend backend) (experimental) Defines the default backend for this ingress.
void	addHostDefaultBackend(String host, IngressBackend backend) (experimental) Specify a default backend for a specific host name.
void	addHostRule(String host, String path, IngressBackend backend) (experimental) Adds an ingress rule applied to requests to a specific host and a specific HTTP path (the `Host` header matches this value).
void	addRule(String path, IngressBackend backend) (experimental) Adds an ingress rule applied to requests sent to a specific HTTP path.
void	addRules(IngressRule... rules) (experimental) Adds rules to this ingress.
protected ApiObject	getApiObject() (experimental) The underlying cdk8s API object.
protected List<String>	onValidate() (experimental) Validate the current construct.

Methods inherited from class org.cdk8s.plus.Resource

getMetadata, getName

Methods inherited from class software.constructs.Construct

onPrepare, onSynthesize, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Ingress

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

Ingress

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

Ingress

@Stability(value=Experimental)
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(value=Experimental)
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(value=Experimental)
public void addDefaultBackend(@NotNull
                                                             IngressBackend backend)

(experimental) 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(value=Experimental)
public void addHostDefaultBackend(@NotNull
                                                                 String host,
                                                                 @NotNull
                                                                 IngressBackend backend)

(experimental) 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(value=Experimental)
public void addHostRule(@NotNull
                                                       String host,
                                                       @NotNull
                                                       String path,
                                                       @NotNull
                                                       IngressBackend backend)

(experimental) 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(value=Experimental)
public void addRule(@NotNull
                                                   String path,
                                                   @NotNull
                                                   IngressBackend backend)

(experimental) 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(value=Experimental)
public void addRules(@NotNull
                                                    IngressRule... rules)

(experimental) Adds rules to this ingress.

Parameters:

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

onValidate

@Stability(value=Experimental)
 @NotNull
protected List<String> onValidate()

(experimental) Validate the current construct.

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Overrides:

onValidate in class software.constructs.Construct

getApiObject

@Stability(value=Experimental)
 @NotNull
protected ApiObject getApiObject()

(experimental) The underlying cdk8s API object.

Specified by:

getApiObject in class Resource

See Also:

base.Resource.apiObject