class DatabaseInstanceEngine

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

A database instance engine.

Provides mapping to DatabaseEngine used for secret rotation.

Example

declare const vpc: ec2.Vpc;
new rds.DatabaseInstanceFromSnapshot(this, 'Instance', {
  snapshotIdentifier: 'my-snapshot',
  engine: rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 }),
  // optional, defaults to m5.large
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),
  vpc,
});

declare const sourceInstance: rds.DatabaseInstance;
new rds.DatabaseInstanceReadReplica(this, 'ReadReplica', {
  sourceDatabaseInstance: sourceInstance,
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),
  vpc,
});

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_SE⚠️	IInstanceEngine	The unversioned 'oracle-se' instance engine.
static ORACLE_SE1⚠️	IInstanceEngine	The unversioned 'oracle-se1' instance engine.
static ORACLE_SE2	IInstanceEngine	The unversioned 'oracle-se2' 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 {@link 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 {@link 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 {@link oracleEe()} method

---

static ORACLE_SE⚠️

⚠️ Deprecated: instances can no longer be created with this engine. See https://forums.aws.amazon.com/ann.jspa?annID=7341

Type: IInstanceEngine

The unversioned 'oracle-se' instance engine.

---

static ORACLE_SE1⚠️

⚠️ Deprecated: instances can no longer be created with this engine. See https://forums.aws.amazon.com/ann.jspa?annID=7341

Type: IInstanceEngine

The unversioned 'oracle-se1' instance engine.

---

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 {@link oracleSe2()} 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 {@link 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 {@link 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 {@link 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 {@link 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 {@link 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 oracleSe(props)⚠️	Creates a new Oracle Standard Edition instance engine.
static oracleSe1(props)⚠️	Creates a new Oracle Standard Edition 1 instance engine.
static oracleSe2(props)	Creates a new Oracle Standard Edition 1 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 oracleSe(props)⚠️

public static oracleSe(props: OracleSeInstanceEngineProps): IInstanceEngine

⚠️ Deprecated: instances can no longer be created with this engine. See https://forums.aws.amazon.com/ann.jspa?annID=7341

Parameters

• props OracleSeInstanceEngineProps

Returns

• IInstanceEngine

Creates a new Oracle Standard Edition instance engine.

---

static oracleSe1(props)⚠️

public static oracleSe1(props: OracleSe1InstanceEngineProps): IInstanceEngine

⚠️ Deprecated: instances can no longer be created with this engine. See https://forums.aws.amazon.com/ann.jspa?annID=7341

Parameters

• props OracleSe1InstanceEngineProps

Returns

• IInstanceEngine

Creates a new Oracle Standard Edition 1 instance engine.

---

static oracleSe2(props)

public static oracleSe2(props: OracleSe2InstanceEngineProps): IInstanceEngine

Parameters

• props OracleSe2InstanceEngineProps

Returns

• IInstanceEngine

Creates a new Oracle Standard Edition 1 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.