Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. VolumeBackup
Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj
Schema (JSON)
dimeskigj/pulumi-dokploy

dokploy.VolumeBackup

dokploy logo Dokploy
Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj
Schema (JSON)
dimeskigj/pulumi-dokploy

    A scheduled Dokploy volume backup for an application or Compose service. Exactly one of applicationId or composeId must be set.

    Create VolumeBackup Resource

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

    Constructor syntax

    new VolumeBackup(name: string, args: VolumeBackupArgs, opts?: CustomResourceOptions);
    @overload
def VolumeBackup(resource_name: str,
                 args: VolumeBackupArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def VolumeBackup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 cron_expression: Optional[str] = None,
                 destination_id: Optional[str] = None,
                 name: Optional[str] = None,
                 prefix: Optional[str] = None,
                 volume_name: Optional[str] = None,
                 application_id: Optional[str] = None,
                 compose_id: Optional[str] = None,
                 enabled: Optional[bool] = None,
                 keep_latest_count: Optional[int] = None,
                 service_name: Optional[str] = None,
                 turn_off: Optional[bool] = None)
    func NewVolumeBackup(ctx *Context, name string, args VolumeBackupArgs, opts ...ResourceOption) (*VolumeBackup, error)
    public VolumeBackup(string name, VolumeBackupArgs args, CustomResourceOptions? opts = null)
    public VolumeBackup(String name, VolumeBackupArgs args)
public VolumeBackup(String name, VolumeBackupArgs args, CustomResourceOptions options)

    type: dokploy:VolumeBackup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "dokploy_volume_backup" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args VolumeBackupArgs
    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 VolumeBackupArgs
    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 VolumeBackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeBackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeBackupArgs
    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 volumeBackupResource = new Dokploy.VolumeBackup("volumeBackupResource", new()
{
    CronExpression = "string",
    DestinationId = "string",
    Name = "string",
    Prefix = "string",
    VolumeName = "string",
    ApplicationId = "string",
    ComposeId = "string",
    Enabled = false,
    KeepLatestCount = 0,
    ServiceName = "string",
    TurnOff = false,
});

    example, err := dokploy.NewVolumeBackup(ctx, "volumeBackupResource", &dokploy.VolumeBackupArgs{
	CronExpression:  pulumi.String("string"),
	DestinationId:   pulumi.String("string"),
	Name:            pulumi.String("string"),
	Prefix:          pulumi.String("string"),
	VolumeName:      pulumi.String("string"),
	ApplicationId:   pulumi.String("string"),
	ComposeId:       pulumi.String("string"),
	Enabled:         pulumi.Bool(false),
	KeepLatestCount: pulumi.Int(0),
	ServiceName:     pulumi.String("string"),
	TurnOff:         pulumi.Bool(false),
})

    resource "dokploy_volume_backup" "volumeBackupResource" {
  pulumi {
    replace_on_changes = [application_id, compose_id, service_name]
  }
  lifecycle {
    create_before_destroy = true
  }
  cron_expression   = "string"
  destination_id    = "string"
  name              = "string"
  prefix            = "string"
  volume_name       = "string"
  application_id    = "string"
  compose_id        = "string"
  enabled           = false
  keep_latest_count = 0
  service_name      = "string"
  turn_off          = false
}

    var volumeBackupResource = new VolumeBackup("volumeBackupResource", VolumeBackupArgs.builder()
    .cronExpression("string")
    .destinationId("string")
    .name("string")
    .prefix("string")
    .volumeName("string")
    .applicationId("string")
    .composeId("string")
    .enabled(false)
    .keepLatestCount(0)
    .serviceName("string")
    .turnOff(false)
    .build());

    volume_backup_resource = dokploy.VolumeBackup("volumeBackupResource",
    cron_expression="string",
    destination_id="string",
    name="string",
    prefix="string",
    volume_name="string",
    application_id="string",
    compose_id="string",
    enabled=False,
    keep_latest_count=0,
    service_name="string",
    turn_off=False)

    const volumeBackupResource = new dokploy.VolumeBackup("volumeBackupResource", {
    cronExpression: "string",
    destinationId: "string",
    name: "string",
    prefix: "string",
    volumeName: "string",
    applicationId: "string",
    composeId: "string",
    enabled: false,
    keepLatestCount: 0,
    serviceName: "string",
    turnOff: false,
});

    type: dokploy:VolumeBackup
properties:
    applicationId: string
    composeId: string
    cronExpression: string
    destinationId: string
    enabled: false
    keepLatestCount: 0
    name: string
    prefix: string
    serviceName: string
    turnOff: false
    volumeName: string

    VolumeBackup 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 VolumeBackup resource accepts the following input properties:

    CronExpression string
    The backup cron schedule.
    DestinationId string
    The destination ID backups are stored to.
    Name string
    The volume backup resource name.
    Prefix string
    The backup file prefix.
    VolumeName string
    The Docker volume name to back up.
    ApplicationId string
    The optional target application ID.
    ComposeId string
    The optional target Compose ID.
    Enabled bool
    Whether the backup schedule is enabled.
    KeepLatestCount int
    The optional number of most recent backups to retain.
    ServiceName string
    The Compose service name that owns the volume.
    TurnOff bool
    Whether to turn the backup off without deleting it.
    CronExpression string
    The backup cron schedule.
    DestinationId string
    The destination ID backups are stored to.
    Name string
    The volume backup resource name.
    Prefix string
    The backup file prefix.
    VolumeName string
    The Docker volume name to back up.
    ApplicationId string
    The optional target application ID.
    ComposeId string
    The optional target Compose ID.
    Enabled bool
    Whether the backup schedule is enabled.
    KeepLatestCount int
    The optional number of most recent backups to retain.
    ServiceName string
    The Compose service name that owns the volume.
    TurnOff bool
    Whether to turn the backup off without deleting it.
    cron_expression string
    The backup cron schedule.
    destination_id string
    The destination ID backups are stored to.
    name string
    The volume backup resource name.
    prefix string
    The backup file prefix.
    volume_name string
    The Docker volume name to back up.
    application_id string
    The optional target application ID.
    compose_id string
    The optional target Compose ID.
    enabled bool
    Whether the backup schedule is enabled.
    keep_latest_count number
    The optional number of most recent backups to retain.
    service_name string
    The Compose service name that owns the volume.
    turn_off bool
    Whether to turn the backup off without deleting it.
    cronExpression String
    The backup cron schedule.
    destinationId String
    The destination ID backups are stored to.
    name String
    The volume backup resource name.
    prefix String
    The backup file prefix.
    volumeName String
    The Docker volume name to back up.
    applicationId String
    The optional target application ID.
    composeId String
    The optional target Compose ID.
    enabled Boolean
    Whether the backup schedule is enabled.
    keepLatestCount Integer
    The optional number of most recent backups to retain.
    serviceName String
    The Compose service name that owns the volume.
    turnOff Boolean
    Whether to turn the backup off without deleting it.
    cronExpression string
    The backup cron schedule.
    destinationId string
    The destination ID backups are stored to.
    name string
    The volume backup resource name.
    prefix string
    The backup file prefix.
    volumeName string
    The Docker volume name to back up.
    applicationId string
    The optional target application ID.
    composeId string
    The optional target Compose ID.
    enabled boolean
    Whether the backup schedule is enabled.
    keepLatestCount number
    The optional number of most recent backups to retain.
    serviceName string
    The Compose service name that owns the volume.
    turnOff boolean
    Whether to turn the backup off without deleting it.
    cron_expression str
    The backup cron schedule.
    destination_id str
    The destination ID backups are stored to.
    name str
    The volume backup resource name.
    prefix str
    The backup file prefix.
    volume_name str
    The Docker volume name to back up.
    application_id str
    The optional target application ID.
    compose_id str
    The optional target Compose ID.
    enabled bool
    Whether the backup schedule is enabled.
    keep_latest_count int
    The optional number of most recent backups to retain.
    service_name str
    The Compose service name that owns the volume.
    turn_off bool
    Whether to turn the backup off without deleting it.
    cronExpression String
    The backup cron schedule.
    destinationId String
    The destination ID backups are stored to.
    name String
    The volume backup resource name.
    prefix String
    The backup file prefix.
    volumeName String
    The Docker volume name to back up.
    applicationId String
    The optional target application ID.
    composeId String
    The optional target Compose ID.
    enabled Boolean
    Whether the backup schedule is enabled.
    keepLatestCount Number
    The optional number of most recent backups to retain.
    serviceName String
    The Compose service name that owns the volume.
    turnOff Boolean
    Whether to turn the backup off without deleting it.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    VolumeBackupId string
    The stable Dokploy volume backup ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    VolumeBackupId string
    The stable Dokploy volume backup ID.
    id string
    The provider-assigned unique ID for this managed resource.
    volume_backup_id string
    The stable Dokploy volume backup ID.
    id String
    The provider-assigned unique ID for this managed resource.
    volumeBackupId String
    The stable Dokploy volume backup ID.
    id string
    The provider-assigned unique ID for this managed resource.
    volumeBackupId string
    The stable Dokploy volume backup ID.
    id str
    The provider-assigned unique ID for this managed resource.
    volume_backup_id str
    The stable Dokploy volume backup ID.
    id String
    The provider-assigned unique ID for this managed resource.
    volumeBackupId String
    The stable Dokploy volume backup 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
    Schema (JSON)
    dimeskigj/pulumi-dokploy

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial