class DatabaseInstanceEngine

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

A database instance engine.

Provides mapping to DatabaseEngine used for secret rotation.

Example

declare const vpc: ec2.Vpc;

const iopsInstance = new rds.DatabaseInstance(this, 'IopsInstance', {
  engine: rds.DatabaseInstanceEngine.mysql({ version: rds.MysqlEngineVersion.VER_8_0_39 }),
  vpc,
  storageType: rds.StorageType.IO1,
  iops: 5000,
});

const gp3Instance = new rds.DatabaseInstance(this, 'Gp3Instance', {
  engine: rds.DatabaseInstanceEngine.mysql({ version: rds.MysqlEngineVersion.VER_8_0_39 }),
  vpc,
  allocatedStorage: 500,
  storageType: rds.StorageType.GP3,
  storageThroughput: 500, // only applicable for GP3
});

Initializer

new DatabaseInstanceEngine()

Properties

Name	Type	Description
static MARIADB	`IInstanceEngine`	The unversioned 'mariadb' instance engine.
static MYSQL	`IInstanceEngine`	The unversioned 'mysql' instance engine.
static ORACLE_EE	`IInstanceEngine`	The unversioned 'oracle-ee' instance engine.
static ORACLE_EE_CDB	`IInstanceEngine`	The unversioned 'oracle-ee-cdb' instance engine.
static ORACLE_SE2	`IInstanceEngine`	The unversioned 'oracle-se2' instance engine.
static ORACLE_SE2_CDB	`IInstanceEngine`	The unversioned 'oracle-se2-cdb' instance engine.
static POSTGRES	`IInstanceEngine`	The unversioned 'postgres' instance engine.
static SQL_SERVER_EE	`IInstanceEngine`	The unversioned 'sqlserver-ee' instance engine.
static SQL_SERVER_EX	`IInstanceEngine`	The unversioned 'sqlserver-ex' instance engine.
static SQL_SERVER_SE	`IInstanceEngine`	The unversioned 'sqlserver-se' instance engine.
static SQL_SERVER_WEB	`IInstanceEngine`	The unversioned 'sqlserver-web' instance engine.

static MARIADB

Type: IInstanceEngine

The unversioned 'mariadb' instance engine.

NOTE: using unversioned engines is an availability risk. We recommend using versioned engines created using the mariaDb() method

static MYSQL

Type: IInstanceEngine

The unversioned 'mysql' instance engine.

NOTE: using unversioned engines is an availability risk. We recommend using versioned engines created using the mysql() method

static ORACLE_EE

Type: IInstanceEngine

The unversioned 'oracle-ee' instance engine.

NOTE: using unversioned engines is an availability risk. We recommend using versioned engines created using the oracleEe() method

static ORACLE_EE_CDB

Type: IInstanceEngine

The unversioned 'oracle-ee-cdb' instance engine.

NOTE: using unversioned engines is an availability risk. We recommend using versioned engines created using the oracleEeCdb() method

static ORACLE_SE2

Type: IInstanceEngine

The unversioned 'oracle-se2' instance engine.

NOTE: using unversioned engines is an availability risk. We recommend using versioned engines created using the oracleSe2() method

static ORACLE_SE2_CDB

Type: IInstanceEngine

The unversioned 'oracle-se2-cdb' instance engine.

NOTE: using unversioned engines is an availability risk. We recommend using versioned engines created using the oracleSe2Cdb() method

static POSTGRES

Type: IInstanceEngine

The unversioned 'postgres' instance engine.

NOTE: using unversioned engines is an availability risk. We recommend using versioned engines created using the postgres() method

static SQL_SERVER_EE

Type: IInstanceEngine

The unversioned 'sqlserver-ee' instance engine.

NOTE: using unversioned engines is an availability risk. We recommend using versioned engines created using the sqlServerEe() method

static SQL_SERVER_EX

Type: IInstanceEngine

The unversioned 'sqlserver-ex' instance engine.

NOTE: using unversioned engines is an availability risk. We recommend using versioned engines created using the sqlServerEx() method

static SQL_SERVER_SE

Type: IInstanceEngine

The unversioned 'sqlserver-se' instance engine.

NOTE: using unversioned engines is an availability risk. We recommend using versioned engines created using the sqlServerSe() method

static SQL_SERVER_WEB

Type: IInstanceEngine

The unversioned 'sqlserver-web' instance engine.

NOTE: using unversioned engines is an availability risk. We recommend using versioned engines created using the sqlServerWeb() method

Methods

Name	Description
static mariaDb(props)	Creates a new MariaDB instance engine.
static mysql(props)	Creates a new MySQL instance engine.
static oracleEe(props)	Creates a new Oracle Enterprise Edition instance engine.
static oracleEeCdb(props)	Creates a new Oracle Enterprise Edition (CDB) instance engine.
static oracleSe2(props)	Creates a new Oracle Standard Edition 2 instance engine.
static oracleSe2Cdb(props)	Creates a new Oracle Standard Edition 2 (CDB) instance engine.
static postgres(props)	Creates a new PostgreSQL instance engine.
static sqlServerEe(props)	Creates a new SQL Server Enterprise Edition instance engine.
static sqlServerEx(props)	Creates a new SQL Server Express Edition instance engine.
static sqlServerSe(props)	Creates a new SQL Server Standard Edition instance engine.
static sqlServerWeb(props)	Creates a new SQL Server Web Edition instance engine.

static mariaDb(props)

public static mariaDb(props: MariaDbInstanceEngineProps): IInstanceEngine

Parameters

props MariaDbInstanceEngineProps

Returns

IInstanceEngine

Creates a new MariaDB instance engine.

static mysql(props)

public static mysql(props: MySqlInstanceEngineProps): IInstanceEngine

Parameters

props MySqlInstanceEngineProps

Returns

IInstanceEngine

Creates a new MySQL instance engine.

static oracleEe(props)

public static oracleEe(props: OracleEeInstanceEngineProps): IInstanceEngine

Parameters

props OracleEeInstanceEngineProps

Returns

IInstanceEngine

Creates a new Oracle Enterprise Edition instance engine.

static oracleEeCdb(props)

public static oracleEeCdb(props: OracleEeCdbInstanceEngineProps): IInstanceEngine

Parameters

props OracleEeCdbInstanceEngineProps

Returns

IInstanceEngine

Creates a new Oracle Enterprise Edition (CDB) instance engine.

static oracleSe2(props)

public static oracleSe2(props: OracleSe2InstanceEngineProps): IInstanceEngine

Parameters

props OracleSe2InstanceEngineProps

Returns

IInstanceEngine

Creates a new Oracle Standard Edition 2 instance engine.

static oracleSe2Cdb(props)

public static oracleSe2Cdb(props: OracleSe2CdbInstanceEngineProps): IInstanceEngine

Parameters

props OracleSe2CdbInstanceEngineProps

Returns

IInstanceEngine

Creates a new Oracle Standard Edition 2 (CDB) instance engine.

static postgres(props)

public static postgres(props: PostgresInstanceEngineProps): IInstanceEngine

Parameters

props PostgresInstanceEngineProps

Returns

IInstanceEngine

Creates a new PostgreSQL instance engine.

static sqlServerEe(props)

public static sqlServerEe(props: SqlServerEeInstanceEngineProps): IInstanceEngine

Parameters

props SqlServerEeInstanceEngineProps

Returns

IInstanceEngine

Creates a new SQL Server Enterprise Edition instance engine.

static sqlServerEx(props)

public static sqlServerEx(props: SqlServerExInstanceEngineProps): IInstanceEngine

Parameters

props SqlServerExInstanceEngineProps

Returns

IInstanceEngine

Creates a new SQL Server Express Edition instance engine.

static sqlServerSe(props)

public static sqlServerSe(props: SqlServerSeInstanceEngineProps): IInstanceEngine

Parameters

props SqlServerSeInstanceEngineProps

Returns

IInstanceEngine

Creates a new SQL Server Standard Edition instance engine.

static sqlServerWeb(props)

public static sqlServerWeb(props: SqlServerWebInstanceEngineProps): IInstanceEngine

Parameters

props SqlServerWebInstanceEngineProps

Returns

IInstanceEngine

Creates a new SQL Server Web Edition instance engine.