PostaResource

Handle

📦 CommunityToolkit.Aspire.Hosting.Posta v13.5.0

interface PostaResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly adminPasswordParameter: ParameterResource;
  readonly connectionStringExpression: ReferenceExpression;
  readonly host: EndpointReferenceExpression;
  readonly jwtSecretParameter: ParameterResource;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  readonly smtpEndpoint: EndpointReference;
  readonly smtpRelayEndpoint: EndpointReference;
  readonly uriExpression: ReferenceExpression;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): PostaResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): PostaResource;
  withPostgresReference(database: PostgresDatabaseResource): PostaResource;
  withRedisReference(
      redis: RedisResource,
      redisPassword?: ParameterResource): PostaResource;
}

13 members

Properties

propertyadminPasswordParameterParameterResourceget

Gets the parameter that contains the initial admin password.

propertyconnectionStringExpressionReferenceExpressionget

Connection string for the Posta HTTP API in the form of Endpoint=http://host:port.

propertyhostEndpointReferenceExpressionget

Gets the host endpoint reference for the HTTP endpoint.

propertyjwtSecretParameterParameterResourceget

Gets the parameter that contains the JWT signing secret.

propertyportEndpointReferenceExpressionget

Gets the port endpoint reference for the HTTP endpoint.

propertyprimaryEndpointEndpointReferenceget

Gets the primary HTTP endpoint for the Posta server.

propertysmtpEndpointEndpointReferenceget

Gets the inbound SMTP endpoint for the Posta server.

propertysmtpRelayEndpointEndpointReferenceget

Gets the authenticated SMTP relay endpoint for the Posta server.

propertyuriExpressionReferenceExpressionget

Gets the connection URI expression for the Posta HTTP API.

Methods

methodwithDataBindMountbuilder

Adds a bind mount for Posta's filesystem-backed attachment data.

withDataBindMount(
    source: string,
    isReadOnly?: boolean): PostaResource

Parameters

sourcestring

isReadOnlybooleanoptional= False

Returns

PostaResource

methodwithDataVolumebuilder

Adds a named volume for Posta's filesystem-backed attachment data.

withDataVolume(
    name?: string,
    isReadOnly?: boolean): PostaResource

Parameters

namestringoptional

isReadOnlybooleanoptional= False

Returns

PostaResource

methodwithPostgresReferencebuilder

Configures the PostgreSQL database used by Posta.

withPostgresReference(database: PostgresDatabaseResource): PostaResource

Parameters

databasePostgresDatabaseResource

Returns

PostaResource

methodwithRedisReferencebuilder

Configures the Redis server used by Posta.

withRedisReference(
    redis: RedisResource,
    redisPassword?: ParameterResource): PostaResource

Parameters

redisRedisResource

redisPasswordParameterResourceoptional

Returns

PostaResource