Watch Aspire live streamsDocsTry Aspire

ListmonkResource

Handle
📦 CommunityToolkit.Aspire.Hosting.Listmonk v13.6.1
interface ListmonkResource
extends IComputeResource,
IExpressionValue,
IManifestExpressionProvider,
IResource,
IResourceWithArgs,
IResourceWithConnectionString,
IResourceWithEndpoints,
IResourceWithEnvironment,
IResourceWithProbes,
IResourceWithWaitSupport,
IValueProvider,
IValueWithReferences,
IResourceWithServiceDiscovery {
readonly connectionStringExpression: ReferenceExpression;
readonly host: EndpointReferenceExpression;
readonly port: EndpointReferenceExpression;
readonly primaryEndpoint: EndpointReference;
readonly uriExpression: ReferenceExpression;
withAdminCredentials(
username: string,
password: ParameterResource): ListmonkResource;
withAdminPassword(password: ParameterResource): ListmonkResource;
withAdminUser(username: string): ListmonkResource;
withAppAddress(address: string): ListmonkResource;
withDatabaseMaxIdleConnections(maxIdle: number): ListmonkResource;
withDatabaseMaxLifetime(maxLifetime: string): ListmonkResource;
withDatabaseMaxOpenConnections(maxOpen: number): ListmonkResource;
withDatabaseParameters(parameters: string): ListmonkResource;
withDatabaseSslMode(sslMode: string): ListmonkResource;
withGroupId(groupId: number): ListmonkResource;
withReference(database: PostgresDatabaseResource): ListmonkResource;
withTimeZone(timeZone: string): ListmonkResource;
withUploadsBindMount(source: string): ListmonkResource;
withUploadsVolume(name?: string): ListmonkResource;
withUserId(userId: number): ListmonkResource;
}

Properties

propertyconnectionStringExpressionReferenceExpressionget
Gets the connection string expression for the listmonk instance.
propertyhostEndpointReferenceExpressionget
Gets the host endpoint reference for this resource.
propertyportEndpointReferenceExpressionget
Gets the port endpoint reference for this resource.
propertyprimaryEndpointEndpointReferenceget
Gets the primary HTTP endpoint for the listmonk instance.
propertyuriExpressionReferenceExpressionget
Gets the connection URI expression for the listmonk instance.

Methods

Configures the first-run listmonk Super Admin credentials.
withAdminCredentials(
username: string,
password: ParameterResource): ListmonkResource
usernamestringThe value for `LISTMONK_ADMIN_USER`.
passwordParameterResourceThe parameter resource used for `LISTMONK_ADMIN_PASSWORD`.
ListmonkResource
methodwithAdminPasswordbuilder
Configures the first-run listmonk Super Admin password.
withAdminPassword(password: ParameterResource): ListmonkResource
passwordParameterResourceThe parameter resource used for `LISTMONK_ADMIN_PASSWORD`.
ListmonkResource
methodwithAdminUserbuilder
Configures the first-run listmonk Super Admin username.
withAdminUser(username: string): ListmonkResource
usernamestringThe value for `LISTMONK_ADMIN_USER`.
ListmonkResource
methodwithAppAddressbuilder
Configures the listmonk web server address.
withAppAddress(address: string): ListmonkResource
addressstringThe address value for `LISTMONK_app__address`, for example `0.0.0.0:9000`.
ListmonkResource
Configures the maximum number of idle PostgreSQL connections.
withDatabaseMaxIdleConnections(maxIdle: number): ListmonkResource
maxIdlenumberThe value for `LISTMONK_db__max_idle`.
ListmonkResource
Configures the maximum lifetime for PostgreSQL connections.
withDatabaseMaxLifetime(maxLifetime: string): ListmonkResource
maxLifetimestringThe duration value for `LISTMONK_db__max_lifetime`, for example `300s`.
ListmonkResource
Configures the maximum number of open PostgreSQL connections.
withDatabaseMaxOpenConnections(maxOpen: number): ListmonkResource
maxOpennumberThe value for `LISTMONK_db__max_open`.
ListmonkResource
Configures additional PostgreSQL DSN parameters.
withDatabaseParameters(parameters: string): ListmonkResource
parametersstringThe space-separated parameter string for `LISTMONK_db__params`.
ListmonkResource
methodwithDatabaseSslModebuilder
Configures the PostgreSQL SSL mode used by listmonk.
withDatabaseSslMode(sslMode: string): ListmonkResource
sslModestringThe PostgreSQL SSL mode value for `LISTMONK_db__ssl_mode`.
ListmonkResource
methodwithGroupIdbuilder
Configures the group ID used by the listmonk container entrypoint.
withGroupId(groupId: number): ListmonkResource
groupIdnumberThe value for `PGID`.
ListmonkResource
methodwithReferencebuilder
References a `PostgresDatabaseResource` as the PostgreSQL database for the listmonk resource.
withReference(database: PostgresDatabaseResource): ListmonkResource
databasePostgresDatabaseResourceThe PostgreSQL database resource builder.
ListmonkResource
methodwithTimeZonebuilder
Configures the time zone used by the listmonk container.
withTimeZone(timeZone: string): ListmonkResource
timeZonestringThe time zone value for `TZ`, for example `Etc/UTC`.
ListmonkResource
Adds a bind mount for listmonk media uploads.
withUploadsBindMount(source: string): ListmonkResource
sourcestringThe source directory on the host to mount into the container.
ListmonkResource
methodwithUploadsVolumebuilder
Adds a named volume for listmonk media uploads.
withUploadsVolume(name?: string): ListmonkResource
namestringoptionalThe name of the volume. Defaults to an auto-generated name based on the application and resource names.
ListmonkResource
methodwithUserIdbuilder
Configures the user ID used by the listmonk container entrypoint.
withUserId(userId: number): ListmonkResource
userIdnumberThe value for `PUID`.
ListmonkResource