aws-cdk-lib.aws_rds.IEngine

IEngine Interface

A common interface for database engines.

Don't implement this interface directly, instead implement one of the known sub-interfaces, like IClusterEngine and IInstanceEngine.

Source

aws-rds/lib/engine.ts

Properties

defaultUsernamestringdefault_usernamestrdefaultUsernameStringDefaultUsernamestringDefaultUsername*string#

The default name of the master database user if one was not provided explicitly.

The global default of 'admin' will be used if this is undefined. Note that 'admin' is a reserved word in PostgreSQL and cannot be used.

engineFamilystringengine_familystrengineFamilyStringEngineFamilystringEngineFamily*string= the engine doesn't belong to any…#

The family this engine belongs to, like "MYSQL", or "POSTGRESQL".

This property is used when creating a Database Proxy. Most engines don't belong to any family (and because of that, you can't create Database Proxies for their Clusters or Instances).

default

Default: the engine doesn't belong to any family

engineTypestringengine_typestrengineTypeStringEngineTypestringEngineType*stringrequired#

The type of the engine, for example "mysql".

engineVersionEngineVersionengine_versionEngineVersionengineVersionEngineVersionEngineVersionEngineVersionEngineVersionEngineVersion= use the default version for this…#

The exact version of the engine that is used, for example "5.1.42".

default

Default: use the default version for this engine type

parameterGroupFamilystringparameter_group_familystrparameterGroupFamilyStringParameterGroupFamilystringParameterGroupFamily*string= the ParameterGroup family is not…#

The family to use for ParameterGroups using this engine.

This is usually equal to "<engineType><engineMajorVersion>", but can sometimes be a variation of that. You can pass this property when creating new ParameterGroup.

default

Default: the ParameterGroup family is not known (which means the major version of the engine is also not known)