DatabaseInstanceEngine Class
A database instance engine.
Provides mapping to DatabaseEngine used for secret rotation.
Example
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
# 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
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();
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
}
});
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
ts
new DatabaseInstanceEngine()
python
DatabaseInstanceEngine()
java
new DatabaseInstanceEngine()
csharp
new DatabaseInstanceEngine()
go
NewDatabaseInstanceEngine()
Properties
MARIADBIInstanceEnginemariadbIInstanceEngineMARIADBIInstanceEngineMARIADBIInstanceEngineMARIADBIInstanceEnginerequiredstatic#The unversioned 'mariadb' instance engine.
NOTE: using unversioned engines is an availability risk. We recommend using versioned engines created using the mariaDb() method
MYSQLIInstanceEnginemysqlIInstanceEngineMYSQLIInstanceEngineMYSQLIInstanceEngineMYSQLIInstanceEnginerequiredstatic#The unversioned 'mysql' instance engine.
NOTE: using unversioned engines is an availability risk. We recommend using versioned engines created using the mysql() method
ORACLE_EEIInstanceEngineoracle_eeIInstanceEngineORACLE_EEIInstanceEngineORACLE_EEIInstanceEngineORACLE_EEIInstanceEnginerequiredstatic#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_CDBIInstanceEngineoracle_ee_cdbIInstanceEngineORACLE_EE_CDBIInstanceEngineORACLE_EE_CDBIInstanceEngineORACLE_EE_CDBIInstanceEnginerequiredstatic#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_SE2IInstanceEngineoracle_se2IInstanceEngineORACLE_SE2IInstanceEngineORACLE_SE2IInstanceEngineORACLE_SE2IInstanceEnginerequiredstatic#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_CDBIInstanceEngineoracle_se2_cdbIInstanceEngineORACLE_SE2_CDBIInstanceEngineORACLE_SE2_CDBIInstanceEngineORACLE_SE2_CDBIInstanceEnginerequiredstatic#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
POSTGRESIInstanceEnginepostgresIInstanceEnginePOSTGRESIInstanceEnginePOSTGRESIInstanceEnginePOSTGRESIInstanceEnginerequiredstatic#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_EEIInstanceEnginesql_server_eeIInstanceEngineSQL_SERVER_EEIInstanceEngineSQL_SERVER_EEIInstanceEngineSQL_SERVER_EEIInstanceEnginerequiredstatic#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_EXIInstanceEnginesql_server_exIInstanceEngineSQL_SERVER_EXIInstanceEngineSQL_SERVER_EXIInstanceEngineSQL_SERVER_EXIInstanceEnginerequiredstatic#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_SEIInstanceEnginesql_server_seIInstanceEngineSQL_SERVER_SEIInstanceEngineSQL_SERVER_SEIInstanceEngineSQL_SERVER_SEIInstanceEnginerequiredstatic#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_WEBIInstanceEnginesql_server_webIInstanceEngineSQL_SERVER_WEBIInstanceEngineSQL_SERVER_WEBIInstanceEngineSQL_SERVER_WEBIInstanceEnginerequiredstatic#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@staticmethod def maria_db(props: MariaDbInstanceEngineProps) -> IInstanceEnginepublic static IInstanceEngine mariaDb(MariaDbInstanceEngineProps props)public static IInstanceEngine MariaDb(MariaDbInstanceEngineProps props)func MariaDb(Props MariaDbInstanceEngineProps) IInstanceEnginestatic#Creates a new MariaDB instance engine.
mysql(props: MySqlInstanceEngineProps): IInstanceEngine@staticmethod def mysql(props: MySqlInstanceEngineProps) -> IInstanceEnginepublic static IInstanceEngine mysql(MySqlInstanceEngineProps props)public static IInstanceEngine Mysql(MySqlInstanceEngineProps props)func Mysql(Props MySqlInstanceEngineProps) IInstanceEnginestatic#Creates a new MySQL instance engine.
oracleEe(props: OracleEeInstanceEngineProps): IInstanceEngine@staticmethod def oracle_ee(props: OracleEeInstanceEngineProps) -> IInstanceEnginepublic static IInstanceEngine oracleEe(OracleEeInstanceEngineProps props)public static IInstanceEngine OracleEe(OracleEeInstanceEngineProps props)func OracleEe(Props OracleEeInstanceEngineProps) IInstanceEnginestatic#Creates a new Oracle Enterprise Edition instance engine.
oracleEeCdb(props: OracleEeCdbInstanceEngineProps): IInstanceEngine@staticmethod def oracle_ee_cdb(props: OracleEeCdbInstanceEngineProps) -> IInstanceEnginepublic static IInstanceEngine oracleEeCdb(OracleEeCdbInstanceEngineProps props)public static IInstanceEngine OracleEeCdb(OracleEeCdbInstanceEngineProps props)func OracleEeCdb(Props OracleEeCdbInstanceEngineProps) IInstanceEnginestatic#Creates a new Oracle Enterprise Edition (CDB) instance engine.
oracleSe2(props: OracleSe2InstanceEngineProps): IInstanceEngine@staticmethod def oracle_se2(props: OracleSe2InstanceEngineProps) -> IInstanceEnginepublic static IInstanceEngine oracleSe2(OracleSe2InstanceEngineProps props)public static IInstanceEngine OracleSe2(OracleSe2InstanceEngineProps props)func OracleSe2(Props OracleSe2InstanceEngineProps) IInstanceEnginestatic#Creates a new Oracle Standard Edition 2 instance engine.
oracleSe2Cdb(props: OracleSe2CdbInstanceEngineProps): IInstanceEngine@staticmethod def oracle_se2_cdb(props: OracleSe2CdbInstanceEngineProps) -> IInstanceEnginepublic static IInstanceEngine oracleSe2Cdb(OracleSe2CdbInstanceEngineProps props)public static IInstanceEngine OracleSe2Cdb(OracleSe2CdbInstanceEngineProps props)func OracleSe2Cdb(Props OracleSe2CdbInstanceEngineProps) IInstanceEnginestatic#Creates a new Oracle Standard Edition 2 (CDB) instance engine.
postgres(props: PostgresInstanceEngineProps): IInstanceEngine@staticmethod def postgres(props: PostgresInstanceEngineProps) -> IInstanceEnginepublic static IInstanceEngine postgres(PostgresInstanceEngineProps props)public static IInstanceEngine Postgres(PostgresInstanceEngineProps props)func Postgres(Props PostgresInstanceEngineProps) IInstanceEnginestatic#Creates a new PostgreSQL instance engine.
sqlServerEe(props: SqlServerEeInstanceEngineProps): IInstanceEngine@staticmethod def sql_server_ee(props: SqlServerEeInstanceEngineProps) -> IInstanceEnginepublic static IInstanceEngine sqlServerEe(SqlServerEeInstanceEngineProps props)public static IInstanceEngine SqlServerEe(SqlServerEeInstanceEngineProps props)func SqlServerEe(Props SqlServerEeInstanceEngineProps) IInstanceEnginestatic#Creates a new SQL Server Enterprise Edition instance engine.
sqlServerEx(props: SqlServerExInstanceEngineProps): IInstanceEngine@staticmethod def sql_server_ex(props: SqlServerExInstanceEngineProps) -> IInstanceEnginepublic static IInstanceEngine sqlServerEx(SqlServerExInstanceEngineProps props)public static IInstanceEngine SqlServerEx(SqlServerExInstanceEngineProps props)func SqlServerEx(Props SqlServerExInstanceEngineProps) IInstanceEnginestatic#Creates a new SQL Server Express Edition instance engine.
sqlServerSe(props: SqlServerSeInstanceEngineProps): IInstanceEngine@staticmethod def sql_server_se(props: SqlServerSeInstanceEngineProps) -> IInstanceEnginepublic static IInstanceEngine sqlServerSe(SqlServerSeInstanceEngineProps props)public static IInstanceEngine SqlServerSe(SqlServerSeInstanceEngineProps props)func SqlServerSe(Props SqlServerSeInstanceEngineProps) IInstanceEnginestatic#Creates a new SQL Server Standard Edition instance engine.
sqlServerWeb(props: SqlServerWebInstanceEngineProps): IInstanceEngine@staticmethod def sql_server_web(props: SqlServerWebInstanceEngineProps) -> IInstanceEnginepublic static IInstanceEngine sqlServerWeb(SqlServerWebInstanceEngineProps props)public static IInstanceEngine SqlServerWeb(SqlServerWebInstanceEngineProps props)func SqlServerWeb(Props SqlServerWebInstanceEngineProps) IInstanceEnginestatic#Creates a new SQL Server Web Edition instance engine.