interface IClusterEngine

Language	Type name
.NET	Amazon.CDK.AWS.RDS.IClusterEngine
Java	software.amazon.awscdk.services.rds.IClusterEngine
Python	aws_cdk.aws_rds.IClusterEngine
TypeScript (source)	@aws-cdk/aws-rds » IClusterEngine

Obtainable from DatabaseClusterEngine.aurora(), DatabaseClusterEngine.auroraMysql(), DatabaseClusterEngine.auroraPostgres()

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

Properties

Name	Type	Description
engineType	string	The type of the engine, for example "mysql".
multiUserRotationApplication	SecretRotationApplication	The application used by this engine to perform rotation for a multi-user scenario.
singleUserRotationApplication	SecretRotationApplication	The application used by this engine to perform rotation for a single-user scenario.
supportedLogTypes	string[]	The log types that are available with this engine type.
combineImportAndExportRoles?	boolean	Whether the IAM Roles used for data importing and exporting need to be combined for this Engine, or can they be kept separate.
defaultUsername?	string	The default name of the master database user if one was not provided explicitly.
engineFamily?	string	The family this engine belongs to, like "MYSQL", or "POSTGRESQL".
engineVersion?	EngineVersion	The exact version of the engine that is used, for example "5.1.42".
parameterGroupFamily?	string	The family to use for ParameterGroups using this engine.

---

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.

---

supportedLogTypes

Type: string[]

The log types that are available with this engine type.

---

combineImportAndExportRoles?

Type: boolean (optional, default: false)

Whether the IAM Roles used for data importing and exporting need to be combined for this Engine, or can they be kept separate.

---

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.

Methods

Name	Description
bindToCluster(scope, options)	Method called when the engine is used to create a new cluster.

---

bindToCluster(scope, options)

public bindToCluster(scope: Construct, options: ClusterEngineBindOptions): ClusterEngineConfig

Parameters

• scope Construct
• options ClusterEngineBindOptions

Returns

• ClusterEngineConfig

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