aws-cdk-lib.aws_rds.IEngine

interface IEngine

LanguageType name
.NETAmazon.CDK.AWS.RDS.IEngine
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#IEngine
Javasoftware.amazon.awscdk.services.rds.IEngine
Pythonaws_cdk.aws_rds.IEngine
TypeScript (source)aws-cdk-lib » aws_rds » IEngine

A common interface for database engines.

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

Properties

NameTypeDescription
engineTypestringThe type of the engine, for example "mysql".
defaultUsername?stringThe default name of the master database user if one was not provided explicitly.
engineFamily?stringThe family this engine belongs to, like "MYSQL", or "POSTGRESQL".
engineVersion?EngineVersionThe exact version of the engine that is used, for example "5.1.42".
parameterGroupFamily?stringThe family to use for ParameterGroups using this engine.

engineType

Type: string

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


defaultUsername?

Type: string (optional)

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.


engineFamily?

Type: string (optional, default: the engine doesn't belong to any family)

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


engineVersion?

Type: EngineVersion (optional, default: use the default version for this engine type)

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


parameterGroupFamily?

Type: string (optional, default: the ParameterGroup family is not known (which means the major version of the engine is also not known))

The family to use for ParameterGroups using this engine.

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