# UmamiResource

- Module: [CommunityToolkit.Aspire.Hosting.Umami](/reference/api/typescript/communitytoolkit.aspire.hosting.umami.md)
- Version: `13.4.0`
- Kind: `handle`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire)

A resource that represents a Umami instance resource.

## Definition

```typescript
interface UmamiResource
  extends IComputeResource,
    IResource,
    IResourceWithArgs,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IResourceWithServiceDiscovery {
  readonly primaryEndpoint: EndpointReference;
  readonly secretParameter: ParameterResource;
  withPostgreSQL(database: PostgresDatabaseResource): UmamiResource;
}
```

## Properties

- `primaryEndpoint`: `EndpointReference` `get` -- Gets the primary endpoint for the Umami instance.
- `secretParameter`: `ParameterResource` `get` -- Gets the parameter that contains the Umami app secret.

## Methods

- [withPostgreSQL](/reference/api/typescript/communitytoolkit.aspire.hosting.umami/umamiresource/withpostgresql.md) -- `method` -- Configures PostgreSQL as the storage backend for Umami
    ```typescript
  withPostgreSQL(database: PostgresDatabaseResource): UmamiResource
  ```