Skip to content
Docs Try Aspire

Volume Properties

Class Properties 8 members
Represents a volume definition in a Docker Compose configuration file.
Driver Section titled Driver nullable 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.
public string? Driver { get; set; }
DriverOpts Section titled DriverOpts 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.
public Dictionary<string, string> DriverOpts { get; set; }
External Section titled External nullable 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.
public bool? External { get; set; }
Labels Section titled Labels 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.
public Dictionary<string, string> Labels { get; set; }
ReadOnly Section titled ReadOnly nullable bool?
Gets or sets a value indicating whether the volume is mounted as read-only.
public bool? ReadOnly { get; set; }
When set to true, the volume will be mounted with read-only permissions, preventing modification of the data within the container. This is commonly used to enforce data immutability for certain use cases.
Source Section titled Source nullable 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.
public string? Source { get; set; }
Target Section titled Target nullable 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.
public string? Target { get; set; }
Type Section titled Type nullable 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.
public string? Type { get; set; }