DockerComposeEnvironmentResource
Represents a Docker Compose environment resource that can host application resources.
type DockerComposeEnvironmentResource interface { ComputeEnvironmentResource Resource}Properties
DashboardEnabled boolget · setDashboardEnabled() (bool, error)SetDashboardEnabled(value bool) DockerComposeEnvironmentResourceDefaultNetworkName *stringget · setDefaultNetworkName() (*string, error)SetDefaultNetworkName(value *string) DockerComposeEnvironmentResourceResourceTypeDisplayName stringgetResourceTypeDisplayName() (string, error)Methods
ConfigureComposeFile(configure func(obj ComposeFile)) DockerComposeEnvironmentResourceParameters
configurefunc(obj ComposeFile) callbackA method that can be used for customizing the ComposeFile .Returns
DockerComposeEnvironmentResource The resource builder.
Returns a handle; failures surface later via Err().
ConfigureDashboard(configure func(obj DockerComposeAspireDashboardResource)) DockerComposeEnvironmentResourceParameters
configurefunc(obj DockerComposeAspireDashboardResource) callbackA method that can be used for customizing the dashboard service.Returns
DockerComposeEnvironmentResource The resource builder.
Returns a handle; failures surface later via Err().
ConfigureEnvFile(configure func(obj *Dict[string, CapturedEnvironmentVariable])) DockerComposeEnvironmentResourceParameters
configurefunc(obj *Dict[string, CapturedEnvironmentVariable]) callbackA method that can be used for customizing the captured environment variables.Returns
DockerComposeEnvironmentResource The resource builder.
Returns a handle; failures surface later via Err().
GetHostAddressExpression GetHostAddressExpression(endpointReference EndpointReference) *ReferenceExpressionParameters
endpointReference EndpointReference Returns
*ReferenceExpression Returns a handle; failures surface later via Err().
WithDashboard(options ...*WithDashboardOptions) DockerComposeEnvironmentResourceParameters
options...*WithDashboardOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithDashboardOptions argument.
Enabled*boolWhether to enable the dashboard. Default is true.Returns
DockerComposeEnvironmentResource The resource builder.
Returns a handle; failures surface later via Err().
WithProperties(configure func(obj DockerComposeEnvironmentResource)) DockerComposeEnvironmentResourceParameters
configurefunc(obj DockerComposeEnvironmentResource) callbackA method that can be used for customizing the DockerComposeEnvironmentResource .Returns
DockerComposeEnvironmentResource The resource builder.
Returns a handle; failures surface later via Err().