# WithKafkaUI

- Module: [Aspire.Hosting.Kafka](/reference/api/go/aspire.hosting.kafka.md)
- Version: `17.0.0`
- Kind: `method`
- Defined on: [`KafkaServerResource`](/reference/api/go/aspire.hosting.kafka/kafkaserverresource.md)
- Source: [GitHub](https://github.com/microsoft/aspire/tree/bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f)

Adds a Kafka UI container to the application.

## Remarks

This version of the package defaults to the tag of the container image.

## Definition

```go
func (KafkaServerResource) WithKafkaUI(options ...*WithKafkaUIOptions) KafkaServerResource
```

## Parameters

- `options` (`...*WithKafkaUIOptions`) -- optional settings, see [Options](#options)

## Options

Optional parameters are passed in a trailing `options ...*WithKafkaUIOptions` argument.

- `ConfigureContainer` (`func(obj KafkaUIContainerResource)`) `callback` -- Configuration callback for KafkaUI container resource.
- `ContainerName` (`*string`) -- The name of the container (Optional).

## Returns

[`KafkaServerResource`](/reference/api/go/aspire.hosting.kafka/kafkaserverresource.md) -- The resource builder.

Returns a handle; failures surface later via `Err()`.

## Applies to

- [`KafkaServerResource`](/reference/api/go/aspire.hosting.kafka/kafkaserverresource.md)
