Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj
published on Tuesday, Sep 29, 2026 by dimeskigj
Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj
published on Tuesday, Sep 29, 2026 by dimeskigj
A Dokploy MariaDB database.
Create MariaDB Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new MariaDB(name: string, args: MariaDBArgs, opts?: CustomResourceOptions);@overload
def MariaDB(resource_name: str,
args: MariaDBArgs,
opts: Optional[ResourceOptions] = None)
@overload
def MariaDB(resource_name: str,
opts: Optional[ResourceOptions] = None,
database_name: Optional[str] = None,
database_password: Optional[str] = None,
database_user: Optional[str] = None,
environment_id: Optional[str] = None,
name: Optional[str] = None,
app_name: Optional[str] = None,
database_root_password: Optional[str] = None,
description: Optional[str] = None,
docker_image: Optional[str] = None,
environment: Optional[str] = None,
external_port: Optional[int] = None,
server_id: Optional[str] = None)func NewMariaDB(ctx *Context, name string, args MariaDBArgs, opts ...ResourceOption) (*MariaDB, error)public MariaDB(string name, MariaDBArgs args, CustomResourceOptions? opts = null)
public MariaDB(String name, MariaDBArgs args)
public MariaDB(String name, MariaDBArgs args, CustomResourceOptions options)
type: dokploy:MariaDB
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "dokploy_maria_d_b" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args MariaDBArgs
- 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 MariaDBArgs
- 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 MariaDBArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MariaDBArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MariaDBArgs
- 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 mariaDBResource = new Dokploy.MariaDB("mariaDBResource", new()
{
DatabaseName = "string",
DatabasePassword = "string",
DatabaseUser = "string",
EnvironmentId = "string",
Name = "string",
AppName = "string",
DatabaseRootPassword = "string",
Description = "string",
DockerImage = "string",
Environment = "string",
ExternalPort = 0,
ServerId = "string",
});
example, err := dokploy.NewMariaDB(ctx, "mariaDBResource", &dokploy.MariaDBArgs{
DatabaseName: pulumi.String("string"),
DatabasePassword: pulumi.String("string"),
DatabaseUser: pulumi.String("string"),
EnvironmentId: pulumi.String("string"),
Name: pulumi.String("string"),
AppName: pulumi.String("string"),
DatabaseRootPassword: pulumi.String("string"),
Description: pulumi.String("string"),
DockerImage: pulumi.String("string"),
Environment: pulumi.String("string"),
ExternalPort: pulumi.Int(0),
ServerId: pulumi.String("string"),
})
resource "dokploy_maria_d_b" "mariaDBResource" {
pulumi {
replace_on_changes = [environment_id, server_id]
}
lifecycle {
create_before_destroy = true
}
database_name = "string"
database_password = "string"
database_user = "string"
environment_id = "string"
name = "string"
app_name = "string"
database_root_password = "string"
description = "string"
docker_image = "string"
environment = "string"
external_port = 0
server_id = "string"
}
var mariaDBResource = new MariaDB("mariaDBResource", MariaDBArgs.builder()
.databaseName("string")
.databasePassword("string")
.databaseUser("string")
.environmentId("string")
.name("string")
.appName("string")
.databaseRootPassword("string")
.description("string")
.dockerImage("string")
.environment("string")
.externalPort(0)
.serverId("string")
.build());
maria_db_resource = dokploy.MariaDB("mariaDBResource",
database_name="string",
database_password="string",
database_user="string",
environment_id="string",
name="string",
app_name="string",
database_root_password="string",
description="string",
docker_image="string",
environment="string",
external_port=0,
server_id="string")
const mariaDBResource = new dokploy.MariaDB("mariaDBResource", {
databaseName: "string",
databasePassword: "string",
databaseUser: "string",
environmentId: "string",
name: "string",
appName: "string",
databaseRootPassword: "string",
description: "string",
dockerImage: "string",
environment: "string",
externalPort: 0,
serverId: "string",
});
type: dokploy:MariaDB
properties:
appName: string
databaseName: string
databasePassword: string
databaseRootPassword: string
databaseUser: string
description: string
dockerImage: string
environment: string
environmentId: string
externalPort: 0
name: string
serverId: string
MariaDB 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 MariaDB resource accepts the following input properties:
- Database
Name string - The MariaDB database name.
- Database
Password string - The MariaDB database password.
- Database
User string - The MariaDB database user.
- Environment
Id string - The target environment ID.
- Name string
- The database resource name.
- App
Name string - The optional deployed database name.
- Database
Root stringPassword - The optional MariaDB root password.
- Description string
- An optional database description.
- Docker
Image string - The MariaDB Docker image.
- Environment string
- Environment variables for MariaDB.
- External
Port int - The optional externally exposed port.
- Server
Id string - The optional server ID.
- Database
Name string - The MariaDB database name.
- Database
Password string - The MariaDB database password.
- Database
User string - The MariaDB database user.
- Environment
Id string - The target environment ID.
- Name string
- The database resource name.
- App
Name string - The optional deployed database name.
- Database
Root stringPassword - The optional MariaDB root password.
- Description string
- An optional database description.
- Docker
Image string - The MariaDB Docker image.
- Environment string
- Environment variables for MariaDB.
- External
Port int - The optional externally exposed port.
- Server
Id string - The optional server ID.
- database_
name string - The MariaDB database name.
- database_
password string - The MariaDB database password.
- database_
user string - The MariaDB database user.
- environment_
id string - The target environment ID.
- name string
- The database resource name.
- app_
name string - The optional deployed database name.
- database_
root_ stringpassword - The optional MariaDB root password.
- description string
- An optional database description.
- docker_
image string - The MariaDB Docker image.
- environment string
- Environment variables for MariaDB.
- external_
port number - The optional externally exposed port.
- server_
id string - The optional server ID.
- database
Name String - The MariaDB database name.
- database
Password String - The MariaDB database password.
- database
User String - The MariaDB database user.
- environment
Id String - The target environment ID.
- name String
- The database resource name.
- app
Name String - The optional deployed database name.
- database
Root StringPassword - The optional MariaDB root password.
- description String
- An optional database description.
- docker
Image String - The MariaDB Docker image.
- environment String
- Environment variables for MariaDB.
- external
Port Integer - The optional externally exposed port.
- server
Id String - The optional server ID.
- database
Name string - The MariaDB database name.
- database
Password string - The MariaDB database password.
- database
User string - The MariaDB database user.
- environment
Id string - The target environment ID.
- name string
- The database resource name.
- app
Name string - The optional deployed database name.
- database
Root stringPassword - The optional MariaDB root password.
- description string
- An optional database description.
- docker
Image string - The MariaDB Docker image.
- environment string
- Environment variables for MariaDB.
- external
Port number - The optional externally exposed port.
- server
Id string - The optional server ID.
- database_
name str - The MariaDB database name.
- database_
password str - The MariaDB database password.
- database_
user str - The MariaDB database user.
- environment_
id str - The target environment ID.
- name str
- The database resource name.
- app_
name str - The optional deployed database name.
- database_
root_ strpassword - The optional MariaDB root password.
- description str
- An optional database description.
- docker_
image str - The MariaDB Docker image.
- environment str
- Environment variables for MariaDB.
- external_
port int - The optional externally exposed port.
- server_
id str - The optional server ID.
- database
Name String - The MariaDB database name.
- database
Password String - The MariaDB database password.
- database
User String - The MariaDB database user.
- environment
Id String - The target environment ID.
- name String
- The database resource name.
- app
Name String - The optional deployed database name.
- database
Root StringPassword - The optional MariaDB root password.
- description String
- An optional database description.
- docker
Image String - The MariaDB Docker image.
- environment String
- Environment variables for MariaDB.
- external
Port Number - The optional externally exposed port.
- server
Id String - The optional server ID.
Outputs
All input properties are implicitly available as output properties. Additionally, the MariaDB resource produces the following output properties:
- id string
- The provider-assigned unique ID for this managed resource.
- mariadb_
id string - The stable Dokploy MariaDB ID.
- status string
- The current MariaDB deployment status.
- id str
- The provider-assigned unique ID for this managed resource.
- mariadb_
id str - The stable Dokploy MariaDB ID.
- status str
- The current MariaDB deployment status.
Package Details
- Repository
- dokploy dimeskigj/pulumi-dokploy
- License
- Apache-2.0
Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj
published on Tuesday, Sep 29, 2026 by dimeskigj