# ListmonkResource

- Module: [CommunityToolkit.Aspire.Hosting.Listmonk](/reference/api/go/communitytoolkit.aspire.hosting.listmonk.md)
- Version: `13.6.1`
- Kind: `handle`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/tree/d9c2addac6f527ef2e33712d290b84574b455a3b)

A resource that represents a listmonk instance.

## Definition

```go
type ListmonkResource interface {
    ExpressionValue
    IComputeResource
    Resource
    ResourceWithArgs
    ResourceWithConnectionString
    ResourceWithEndpoints
    ResourceWithEnvironment
    ResourceWithWaitSupport
}
```

## Embeds

- `ExpressionValue`
- `IComputeResource`
- `Resource`
- `ResourceWithArgs`
- `ResourceWithConnectionString`
- `ResourceWithEndpoints`
- `ResourceWithEnvironment`
- `ResourceWithWaitSupport`

## Properties

- `ConnectionStringExpression`: `*ReferenceExpression` `get` -- Gets the connection string expression for the listmonk instance.
- `Host`: `EndpointReferenceExpression` `get` -- Gets the host endpoint reference for this resource.
- `Port`: `EndpointReferenceExpression` `get` -- Gets the port endpoint reference for this resource.
- `PrimaryEndpoint`: `EndpointReference` `get` -- Gets the primary HTTP endpoint for the listmonk instance.
- `UriExpression`: `*ReferenceExpression` `get` -- Gets the connection URI expression for the listmonk instance.

## Methods

- [WithAdminCredentials](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withadmincredentials.md) -- `method` -- Configures the first-run listmonk Super Admin credentials.
  ```go
  WithAdminCredentials(username string, password ParameterResource) ListmonkResource
  ```
- [WithAdminPassword](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withadminpassword.md) -- `method` -- Configures the first-run listmonk Super Admin password.
  ```go
  WithAdminPassword(password ParameterResource) ListmonkResource
  ```
- [WithAdminUser](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withadminuser.md) -- `method` -- Configures the first-run listmonk Super Admin username.
  ```go
  WithAdminUser(username string) ListmonkResource
  ```
- [WithAppAddress](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withappaddress.md) -- `method` -- Configures the listmonk web server address.
  ```go
  WithAppAddress(address string) ListmonkResource
  ```
- [WithDatabaseMaxIdleConnections](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withdatabasemaxidleconnections.md) -- `method` -- Configures the maximum number of idle PostgreSQL connections.
  ```go
  WithDatabaseMaxIdleConnections(maxIdle float64) ListmonkResource
  ```
- [WithDatabaseMaxLifetime](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withdatabasemaxlifetime.md) -- `method` -- Configures the maximum lifetime for PostgreSQL connections.
  ```go
  WithDatabaseMaxLifetime(maxLifetime string) ListmonkResource
  ```
- [WithDatabaseMaxOpenConnections](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withdatabasemaxopenconnections.md) -- `method` -- Configures the maximum number of open PostgreSQL connections.
  ```go
  WithDatabaseMaxOpenConnections(maxOpen float64) ListmonkResource
  ```
- [WithDatabaseParameters](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withdatabaseparameters.md) -- `method` -- Configures additional PostgreSQL DSN parameters.
  ```go
  WithDatabaseParameters(parameters string) ListmonkResource
  ```
- [WithDatabaseSslMode](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withdatabasesslmode.md) -- `method` -- Configures the PostgreSQL SSL mode used by listmonk.
  ```go
  WithDatabaseSslMode(sslMode string) ListmonkResource
  ```
- [WithGroupId](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withgroupid.md) -- `method` -- Configures the group ID used by the listmonk container entrypoint.
  ```go
  WithGroupId(groupId float64) ListmonkResource
  ```
- [WithReference](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withreference.md) -- `method` -- References a `PostgresDatabaseResource` as the PostgreSQL database for the listmonk resource.
  ```go
  WithReference(database PostgresDatabaseResource) ListmonkResource
  ```
- [WithTimeZone](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withtimezone.md) -- `method` -- Configures the time zone used by the listmonk container.
  ```go
  WithTimeZone(timeZone string) ListmonkResource
  ```
- [WithUploadsBindMount](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withuploadsbindmount.md) -- `method` -- Adds a bind mount for listmonk media uploads.
  ```go
  WithUploadsBindMount(source string) ListmonkResource
  ```
- [WithUploadsVolume](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withuploadsvolume.md) -- `method` -- Adds a named volume for listmonk media uploads.
  ```go
  WithUploadsVolume(options ...*WithUploadsVolumeOptions) ListmonkResource
  ```
- [WithUserId](/reference/api/go/communitytoolkit.aspire.hosting.listmonk/listmonkresource/withuserid.md) -- `method` -- Configures the user ID used by the listmonk container entrypoint.
  ```go
  WithUserId(userId float64) ListmonkResource
  ```
