# YarpCluster

- Module: [Aspire.Hosting.Yarp](/reference/api/typescript/aspire.hosting.yarp.md)
- Version: `13.2.0`
- Kind: `handle`
- Source: [GitHub](https://github.com/microsoft/aspire)

## Definition

```typescript
interface YarpCluster {
  withForwarderRequestConfig(config: YarpForwarderRequestConfig): YarpCluster;
  withHealthCheckConfig(config: YarpHealthCheckConfig): YarpCluster;
  withHttpClientConfig(config: YarpHttpClientConfig): YarpCluster;
  withLoadBalancingPolicy(policy: string): YarpCluster;
  withMetadata(metadata: Dict<string,string>): YarpCluster;
  withSessionAffinityConfig(config: YarpSessionAffinityConfig): YarpCluster;
}
```

## Methods

- [withForwarderRequestConfig](/reference/api/typescript/aspire.hosting.yarp/yarpcluster/withforwarderrequestconfig.md) -- `method` -- Sets the forwarder request configuration for the cluster.
    ```typescript
  withForwarderRequestConfig(config: YarpForwarderRequestConfig): YarpCluster
  ```
- [withHealthCheckConfig](/reference/api/typescript/aspire.hosting.yarp/yarpcluster/withhealthcheckconfig.md) -- `method` -- Sets the health check configuration for the cluster.
    ```typescript
  withHealthCheckConfig(config: YarpHealthCheckConfig): YarpCluster
  ```
- [withHttpClientConfig](/reference/api/typescript/aspire.hosting.yarp/yarpcluster/withhttpclientconfig.md) -- `method` -- Sets the HTTP client configuration for the cluster.
    ```typescript
  withHttpClientConfig(config: YarpHttpClientConfig): YarpCluster
  ```
- [withLoadBalancingPolicy](/reference/api/typescript/aspire.hosting.yarp/yarpcluster/withloadbalancingpolicy.md) -- `method` -- Sets the load balancing policy for the cluster.
    ```typescript
  withLoadBalancingPolicy(policy: string): YarpCluster
  ```
- [withMetadata](/reference/api/typescript/aspire.hosting.yarp/yarpcluster/withmetadata.md) -- `method` -- Sets metadata for the cluster.
    ```typescript
  withMetadata(metadata: Dict<string,string>): YarpCluster
  ```
- [withSessionAffinityConfig](/reference/api/typescript/aspire.hosting.yarp/yarpcluster/withsessionaffinityconfig.md) -- `method` -- Sets the session affinity configuration for the cluster.
    ```typescript
  withSessionAffinityConfig(config: YarpSessionAffinityConfig): YarpCluster
  ```