interface IInstanceEngine
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.RDS.IInstanceEngine |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsrds#IInstanceEngine |
![]() | software.amazon.awscdk.services.rds.IInstanceEngine |
![]() | aws_cdk.aws_rds.IInstanceEngine |
![]() | aws-cdk-lib » aws_rds » IInstanceEngine |
Obtainable from
Database
.mariaDb()
, Database
.mysql()
, Database
.oracleEe()
, Database
.oracleEeCdb()
, Database
.oracleSe2()
, Database
.oracleSe2Cdb()
, Database
.postgres()
, Database
.sqlServerEe()
, Database
.sqlServerEx()
, Database
.sqlServerSe()
, Database
.sqlServerWeb()
Interface representing a database instance (as opposed to cluster) engine.
Properties
Name | Type | Description |
---|---|---|
engine | string | The type of the engine, for example "mysql". |
multi | Secret | The application used by this engine to perform rotation for a multi-user scenario. |
single | Secret | The application used by this engine to perform rotation for a single-user scenario. |
default | string | The default name of the master database user if one was not provided explicitly. |
engine | string | The family this engine belongs to, like "MYSQL", or "POSTGRESQL". |
engine | Engine | The exact version of the engine that is used, for example "5.1.42". |
parameter | string | The family to use for ParameterGroups using this engine. |
supports | boolean | Whether this engine supports automatic backups of a read replica instance. |
engineType
Type:
string
The type of the engine, for example "mysql".
multiUserRotationApplication
Type:
Secret
The application used by this engine to perform rotation for a multi-user scenario.
singleUserRotationApplication
Type:
Secret
The application used by this engine to perform rotation for a single-user scenario.
defaultUsername?
Type:
string
(optional)
The default name of the master database user if one was not provided explicitly.
The global default of 'admin' will be used if this is undefined
.
Note that 'admin' is a reserved word in PostgreSQL and cannot be used.
engineFamily?
Type:
string
(optional, default: the engine doesn't belong to any family)
The family this engine belongs to, like "MYSQL", or "POSTGRESQL".
This property is used when creating a Database Proxy. Most engines don't belong to any family (and because of that, you can't create Database Proxies for their Clusters or Instances).
engineVersion?
Type:
Engine
(optional, default: use the default version for this engine type)
The exact version of the engine that is used, for example "5.1.42".
parameterGroupFamily?
Type:
string
(optional, default: the ParameterGroup family is not known
(which means the major version of the engine is also not known))
The family to use for ParameterGroups using this engine.
This is usually equal to "<engineType><engineMajorVersion>", but can sometimes be a variation of that. You can pass this property when creating new ParameterGroup.
supportsReadReplicaBackups?
Type:
boolean
(optional, default: false)
Whether this engine supports automatic backups of a read replica instance.
Methods
Name | Description |
---|---|
bind | Method called when the engine is used to create a new instance. |
bindToInstance(scope, options)
public bindToInstance(scope: Construct, options: InstanceEngineBindOptions): InstanceEngineConfig
Parameters
- scope
Construct
- options
Instance
Engine Bind Options
Returns
Method called when the engine is used to create a new instance.