aws-cdk-lib.aws_rds.IInstanceEngine

IInstanceEngine Interface

Interface representing a database instance (as opposed to cluster) engine.

IInstanceEngine

extends

• IEngine

Source

aws-rds/lib/instance-engine.ts

Properties

defaultUsername?may be undefinedstringdefault_username?may be undefinedstrdefaultUsername?may be undefinedStringDefaultUsername?may be undefinedstringDefaultUsername?may be undefined*string#

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?may be undefinedstringengine_family?may be undefinedstrengineFamily?may be undefinedStringEngineFamily?may be undefinedstringEngineFamily?may be undefined*string#

The family this engine belongs to, like "MYSQL", or "POSTGRESQL".

Default: the engine doesn't belong to any family

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).

engineTypestringengine_typestrengineTypeStringEngineTypestringEngineType*stringrequired#

The type of the engine, for example "mysql".

engineVersion?may be undefinedEngineVersionengine_version?may be undefinedEngineVersionengineVersion?may be undefinedEngineVersionEngineVersion?may be undefinedEngineVersionEngineVersion?may be undefinedEngineVersion#

The exact version of the engine that is used, for example "5.1.42".

Default: use the default version for this engine type

multiUserRotationApplicationSecretRotationApplicationmulti_user_rotation_applicationSecretRotationApplicationmultiUserRotationApplicationSecretRotationApplicationMultiUserRotationApplicationSecretRotationApplicationMultiUserRotationApplicationSecretRotationApplicationrequired#

The application used by this engine to perform rotation for a multi-user scenario.

parameterGroupFamily?may be undefinedstringparameter_group_family?may be undefinedstrparameterGroupFamily?may be undefinedStringParameterGroupFamily?may be undefinedstringParameterGroupFamily?may be undefined*string#

The family to use for ParameterGroups using this engine.

Default: the ParameterGroup family is not known (which means the major version of the engine is also not known)

This is usually equal to "<engineType><engineMajorVersion>", but can sometimes be a variation of that. You can pass this property when creating new ParameterGroup.

singleUserRotationApplicationSecretRotationApplicationsingle_user_rotation_applicationSecretRotationApplicationsingleUserRotationApplicationSecretRotationApplicationSingleUserRotationApplicationSecretRotationApplicationSingleUserRotationApplicationSecretRotationApplicationrequired#

The application used by this engine to perform rotation for a single-user scenario.

supportsReadReplicaBackups?may be undefinedbooleansupports_read_replica_backups?may be undefinedboolsupportsReadReplicaBackups?may be undefinedBooleanSupportsReadReplicaBackups?may be undefinedboolSupportsReadReplicaBackups?may be undefined*bool= false#

Whether this engine supports automatic backups of a read replica instance.

Methods

bindToInstance(scope: Construct, options: InstanceEngineBindOptions): InstanceEngineConfigdef bind_to_instance(self, scope: Construct, options: InstanceEngineBindOptions) -> InstanceEngineConfigpublic InstanceEngineConfig bindToInstance(Construct scope, InstanceEngineBindOptions options)public InstanceEngineConfig BindToInstance(Construct scope, InstanceEngineBindOptions options)func BindToInstance(Scope Construct, Options InstanceEngineBindOptions) InstanceEngineConfig#

Method called when the engine is used to create a new instance.