KubernetesGatewayResource

Handle

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

interface KubernetesGatewayResource
  extends IResource,
    IResourceWithParent,
    KubernetesEnvironmentResource]] {
  withGatewayAnnotation(
      key: string,
      value: string): KubernetesGatewayResource;
  withGatewayAnnotationParam(
      key: string,
      value: ParameterResource): KubernetesGatewayResource;
  withGatewayClass(className: string): KubernetesGatewayResource;
  withGatewayClassParam(className: ParameterResource): KubernetesGatewayResource;
  withGatewayHostnameParam(hostname: ParameterResource): KubernetesGatewayResource;
  withGatewayHostRoute(
      host: string,
      path: string,
      endpoint: EndpointReference,
      pathType?: IngressPathType): KubernetesGatewayResource;
  withGatewayPathRoute(
      path: string,
      endpoint: EndpointReference,
      pathType?: IngressPathType): KubernetesGatewayResource;
  withGatewayTlsAuto(): KubernetesGatewayResource;
  withGatewayTlsParam(secretName: ParameterResource): KubernetesGatewayResource;
  withHostname(hostname: string): KubernetesGatewayResource;
  withTls(secretName: string): KubernetesGatewayResource;
}

11 members

Methods

method withGatewayAnnotation builder

Adds a Kubernetes metadata annotation to a Gateway

withGatewayAnnotation(
    key: string,
    value: string): KubernetesGatewayResource

Parameters

key string

value string

Returns

KubernetesGatewayResource

method withGatewayAnnotationParam builder

Adds a parameterized Kubernetes metadata annotation to a Gateway

withGatewayAnnotationParam(
    key: string,
    value: ParameterResource): KubernetesGatewayResource

Parameters

key string

value ParameterResource

Returns

KubernetesGatewayResource

method withGatewayClass builder

Sets the GatewayClass for a Kubernetes Gateway

withGatewayClass(className: string): KubernetesGatewayResource

Parameters

className string

Returns

KubernetesGatewayResource

method withGatewayClassParam builder

Sets a parameterized GatewayClass for a Kubernetes Gateway

withGatewayClassParam(className: ParameterResource): KubernetesGatewayResource

Parameters

className ParameterResource

Returns

KubernetesGatewayResource

method withGatewayHostnameParam builder

Adds a parameterized hostname to a Kubernetes Gateway

withGatewayHostnameParam(hostname: ParameterResource): KubernetesGatewayResource

Parameters

hostname ParameterResource

Returns

KubernetesGatewayResource

method withGatewayHostRoute builder

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

withGatewayHostRoute(
    host: string,
    path: string,
    endpoint: EndpointReference,
    pathType?: IngressPathType): KubernetesGatewayResource

Parameters

host string

path string

endpoint EndpointReference

pathType IngressPathType optional = Prefix

Returns

KubernetesGatewayResource

method withGatewayPathRoute builder

Adds a path-based route to a Kubernetes Gateway

withGatewayPathRoute(
    path: string,
    endpoint: EndpointReference,
    pathType?: IngressPathType): KubernetesGatewayResource

Parameters

path string

endpoint EndpointReference

pathType IngressPathType optional = Prefix

Returns

KubernetesGatewayResource

method withGatewayTlsAuto builder

Configures TLS on a Kubernetes Gateway with an auto-generated secret

withGatewayTlsAuto(): KubernetesGatewayResource

Returns

KubernetesGatewayResource

method withGatewayTlsParam builder

Configures TLS on a Kubernetes Gateway with a parameterized secret

withGatewayTlsParam(secretName: ParameterResource): KubernetesGatewayResource

Parameters

secretName ParameterResource

Returns

KubernetesGatewayResource

method withHostname builder

Adds a hostname to a Kubernetes Gateway

withHostname(hostname: string): KubernetesGatewayResource

Parameters

hostname string

Returns

KubernetesGatewayResource

method withTls builder

Configures TLS on a Kubernetes Gateway listener

withTls(secretName: string): KubernetesGatewayResource

Parameters

secretName string

Returns

KubernetesGatewayResource