KubernetesIngressResource

Handle

📦 Aspire.Hosting.Kubernetes v13.6.0-preview.1.26478.8

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

methodwithDefaultBackendbuilder

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

endpointEndpointReference

Returns

KubernetesIngressResource

methodwithHostnamebuilder

Adds a hostname that this ingress matches. Multiple hostnames can be added by calling this method repeatedly. Path rules without an explicit host apply to each configured hostname. If no hostnames are configured, those rules match all hosts.

withHostname(hostname: string): KubernetesIngressResource

Parameters

hostnamestring

Returns

KubernetesIngressResource

methodwithIngressAnnotationbuilder

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

keystring

valuestring

Returns

KubernetesIngressResource

methodwithIngressAnnotationParambuilder

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

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

Parameters

keystring

valueParameterResource

Returns

KubernetesIngressResource

methodwithIngressClassbuilder

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

withIngressClass(className: string): KubernetesIngressResource

Parameters

classNamestring

Returns

KubernetesIngressResource

methodwithIngressClassParambuilder

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

withIngressClassParam(className: ParameterResource): KubernetesIngressResource

Parameters

classNameParameterResource

Returns

KubernetesIngressResource

methodwithIngressHostAndPathbuilder

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

hoststring

pathstring

endpointEndpointReference

pathTypeIngressPathTypeoptional= Prefix

Returns

KubernetesIngressResource

methodwithIngressHostnameParambuilder

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

withIngressHostnameParam(hostname: ParameterResource): KubernetesIngressResource

Parameters

hostnameParameterResource

Returns

KubernetesIngressResource

methodwithIngressPathbuilder

Adds a path-based rule to the ingress. The rule matches each hostname configured with `WithHostname`, or all hosts when no hostname is configured, and forwards matching traffic to the endpoint's backing Kubernetes service.

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

Parameters

pathstring

endpointEndpointReference

pathTypeIngressPathTypeoptional= Prefix

Returns

KubernetesIngressResource

methodwithIngressTlsAutobuilder

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

withIngressTlsAuto(): KubernetesIngressResource

Returns

KubernetesIngressResource

methodwithIngressTlsParambuilder

Configures TLS termination using a parameter for the secret name.

withIngressTlsParam(secretName: ParameterResource): KubernetesIngressResource

Parameters

secretNameParameterResource

Returns

KubernetesIngressResource

methodwithTlsbuilder

Configures TLS for a Kubernetes Ingress using a K8S secret

withTls(secretName: string): KubernetesIngressResource

Parameters

secretNamestring

Returns

KubernetesIngressResource