Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

ListmonkResource

Handle
📦 CommunityToolkit.Aspire.Hosting.Listmonk v13.6.1

A resource that represents a listmonk instance.

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

Properties

propertyConnectionStringExpression*ReferenceExpressionget
Gets the connection string expression for the listmonk instance.
ConnectionStringExpression() *ReferenceExpression
propertyHostEndpointReferenceExpressionget
Gets the host endpoint reference for this resource.
Host() EndpointReferenceExpression
propertyPortEndpointReferenceExpressionget
Gets the port endpoint reference for this resource.
Port() EndpointReferenceExpression
propertyPrimaryEndpointEndpointReferenceget
Gets the primary HTTP endpoint for the listmonk instance.
PrimaryEndpoint() EndpointReference
propertyUriExpression*ReferenceExpressionget
Gets the connection URI expression for the listmonk instance.
UriExpression() *ReferenceExpression

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

The IResourceBuilder.

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

methodWithAdminPasswordbuilder
Configures the first-run listmonk Super Admin password.
WithAdminPassword(password ParameterResource) ListmonkResource
passwordParameterResourceThe parameter resource used for LISTMONK_ADMIN_PASSWORD.
ListmonkResource

The IResourceBuilder.

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

methodWithAdminUserbuilder
Configures the first-run listmonk Super Admin username.
WithAdminUser(username string) ListmonkResource
usernamestringThe value for LISTMONK_ADMIN_USER.
ListmonkResource

The IResourceBuilder.

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

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

The IResourceBuilder.

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

Configures the maximum number of idle PostgreSQL connections.
WithDatabaseMaxIdleConnections(maxIdle float64) ListmonkResource
maxIdlefloat64The value for LISTMONK_db__max_idle.
ListmonkResource

The IResourceBuilder.

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

Configures the maximum lifetime for PostgreSQL connections.
WithDatabaseMaxLifetime(maxLifetime string) ListmonkResource
maxLifetimestringThe duration value for LISTMONK_db__max_lifetime, for example 300s.
ListmonkResource

The IResourceBuilder.

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

Configures the maximum number of open PostgreSQL connections.
WithDatabaseMaxOpenConnections(maxOpen float64) ListmonkResource
maxOpenfloat64The value for LISTMONK_db__max_open.
ListmonkResource

The IResourceBuilder.

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

Configures additional PostgreSQL DSN parameters.
WithDatabaseParameters(parameters string) ListmonkResource
parametersstringThe space-separated parameter string for LISTMONK_db__params.
ListmonkResource

The IResourceBuilder.

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

methodWithDatabaseSslModebuilder
Configures the PostgreSQL SSL mode used by listmonk.
WithDatabaseSslMode(sslMode string) ListmonkResource
sslModestringThe PostgreSQL SSL mode value for LISTMONK_db__ssl_mode.
ListmonkResource

The IResourceBuilder.

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

methodWithGroupIdbuilder
Configures the group ID used by the listmonk container entrypoint.
WithGroupId(groupId float64) ListmonkResource
groupIdfloat64The value for PGID.
ListmonkResource

The IResourceBuilder.

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

methodWithReferencebuilder
References a PostgresDatabaseResource as the PostgreSQL database for the listmonk resource.
WithReference(database PostgresDatabaseResource) ListmonkResource
databasePostgresDatabaseResourceThe PostgreSQL database resource builder.
ListmonkResource

The IResourceBuilder.

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

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

The IResourceBuilder.

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

Adds a bind mount for listmonk media uploads.
WithUploadsBindMount(source string) ListmonkResource
sourcestringThe source directory on the host to mount into the container.
ListmonkResource

The IResourceBuilder.

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

methodWithUploadsVolumebuilder
Adds a named volume for listmonk media uploads.
WithUploadsVolume(options ...*WithUploadsVolumeOptions) ListmonkResource
options...*WithUploadsVolumeOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithUploadsVolumeOptions argument.

Name*stringThe name of the volume. Defaults to an auto-generated name based on the application and resource names.
ListmonkResource

The IResourceBuilder.

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

methodWithUserIdbuilder
Configures the user ID used by the listmonk container entrypoint.
WithUserId(userId float64) ListmonkResource
userIdfloat64The value for PUID.
ListmonkResource

The IResourceBuilder.

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