IInstanceEngine

class aws_cdk.aws_rds.IInstanceEngine(*args, **kwds)

Bases: aws_cdk.aws_rds.IEngine, typing_extensions.Protocol

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

Methods

bind_to_instance(scope, *, domain=None, option_group=None, s3_export_role=None, s3_import_role=None, timezone=None)

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

Parameters

  • scope (Construct) –

  • domain (Optional[str]) – The Active Directory directory ID to create the DB instance in. Default: - none (it’s an optional field)

  • option_group (Optional[IOptionGroup]) – The option group of the database. Default: - none

  • s3_export_role (Optional[IRole]) – The role used for S3 exporting. Default: - none

  • s3_import_role (Optional[IRole]) – The role used for S3 importing. Default: - none

  • timezone (Optional[str]) – The timezone of the database, set by the customer. Default: - none (it’s an optional field)

Return type

InstanceEngineConfig

Attributes

default_username

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.

Return type

Optional[str]

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

Default

  • the engine doesn’t belong to any family

Return type

Optional[str]

engine_type

The type of the engine, for example “mysql”.

Return type

str

engine_version

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

Default

  • use the default version for this engine type

Return type

Optional[EngineVersion]

multi_user_rotation_application

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

Return type

SecretRotationApplication

parameter_group_family

The family to use for ParameterGroups using this engine.

This is usually equal to “”, but can sometimes be a variation of that. You can pass this property when creating new ParameterGroup.

Default

  • the ParameterGroup family is not known

(which means the major version of the engine is also not known)

Return type

Optional[str]

single_user_rotation_application

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

Return type

SecretRotationApplication

supports_read_replica_backups

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

Default

false

Return type

Optional[bool]