KubernetesIngressResource

Handle

📦 Aspire.Hosting.Kubernetes v13.4.0-preview.1.26281.18

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;
  withIngressHostAndPath(
      host: string,
      path: string,
      endpoint: EndpointReference,
      pathType?: IngressPathType): KubernetesIngressResource;
  withIngressHostnameParam(hostname: ParameterResource): KubernetesIngressResource;
  withIngressPath(
      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 the ingress. The default backend handles requests that do not match any of the defined routing rules.

withDefaultBackend(endpoint: EndpointReference): KubernetesIngressResource

Parameters

endpoint EndpointReference

Returns

KubernetesIngressResource

method withHostname builder

Adds a hostname that this ingress matches. Multiple hostnames can be added by calling this method repeatedly. If no hostnames are configured, the ingress matches all hosts.

withHostname(hostname: string): KubernetesIngressResource

Parameters

hostname string

Returns

KubernetesIngressResource

method withIngressAnnotation builder

Adds a Kubernetes metadata annotation to the generated Ingress resource. These are key-value pairs in the `metadata.annotations` field of the K8S Ingress, commonly used to configure ingress controller-specific behavior.

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

Parameters

key string

value string

Returns

KubernetesIngressResource

method withIngressAnnotationParam builder

Adds a Kubernetes metadata annotation with a parameter value that will be resolved at deploy time.

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

Parameters

key string

value ParameterResource

Returns

KubernetesIngressResource

method withIngressClass builder

Sets the Kubernetes ingress class name that selects which ingress controller handles this ingress resource.

withIngressClass(className: string): KubernetesIngressResource

Parameters

className string

Returns

KubernetesIngressResource

method withIngressClassParam builder

Sets the Kubernetes ingress class name using a parameter that will be resolved at deploy time.

withIngressClassParam(className: ParameterResource): KubernetesIngressResource

Parameters

className ParameterResource

Returns

KubernetesIngressResource

method withIngressHostAndPath builder

Adds a host-scoped path rule to the ingress. The rule matches traffic for the specified host and path, forwarding it to the given endpoint's backing Kubernetes service.

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

Parameters

host string

path string

endpoint EndpointReference

pathType IngressPathType optional = Prefix

Returns

KubernetesIngressResource

method withIngressHostnameParam builder

Adds a hostname using a parameter that will be resolved at deploy time.

withIngressHostnameParam(hostname: ParameterResource): KubernetesIngressResource

Parameters

hostname ParameterResource

Returns

KubernetesIngressResource

method withIngressPath builder

Adds a path-based rule to the ingress. The rule matches all hosts and forwards traffic matching the specified path to the given endpoint's backing Kubernetes service.

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

Parameters

path string

endpoint EndpointReference

pathType IngressPathType optional = Prefix

Returns

KubernetesIngressResource

method withIngressTlsAuto builder

Configures TLS termination with an auto-generated secret name derived from the ingress name.

withIngressTlsAuto(): KubernetesIngressResource

Returns

KubernetesIngressResource

method withIngressTlsParam builder

Configures TLS termination using a parameter for the secret name.

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