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

dokploy.Destination

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

    A Dokploy S3-compatible backup storage destination.

    Create Destination Resource

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

    Constructor syntax

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

@overload
def Destination(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                access_key: Optional[str] = None,
                bucket: Optional[str] = None,
                endpoint: Optional[str] = None,
                name: Optional[str] = None,
                region: Optional[str] = None,
                secret_access_key: Optional[str] = None,
                additional_flags: Optional[Sequence[str]] = None,
                provider: Optional[str] = None,
                server_id: Optional[str] = None)
    func NewDestination(ctx *Context, name string, args DestinationArgs, opts ...ResourceOption) (*Destination, error)
    public Destination(string name, DestinationArgs args, CustomResourceOptions? opts = null)
    public Destination(String name, DestinationArgs args)
public Destination(String name, DestinationArgs args, CustomResourceOptions options)

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


    resource "dokploy_destination" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args DestinationArgs
    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 DestinationArgs
    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 DestinationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DestinationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DestinationArgs
    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 destinationResource = new Dokploy.Destination("destinationResource", new()
{
    AccessKey = "string",
    Bucket = "string",
    Endpoint = "string",
    Name = "string",
    Region = "string",
    SecretAccessKey = "string",
    AdditionalFlags = new[]
    {
        "string",
    },
    Provider = "string",
    ServerId = "string",
});

    example, err := dokploy.NewDestination(ctx, "destinationResource", &dokploy.DestinationArgs{
	AccessKey:       pulumi.String("string"),
	Bucket:          pulumi.String("string"),
	Endpoint:        pulumi.String("string"),
	Name:            pulumi.String("string"),
	Region:          pulumi.String("string"),
	SecretAccessKey: pulumi.String("string"),
	AdditionalFlags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Provider: pulumi.String("string"),
	ServerId: pulumi.String("string"),
})

    resource "dokploy_destination" "destinationResource" {
  lifecycle {
    create_before_destroy = true
  }
  access_key        = "string"
  bucket            = "string"
  endpoint          = "string"
  name              = "string"
  region            = "string"
  secret_access_key = "string"
  additional_flags  = ["string"]
  provider          = "string"
  server_id         = "string"
}

    var destinationResource = new Destination("destinationResource", DestinationArgs.builder()
    .accessKey("string")
    .bucket("string")
    .endpoint("string")
    .name("string")
    .region("string")
    .secretAccessKey("string")
    .additionalFlags("string")
    .provider("string")
    .serverId("string")
    .build());

    destination_resource = dokploy.Destination("destinationResource",
    access_key="string",
    bucket="string",
    endpoint="string",
    name="string",
    region="string",
    secret_access_key="string",
    additional_flags=["string"],
    provider="string",
    server_id="string")

    const destinationResource = new dokploy.Destination("destinationResource", {
    accessKey: "string",
    bucket: "string",
    endpoint: "string",
    name: "string",
    region: "string",
    secretAccessKey: "string",
    additionalFlags: ["string"],
    provider: "string",
    serverId: "string",
});

    type: dokploy:Destination
properties:
    accessKey: string
    additionalFlags:
        - string
    bucket: string
    endpoint: string
    name: string
    provider: string
    region: string
    secretAccessKey: string
    serverId: string

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

    AccessKey string
    The storage access key ID.
    Bucket string
    The storage bucket name.
    Endpoint string
    The storage endpoint URL.
    Name string
    The destination name.
    Region string
    The storage region.
    SecretAccessKey string
    The storage secret access key.
    AdditionalFlags List<string>
    Additional rclone flags for backup and restore operations.
    Provider string
    The storage provider.
    ServerId string
    The optional server ID this destination is scoped to.
    AccessKey string
    The storage access key ID.
    Bucket string
    The storage bucket name.
    Endpoint string
    The storage endpoint URL.
    Name string
    The destination name.
    Region string
    The storage region.
    SecretAccessKey string
    The storage secret access key.
    AdditionalFlags []string
    Additional rclone flags for backup and restore operations.
    Provider string
    The storage provider.
    ServerId string
    The optional server ID this destination is scoped to.
    access_key string
    The storage access key ID.
    bucket string
    The storage bucket name.
    endpoint string
    The storage endpoint URL.
    name string
    The destination name.
    region string
    The storage region.
    secret_access_key string
    The storage secret access key.
    additional_flags list(string)
    Additional rclone flags for backup and restore operations.
    provider string
    The storage provider.
    server_id string
    The optional server ID this destination is scoped to.
    accessKey String
    The storage access key ID.
    bucket String
    The storage bucket name.
    endpoint String
    The storage endpoint URL.
    name String
    The destination name.
    region String
    The storage region.
    secretAccessKey String
    The storage secret access key.
    additionalFlags List<String>
    Additional rclone flags for backup and restore operations.
    provider String
    The storage provider.
    serverId String
    The optional server ID this destination is scoped to.
    accessKey string
    The storage access key ID.
    bucket string
    The storage bucket name.
    endpoint string
    The storage endpoint URL.
    name string
    The destination name.
    region string
    The storage region.
    secretAccessKey string
    The storage secret access key.
    additionalFlags string[]
    Additional rclone flags for backup and restore operations.
    provider string
    The storage provider.
    serverId string
    The optional server ID this destination is scoped to.
    access_key str
    The storage access key ID.
    bucket str
    The storage bucket name.
    endpoint str
    The storage endpoint URL.
    name str
    The destination name.
    region str
    The storage region.
    secret_access_key str
    The storage secret access key.
    additional_flags Sequence[str]
    Additional rclone flags for backup and restore operations.
    provider str
    The storage provider.
    server_id str
    The optional server ID this destination is scoped to.
    accessKey String
    The storage access key ID.
    bucket String
    The storage bucket name.
    endpoint String
    The storage endpoint URL.
    name String
    The destination name.
    region String
    The storage region.
    secretAccessKey String
    The storage secret access key.
    additionalFlags List<String>
    Additional rclone flags for backup and restore operations.
    provider String
    The storage provider.
    serverId String
    The optional server ID this destination is scoped to.

    Outputs

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

    DestinationId string
    The stable Dokploy destination ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    DestinationId string
    The stable Dokploy destination ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    destination_id string
    The stable Dokploy destination ID.
    id string
    The provider-assigned unique ID for this managed resource.
    destinationId String
    The stable Dokploy destination ID.
    id String
    The provider-assigned unique ID for this managed resource.
    destinationId string
    The stable Dokploy destination ID.
    id string
    The provider-assigned unique ID for this managed resource.
    destination_id str
    The stable Dokploy destination ID.
    id str
    The provider-assigned unique ID for this managed resource.
    destinationId String
    The stable Dokploy destination ID.
    id String
    The provider-assigned unique ID for this managed resource.

    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