1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. Mount
Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj
dokploy logo Dokploy
Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj

    A Dokploy workload mount.

    Create Mount Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Mount(name: string, args: MountArgs, opts?: CustomResourceOptions);
    @overload
    def Mount(resource_name: str,
              args: MountArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Mount(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              mount_path: Optional[str] = None,
              type: Optional[str] = None,
              application_id: Optional[str] = None,
              compose_id: Optional[str] = None,
              content: Optional[str] = None,
              file_path: Optional[str] = None,
              host_path: Optional[str] = None,
              mariadb_id: Optional[str] = None,
              mysql_id: Optional[str] = None,
              postgres_id: Optional[str] = None,
              redis_id: Optional[str] = None,
              volume_name: Optional[str] = None)
    func NewMount(ctx *Context, name string, args MountArgs, opts ...ResourceOption) (*Mount, error)
    public Mount(string name, MountArgs args, CustomResourceOptions? opts = null)
    public Mount(String name, MountArgs args)
    public Mount(String name, MountArgs args, CustomResourceOptions options)
    
    type: dokploy:Mount
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "dokploy_mount" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args MountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MountArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MountArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var mountResource = new Dokploy.Mount("mountResource", new()
    {
        MountPath = "string",
        Type = "string",
        ApplicationId = "string",
        ComposeId = "string",
        Content = "string",
        FilePath = "string",
        HostPath = "string",
        MariadbId = "string",
        MysqlId = "string",
        PostgresId = "string",
        RedisId = "string",
        VolumeName = "string",
    });
    
    example, err := dokploy.NewMount(ctx, "mountResource", &dokploy.MountArgs{
    	MountPath:     pulumi.String("string"),
    	Type:          pulumi.String("string"),
    	ApplicationId: pulumi.String("string"),
    	ComposeId:     pulumi.String("string"),
    	Content:       pulumi.String("string"),
    	FilePath:      pulumi.String("string"),
    	HostPath:      pulumi.String("string"),
    	MariadbId:     pulumi.String("string"),
    	MysqlId:       pulumi.String("string"),
    	PostgresId:    pulumi.String("string"),
    	RedisId:       pulumi.String("string"),
    	VolumeName:    pulumi.String("string"),
    })
    
    resource "dokploy_mount" "mountResource" {
      pulumi {
        replace_on_changes = [application_id, compose_id, mariadb_id, mysql_id, postgres_id, redis_id, type]
      }
      lifecycle {
        create_before_destroy = true
      }
      mount_path     = "string"
      type           = "string"
      application_id = "string"
      compose_id     = "string"
      content        = "string"
      file_path      = "string"
      host_path      = "string"
      mariadb_id     = "string"
      mysql_id       = "string"
      postgres_id    = "string"
      redis_id       = "string"
      volume_name    = "string"
    }
    
    var mountResource = new Mount("mountResource", MountArgs.builder()
        .mountPath("string")
        .type("string")
        .applicationId("string")
        .composeId("string")
        .content("string")
        .filePath("string")
        .hostPath("string")
        .mariadbId("string")
        .mysqlId("string")
        .postgresId("string")
        .redisId("string")
        .volumeName("string")
        .build());
    
    mount_resource = dokploy.Mount("mountResource",
        mount_path="string",
        type="string",
        application_id="string",
        compose_id="string",
        content="string",
        file_path="string",
        host_path="string",
        mariadb_id="string",
        mysql_id="string",
        postgres_id="string",
        redis_id="string",
        volume_name="string")
    
    const mountResource = new dokploy.Mount("mountResource", {
        mountPath: "string",
        type: "string",
        applicationId: "string",
        composeId: "string",
        content: "string",
        filePath: "string",
        hostPath: "string",
        mariadbId: "string",
        mysqlId: "string",
        postgresId: "string",
        redisId: "string",
        volumeName: "string",
    });
    
    type: dokploy:Mount
    properties:
        applicationId: string
        composeId: string
        content: string
        filePath: string
        hostPath: string
        mariadbId: string
        mountPath: string
        mysqlId: string
        postgresId: string
        redisId: string
        type: string
        volumeName: string
    

    Mount Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Mount resource accepts the following input properties:

    MountPath string
    The path inside the workload.
    Type string
    The mount type.
    ApplicationId string
    The application target.
    ComposeId string
    The Compose target.
    Content string
    The file content.
    FilePath string
    The file path.
    HostPath string
    The host path.
    MariadbId string
    The MariaDB target.
    MysqlId string
    The MySQL target.
    PostgresId string
    The Postgres target.
    RedisId string
    The Redis target.
    VolumeName string
    The volume name.
    MountPath string
    The path inside the workload.
    Type string
    The mount type.
    ApplicationId string
    The application target.
    ComposeId string
    The Compose target.
    Content string
    The file content.
    FilePath string
    The file path.
    HostPath string
    The host path.
    MariadbId string
    The MariaDB target.
    MysqlId string
    The MySQL target.
    PostgresId string
    The Postgres target.
    RedisId string
    The Redis target.
    VolumeName string
    The volume name.
    mount_path string
    The path inside the workload.
    type string
    The mount type.
    application_id string
    The application target.
    compose_id string
    The Compose target.
    content string
    The file content.
    file_path string
    The file path.
    host_path string
    The host path.
    mariadb_id string
    The MariaDB target.
    mysql_id string
    The MySQL target.
    postgres_id string
    The Postgres target.
    redis_id string
    The Redis target.
    volume_name string
    The volume name.
    mountPath String
    The path inside the workload.
    type String
    The mount type.
    applicationId String
    The application target.
    composeId String
    The Compose target.
    content String
    The file content.
    filePath String
    The file path.
    hostPath String
    The host path.
    mariadbId String
    The MariaDB target.
    mysqlId String
    The MySQL target.
    postgresId String
    The Postgres target.
    redisId String
    The Redis target.
    volumeName String
    The volume name.
    mountPath string
    The path inside the workload.
    type string
    The mount type.
    applicationId string
    The application target.
    composeId string
    The Compose target.
    content string
    The file content.
    filePath string
    The file path.
    hostPath string
    The host path.
    mariadbId string
    The MariaDB target.
    mysqlId string
    The MySQL target.
    postgresId string
    The Postgres target.
    redisId string
    The Redis target.
    volumeName string
    The volume name.
    mount_path str
    The path inside the workload.
    type str
    The mount type.
    application_id str
    The application target.
    compose_id str
    The Compose target.
    content str
    The file content.
    file_path str
    The file path.
    host_path str
    The host path.
    mariadb_id str
    The MariaDB target.
    mysql_id str
    The MySQL target.
    postgres_id str
    The Postgres target.
    redis_id str
    The Redis target.
    volume_name str
    The volume name.
    mountPath String
    The path inside the workload.
    type String
    The mount type.
    applicationId String
    The application target.
    composeId String
    The Compose target.
    content String
    The file content.
    filePath String
    The file path.
    hostPath String
    The host path.
    mariadbId String
    The MariaDB target.
    mysqlId String
    The MySQL target.
    postgresId String
    The Postgres target.
    redisId String
    The Redis target.
    volumeName String
    The volume name.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Mount resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    MountId string
    The stable Dokploy mount ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    MountId string
    The stable Dokploy mount ID.
    id string
    The provider-assigned unique ID for this managed resource.
    mount_id string
    The stable Dokploy mount ID.
    id String
    The provider-assigned unique ID for this managed resource.
    mountId String
    The stable Dokploy mount ID.
    id string
    The provider-assigned unique ID for this managed resource.
    mountId string
    The stable Dokploy mount ID.
    id str
    The provider-assigned unique ID for this managed resource.
    mount_id str
    The stable Dokploy mount ID.
    id String
    The provider-assigned unique ID for this managed resource.
    mountId String
    The stable Dokploy mount ID.

    Package Details

    Repository
    dokploy dimeskigj/pulumi-dokploy
    License
    Apache-2.0
    dokploy logo Dokploy
    Viewing docs for Dokploy v0.3.1
    published on Tuesday, Sep 29, 2026 by dimeskigj

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial