Interface IEngine

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IClusterEngine, IClusterEngine.Jsii$Default, IEngine.Jsii$Default, IInstanceEngine, IInstanceEngine.Jsii$Default
All Known Implementing Classes:
IClusterEngine.Jsii$Proxy, IEngine.Jsii$Proxy, IInstanceEngine.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-24T21:00:35.250Z") @Stability(Stable) public interface IEngine extends software.amazon.jsii.JsiiSerializable
A common interface for database engines.

Don't implement this interface directly, instead implement one of the known sub-interfaces, like IClusterEngine and IInstanceEngine.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Internal default implementation for IEngine.
    static final class 
    A proxy class which represents a concrete javascript instance of this type.
  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    The default name of the master database user if one was not provided explicitly.
    default String
    The family this engine belongs to, like "MYSQL", or "POSTGRESQL".
    The type of the engine, for example "mysql".
    The exact version of the engine that is used, for example "5.1.42".
    default String
    The family to use for ParameterGroups using this engine.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson
  • Method Details

    • getEngineType

      @Stability(Stable) @NotNull String getEngineType()
      The type of the engine, for example "mysql".
    • getDefaultUsername

      @Stability(Stable) @Nullable default String getDefaultUsername()
      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.

    • getEngineFamily

      @Stability(Stable) @Nullable default String getEngineFamily()
      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

    • getEngineVersion

      @Stability(Stable) @Nullable default EngineVersion getEngineVersion()
      The exact version of the engine that is used, for example "5.1.42".

      Default: - use the default version for this engine type

    • getParameterGroupFamily

      @Stability(Stable) @Nullable default String getParameterGroupFamily()
      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)