aws-cdk-lib.aws_rds.IInstanceEngine

interface IInstanceEngine

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

Obtainable from DatabaseInstanceEngine.mariaDb(), DatabaseInstanceEngine.mysql(), DatabaseInstanceEngine.oracleEe(), DatabaseInstanceEngine.oracleEeCdb(), DatabaseInstanceEngine.oracleSe2(), DatabaseInstanceEngine.oracleSe2Cdb(), DatabaseInstanceEngine.postgres(), DatabaseInstanceEngine.sqlServerEe(), DatabaseInstanceEngine.sqlServerEx(), DatabaseInstanceEngine.sqlServerSe(), DatabaseInstanceEngine.sqlServerWeb()

Interface representing a database instance (as opposed to cluster) engine.

Properties

NameTypeDescription
engineTypestringThe type of the engine, for example "mysql".
multiUserRotationApplicationSecretRotationApplicationThe application used by this engine to perform rotation for a multi-user scenario.
singleUserRotationApplicationSecretRotationApplicationThe application used by this engine to perform rotation for a single-user scenario.
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.
supportsReadReplicaBackups?booleanWhether this engine supports automatic backups of a read replica instance.

engineType

Type: string

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


multiUserRotationApplication

Type: SecretRotationApplication

The application used by this engine to perform rotation for a multi-user scenario.


singleUserRotationApplication

Type: SecretRotationApplication

The application used by this engine to perform rotation for a single-user scenario.


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.


supportsReadReplicaBackups?

Type: boolean (optional, default: false)

Whether this engine supports automatic backups of a read replica instance.

Methods

NameDescription
bindToInstance(scope, options)Method called when the engine is used to create a new instance.

bindToInstance(scope, options)

public bindToInstance(scope: Construct, options: InstanceEngineBindOptions): InstanceEngineConfig

Parameters

  • scope Construct
  • options InstanceEngineBindOptions

Returns

  • InstanceEngineConfig

Method called when the engine is used to create a new instance.