class DatabaseClusterEngine

Language	Type name
.NET	Amazon.CDK.AWS.RDS.DatabaseClusterEngine
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsrds#DatabaseClusterEngine
Java	software.amazon.awscdk.services.rds.DatabaseClusterEngine
Python	aws_cdk.aws_rds.DatabaseClusterEngine
TypeScript (source)	aws-cdk-lib » aws_rds » DatabaseClusterEngine

A database cluster engine.

Provides mapping to the serverless application used for secret rotation.

Example

declare const vpc: ec2.Vpc;
const cluster = new rds.DatabaseCluster(this, 'Database', {
  engine: rds.DatabaseClusterEngine.auroraMysql({
    version: rds.AuroraMysqlEngineVersion.VER_3_03_0,
  }),
  writer: rds.ClusterInstance.provisioned('writer'),
  vpc,
});

const proxy = new rds.DatabaseProxy(this, 'Proxy', {
  proxyTarget: rds.ProxyTarget.fromCluster(cluster),
  secrets: [cluster.secret!],
  vpc,
  clientPasswordAuthType: rds.ClientPasswordAuthType.MYSQL_NATIVE_PASSWORD,
});

Initializer

new DatabaseClusterEngine()

Properties

Name	Type	Description
static AURORA⚠️	IClusterEngine	The unversioned 'aurora' cluster engine.
static AURORA_MYSQL	IClusterEngine	The unversioned 'aurora-msql' cluster engine.
static AURORA_POSTGRESQL	IClusterEngine	The unversioned 'aurora-postgresql' cluster engine.

---

static AURORA⚠️

⚠️ Deprecated: use AURORA_MYSQL instead

Type: IClusterEngine

The unversioned 'aurora' cluster engine.

Note: we do not recommend using unversioned engines for non-serverless Clusters, as that can pose an availability risk. We recommend using versioned engines created using the aurora() method

---

static AURORA_MYSQL

Type: IClusterEngine

The unversioned 'aurora-msql' cluster engine.

Note: we do not recommend using unversioned engines for non-serverless Clusters, as that can pose an availability risk. We recommend using versioned engines created using the auroraMysql() method

---

static AURORA_POSTGRESQL

Type: IClusterEngine

The unversioned 'aurora-postgresql' cluster engine.

Note: we do not recommend using unversioned engines for non-serverless Clusters, as that can pose an availability risk. We recommend using versioned engines created using the auroraPostgres() method

Methods

Name	Description
static aurora(props)⚠️	Creates a new plain Aurora database cluster engine.
static auroraMysql(props)	Creates a new Aurora MySQL database cluster engine.
static auroraPostgres(props)	Creates a new Aurora PostgreSQL database cluster engine.

---

static aurora(props)⚠️

public static aurora(props: AuroraClusterEngineProps): IClusterEngine

⚠️ Deprecated: use auroraMysql() instead

Parameters

• props AuroraClusterEngineProps

Returns

• IClusterEngine

Creates a new plain Aurora database cluster engine.

---

static auroraMysql(props)

public static auroraMysql(props: AuroraMysqlClusterEngineProps): IClusterEngine

Parameters

• props AuroraMysqlClusterEngineProps

Returns

• IClusterEngine

Creates a new Aurora MySQL database cluster engine.

---

static auroraPostgres(props)

public static auroraPostgres(props: AuroraPostgresClusterEngineProps): IClusterEngine

Parameters

• props AuroraPostgresClusterEngineProps

Returns

• IClusterEngine

Creates a new Aurora PostgreSQL database cluster engine.