Interface IEngine

A common interface for database engines.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IEngine

Syntax (vb)

Public Interface IEngine

Remarks

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

Synopsis

Properties

DefaultUsername	The default name of the master database user if one was not provided explicitly.
EngineFamily	The family this engine belongs to, like "MYSQL", or "POSTGRESQL".
EngineType	The type of the engine, for example "mysql".
EngineVersion	The exact version of the engine that is used, for example "5.1.42".
ParameterGroupFamily	The family to use for ParameterGroups using this engine.

Properties

DefaultUsername

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

string? DefaultUsername { get; }

Property Value

string

Remarks

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

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

string? EngineFamily { get; }

Property Value

string

Remarks

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: - the engine doesn't belong to any family

EngineType

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

string EngineType { get; }

Property Value

string

Remarks

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

EngineVersion

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

IEngineVersion? EngineVersion { get; }

Property Value

IEngineVersion

Remarks

Default: - use the default version for this engine type

ParameterGroupFamily

The family to use for ParameterGroups using this engine.

string? ParameterGroupFamily { get; }

Property Value

string

Remarks

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: - the ParameterGroup family is not known (which means the major version of the engine is also not known)