LogtoResource

Handle

📦 CommunityToolkit.Aspire.Hosting.Logto v13.5.0

interface LogtoResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  readonly host: EndpointReferenceExpression;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  readonly uriExpression: ReferenceExpression;
  withAdminEndpoint(url: string): LogtoResource;
  withDatabase(
      postgres: PostgresServerResource,
      databaseName?: string): LogtoResource;
  withDatabaseSeeding(): LogtoResource;
  withDataBindMount(source: string): LogtoResource;
  withDataVolume(name?: string): LogtoResource;
  withDeprecationTracing(): LogtoResource;
  withDisableAdminConsole(disable: boolean): LogtoResource;
  withNodeEnv(env: string): LogtoResource;
  withRedis(redis: RedisResource): LogtoResource;
  withResourcePort(
      port?: number,
      adminPort?: number): LogtoResource;
  withSecretVault(secretVaultKek: string): LogtoResource;
  withSensitiveUsername(sensitiveUsername: boolean): LogtoResource;
  withTrustProxyHeader(trustProxyHeader: boolean): LogtoResource;
}

18 members

Properties

propertyconnectionStringExpressionReferenceExpressionget

Gets the ConnectionStringExpression property

propertyhostEndpointReferenceExpressionget

Gets the Host property

propertyportEndpointReferenceExpressionget

Gets the Port property

propertyprimaryEndpointEndpointReferenceget

Gets the PrimaryEndpoint property

propertyuriExpressionReferenceExpressionget

Gets the connection URI expression for the Logto container resource.

Methods

methodwithAdminEndpointbuilder

Configures the specified Logto resource to include an administrative endpoint with the given URL.

withAdminEndpoint(url: string): LogtoResource

Parameters

urlstring

Returns

LogtoResource

methodwithDatabasebuilder

Configures the Logto resource to connect to the specified PostgreSQL database.

withDatabase(
    postgres: PostgresServerResource,
    databaseName?: string): LogtoResource

Parameters

postgresPostgresServerResource

databaseNamestringoptional= logto_db

Returns

LogtoResource

methodwithDatabaseSeedingbuilder

Starts Logto by running the database seed command before the application process.

withDatabaseSeeding(): LogtoResource

Returns

LogtoResource

methodwithDataBindMountbuilder

Configures the Logto resource to use a data bind mount with the specified source directory.

withDataBindMount(source: string): LogtoResource

Parameters

sourcestring

Returns

LogtoResource

methodwithDataVolumebuilder

Configures the Logto resource with a data volume, allowing persistent storage.

withDataVolume(name?: string): LogtoResource

Parameters

namestringoptional

Returns

LogtoResource

methodwithDeprecationTracingbuilder

Enables Node.js deprecation tracing for the Logto by setting the NODE_OPTIONS environment variable to '--trace-deprecation'. This allows stack traces to be printed for deprecated API usage.

withDeprecationTracing(): LogtoResource

Returns

LogtoResource

methodwithDisableAdminConsolebuilder

Configures the Logto resource to disable the Admin Console port.

withDisableAdminConsole(disable: boolean): LogtoResource

Parameters

disableboolean

Returns

LogtoResource

methodwithNodeEnvbuilder

Configures the Logto resource to use the specified Node.js environment value by setting the corresponding environment variable.

withNodeEnv(env: string): LogtoResource

Parameters

envstring

Returns

LogtoResource

methodwithRedisbuilder

Configures the Logto resource to use a specified Redis resource for caching or other functionality.

withRedis(redis: RedisResource): LogtoResource

Parameters

redisRedisResource

Returns

LogtoResource

methodwithResourcePortbuilder

Configures HTTP endpoints for the given Logto resource builder with specified port settings.

withResourcePort(
    port?: number,
    adminPort?: number): LogtoResource

Parameters

portnumberoptional

adminPortnumberoptional

Returns

LogtoResource

methodwithSecretVaultbuilder

Configures the Logto resource to use a secret vault with the specified key encryption key (KEK).

withSecretVault(secretVaultKek: string): LogtoResource

Parameters

secretVaultKekstring

Returns

LogtoResource

methodwithSensitiveUsernamebuilder

Specifies whether the username is case-sensitive.

withSensitiveUsername(sensitiveUsername: boolean): LogtoResource

Parameters

sensitiveUsernameboolean

Returns

LogtoResource

methodwithTrustProxyHeaderbuilder

Configures the Logto resource to enable or disable the trust proxy header behavior.

withTrustProxyHeader(trustProxyHeader: boolean): LogtoResource

Parameters

trustProxyHeaderboolean

Returns

LogtoResource