Skip to main content

Schema

Required

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

Optional

bool
Upgrade to higher plans automatically when it hits quotas
bool
Enable eviction, to evict keys when your database reaches the max size
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])
set(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.)
bool
When enabled, data is encrypted in transit. (If changed to false from true, results in deletion and recreation of the resource)

Read-Only

number
Creation time of the database
string
Unique Database ID for created database
string
Type of the database
number
Daily bandwidth limit for the database
number
Disk threshold for the database
number
Max clients for the database
number
Max commands per second for the database
number
Max entry size for the database
number
Max request size for the database
number
Memory threshold for the database
string
Database URL for connection
string
The ID of this resource.
string
Password of the database
number
Port of the endpoint
string
Rest Token for the database.
string
Rest Token for the database.
string
State of the database
string
User email for the database