Upstash Documentation

upstash_redis_database_data

2 min read

Schema#

Required#

database_idstringrequired#

Unique Database ID for created database

Read-Only#

auto_scalebool#

Upgrade to higher plans automatically when it hits quotas

creation_timenumber#

Creation time of the database

database_namestring#

Name of the database

database_typestring#

Type of the database

db_daily_bandwidth_limitnumber#

Daily bandwidth limit for the database

db_disk_thresholdnumber#

Disk threshold for the database

db_max_clientsnumber#

Max clients for the database

db_max_commands_per_secondnumber#

Max commands per second for the database

db_max_entry_sizenumber#

Max entry size for the database

db_max_request_sizenumber#

Max request size for the database

db_memory_thresholdnumber#

Memory threshold for the database

endpointstring#

Database URL for connection

idstring#

The ID of this resource.

passwordstring#

Password of the database

portnumber#

Port of the endpoint

primary_regionstring#

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])

read_only_rest_tokenstring#

Rest Token for the database.

read_regionsset(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.)

regionstring#

Region of the database. Possible values are: global, eu-west-1, us-east-1, us-west-1, ap-northeast-1 , eu-central1

rest_tokenstring#

Rest Token for the database.

statestring#

State of the database

tlsbool#

When enabled, data is encrypted in transit. (If changed to false from true, results in deletion and recreation of the resource)

user_emailstring#

User email for the database