# DockerComposeEnvironmentResource

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

Represents a Docker Compose environment resource that can host application resources.

## Remarks

Initializes a new instance of the `DockerComposeEnvironmentResource` class.

## Definition

```go
type DockerComposeEnvironmentResource interface {
    ComputeEnvironmentResource
    Resource
}
```

## Embeds

- `ComputeEnvironmentResource`
- `Resource`

## Properties

- `DashboardEnabled`: `bool` `get/set` -- Determines whether to include an Aspire dashboard for telemetry visualization in this environment.
- `DefaultNetworkName`: `*string` `get/set` -- The name of an existing network to be used.
- `ResourceTypeDisplayName`: `string` `get` -- Gets the ResourceTypeDisplayName property

## Methods

- [ConfigureComposeFile](/reference/api/go/aspire.hosting.docker/dockercomposeenvironmentresource/configurecomposefile.md) -- `method` -- Configures the Docker Compose file for the environment resource.
  ```go
  ConfigureComposeFile(configure func(obj ComposeFile)) DockerComposeEnvironmentResource
  ```
- [ConfigureDashboard](/reference/api/go/aspire.hosting.docker/dockercomposeenvironmentresource/configuredashboard.md) -- `method` -- Configures the dashboard properties for this Docker Compose environment.
  ```go
  ConfigureDashboard(configure func(obj DockerComposeAspireDashboardResource)) DockerComposeEnvironmentResource
  ```
- [ConfigureEnvFile](/reference/api/go/aspire.hosting.docker/dockercomposeenvironmentresource/configureenvfile.md) -- `method` -- Configures the captured environment variables for the Docker Compose environment before they are written to the .env file.
  ```go
  ConfigureEnvFile(configure func(obj *Dict[string, CapturedEnvironmentVariable])) DockerComposeEnvironmentResource
  ```
- [GetHostAddressExpression](/reference/api/go/aspire.hosting.docker/dockercomposeenvironmentresource/gethostaddressexpression.md) -- `method` -- Invokes the GetHostAddressExpression method
  ```go
  GetHostAddressExpression(endpointReference EndpointReference) *ReferenceExpression
  ```
- [WithDashboard](/reference/api/go/aspire.hosting.docker/dockercomposeenvironmentresource/withdashboard.md) -- `method` -- Enables the Aspire dashboard for telemetry visualization in this Docker Compose environment.
  ```go
  WithDashboard(options ...*WithDashboardOptions) DockerComposeEnvironmentResource
  ```
- [WithProperties](/reference/api/go/aspire.hosting.docker/dockercomposeenvironmentresource/withproperties.md) -- `method` -- Allows setting the properties of a Docker Compose environment resource.
  ```go
  WithProperties(configure func(obj DockerComposeEnvironmentResource)) DockerComposeEnvironmentResource
  ```
