AWS CDK Reference

Appearance

v2.274.0

IClusterEngine Interface ​

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

Source
aws-rds/lib/cluster-engine.ts
Type last changed
v2.21.0 · 22 Apr 2022

Properties ​

combineImportAndExportRolesbooleancombine_import_and_export_rolesboolcombineImportAndExportRolesBooleanCombineImportAndExportRolesboolCombineImportAndExportRoles*bool= false#
Whether the IAM Roles used for data importing and exporting need to be combined for this Engine, or can they be kept separate.
defaultUsernamestringdefault_usernamestrdefaultUsernameStringDefaultUsernamestringDefaultUsername*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.

engineFamilystringengine_familystrengineFamilyStringEngineFamilystringEngineFamily*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".
engineVersionEngineVersionengine_versionEngineVersionengineVersionEngineVersionEngineVersionEngineVersionEngineVersionEngineVersion#
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.
parameterGroupFamilystringparameter_group_familystrparameterGroupFamilyStringParameterGroupFamilystringParameterGroupFamily*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.
supportedLogTypesstring[]supported_log_typestyping.List[str]supportedLogTypesList<String>SupportedLogTypesstring[]SupportedLogTypes*[]*stringrequired#
The log types that are available with this engine type.

Methods ​

bindToCluster(scope: Construct, options: ClusterEngineBindOptions): ClusterEngineConfigdef bind_to_cluster(self, scope: Construct, options: ClusterEngineBindOptions) -> ClusterEngineConfigpublic ClusterEngineConfig bindToCluster(Construct scope, ClusterEngineBindOptions options)public ClusterEngineConfig BindToCluster(Construct scope, ClusterEngineBindOptions options)func BindToCluster(Scope Construct, Options ClusterEngineBindOptions) ClusterEngineConfig#
Method called when the engine is used to create a new cluster.