# KubernetesIngressResource

- Module: [Aspire.Hosting.Kubernetes](/reference/api/go/aspire.hosting.kubernetes.md)
- Version: `13.6.5-preview.1.26559.7`
- Kind: `handle`
- Source: [GitHub](https://github.com/microsoft/aspire/tree/b33d222049f1ecc3bc7257ec07b622fe550b2580)

Represents a Kubernetes Ingress as a first-class resource in the Aspire application model. An Ingress defines HTTP routing rules that direct external traffic to services in the cluster.

## Definition

```go
type KubernetesIngressResource interface {
    Resource
    ResourceWithParent
}
```

## Embeds

- `Resource`
- `ResourceWithParent`

## Methods

- [WithDefaultBackend](/reference/api/go/aspire.hosting.kubernetes/kubernetesingressresource/withdefaultbackend.md) -- `method` -- Sets the default backend for the ingress. The default backend handles requests that do not match any of the defined routing rules.
  ```go
  WithDefaultBackend(endpoint EndpointReference) KubernetesIngressResource
  ```
- [WithHostname](/reference/api/go/aspire.hosting.kubernetes/kubernetesingressresource/withhostname.md) -- `method` -- 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.
  ```go
  WithHostname(hostname string) KubernetesIngressResource
  ```
- [WithIngressAnnotation](/reference/api/go/aspire.hosting.kubernetes/kubernetesingressresource/withingressannotation.md) -- `method` -- 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.
  ```go
  WithIngressAnnotation(key string, value string) KubernetesIngressResource
  ```
- [WithIngressAnnotationParam](/reference/api/go/aspire.hosting.kubernetes/kubernetesingressresource/withingressannotationparam.md) -- `method` -- Adds a Kubernetes metadata annotation with a parameter value that will be resolved at deploy time.
  ```go
  WithIngressAnnotationParam(key string, value ParameterResource) KubernetesIngressResource
  ```
- [WithIngressClass](/reference/api/go/aspire.hosting.kubernetes/kubernetesingressresource/withingressclass.md) -- `method` -- Sets the Kubernetes ingress class name that selects which ingress controller handles this ingress resource.
  ```go
  WithIngressClass(className string) KubernetesIngressResource
  ```
- [WithIngressClassParam](/reference/api/go/aspire.hosting.kubernetes/kubernetesingressresource/withingressclassparam.md) -- `method` -- Sets the Kubernetes ingress class name using a parameter that will be resolved at deploy time.
  ```go
  WithIngressClassParam(className ParameterResource) KubernetesIngressResource
  ```
- [WithIngressHostAndPath](/reference/api/go/aspire.hosting.kubernetes/kubernetesingressresource/withingresshostandpath.md) -- `method` -- 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.
  ```go
  WithIngressHostAndPath(host string, path string, endpoint EndpointReference, options ...*WithIngressHostAndPathOptions) KubernetesIngressResource
  ```
- [WithIngressHostnameParam](/reference/api/go/aspire.hosting.kubernetes/kubernetesingressresource/withingresshostnameparam.md) -- `method` -- Adds a hostname using a parameter that will be resolved at deploy time.
  ```go
  WithIngressHostnameParam(hostname ParameterResource) KubernetesIngressResource
  ```
- [WithIngressPath](/reference/api/go/aspire.hosting.kubernetes/kubernetesingressresource/withingresspath.md) -- `method` -- 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.
  ```go
  WithIngressPath(path string, endpoint EndpointReference, options ...*WithIngressPathOptions) KubernetesIngressResource
  ```
- [WithIngressTlsAuto](/reference/api/go/aspire.hosting.kubernetes/kubernetesingressresource/withingresstlsauto.md) -- `method` -- Configures TLS termination with an auto-generated secret name derived from the ingress name.
  ```go
  WithIngressTlsAuto() KubernetesIngressResource
  ```
- [WithIngressTlsParam](/reference/api/go/aspire.hosting.kubernetes/kubernetesingressresource/withingresstlsparam.md) -- `method` -- Configures TLS termination using a parameter for the secret name.
  ```go
  WithIngressTlsParam(secretName ParameterResource) KubernetesIngressResource
  ```
- [WithTls](/reference/api/go/aspire.hosting.kubernetes/kubernetesingressresource/withtls.md) -- `method` -- Configures TLS for a Kubernetes Ingress using a K8S secret
  ```go
  WithTls(secretName string) KubernetesIngressResource
  ```
