published on Thursday, Nov 5, 2026 by dimeskigj
published on Thursday, Nov 5, 2026 by dimeskigj
A Dokploy project.
Create Project Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Project(name: string, args: ProjectArgs, opts?: CustomResourceOptions);@overload
def Project(resource_name: str,
args: ProjectArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Project(resource_name: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
description: Optional[str] = None)func NewProject(ctx *Context, name string, args ProjectArgs, opts ...ResourceOption) (*Project, error)public Project(string name, ProjectArgs args, CustomResourceOptions? opts = null)
public Project(String name, ProjectArgs args)
public Project(String name, ProjectArgs args, CustomResourceOptions options)
type: dokploy:Project
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "dokploy_project" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ProjectArgs
- 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 ProjectArgs
- 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 ProjectArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProjectArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProjectArgs
- 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 projectResource = new Dokploy.Project("projectResource", new()
{
Name = "string",
Description = "string",
});
example, err := dokploy.NewProject(ctx, "projectResource", &dokploy.ProjectArgs{
Name: pulumi.String("string"),
Description: pulumi.String("string"),
})
resource "dokploy_project" "projectResource" {
lifecycle {
create_before_destroy = true
}
name = "string"
description = "string"
}
var projectResource = new Project("projectResource", ProjectArgs.builder()
.name("string")
.description("string")
.build());
project_resource = dokploy.Project("projectResource",
name="string",
description="string")
const projectResource = new dokploy.Project("projectResource", {
name: "string",
description: "string",
});
type: dokploy:Project
properties:
description: string
name: string
Project 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 Project resource accepts the following input properties:
- Name string
- The project name.
- Description string
- An optional project description.
- Name string
- The project name.
- Description string
- An optional project description.
- name string
- The project name.
- description string
- An optional project description.
- name String
- The project name.
- description String
- An optional project description.
- name string
- The project name.
- description string
- An optional project description.
- name str
- The project name.
- description str
- An optional project description.
- name String
- The project name.
- description String
- An optional project description.
Outputs
All input properties are implicitly available as output properties. Additionally, the Project resource produces the following output properties:
- Default
Environment stringId - The project's default environment ID.
- Id string
- The provider-assigned unique ID for this managed resource.
- Project
Id string - The stable Dokploy project ID.
- Default
Environment stringId - The project's default environment ID.
- Id string
- The provider-assigned unique ID for this managed resource.
- Project
Id string - The stable Dokploy project ID.
- default_
environment_ stringid - The project's default environment ID.
- id string
- The provider-assigned unique ID for this managed resource.
- project_
id string - The stable Dokploy project ID.
- default
Environment StringId - The project's default environment ID.
- id String
- The provider-assigned unique ID for this managed resource.
- project
Id String - The stable Dokploy project ID.
- default
Environment stringId - The project's default environment ID.
- id string
- The provider-assigned unique ID for this managed resource.
- project
Id string - The stable Dokploy project ID.
- default_
environment_ strid - The project's default environment ID.
- id str
- The provider-assigned unique ID for this managed resource.
- project_
id str - The stable Dokploy project ID.
- default
Environment StringId - The project's default environment ID.
- id String
- The provider-assigned unique ID for this managed resource.
- project
Id String - The stable Dokploy project ID.
Look up Existing Project Resource
Get an existing Project resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Project@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Projectfunc GetProject(ctx *Context, name string, id IDInput, state *ProjectState, opts ...ResourceOption) (*Project, error)public static Project Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Project get(String name, Output<String> id, CustomResourceOptions options)resources: existingProject: type: dokploy:Project get: id: ${id}import {
to = dokploy_project.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state ProjectState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Package Details
- Repository
- dokploy dimeskigj/pulumi-dokploy
- License
- Apache-2.0
published on Thursday, Nov 5, 2026 by dimeskigj