Upstash v0.5.0, Aug 27 25

Upstash v0.5.0 published on Wednesday, Aug 27, 2025 by Upstash

upstash.RedisDatabase

Explore with Pulumi AI

Upstash v0.5.0 published on Wednesday, Aug 27, 2025 by Upstash

Create RedisDatabase Resource

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

Constructor syntax

new RedisDatabase(name: string, args: RedisDatabaseArgs, opts?: CustomResourceOptions);

@overload
def RedisDatabase(resource_name: str,
                  args: RedisDatabaseArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def RedisDatabase(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  database_name: Optional[str] = None,
                  region: Optional[str] = None,
                  auto_scale: Optional[bool] = None,
                  budget: Optional[int] = None,
                  consistent: Optional[bool] = None,
                  eviction: Optional[bool] = None,
                  ip_allowlists: Optional[Sequence[str]] = None,
                  multizone: Optional[bool] = None,
                  primary_region: Optional[str] = None,
                  prod_pack: Optional[bool] = None,
                  read_regions: Optional[Sequence[str]] = None,
                  tls: Optional[bool] = None)

func NewRedisDatabase(ctx *Context, name string, args RedisDatabaseArgs, opts ...ResourceOption) (*RedisDatabase, error)

public RedisDatabase(string name, RedisDatabaseArgs args, CustomResourceOptions? opts = null)

public RedisDatabase(String name, RedisDatabaseArgs args)
public RedisDatabase(String name, RedisDatabaseArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args RedisDatabaseArgs: 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 RedisDatabaseArgs: 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 RedisDatabaseArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RedisDatabaseArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RedisDatabaseArgs: 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 redisDatabaseResource = new Upstash.RedisDatabase("redisDatabaseResource", new()
{
    DatabaseName = "string",
    Region = "string",
    AutoScale = false,
    Budget = 0,
    Eviction = false,
    IpAllowlists = new[]
    {
        "string",
    },
    PrimaryRegion = "string",
    ProdPack = false,
    ReadRegions = new[]
    {
        "string",
    },
    Tls = false,
});

example, err := upstash.NewRedisDatabase(ctx, "redisDatabaseResource", &upstash.RedisDatabaseArgs{
	DatabaseName: pulumi.String("string"),
	Region:       pulumi.String("string"),
	AutoScale:    pulumi.Bool(false),
	Budget:       pulumi.Int(0),
	Eviction:     pulumi.Bool(false),
	IpAllowlists: pulumi.StringArray{
		pulumi.String("string"),
	},
	PrimaryRegion: pulumi.String("string"),
	ProdPack:      pulumi.Bool(false),
	ReadRegions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tls: pulumi.Bool(false),
})

var redisDatabaseResource = new RedisDatabase("redisDatabaseResource", RedisDatabaseArgs.builder()
    .databaseName("string")
    .region("string")
    .autoScale(false)
    .budget(0)
    .eviction(false)
    .ipAllowlists("string")
    .primaryRegion("string")
    .prodPack(false)
    .readRegions("string")
    .tls(false)
    .build());

redis_database_resource = upstash.RedisDatabase("redisDatabaseResource",
    database_name="string",
    region="string",
    auto_scale=False,
    budget=0,
    eviction=False,
    ip_allowlists=["string"],
    primary_region="string",
    prod_pack=False,
    read_regions=["string"],
    tls=False)

const redisDatabaseResource = new upstash.RedisDatabase("redisDatabaseResource", {
    databaseName: "string",
    region: "string",
    autoScale: false,
    budget: 0,
    eviction: false,
    ipAllowlists: ["string"],
    primaryRegion: "string",
    prodPack: false,
    readRegions: ["string"],
    tls: false,
});

type: upstash:RedisDatabase
properties:
    autoScale: false
    budget: 0
    databaseName: string
    eviction: false
    ipAllowlists:
        - string
    primaryRegion: string
    prodPack: false
    readRegions:
        - string
    region: string
    tls: false

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

DatabaseName string: Name of the database
Region string: Region of the database. For global gcp regions, use gcp-global. For globals, check for primary_region and read_regions fields
AutoScale bool: Upgrade to higher plans automatically when it hits quotas
Budget int: Budget for the database (default $20). It is used to limit the cost of the database. If the budget is reached, the database will be throttled until the next month.
Consistent bool: When enabled, all writes are synchronously persisted to the disk.
Deprecated: Consistent option is deprecated.
Eviction bool: Enable eviction, to evict keys when your database reaches the max size
IpAllowlists List<string>: Ip CIDR allowlist for the database. If not set, all IPs are allowed to connect to the database.
Multizone bool: When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)
Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.
PrimaryRegion string: Primary region for the database (Only works if region='global'. Can be one of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2])
ProdPack bool: Whether Prod Pack is enabled for the database.
ReadRegions List<string>: Read regions for the database (Only works if region='global' and primary_region is set. Can be any combination of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2], excluding the one given as primary.)
Tls bool: When enabled, data is encrypted in transit. TLS is enabled by default for newly created databases and cannot be disabled.

DatabaseName string: Name of the database
Region string: Region of the database. For global gcp regions, use gcp-global. For globals, check for primary_region and read_regions fields
AutoScale bool: Upgrade to higher plans automatically when it hits quotas
Budget int: Budget for the database (default $20). It is used to limit the cost of the database. If the budget is reached, the database will be throttled until the next month.
Consistent bool: When enabled, all writes are synchronously persisted to the disk.
Deprecated: Consistent option is deprecated.
Eviction bool: Enable eviction, to evict keys when your database reaches the max size
IpAllowlists []string: Ip CIDR allowlist for the database. If not set, all IPs are allowed to connect to the database.
Multizone bool: When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)
Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.
PrimaryRegion string: Primary region for the database (Only works if region='global'. Can be one of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2])
ProdPack bool: Whether Prod Pack is enabled for the database.
ReadRegions []string: Read regions for the database (Only works if region='global' and primary_region is set. Can be any combination of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2], excluding the one given as primary.)
Tls bool: When enabled, data is encrypted in transit. TLS is enabled by default for newly created databases and cannot be disabled.

databaseName String: Name of the database
region String: Region of the database. For global gcp regions, use gcp-global. For globals, check for primary_region and read_regions fields
autoScale Boolean: Upgrade to higher plans automatically when it hits quotas
budget Integer: Budget for the database (default $20). It is used to limit the cost of the database. If the budget is reached, the database will be throttled until the next month.
consistent Boolean: When enabled, all writes are synchronously persisted to the disk.
Deprecated: Consistent option is deprecated.
eviction Boolean: Enable eviction, to evict keys when your database reaches the max size
ipAllowlists List<String>: Ip CIDR allowlist for the database. If not set, all IPs are allowed to connect to the database.
multizone Boolean: When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)
Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.
primaryRegion String: Primary region for the database (Only works if region='global'. Can be one of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2])
prodPack Boolean: Whether Prod Pack is enabled for the database.
readRegions List<String>: Read regions for the database (Only works if region='global' and primary_region is set. Can be any combination of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2], excluding the one given as primary.)
tls Boolean: When enabled, data is encrypted in transit. TLS is enabled by default for newly created databases and cannot be disabled.

databaseName string: Name of the database
region string: Region of the database. For global gcp regions, use gcp-global. For globals, check for primary_region and read_regions fields
autoScale boolean: Upgrade to higher plans automatically when it hits quotas
budget number: Budget for the database (default $20). It is used to limit the cost of the database. If the budget is reached, the database will be throttled until the next month.
consistent boolean: When enabled, all writes are synchronously persisted to the disk.
Deprecated: Consistent option is deprecated.
eviction boolean: Enable eviction, to evict keys when your database reaches the max size
ipAllowlists string[]: Ip CIDR allowlist for the database. If not set, all IPs are allowed to connect to the database.
multizone boolean: When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)
Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.
primaryRegion string: Primary region for the database (Only works if region='global'. Can be one of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2])
prodPack boolean: Whether Prod Pack is enabled for the database.
readRegions string[]: Read regions for the database (Only works if region='global' and primary_region is set. Can be any combination of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2], excluding the one given as primary.)
tls boolean: When enabled, data is encrypted in transit. TLS is enabled by default for newly created databases and cannot be disabled.

database_name str: Name of the database
region str: Region of the database. For global gcp regions, use gcp-global. For globals, check for primary_region and read_regions fields
auto_scale bool: Upgrade to higher plans automatically when it hits quotas
budget int: Budget for the database (default $20). It is used to limit the cost of the database. If the budget is reached, the database will be throttled until the next month.
consistent bool: When enabled, all writes are synchronously persisted to the disk.
Deprecated: Consistent option is deprecated.
eviction bool: Enable eviction, to evict keys when your database reaches the max size
ip_allowlists Sequence[str]: Ip CIDR allowlist for the database. If not set, all IPs are allowed to connect to the database.
multizone bool: When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)
Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.
primary_region str: Primary region for the database (Only works if region='global'. Can be one of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2])
prod_pack bool: Whether Prod Pack is enabled for the database.
read_regions Sequence[str]: Read regions for the database (Only works if region='global' and primary_region is set. Can be any combination of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2], excluding the one given as primary.)
tls bool: When enabled, data is encrypted in transit. TLS is enabled by default for newly created databases and cannot be disabled.

databaseName String: Name of the database
region String: Region of the database. For global gcp regions, use gcp-global. For globals, check for primary_region and read_regions fields
autoScale Boolean: Upgrade to higher plans automatically when it hits quotas
budget Number: Budget for the database (default $20). It is used to limit the cost of the database. If the budget is reached, the database will be throttled until the next month.
consistent Boolean: When enabled, all writes are synchronously persisted to the disk.
Deprecated: Consistent option is deprecated.
eviction Boolean: Enable eviction, to evict keys when your database reaches the max size
ipAllowlists List<String>: Ip CIDR allowlist for the database. If not set, all IPs are allowed to connect to the database.
multizone Boolean: When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)
Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.
primaryRegion String: Primary region for the database (Only works if region='global'. Can be one of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2])
prodPack Boolean: Whether Prod Pack is enabled for the database.
readRegions List<String>: Read regions for the database (Only works if region='global' and primary_region is set. Can be any combination of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2], excluding the one given as primary.)
tls Boolean: When enabled, data is encrypted in transit. TLS is enabled by default for newly created databases and cannot be disabled.

Outputs

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

CreationTime int: Creation time of the database
DatabaseId string: Unique Database ID for created database
DatabaseType string: Type of the database
DbDailyBandwidthLimit int: Daily bandwidth limit for the database
DbDiskThreshold int: Disk threshold for the database
DbMaxClients int: Max clients for the database
DbMaxCommandsPerSecond int: Max commands per second for the database
DbMaxEntrySize int: Max entry size for the database
DbMaxRequestSize int: Max request size for the database
DbMemoryThreshold int: Memory threshold for the database
Endpoint string: Database URL for connection
Id string: The provider-assigned unique ID for this managed resource.
Password string: Password of the database
Port int: Port of the endpoint
ReadOnlyRestToken string: Rest Token for the database.
RestToken string: Rest Token for the database.
State string: State of the database
UserEmail string: User email for the database

CreationTime int: Creation time of the database
DatabaseId string: Unique Database ID for created database
DatabaseType string: Type of the database
DbDailyBandwidthLimit int: Daily bandwidth limit for the database
DbDiskThreshold int: Disk threshold for the database
DbMaxClients int: Max clients for the database
DbMaxCommandsPerSecond int: Max commands per second for the database
DbMaxEntrySize int: Max entry size for the database
DbMaxRequestSize int: Max request size for the database
DbMemoryThreshold int: Memory threshold for the database
Endpoint string: Database URL for connection
Id string: The provider-assigned unique ID for this managed resource.
Password string: Password of the database
Port int: Port of the endpoint
ReadOnlyRestToken string: Rest Token for the database.
RestToken string: Rest Token for the database.
State string: State of the database
UserEmail string: User email for the database

creationTime Integer: Creation time of the database
databaseId String: Unique Database ID for created database
databaseType String: Type of the database
dbDailyBandwidthLimit Integer: Daily bandwidth limit for the database
dbDiskThreshold Integer: Disk threshold for the database
dbMaxClients Integer: Max clients for the database
dbMaxCommandsPerSecond Integer: Max commands per second for the database
dbMaxEntrySize Integer: Max entry size for the database
dbMaxRequestSize Integer: Max request size for the database
dbMemoryThreshold Integer: Memory threshold for the database
endpoint String: Database URL for connection
id String: The provider-assigned unique ID for this managed resource.
password String: Password of the database
port Integer: Port of the endpoint
readOnlyRestToken String: Rest Token for the database.
restToken String: Rest Token for the database.
state String: State of the database
userEmail String: User email for the database

creationTime number: Creation time of the database
databaseId string: Unique Database ID for created database
databaseType string: Type of the database
dbDailyBandwidthLimit number: Daily bandwidth limit for the database
dbDiskThreshold number: Disk threshold for the database
dbMaxClients number: Max clients for the database
dbMaxCommandsPerSecond number: Max commands per second for the database
dbMaxEntrySize number: Max entry size for the database
dbMaxRequestSize number: Max request size for the database
dbMemoryThreshold number: Memory threshold for the database
endpoint string: Database URL for connection
id string: The provider-assigned unique ID for this managed resource.
password string: Password of the database
port number: Port of the endpoint
readOnlyRestToken string: Rest Token for the database.
restToken string: Rest Token for the database.
state string: State of the database
userEmail string: User email for the database

creation_time int: Creation time of the database
database_id str: Unique Database ID for created database
database_type str: Type of the database
db_daily_bandwidth_limit int: Daily bandwidth limit for the database
db_disk_threshold int: Disk threshold for the database
db_max_clients int: Max clients for the database
db_max_commands_per_second int: Max commands per second for the database
db_max_entry_size int: Max entry size for the database
db_max_request_size int: Max request size for the database
db_memory_threshold int: Memory threshold for the database
endpoint str: Database URL for connection
id str: The provider-assigned unique ID for this managed resource.
password str: Password of the database
port int: Port of the endpoint
read_only_rest_token str: Rest Token for the database.
rest_token str: Rest Token for the database.
state str: State of the database
user_email str: User email for the database

creationTime Number: Creation time of the database
databaseId String: Unique Database ID for created database
databaseType String: Type of the database
dbDailyBandwidthLimit Number: Daily bandwidth limit for the database
dbDiskThreshold Number: Disk threshold for the database
dbMaxClients Number: Max clients for the database
dbMaxCommandsPerSecond Number: Max commands per second for the database
dbMaxEntrySize Number: Max entry size for the database
dbMaxRequestSize Number: Max request size for the database
dbMemoryThreshold Number: Memory threshold for the database
endpoint String: Database URL for connection
id String: The provider-assigned unique ID for this managed resource.
password String: Password of the database
port Number: Port of the endpoint
readOnlyRestToken String: Rest Token for the database.
restToken String: Rest Token for the database.
state String: State of the database
userEmail String: User email for the database

Look up Existing RedisDatabase Resource

Get an existing RedisDatabase 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>, state?: RedisDatabaseState, opts?: CustomResourceOptions): RedisDatabase

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_scale: Optional[bool] = None,
        budget: Optional[int] = None,
        consistent: Optional[bool] = None,
        creation_time: Optional[int] = None,
        database_id: Optional[str] = None,
        database_name: Optional[str] = None,
        database_type: Optional[str] = None,
        db_daily_bandwidth_limit: Optional[int] = None,
        db_disk_threshold: Optional[int] = None,
        db_max_clients: Optional[int] = None,
        db_max_commands_per_second: Optional[int] = None,
        db_max_entry_size: Optional[int] = None,
        db_max_request_size: Optional[int] = None,
        db_memory_threshold: Optional[int] = None,
        endpoint: Optional[str] = None,
        eviction: Optional[bool] = None,
        ip_allowlists: Optional[Sequence[str]] = None,
        multizone: Optional[bool] = None,
        password: Optional[str] = None,
        port: Optional[int] = None,
        primary_region: Optional[str] = None,
        prod_pack: Optional[bool] = None,
        read_only_rest_token: Optional[str] = None,
        read_regions: Optional[Sequence[str]] = None,
        region: Optional[str] = None,
        rest_token: Optional[str] = None,
        state: Optional[str] = None,
        tls: Optional[bool] = None,
        user_email: Optional[str] = None) -> RedisDatabase

func GetRedisDatabase(ctx *Context, name string, id IDInput, state *RedisDatabaseState, opts ...ResourceOption) (*RedisDatabase, error)

public static RedisDatabase Get(string name, Input<string> id, RedisDatabaseState? state, CustomResourceOptions? opts = null)

public static RedisDatabase get(String name, Output<String> id, RedisDatabaseState state, CustomResourceOptions options)

resources:  _:    type: upstash:RedisDatabase    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutoScale bool: Upgrade to higher plans automatically when it hits quotas
Budget int: Budget for the database (default $20). It is used to limit the cost of the database. If the budget is reached, the database will be throttled until the next month.
Consistent bool: When enabled, all writes are synchronously persisted to the disk.
Deprecated: Consistent option is deprecated.
CreationTime int: Creation time of the database
DatabaseId string: Unique Database ID for created database
DatabaseName string: Name of the database
DatabaseType string: Type of the database
DbDailyBandwidthLimit int: Daily bandwidth limit for the database
DbDiskThreshold int: Disk threshold for the database
DbMaxClients int: Max clients for the database
DbMaxCommandsPerSecond int: Max commands per second for the database
DbMaxEntrySize int: Max entry size for the database
DbMaxRequestSize int: Max request size for the database
DbMemoryThreshold int: Memory threshold for the database
Endpoint string: Database URL for connection
Eviction bool: Enable eviction, to evict keys when your database reaches the max size
IpAllowlists List<string>: Ip CIDR allowlist for the database. If not set, all IPs are allowed to connect to the database.
Multizone bool: When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)
Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.
Password string: Password of the database
Port int: Port of the endpoint
PrimaryRegion string: Primary region for the database (Only works if region='global'. Can be one of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2])
ProdPack bool: Whether Prod Pack is enabled for the database.
ReadOnlyRestToken string: Rest Token for the database.
ReadRegions List<string>: Read regions for the database (Only works if region='global' and primary_region is set. Can be any combination of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2], excluding the one given as primary.)
Region string: Region of the database. For global gcp regions, use gcp-global. For globals, check for primary_region and read_regions fields
RestToken string: Rest Token for the database.
State string: State of the database
Tls bool: When enabled, data is encrypted in transit. TLS is enabled by default for newly created databases and cannot be disabled.
UserEmail string: User email for the database

AutoScale bool: Upgrade to higher plans automatically when it hits quotas
Budget int: Budget for the database (default $20). It is used to limit the cost of the database. If the budget is reached, the database will be throttled until the next month.
Consistent bool: When enabled, all writes are synchronously persisted to the disk.
Deprecated: Consistent option is deprecated.
CreationTime int: Creation time of the database
DatabaseId string: Unique Database ID for created database
DatabaseName string: Name of the database
DatabaseType string: Type of the database
DbDailyBandwidthLimit int: Daily bandwidth limit for the database
DbDiskThreshold int: Disk threshold for the database
DbMaxClients int: Max clients for the database
DbMaxCommandsPerSecond int: Max commands per second for the database
DbMaxEntrySize int: Max entry size for the database
DbMaxRequestSize int: Max request size for the database
DbMemoryThreshold int: Memory threshold for the database
Endpoint string: Database URL for connection
Eviction bool: Enable eviction, to evict keys when your database reaches the max size
IpAllowlists []string: Ip CIDR allowlist for the database. If not set, all IPs are allowed to connect to the database.
Multizone bool: When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)
Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.
Password string: Password of the database
Port int: Port of the endpoint
PrimaryRegion string: Primary region for the database (Only works if region='global'. Can be one of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2])
ProdPack bool: Whether Prod Pack is enabled for the database.
ReadOnlyRestToken string: Rest Token for the database.
ReadRegions []string: Read regions for the database (Only works if region='global' and primary_region is set. Can be any combination of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2], excluding the one given as primary.)
Region string: Region of the database. For global gcp regions, use gcp-global. For globals, check for primary_region and read_regions fields
RestToken string: Rest Token for the database.
State string: State of the database
Tls bool: When enabled, data is encrypted in transit. TLS is enabled by default for newly created databases and cannot be disabled.
UserEmail string: User email for the database

autoScale Boolean: Upgrade to higher plans automatically when it hits quotas
budget Integer: Budget for the database (default $20). It is used to limit the cost of the database. If the budget is reached, the database will be throttled until the next month.
consistent Boolean: When enabled, all writes are synchronously persisted to the disk.
Deprecated: Consistent option is deprecated.
creationTime Integer: Creation time of the database
databaseId String: Unique Database ID for created database
databaseName String: Name of the database
databaseType String: Type of the database
dbDailyBandwidthLimit Integer: Daily bandwidth limit for the database
dbDiskThreshold Integer: Disk threshold for the database
dbMaxClients Integer: Max clients for the database
dbMaxCommandsPerSecond Integer: Max commands per second for the database
dbMaxEntrySize Integer: Max entry size for the database
dbMaxRequestSize Integer: Max request size for the database
dbMemoryThreshold Integer: Memory threshold for the database
endpoint String: Database URL for connection
eviction Boolean: Enable eviction, to evict keys when your database reaches the max size
ipAllowlists List<String>: Ip CIDR allowlist for the database. If not set, all IPs are allowed to connect to the database.
multizone Boolean: When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)
Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.
password String: Password of the database
port Integer: Port of the endpoint
primaryRegion String: Primary region for the database (Only works if region='global'. Can be one of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2])
prodPack Boolean: Whether Prod Pack is enabled for the database.
readOnlyRestToken String: Rest Token for the database.
readRegions List<String>: Read regions for the database (Only works if region='global' and primary_region is set. Can be any combination of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2], excluding the one given as primary.)
region String: Region of the database. For global gcp regions, use gcp-global. For globals, check for primary_region and read_regions fields
restToken String: Rest Token for the database.
state String: State of the database
tls Boolean: When enabled, data is encrypted in transit. TLS is enabled by default for newly created databases and cannot be disabled.
userEmail String: User email for the database

autoScale boolean: Upgrade to higher plans automatically when it hits quotas
budget number: Budget for the database (default $20). It is used to limit the cost of the database. If the budget is reached, the database will be throttled until the next month.
consistent boolean: When enabled, all writes are synchronously persisted to the disk.
Deprecated: Consistent option is deprecated.
creationTime number: Creation time of the database
databaseId string: Unique Database ID for created database
databaseName string: Name of the database
databaseType string: Type of the database
dbDailyBandwidthLimit number: Daily bandwidth limit for the database
dbDiskThreshold number: Disk threshold for the database
dbMaxClients number: Max clients for the database
dbMaxCommandsPerSecond number: Max commands per second for the database
dbMaxEntrySize number: Max entry size for the database
dbMaxRequestSize number: Max request size for the database
dbMemoryThreshold number: Memory threshold for the database
endpoint string: Database URL for connection
eviction boolean: Enable eviction, to evict keys when your database reaches the max size
ipAllowlists string[]: Ip CIDR allowlist for the database. If not set, all IPs are allowed to connect to the database.
multizone boolean: When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)
Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.
password string: Password of the database
port number: Port of the endpoint
primaryRegion string: Primary region for the database (Only works if region='global'. Can be one of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2])
prodPack boolean: Whether Prod Pack is enabled for the database.
readOnlyRestToken string: Rest Token for the database.
readRegions string[]: Read regions for the database (Only works if region='global' and primary_region is set. Can be any combination of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2], excluding the one given as primary.)
region string: Region of the database. For global gcp regions, use gcp-global. For globals, check for primary_region and read_regions fields
restToken string: Rest Token for the database.
state string: State of the database
tls boolean: When enabled, data is encrypted in transit. TLS is enabled by default for newly created databases and cannot be disabled.
userEmail string: User email for the database

auto_scale bool: Upgrade to higher plans automatically when it hits quotas
budget int: Budget for the database (default $20). It is used to limit the cost of the database. If the budget is reached, the database will be throttled until the next month.
consistent bool: When enabled, all writes are synchronously persisted to the disk.
Deprecated: Consistent option is deprecated.
creation_time int: Creation time of the database
database_id str: Unique Database ID for created database
database_name str: Name of the database
database_type str: Type of the database
db_daily_bandwidth_limit int: Daily bandwidth limit for the database
db_disk_threshold int: Disk threshold for the database
db_max_clients int: Max clients for the database
db_max_commands_per_second int: Max commands per second for the database
db_max_entry_size int: Max entry size for the database
db_max_request_size int: Max request size for the database
db_memory_threshold int: Memory threshold for the database
endpoint str: Database URL for connection
eviction bool: Enable eviction, to evict keys when your database reaches the max size
ip_allowlists Sequence[str]: Ip CIDR allowlist for the database. If not set, all IPs are allowed to connect to the database.
multizone bool: When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)
Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.
password str: Password of the database
port int: Port of the endpoint
primary_region str: Primary region for the database (Only works if region='global'. Can be one of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2])
prod_pack bool: Whether Prod Pack is enabled for the database.
read_only_rest_token str: Rest Token for the database.
read_regions Sequence[str]: Read regions for the database (Only works if region='global' and primary_region is set. Can be any combination of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2], excluding the one given as primary.)
region str: Region of the database. For global gcp regions, use gcp-global. For globals, check for primary_region and read_regions fields
rest_token str: Rest Token for the database.
state str: State of the database
tls bool: When enabled, data is encrypted in transit. TLS is enabled by default for newly created databases and cannot be disabled.
user_email str: User email for the database

autoScale Boolean: Upgrade to higher plans automatically when it hits quotas
budget Number: Budget for the database (default $20). It is used to limit the cost of the database. If the budget is reached, the database will be throttled until the next month.
consistent Boolean: When enabled, all writes are synchronously persisted to the disk.
Deprecated: Consistent option is deprecated.
creationTime Number: Creation time of the database
databaseId String: Unique Database ID for created database
databaseName String: Name of the database
databaseType String: Type of the database
dbDailyBandwidthLimit Number: Daily bandwidth limit for the database
dbDiskThreshold Number: Disk threshold for the database
dbMaxClients Number: Max clients for the database
dbMaxCommandsPerSecond Number: Max commands per second for the database
dbMaxEntrySize Number: Max entry size for the database
dbMaxRequestSize Number: Max request size for the database
dbMemoryThreshold Number: Memory threshold for the database
endpoint String: Database URL for connection
eviction Boolean: Enable eviction, to evict keys when your database reaches the max size
ipAllowlists List<String>: Ip CIDR allowlist for the database. If not set, all IPs are allowed to connect to the database.
multizone Boolean: When enabled, database becomes highly available and is deployed in multiple zones. (If changed to false from true, results in deletion and recreation of the resource)
Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.
password String: Password of the database
port Number: Port of the endpoint
primaryRegion String: Primary region for the database (Only works if region='global'. Can be one of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2])
prodPack Boolean: Whether Prod Pack is enabled for the database.
readOnlyRestToken String: Rest Token for the database.
readRegions List<String>: Read regions for the database (Only works if region='global' and primary_region is set. Can be any combination of [us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, sa-east-1, ap-southeast-1, ap-southeast-2], excluding the one given as primary.)
region String: Region of the database. For global gcp regions, use gcp-global. For globals, check for primary_region and read_regions fields
restToken String: Rest Token for the database.
state String: State of the database
tls Boolean: When enabled, data is encrypted in transit. TLS is enabled by default for newly created databases and cannot be disabled.
userEmail String: User email for the database

Package Details

Repository: upstash upstash/pulumi-upstash
License: Apache-2.0
Notes: This Pulumi package is based on the upstash Terraform Provider.

Upstash v0.5.0 published on Wednesday, Aug 27, 2025 by Upstash

upstash/pulumi-upstash

upstash.RedisDatabase

On this page

On this page

Create RedisDatabase Resource

Constructor syntax

Parameters

Constructor example

RedisDatabase Resource Properties

Inputs

Outputs

Look up Existing RedisDatabase Resource

Package Details

On this page

On this page