aws-cdk-lib.aws_rds.DatabaseInstanceEngine

class DatabaseInstanceEngine

LanguageType name
.NETAmazon.CDK.AWS.RDS.DatabaseInstanceEngine
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#DatabaseInstanceEngine
Javasoftware.amazon.awscdk.services.rds.DatabaseInstanceEngine
Pythonaws_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.IVpc;

const instance1 = new rds.DatabaseInstance(this, "PostgresInstance1", {
  engine: rds.DatabaseInstanceEngine.POSTGRES,
  // Generate the secret with admin username `postgres` and random password
  credentials: rds.Credentials.fromGeneratedSecret('postgres'),
  vpc
});
// Templated secret with username and password fields
const templatedSecret = new secretsmanager.Secret(this, 'TemplatedSecret', {
  generateSecretString: {
    secretStringTemplate: JSON.stringify({ username: 'postgres' }),
    generateStringKey: 'password',
    excludeCharacters: '/@"',
  },
});
// Using the templated secret as credentials
const instance2 = new rds.DatabaseInstance(this, "PostgresInstance2", {
  engine: rds.DatabaseInstanceEngine.POSTGRES,
  credentials: {
    username: templatedSecret.secretValueFromJson('username').toString(),
    password: templatedSecret.secretValueFromJson('password')
  },
  vpc
});

Initializer

new DatabaseInstanceEngine()

Properties

NameTypeDescription
static MARIADBIInstanceEngineThe unversioned 'mariadb' instance engine.
static MYSQLIInstanceEngineThe unversioned 'mysql' instance engine.
static ORACLE_EEIInstanceEngineThe unversioned 'oracle-ee' instance engine.
static ORACLE_EE_CDBIInstanceEngineThe unversioned 'oracle-ee-cdb' instance engine.
static ORACLE_SE2IInstanceEngineThe unversioned 'oracle-se2' instance engine.
static ORACLE_SE2_CDBIInstanceEngineThe unversioned 'oracle-se2-cdb' instance engine.
static POSTGRESIInstanceEngineThe unversioned 'postgres' instance engine.
static SQL_SERVER_EEIInstanceEngineThe unversioned 'sqlserver-ee' instance engine.
static SQL_SERVER_EXIInstanceEngineThe unversioned 'sqlserver-ex' instance engine.
static SQL_SERVER_SEIInstanceEngineThe unversioned 'sqlserver-se' instance engine.
static SQL_SERVER_WEBIInstanceEngineThe 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

NameDescription
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.