Interface IDockerVolume

A Docker volume.

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IDockerVolume

Syntax (vb)

Public Interface IDockerVolume

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;

            var dockerVolume = new DockerVolume {
                ContainerPath = "containerPath",
                HostPath = "hostPath",

                // the properties below are optional
                Consistency = DockerVolumeConsistency.CONSISTENT
            };

Synopsis

Properties

Consistency	Mount consistency.
ContainerPath	The path where the file or directory is mounted in the container.
HostPath	The path to the file or directory on the host machine.

Properties

Consistency

Mount consistency.

DockerVolumeConsistency? Consistency { get; }

Property Value

DockerVolumeConsistency?

Remarks

Only applicable for macOS

Default: DockerConsistency.DELEGATED

See: https://docs.docker.com/storage/bind-mounts/#configure-mount-consistency-for-macos

ContainerPath

The path where the file or directory is mounted in the container.

string ContainerPath { get; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

HostPath

The path to the file or directory on the host machine.

string HostPath { get; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated