software.amazon.awscdk.services.rds

Class DatabaseInstanceEngine

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.rds.DatabaseInstanceEngine

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.455Z")
 @Stability(value=Stable)
public class DatabaseInstanceEngine
extends software.amazon.jsii.JsiiObject

A database instance engine.

Provides mapping to DatabaseEngine used for secret rotation.

Example:

 Vpc vpc;
 // Simple secret
 Secret secret = new Secret(this, "Secret");
 // Using the secret
 DatabaseInstance instance1 = DatabaseInstance.Builder.create(this, "PostgresInstance1")
         .engine(DatabaseInstanceEngine.POSTGRES)
         .credentials(Credentials.fromSecret(secret))
         .vpc(vpc)
         .build();
 // Templated secret with username and password fields
 Secret templatedSecret = Secret.Builder.create(this, "TemplatedSecret")
         .generateSecretString(SecretStringGenerator.builder()
                 .secretStringTemplate(JSON.stringify(Map.of("username", "postgres")))
                 .generateStringKey("password")
                 .build())
         .build();
 // Using the templated secret as credentials
 DatabaseInstance instance2 = DatabaseInstance.Builder.create(this, "PostgresInstance2")
         .engine(DatabaseInstanceEngine.POSTGRES)
         .credentials(Map.of(
                 "username", templatedSecret.secretValueFromJson("username").toString(),
                 "password", templatedSecret.secretValueFromJson("password")))
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	DatabaseInstanceEngine()
protected	DatabaseInstanceEngine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DatabaseInstanceEngine(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IInstanceEngine	mariaDb(MariaDbInstanceEngineProps props) Creates a new MariaDB instance engine.
static IInstanceEngine	mysql(MySqlInstanceEngineProps props) Creates a new MySQL instance engine.
static IInstanceEngine	oracleEe(OracleEeInstanceEngineProps props) Creates a new Oracle Enterprise Edition instance engine.
static IInstanceEngine	oracleEeCdb(OracleEeCdbInstanceEngineProps props) Creates a new Oracle Enterprise Edition (CDB) instance engine.
static IInstanceEngine	oracleSe2(OracleSe2InstanceEngineProps props) Creates a new Oracle Standard Edition 2 instance engine.
static IInstanceEngine	oracleSe2Cdb(OracleSe2CdbInstanceEngineProps props) Creates a new Oracle Standard Edition 2 (CDB) instance engine.
static IInstanceEngine	postgres(PostgresInstanceEngineProps props) Creates a new PostgreSQL instance engine.
static IInstanceEngine	sqlServerEe(SqlServerEeInstanceEngineProps props) Creates a new SQL Server Enterprise Edition instance engine.
static IInstanceEngine	sqlServerEx(SqlServerExInstanceEngineProps props) Creates a new SQL Server Express Edition instance engine.
static IInstanceEngine	sqlServerSe(SqlServerSeInstanceEngineProps props) Creates a new SQL Server Standard Edition instance engine.
static IInstanceEngine	sqlServerWeb(SqlServerWebInstanceEngineProps props) Creates a new SQL Server Web Edition instance engine.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

MARIADB

@Stability(value=Stable)
public static final IInstanceEngine MARIADB

The unversioned 'mariadb' instance engine.

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

MYSQL

@Stability(value=Stable)
public static final IInstanceEngine MYSQL

The unversioned 'mysql' instance engine.

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

ORACLE_EE

@Stability(value=Stable)
public static final IInstanceEngine ORACLE_EE

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

ORACLE_EE_CDB

@Stability(value=Stable)
public static final IInstanceEngine ORACLE_EE_CDB

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

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

ORACLE_SE2

@Stability(value=Stable)
public static final IInstanceEngine ORACLE_SE2

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

ORACLE_SE2_CDB

@Stability(value=Stable)
public static final IInstanceEngine ORACLE_SE2_CDB

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

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

POSTGRES

@Stability(value=Stable)
public static final IInstanceEngine POSTGRES

The unversioned 'postgres' instance engine.

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

SQL_SERVER_EE

@Stability(value=Stable)
public static final IInstanceEngine SQL_SERVER_EE

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

SQL_SERVER_EX

@Stability(value=Stable)
public static final IInstanceEngine SQL_SERVER_EX

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

SQL_SERVER_SE

@Stability(value=Stable)
public static final IInstanceEngine SQL_SERVER_SE

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

SQL_SERVER_WEB

@Stability(value=Stable)
public static final IInstanceEngine SQL_SERVER_WEB

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

Constructor Detail

DatabaseInstanceEngine

protected DatabaseInstanceEngine(software.amazon.jsii.JsiiObjectRef objRef)

DatabaseInstanceEngine

protected DatabaseInstanceEngine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

DatabaseInstanceEngine

@Stability(value=Stable)
public DatabaseInstanceEngine()

Method Detail

mariaDb

@Stability(value=Stable)
 @NotNull
public static IInstanceEngine mariaDb(@NotNull
                                                                         MariaDbInstanceEngineProps props)

Creates a new MariaDB instance engine.

Parameters:

props - This parameter is required.

mysql

@Stability(value=Stable)
 @NotNull
public static IInstanceEngine mysql(@NotNull
                                                                       MySqlInstanceEngineProps props)

Creates a new MySQL instance engine.

Parameters:

props - This parameter is required.

oracleEe

@Stability(value=Stable)
 @NotNull
public static IInstanceEngine oracleEe(@NotNull
                                                                          OracleEeInstanceEngineProps props)

Creates a new Oracle Enterprise Edition instance engine.

Parameters:

props - This parameter is required.

oracleEeCdb

@Stability(value=Stable)
 @NotNull
public static IInstanceEngine oracleEeCdb(@NotNull
                                                                             OracleEeCdbInstanceEngineProps props)

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

Parameters:

props - This parameter is required.

oracleSe2

@Stability(value=Stable)
 @NotNull
public static IInstanceEngine oracleSe2(@NotNull
                                                                           OracleSe2InstanceEngineProps props)

Creates a new Oracle Standard Edition 2 instance engine.

Parameters:

props - This parameter is required.

oracleSe2Cdb

@Stability(value=Stable)
 @NotNull
public static IInstanceEngine oracleSe2Cdb(@NotNull
                                                                              OracleSe2CdbInstanceEngineProps props)

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

Parameters:

props - This parameter is required.

postgres

@Stability(value=Stable)
 @NotNull
public static IInstanceEngine postgres(@NotNull
                                                                          PostgresInstanceEngineProps props)

Creates a new PostgreSQL instance engine.

Parameters:

props - This parameter is required.

sqlServerEe

@Stability(value=Stable)
 @NotNull
public static IInstanceEngine sqlServerEe(@NotNull
                                                                             SqlServerEeInstanceEngineProps props)

Creates a new SQL Server Enterprise Edition instance engine.

Parameters:

props - This parameter is required.

sqlServerEx

@Stability(value=Stable)
 @NotNull
public static IInstanceEngine sqlServerEx(@NotNull
                                                                             SqlServerExInstanceEngineProps props)

Creates a new SQL Server Express Edition instance engine.

Parameters:

props - This parameter is required.

sqlServerSe

@Stability(value=Stable)
 @NotNull
public static IInstanceEngine sqlServerSe(@NotNull
                                                                             SqlServerSeInstanceEngineProps props)

Creates a new SQL Server Standard Edition instance engine.

Parameters:

props - This parameter is required.

sqlServerWeb

@Stability(value=Stable)
 @NotNull
public static IInstanceEngine sqlServerWeb(@NotNull
                                                                              SqlServerWebInstanceEngineProps props)

Creates a new SQL Server Web Edition instance engine.

Parameters:

props - This parameter is required.