Volume

Classsealednet10.0

📦 Aspire.Hosting.Docker v13.6.0

Represents a volume definition in a Docker Compose configuration file.

namespace Aspire.Hosting.Docker.Resources.ServiceNodes;

public sealed class Volume
    : Aspire.Hosting.Docker.Resources.ComposeNodes.NamedComposeMember
{
    // ...
}

NamedComposeMember

9 members

Remarks

The Volume class is used to define properties and options for volumes in a Docker environment. Volumes are used to persist data beyond the lifecycle of a container and can be shared among multiple containers.

Constructors1

Volume

View all constructors

Properties8

Driverget; set

string?

Gets or sets the name of the driver used for the volume. The driver is responsible for managing the volume and its storage backend.

DriverOptsget; set

Dictionary<string, string>

Represents a collection of driver-specific options for the volume. These options are passed as key-value pairs to the volume driver, allowing customization or configuration specific to the driver being used.

Externalget; set

bool?

Indicates whether the volume is external to the current scope or environment. A value of true specifies that the volume is managed outside the scope of the current application or configuration. A value of false, or a null value, indicates that the volume is managed internally or by default behavior.

Labelsget; set

Dictionary<string, string>

Gets or sets a dictionary of labels associated with the volume. Labels are key-value pairs that can be used for metadata purposes or for organizing and identifying volumes within Docker services.

ReadOnlyget; set

bool?

Gets or sets a value indicating whether the volume is mounted as read-only.

Sourceget; set

string?

Gets or sets the source property of the volume. The source defines the location on the host system or the specific resource from which the volume is sourced.

Targetget; set

string?

Gets or sets the target path inside the container where the volume is mounted. This specifies the container location for the volume's data.

Typeget; set

string?

Gets or sets the type of volume. This specifies the method of volume provisioning such as bind mounts, named volumes, or other supported volume types in Docker.

View all properties