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

dokploy.Redis

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 Redis database.

    Create Redis Resource

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

    Constructor syntax

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

@overload
def Redis(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          database_password: Optional[str] = None,
          environment_id: Optional[str] = None,
          name: Optional[str] = None,
          app_name: 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 NewRedis(ctx *Context, name string, args RedisArgs, opts ...ResourceOption) (*Redis, error)
    public Redis(string name, RedisArgs args, CustomResourceOptions? opts = null)
    public Redis(String name, RedisArgs args)
public Redis(String name, RedisArgs args, CustomResourceOptions options)

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


    resource "dokploy_redis" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args RedisArgs
    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 RedisArgs
    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 RedisArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RedisArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RedisArgs
    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 redisResource = new Dokploy.Redis("redisResource", new()
{
    DatabasePassword = "string",
    EnvironmentId = "string",
    Name = "string",
    AppName = "string",
    Description = "string",
    DockerImage = "string",
    Environment = "string",
    ExternalPort = 0,
    ServerId = "string",
});

    example, err := dokploy.NewRedis(ctx, "redisResource", &dokploy.RedisArgs{
	DatabasePassword: pulumi.String("string"),
	EnvironmentId:    pulumi.String("string"),
	Name:             pulumi.String("string"),
	AppName:          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_redis" "redisResource" {
  pulumi {
    replace_on_changes = [environment_id, server_id]
  }
  lifecycle {
    create_before_destroy = true
  }
  database_password = "string"
  environment_id    = "string"
  name              = "string"
  app_name          = "string"
  description       = "string"
  docker_image      = "string"
  environment       = "string"
  external_port     = 0
  server_id         = "string"
}

    var redisResource = new Redis("redisResource", RedisArgs.builder()
    .databasePassword("string")
    .environmentId("string")
    .name("string")
    .appName("string")
    .description("string")
    .dockerImage("string")
    .environment("string")
    .externalPort(0)
    .serverId("string")
    .build());

    redis_resource = dokploy.Redis("redisResource",
    database_password="string",
    environment_id="string",
    name="string",
    app_name="string",
    description="string",
    docker_image="string",
    environment="string",
    external_port=0,
    server_id="string")

    const redisResource = new dokploy.Redis("redisResource", {
    databasePassword: "string",
    environmentId: "string",
    name: "string",
    appName: "string",
    description: "string",
    dockerImage: "string",
    environment: "string",
    externalPort: 0,
    serverId: "string",
});

    type: dokploy:Redis
properties:
    appName: string
    databasePassword: string
    description: string
    dockerImage: string
    environment: string
    environmentId: string
    externalPort: 0
    name: string
    serverId: string

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

    DatabasePassword string
    The Redis database password.
    EnvironmentId string
    The target environment ID.
    Name string
    The database resource name.
    AppName string
    The optional deployed database name.
    Description string
    An optional database description.
    DockerImage string
    The Redis Docker image.
    Environment string
    Environment variables for Redis.
    ExternalPort int
    The optional externally exposed port.
    ServerId string
    The optional server ID.
    DatabasePassword string
    The Redis database password.
    EnvironmentId string
    The target environment ID.
    Name string
    The database resource name.
    AppName string
    The optional deployed database name.
    Description string
    An optional database description.
    DockerImage string
    The Redis Docker image.
    Environment string
    Environment variables for Redis.
    ExternalPort int
    The optional externally exposed port.
    ServerId string
    The optional server ID.
    database_password string
    The Redis database password.
    environment_id string
    The target environment ID.
    name string
    The database resource name.
    app_name string
    The optional deployed database name.
    description string
    An optional database description.
    docker_image string
    The Redis Docker image.
    environment string
    Environment variables for Redis.
    external_port number
    The optional externally exposed port.
    server_id string
    The optional server ID.
    databasePassword String
    The Redis database password.
    environmentId String
    The target environment ID.
    name String
    The database resource name.
    appName String
    The optional deployed database name.
    description String
    An optional database description.
    dockerImage String
    The Redis Docker image.
    environment String
    Environment variables for Redis.
    externalPort Integer
    The optional externally exposed port.
    serverId String
    The optional server ID.
    databasePassword string
    The Redis database password.
    environmentId string
    The target environment ID.
    name string
    The database resource name.
    appName string
    The optional deployed database name.
    description string
    An optional database description.
    dockerImage string
    The Redis Docker image.
    environment string
    Environment variables for Redis.
    externalPort number
    The optional externally exposed port.
    serverId string
    The optional server ID.
    database_password str
    The Redis database password.
    environment_id str
    The target environment ID.
    name str
    The database resource name.
    app_name str
    The optional deployed database name.
    description str
    An optional database description.
    docker_image str
    The Redis Docker image.
    environment str
    Environment variables for Redis.
    external_port int
    The optional externally exposed port.
    server_id str
    The optional server ID.
    databasePassword String
    The Redis database password.
    environmentId String
    The target environment ID.
    name String
    The database resource name.
    appName String
    The optional deployed database name.
    description String
    An optional database description.
    dockerImage String
    The Redis Docker image.
    environment String
    Environment variables for Redis.
    externalPort Number
    The optional externally exposed port.
    serverId String
    The optional server ID.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    RedisId string
    The stable Dokploy Redis ID.
    Status string
    The current Redis deployment status.
    Id string
    The provider-assigned unique ID for this managed resource.
    RedisId string
    The stable Dokploy Redis ID.
    Status string
    The current Redis deployment status.
    id string
    The provider-assigned unique ID for this managed resource.
    redis_id string
    The stable Dokploy Redis ID.
    status string
    The current Redis deployment status.
    id String
    The provider-assigned unique ID for this managed resource.
    redisId String
    The stable Dokploy Redis ID.
    status String
    The current Redis deployment status.
    id string
    The provider-assigned unique ID for this managed resource.
    redisId string
    The stable Dokploy Redis ID.
    status string
    The current Redis deployment status.
    id str
    The provider-assigned unique ID for this managed resource.
    redis_id str
    The stable Dokploy Redis ID.
    status str
    The current Redis deployment status.
    id String
    The provider-assigned unique ID for this managed resource.
    redisId String
    The stable Dokploy Redis ID.
    status String
    The current Redis deployment status.

    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