# DockerComposeEnvironmentResource

- Module: [Aspire.Hosting.Docker](/reference/api/typescript/aspire.hosting.docker.md)
- Version: `13.2.0`
- Kind: `handle`
- Source: [GitHub](https://github.com/microsoft/aspire)

## Definition

```typescript
interface DockerComposeEnvironmentResource
  extends IComputeEnvironmentResource,
    IResource {
  dashboardEnabled: boolean;
  defaultNetworkName: string;
  readonly name: string;
  configureDashboard(configure: (obj: DockerComposeAspireDashboardResource) => Promise<void>): DockerComposeEnvironmentResource;
  withDashboard(enabled?: boolean): DockerComposeEnvironmentResource;
  withProperties(configure: (obj: DockerComposeEnvironmentResource) => Promise<void>): DockerComposeEnvironmentResource;
}
```

## Properties

- `dashboardEnabled`: `boolean` `get - set` -- Gets the DashboardEnabled property
- `defaultNetworkName`: `string` `get - set` -- Gets the DefaultNetworkName property
- `name`: `string` `get` -- Gets the Name property

## Methods

- [configureDashboard](/reference/api/typescript/aspire.hosting.docker/dockercomposeenvironmentresource/configuredashboard.md) -- `method` -- Configures the Aspire dashboard resource for the Docker Compose environment
    ```typescript
  configureDashboard(configure: (obj: DockerComposeAspireDashboardResource) => Promise<void>): DockerComposeEnvironmentResource
  ```
- [withDashboard](/reference/api/typescript/aspire.hosting.docker/dockercomposeenvironmentresource/withdashboard.md) -- `method` -- Enables or disables the Aspire dashboard for the Docker Compose environment
    ```typescript
  withDashboard(enabled?: boolean): DockerComposeEnvironmentResource
  ```
- [withProperties](/reference/api/typescript/aspire.hosting.docker/dockercomposeenvironmentresource/withproperties.md) -- `method` -- Configures properties of the Docker Compose environment
    ```typescript
  withProperties(configure: (obj: DockerComposeEnvironmentResource) => Promise<void>): DockerComposeEnvironmentResource
  ```