ListmonkResource

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /CommunityToolkit.Aspire.Hosting.Listmonk
5. /ListmonkResource

Handle

📦 CommunityToolkit.Aspire.Hosting.Listmonk v13.5.0

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;
}

Implements

• IComputeResource
• IExpressionValue
• IManifestExpressionProvider
• IResource
• IResourceWithArgs
• IResourceWithConnectionString
• IResourceWithEndpoints
• IResourceWithEnvironment
• IResourceWithProbes
• IResourceWithWaitSupport
• IValueProvider
• IValueWithReferences
• IResourceWithServiceDiscovery

Search members of ListmonkResource…

methodproperty

20 members

Clear filtersReset all

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

methodwithAdminCredentialsbuilder

Configures the first-run listmonk Super Admin credentials.

withAdminCredentials(
    username: string,
    password: ParameterResource): ListmonkResource

Parameters

usernamestring

passwordParameterResource

Returns

ListmonkResource

methodwithAdminPasswordbuilder

Configures the first-run listmonk Super Admin password.

withAdminPassword(password: ParameterResource): ListmonkResource

Parameters

passwordParameterResource

Returns

ListmonkResource

methodwithAdminUserbuilder

Configures the first-run listmonk Super Admin username.

withAdminUser(username: string): ListmonkResource

Parameters

usernamestring

Returns

ListmonkResource

methodwithAppAddressbuilder

Configures the listmonk web server address.

withAppAddress(address: string): ListmonkResource

Parameters

addressstring

Returns

ListmonkResource

methodwithDatabaseMaxIdleConnectionsbuilder

Configures the maximum number of idle PostgreSQL connections.

withDatabaseMaxIdleConnections(maxIdle: number): ListmonkResource

Parameters

maxIdlenumber

Returns

ListmonkResource

methodwithDatabaseMaxLifetimebuilder

Configures the maximum lifetime for PostgreSQL connections.

withDatabaseMaxLifetime(maxLifetime: string): ListmonkResource

Parameters

maxLifetimestring

Returns

ListmonkResource

methodwithDatabaseMaxOpenConnectionsbuilder

Configures the maximum number of open PostgreSQL connections.

withDatabaseMaxOpenConnections(maxOpen: number): ListmonkResource

Parameters

maxOpennumber

Returns

ListmonkResource

methodwithDatabaseParametersbuilder

Configures additional PostgreSQL DSN parameters.

withDatabaseParameters(parameters: string): ListmonkResource

Parameters

parametersstring

Returns

ListmonkResource

methodwithDatabaseSslModebuilder

Configures the PostgreSQL SSL mode used by listmonk.

withDatabaseSslMode(sslMode: string): ListmonkResource

Parameters

sslModestring

Returns

ListmonkResource

methodwithGroupIdbuilder

Configures the group ID used by the listmonk container entrypoint.

withGroupId(groupId: number): ListmonkResource

Parameters

groupIdnumber

Returns

ListmonkResource

methodwithReferencebuilder

References a `PostgresDatabaseResource` as the PostgreSQL database for the listmonk resource.

withReference(database: PostgresDatabaseResource): ListmonkResource

Parameters

databasePostgresDatabaseResource

Returns

ListmonkResource

methodwithTimeZonebuilder

Configures the time zone used by the listmonk container.

withTimeZone(timeZone: string): ListmonkResource

Parameters

timeZonestring

Returns

ListmonkResource

methodwithUploadsBindMountbuilder

Adds a bind mount for listmonk media uploads.

withUploadsBindMount(source: string): ListmonkResource

Parameters

sourcestring

Returns

ListmonkResource

methodwithUploadsVolumebuilder

Adds a named volume for listmonk media uploads.

withUploadsVolume(name?: string): ListmonkResource

Parameters

namestringoptional

Returns

ListmonkResource

methodwithUserIdbuilder

Configures the user ID used by the listmonk container entrypoint.

withUserId(userId: number): ListmonkResource

Parameters

userIdnumber

Returns

ListmonkResource