Skip to main content
Version: v0.9

database

Schema Database

As an important supporting accessory, Database describes the attributes
to locally deploy or create a cloud provider managed database instance for
the workload.

Attributes

Name and DescriptionTypeDefault ValueRequired
type
Type defines the local deployment mode or the specific cloud vendor that
provides the relational database service (rds).
strUndefinedrequired
engine
Engine defines the database engine to use.
strUndefinedrequired
version
Version defines the database engine version to use.
strUndefinedrequired
instanceType
InstanceType defines the type of the database which is required when
creating an rds instance provided by the cloud vendor.
strUndefinedoptional
size
Size defines the allocated storage size of the rds instance provided by
the cloud vendor in GB.
int10optional
category
Category defines the edition of the rds instance provided by the cloud
vendor.
str"Basic"optional
username
Username defines the operation account for the database.
str"root"optional
securityIPs
SecurityIPs defines the list of IP addresses allowed to access the rds
instance provided by the cloud vendor.
[str]["0.0.0.0/0"]optional
subnetID
SubnetID defines the virtual subnet ID associated with the VPC that the rds
instance will be created in.
strUndefinedoptional
privateLink
PrivateLink defines whether the host address of the rds instance for the workload
to connect with is via public network or private network of the cloud vendor.
boolTrueoptional
extraMap
ExtraMap defines the diversified rds configuration items from different
cloud vendors.
{str: str}Undefinedoptional

Examples

Instantiate an aws rds with mysql 5.7. 

import catalog.models.schema.v1.accessories.database as db

database: db.Database {
type: "aws"
engine: "mysql"
version: "5.7"
instanceType: "db.t3.micro"
}