Class DatabaseInstanceEngine

A database instance engine.

Inheritance

System.Object

DatabaseInstanceEngine

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.AWS.RDS.dll

Syntax (csharp)

public class DatabaseInstanceEngine : DeputyBase

Syntax (vb)

Public Class DatabaseInstanceEngine
    Inherits DeputyBase

Remarks

Provides mapping to DatabaseEngine used for secret rotation.

ExampleMetadata: infused

Examples

Vpc vpc;

DatabaseInstance sourceInstance;

new DatabaseInstanceFromSnapshot(this, "Instance", new DatabaseInstanceFromSnapshotProps {
    SnapshotIdentifier = "my-snapshot",
    Engine = DatabaseInstanceEngine.Postgres(new PostgresInstanceEngineProps { Version = PostgresEngineVersion.VER_12_3 }),
    // optional, defaults to m5.large
    InstanceType = InstanceType.Of(InstanceClass.BURSTABLE2, InstanceSize.LARGE),
    Vpc = vpc
});
new DatabaseInstanceReadReplica(this, "ReadReplica", new DatabaseInstanceReadReplicaProps {
    SourceDatabaseInstance = sourceInstance,
    InstanceType = InstanceType.Of(InstanceClass.BURSTABLE2, InstanceSize.LARGE),
    Vpc = vpc
});

Synopsis

Constructors

DatabaseInstanceEngine()
DatabaseInstanceEngine(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
DatabaseInstanceEngine(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

MARIADB	The unversioned 'mariadb' instance engine.
MYSQL	The unversioned 'mysql' instance engine.
ORACLE_EE	The unversioned 'oracle-ee' instance engine.
ORACLE_SE	(deprecated) The unversioned 'oracle-se' instance engine.
ORACLE_SE1	(deprecated) The unversioned 'oracle-se1' instance engine.
ORACLE_SE2	The unversioned 'oracle-se2' instance engine.
POSTGRES	The unversioned 'postgres' instance engine.
SQL_SERVER_EE	The unversioned 'sqlserver-ee' instance engine.
SQL_SERVER_EX	The unversioned 'sqlserver-ex' instance engine.
SQL_SERVER_SE	The unversioned 'sqlserver-se' instance engine.
SQL_SERVER_WEB	The unversioned 'sqlserver-web' instance engine.

Methods

MariaDb(IMariaDbInstanceEngineProps)	Creates a new MariaDB instance engine.
Mysql(IMySqlInstanceEngineProps)	Creates a new MySQL instance engine.
OracleEe(IOracleEeInstanceEngineProps)	Creates a new Oracle Enterprise Edition instance engine.
OracleSe(IOracleSeInstanceEngineProps)	(deprecated) Creates a new Oracle Standard Edition instance engine.
OracleSe1(IOracleSe1InstanceEngineProps)	(deprecated) Creates a new Oracle Standard Edition 1 instance engine.
OracleSe2(IOracleSe2InstanceEngineProps)	Creates a new Oracle Standard Edition 1 instance engine.
Postgres(IPostgresInstanceEngineProps)	Creates a new PostgreSQL instance engine.
SqlServerEe(ISqlServerEeInstanceEngineProps)	Creates a new SQL Server Enterprise Edition instance engine.
SqlServerEx(ISqlServerExInstanceEngineProps)	Creates a new SQL Server Express Edition instance engine.
SqlServerSe(ISqlServerSeInstanceEngineProps)	Creates a new SQL Server Standard Edition instance engine.
SqlServerWeb(ISqlServerWebInstanceEngineProps)	Creates a new SQL Server Web Edition instance engine.

Constructors

DatabaseInstanceEngine()

public DatabaseInstanceEngine()

DatabaseInstanceEngine(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected DatabaseInstanceEngine(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

DatabaseInstanceEngine(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected DatabaseInstanceEngine(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

MARIADB

The unversioned 'mariadb' instance engine.

public static IInstanceEngine MARIADB { get; }

Property Value

IInstanceEngine

Remarks

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

MYSQL

The unversioned 'mysql' instance engine.

public static IInstanceEngine MYSQL { get; }

Property Value

IInstanceEngine

Remarks

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

ORACLE_EE

The unversioned 'oracle-ee' instance engine.

public static IInstanceEngine ORACLE_EE { get; }

Property Value

IInstanceEngine

Remarks

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

ORACLE_SE

(deprecated) The unversioned 'oracle-se' instance engine.

public static IInstanceEngine ORACLE_SE { get; }

Property Value

IInstanceEngine

Remarks

Stability: Deprecated

ORACLE_SE1

(deprecated) The unversioned 'oracle-se1' instance engine.

public static IInstanceEngine ORACLE_SE1 { get; }

Property Value

IInstanceEngine

Remarks

Stability: Deprecated

ORACLE_SE2

The unversioned 'oracle-se2' instance engine.

public static IInstanceEngine ORACLE_SE2 { get; }

Property Value

IInstanceEngine

Remarks

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

POSTGRES

The unversioned 'postgres' instance engine.

public static IInstanceEngine POSTGRES { get; }

Property Value

IInstanceEngine

Remarks

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

SQL_SERVER_EE

The unversioned 'sqlserver-ee' instance engine.

public static IInstanceEngine SQL_SERVER_EE { get; }

Property Value

IInstanceEngine

Remarks

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

SQL_SERVER_EX

The unversioned 'sqlserver-ex' instance engine.

public static IInstanceEngine SQL_SERVER_EX { get; }

Property Value

IInstanceEngine

Remarks

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

SQL_SERVER_SE

The unversioned 'sqlserver-se' instance engine.

public static IInstanceEngine SQL_SERVER_SE { get; }

Property Value

IInstanceEngine

Remarks

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

SQL_SERVER_WEB

The unversioned 'sqlserver-web' instance engine.

public static IInstanceEngine SQL_SERVER_WEB { get; }

Property Value

IInstanceEngine

Remarks

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

Methods

MariaDb(IMariaDbInstanceEngineProps)

Creates a new MariaDB instance engine.

public static IInstanceEngine MariaDb(IMariaDbInstanceEngineProps props)

Parameters

props IMariaDbInstanceEngineProps

Returns

IInstanceEngine

Mysql(IMySqlInstanceEngineProps)

Creates a new MySQL instance engine.

public static IInstanceEngine Mysql(IMySqlInstanceEngineProps props)

Parameters

props IMySqlInstanceEngineProps

Returns

IInstanceEngine

OracleEe(IOracleEeInstanceEngineProps)

Creates a new Oracle Enterprise Edition instance engine.

public static IInstanceEngine OracleEe(IOracleEeInstanceEngineProps props)

Parameters

props IOracleEeInstanceEngineProps

Returns

IInstanceEngine

OracleSe(IOracleSeInstanceEngineProps)

(deprecated) Creates a new Oracle Standard Edition instance engine.

public static IInstanceEngine OracleSe(IOracleSeInstanceEngineProps props)

Parameters

props IOracleSeInstanceEngineProps

Returns

IInstanceEngine

Remarks

Stability: Deprecated

OracleSe1(IOracleSe1InstanceEngineProps)

(deprecated) Creates a new Oracle Standard Edition 1 instance engine.

public static IInstanceEngine OracleSe1(IOracleSe1InstanceEngineProps props)

Parameters

props IOracleSe1InstanceEngineProps

Returns

IInstanceEngine

Remarks

Stability: Deprecated

OracleSe2(IOracleSe2InstanceEngineProps)

Creates a new Oracle Standard Edition 1 instance engine.

public static IInstanceEngine OracleSe2(IOracleSe2InstanceEngineProps props)

Parameters

props IOracleSe2InstanceEngineProps

Returns

IInstanceEngine

Postgres(IPostgresInstanceEngineProps)

Creates a new PostgreSQL instance engine.

public static IInstanceEngine Postgres(IPostgresInstanceEngineProps props)

Parameters

props IPostgresInstanceEngineProps

Returns

IInstanceEngine

SqlServerEe(ISqlServerEeInstanceEngineProps)

Creates a new SQL Server Enterprise Edition instance engine.

public static IInstanceEngine SqlServerEe(ISqlServerEeInstanceEngineProps props)

Parameters

props ISqlServerEeInstanceEngineProps

Returns

IInstanceEngine

SqlServerEx(ISqlServerExInstanceEngineProps)

Creates a new SQL Server Express Edition instance engine.

public static IInstanceEngine SqlServerEx(ISqlServerExInstanceEngineProps props)

Parameters

props ISqlServerExInstanceEngineProps

Returns

IInstanceEngine

SqlServerSe(ISqlServerSeInstanceEngineProps)

Creates a new SQL Server Standard Edition instance engine.

public static IInstanceEngine SqlServerSe(ISqlServerSeInstanceEngineProps props)

Parameters

props ISqlServerSeInstanceEngineProps

Returns

IInstanceEngine

SqlServerWeb(ISqlServerWebInstanceEngineProps)

Creates a new SQL Server Web Edition instance engine.

public static IInstanceEngine SqlServerWeb(ISqlServerWebInstanceEngineProps props)

Parameters

props ISqlServerWebInstanceEngineProps

Returns

IInstanceEngine