KubernetesIngressResource

Handle

📦 Aspire.Hosting.Kubernetes v13.3.0-preview.1.26254.5

interface KubernetesIngressResource
  extends IResource,
    IResourceWithParent,
    KubernetesEnvironmentResource]] {
  withDefaultBackend(endpoint: EndpointReference): KubernetesIngressResource;
  withHostname(hostname: string): KubernetesIngressResource;
  withIngressAnnotation(
      key: string,
      value: string): KubernetesIngressResource;
  withIngressAnnotationParam(
      key: string,
      value: ParameterResource): KubernetesIngressResource;
  withIngressClass(className: string): KubernetesIngressResource;
  withIngressClassParam(className: ParameterResource): KubernetesIngressResource;
  withIngressHostnameParam(hostname: ParameterResource): KubernetesIngressResource;
  withIngressHostRoute(
      host: string,
      path: string,
      endpoint: EndpointReference,
      pathType?: IngressPathType): KubernetesIngressResource;
  withIngressPathRoute(
      path: string,
      endpoint: EndpointReference,
      pathType?: IngressPathType): KubernetesIngressResource;
  withIngressTlsAuto(): KubernetesIngressResource;
  withIngressTlsParam(secretName: ParameterResource): KubernetesIngressResource;
  withTls(secretName: string): KubernetesIngressResource;
}

12 members

Methods

method withDefaultBackend builder

Sets the default backend for a Kubernetes Ingress

withDefaultBackend(endpoint: EndpointReference): KubernetesIngressResource

Parameters

endpoint EndpointReference

Returns

KubernetesIngressResource

method withHostname builder

Adds a hostname to a Kubernetes Ingress

withHostname(hostname: string): KubernetesIngressResource

Parameters

hostname string

Returns

KubernetesIngressResource

method withIngressAnnotation builder

Adds a Kubernetes metadata annotation to a Kubernetes Ingress

withIngressAnnotation(
    key: string,
    value: string): KubernetesIngressResource

Parameters

key string

value string

Returns

KubernetesIngressResource

method withIngressAnnotationParam builder

Adds a parameterized Kubernetes metadata annotation to an Ingress

withIngressAnnotationParam(
    key: string,
    value: ParameterResource): KubernetesIngressResource

Parameters

key string

value ParameterResource

Returns

KubernetesIngressResource

method withIngressClass builder

Sets the ingress class for a Kubernetes Ingress

withIngressClass(className: string): KubernetesIngressResource

Parameters

className string

Returns

KubernetesIngressResource

method withIngressClassParam builder

Sets a parameterized ingress class for a Kubernetes Ingress

withIngressClassParam(className: ParameterResource): KubernetesIngressResource

Parameters

className ParameterResource

Returns

KubernetesIngressResource

method withIngressHostnameParam builder

Adds a parameterized hostname to a Kubernetes Ingress

withIngressHostnameParam(hostname: ParameterResource): KubernetesIngressResource

Parameters

hostname ParameterResource

Returns

KubernetesIngressResource

method withIngressHostRoute builder

Adds a host-and-path route to a Kubernetes Ingress

withIngressHostRoute(
    host: string,
    path: string,
    endpoint: EndpointReference,
    pathType?: IngressPathType): KubernetesIngressResource

Parameters

host string

path string

endpoint EndpointReference

pathType IngressPathType optional = Prefix

Returns

KubernetesIngressResource

method withIngressPathRoute builder

Adds a path-based route to a Kubernetes Ingress

withIngressPathRoute(
    path: string,
    endpoint: EndpointReference,
    pathType?: IngressPathType): KubernetesIngressResource

Parameters

path string

endpoint EndpointReference

pathType IngressPathType optional = Prefix

Returns

KubernetesIngressResource

method withIngressTlsAuto builder

Configures TLS for a Kubernetes Ingress with an auto-generated secret

withIngressTlsAuto(): KubernetesIngressResource

Returns

KubernetesIngressResource

method withIngressTlsParam builder

Configures TLS for a Kubernetes Ingress with a parameterized secret

withIngressTlsParam(secretName: ParameterResource): KubernetesIngressResource

Parameters

secretName ParameterResource

Returns

KubernetesIngressResource

method withTls builder

Configures TLS for a Kubernetes Ingress using a K8S secret

withTls(secretName: string): KubernetesIngressResource

Parameters

secretName string

Returns

KubernetesIngressResource