# DatabaseInstanceEngine

A database instance engine.

Provides mapping to DatabaseEngine used for
secret rotation.

- Source: [`aws-rds/lib/instance-engine.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0/packages/aws-cdk-lib/aws-rds/lib/instance-engine.ts#L3430)
- Type last changed: v2.34.0 · 29 Jul 2022

## Example

TypeScript:

```ts
declare const vpc: ec2.Vpc;
const instance = new rds.DatabaseInstance(this, 'Instance', {
  engine: rds.DatabaseInstanceEngine.oracleSe2({ version: rds.OracleEngineVersion.VER_19_0_0_0_2020_04_R1 }),
  // optional, defaults to m5.large
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE3, ec2.InstanceSize.SMALL),
  credentials: rds.Credentials.fromGeneratedSecret('syscdk'), // Optional - will default to 'admin' username and generated password
  vpc,
  vpcSubnets: {
    subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS,
  }
});
```

Python:

```python
# vpc: ec2.Vpc

instance = rds.DatabaseInstance(self, "Instance",
    engine=rds.DatabaseInstanceEngine.oracle_se2(version=rds.OracleEngineVersion.VER_19_0_0_0_2020_04_R1),
    # optional, defaults to m5.large
    instance_type=ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE3, ec2.InstanceSize.SMALL),
    credentials=rds.Credentials.from_generated_secret("syscdk"),  # Optional - will default to 'admin' username and generated password
    vpc=vpc,
    vpc_subnets=ec2.SubnetSelection(
        subnet_type=ec2.SubnetType.PRIVATE_WITH_EGRESS
    )
)
```

Java:

```java
Vpc vpc;

DatabaseInstance instance = DatabaseInstance.Builder.create(this, "Instance")
        .engine(DatabaseInstanceEngine.oracleSe2(OracleSe2InstanceEngineProps.builder().version(OracleEngineVersion.VER_19_0_0_0_2020_04_R1).build()))
        // optional, defaults to m5.large
        .instanceType(InstanceType.of(InstanceClass.BURSTABLE3, InstanceSize.SMALL))
        .credentials(Credentials.fromGeneratedSecret("syscdk")) // Optional - will default to 'admin' username and generated password
        .vpc(vpc)
        .vpcSubnets(SubnetSelection.builder()
                .subnetType(SubnetType.PRIVATE_WITH_EGRESS)
                .build())
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
Vpc vpc;

var instance = new DatabaseInstance(this, "Instance", new DatabaseInstanceProps {
    Engine = DatabaseInstanceEngine.OracleSe2(new OracleSe2InstanceEngineProps { Version = OracleEngineVersion.VER_19_0_0_0_2020_04_R1 }),
    // optional, defaults to m5.large
    InstanceType = InstanceType.Of(InstanceClass.BURSTABLE3, InstanceSize.SMALL),
    Credentials = Credentials.FromGeneratedSecret("syscdk"),  // Optional - will default to 'admin' username and generated password
    Vpc = vpc,
    VpcSubnets = new SubnetSelection {
        SubnetType = SubnetType.PRIVATE_WITH_EGRESS
    }
});
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var vpc Vpc

instance := rds.NewDatabaseInstance(this, jsii.String("Instance"), &DatabaseInstanceProps{
	Engine: rds.DatabaseInstanceEngine_OracleSe2(&OracleSe2InstanceEngineProps{
		Version: rds.OracleEngineVersion_VER_19_0_0_0_2020_04_R1(),
	}),
	// optional, defaults to m5.large
	InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_BURSTABLE3, ec2.InstanceSize_SMALL),
	Credentials: rds.Credentials_FromGeneratedSecret(jsii.String("syscdk")),
	 // Optional - will default to 'admin' username and generated password
	Vpc: Vpc,
	VpcSubnets: &SubnetSelection{
		SubnetType: ec2.SubnetType_PRIVATE_WITH_EGRESS,
	},
})
```

## Initializer

TypeScript:

```ts
new DatabaseInstanceEngine()
```

Python:

```python
DatabaseInstanceEngine()
```

Java:

```java
new DatabaseInstanceEngine()
```

C# / .NET:

```csharp
new DatabaseInstanceEngine()
```

Golang:

```go
NewDatabaseInstanceEngine()
```

## Properties

- `MARIADB`: [IInstanceEngine](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.IInstanceEngine.html) (static) — The unversioned 'mariadb' instance engine.

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

- `MYSQL`: [IInstanceEngine](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.IInstanceEngine.html) (static) — The unversioned 'mysql' instance engine.

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

- `ORACLE_EE`: [IInstanceEngine](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.IInstanceEngine.html) (static) — The unversioned 'oracle-ee' instance engine.

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

- `ORACLE_EE_CDB`: [IInstanceEngine](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.IInstanceEngine.html) (static) — 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

- `ORACLE_SE2`: [IInstanceEngine](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.IInstanceEngine.html) (static) — The unversioned 'oracle-se2' instance engine.

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

- `ORACLE_SE2_CDB`: [IInstanceEngine](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.IInstanceEngine.html) (static) — 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

- `POSTGRES`: [IInstanceEngine](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.IInstanceEngine.html) (static) — The unversioned 'postgres' instance engine.

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

- `SQL_SERVER_EE`: [IInstanceEngine](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.IInstanceEngine.html) (static) — The unversioned 'sqlserver-ee' instance engine.

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

- `SQL_SERVER_EX`: [IInstanceEngine](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.IInstanceEngine.html) (static) — The unversioned 'sqlserver-ex' instance engine.

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

- `SQL_SERVER_SE`: [IInstanceEngine](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.IInstanceEngine.html) (static) — The unversioned 'sqlserver-se' instance engine.

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

- `SQL_SERVER_WEB`: [IInstanceEngine](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.IInstanceEngine.html) (static) — 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

- `mariaDb(props: MariaDbInstanceEngineProps): IInstanceEngine` (static) — Creates a new MariaDB instance engine.

- `mysql(props: MySqlInstanceEngineProps): IInstanceEngine` (static) — Creates a new MySQL instance engine.

- `oracleEe(props: OracleEeInstanceEngineProps): IInstanceEngine` (static) — Creates a new Oracle Enterprise Edition instance engine.

- `oracleEeCdb(props: OracleEeCdbInstanceEngineProps): IInstanceEngine` (static) — Creates a new Oracle Enterprise Edition (CDB) instance engine.

- `oracleSe2(props: OracleSe2InstanceEngineProps): IInstanceEngine` (static) — Creates a new Oracle Standard Edition 2 instance engine.

- `oracleSe2Cdb(props: OracleSe2CdbInstanceEngineProps): IInstanceEngine` (static) — Creates a new Oracle Standard Edition 2 (CDB) instance engine.

- `postgres(props: PostgresInstanceEngineProps): IInstanceEngine` (static) — Creates a new PostgreSQL instance engine.

- `sqlServerEe(props: SqlServerEeInstanceEngineProps): IInstanceEngine` (static) — Creates a new SQL Server Enterprise Edition instance engine.

- `sqlServerEx(props: SqlServerExInstanceEngineProps): IInstanceEngine` (static) — Creates a new SQL Server Express Edition instance engine.

- `sqlServerSe(props: SqlServerSeInstanceEngineProps): IInstanceEngine` (static) — Creates a new SQL Server Standard Edition instance engine.

- `sqlServerWeb(props: SqlServerWebInstanceEngineProps): IInstanceEngine` (static) — Creates a new SQL Server Web Edition instance engine.
