---
title: "ForwardToClusterBySNIConfig"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19/schemas/ForwardToClusterBySNIConfig"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19.md

# ForwardToClusterBySNIConfig

The configuration to forward requests to virtual clusters configured with SNI routing.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Control Planes Configuration for Event Gateways
  version: 1.0.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    ForwardToClusterBySNIConfig:
      description: >
        The configuration to forward requests to virtual clusters configured
        with SNI routing.
      type: object
      properties:
        type:
          type: string
          enum:
            - sni
          x-terraform-transform-const: true
        sni_suffix:
          description: >
            Optional suffix for TLS SNI validation.


            This suffix is concatenated with the virtual cluster "dns.label"
            label to form the base name for the SNI.

            If not provided, the virtual cluster "dns.label" label alone is used
            as the base name for the SNI.

            For example with sni_suffix: `.example.com` and virtual cluster
            "dns.label" label: `my-cluster`,

            the SNI suffix for it is `my-cluster.example.com`.

            If "dns.label" label is absent on the virtual cluster, the traffic
            won't be routed there.


            The bootstrap host is `bootstrap.my-cluster.example.com` and then
            each broker is addressable at `broker-0.my-cluster.example.com`,
            `broker-1.my-cluster.example.com`, etc.

            This means that your deployment needs to have a wildcard certificate
            for the domain and a DNS resolver that routes
            `*.my-cluster.example.com` to the proxy.


            The accepted format is a DNS subdomain starting with either `.` or
            `-`. For example, `-keg.example.com`, `.keg.example.com`,
            `.namespace.svc.cluster.local`, and `.localhost` are all valid,

            while `keg.example.com` is not.
          type: string
          example: .example.com
          pattern: ^[\.-]([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)*([a-z0-9-]*[a-z0-9])$
        advertised_port:
          description: >
            Virtual brokers are advertised to clients with this port instead of
            listen_port. Useful when proxy is

            behind loadbalancer listening on different port.
          type: integer
          maximum: 65535
          minimum: 1
        broker_host_format:
          description: >-
            Configures DNS names assigned to brokers in virtual clusters.


            - `per_cluster_suffix` is the default and allocates one level in the
            hierarchy for virtual clusters:
            `broker-{node_id}.{virtual_cluster}.{sni_suffix}`

            - `shared_suffix` puts all brokers from every virtual clusters into
            the same level: `broker-{node_id}-{virtual_cluster}.{sni_suffix}`.
            This makes it easier to manage certificates for this listener.


            **Requires a minimum runtime version of `1.1`**.
          type: object
          properties:
            type:
              type: string
              default: per_cluster_suffix
              enum:
                - per_cluster_suffix
                - shared_suffix
          required:
            - type
          x-min-runtime-version: "1.1"
      additionalProperties: false
      required:
        - type
```
