Interface IInstanceEngine.Jsii$Default

All Superinterfaces:
IEngine, IEngine.Jsii$Default, IInstanceEngine,
All Known Implementing Classes:
Enclosing interface:

@Internal public static interface IInstanceEngine.Jsii$Default extends IInstanceEngine, IEngine.Jsii$Default
Internal default implementation for IInstanceEngine.
  • Method Details

    • getEngineType

      @Stability(Stable) @NotNull default String getEngineType()
      The type of the engine, for example "mysql".
      Specified by:
      getEngineType in interface IEngine
      Specified by:
      getEngineType in interface IEngine.Jsii$Default
    • 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.

      Specified by:
      getDefaultUsername in interface IEngine
      Specified by:
      getDefaultUsername in interface IEngine.Jsii$Default
    • 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

      Specified by:
      getEngineFamily in interface IEngine
      Specified by:
      getEngineFamily in interface IEngine.Jsii$Default
    • 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

      Specified by:
      getEngineVersion in interface IEngine
      Specified by:
      getEngineVersion in interface IEngine.Jsii$Default
    • 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)

      Specified by:
      getParameterGroupFamily in interface IEngine
      Specified by:
      getParameterGroupFamily in interface IEngine.Jsii$Default
    • getMultiUserRotationApplication

      @Stability(Stable) @NotNull default SecretRotationApplication getMultiUserRotationApplication()
      The application used by this engine to perform rotation for a multi-user scenario.
      Specified by:
      getMultiUserRotationApplication in interface IInstanceEngine
    • getSingleUserRotationApplication

      @Stability(Stable) @NotNull default SecretRotationApplication getSingleUserRotationApplication()
      The application used by this engine to perform rotation for a single-user scenario.
      Specified by:
      getSingleUserRotationApplication in interface IInstanceEngine
    • getSupportsReadReplicaBackups

      @Stability(Stable) @Nullable default Boolean getSupportsReadReplicaBackups()
      Whether this engine supports automatic backups of a read replica instance.

      Default: false

      Specified by:
      getSupportsReadReplicaBackups in interface IInstanceEngine
    • bindToInstance

      @Stability(Stable) @NotNull default InstanceEngineConfig bindToInstance(@NotNull software.constructs.Construct scope, @NotNull InstanceEngineBindOptions options)
      Method called when the engine is used to create a new instance.

      Specified by:
      bindToInstance in interface IInstanceEngine
      scope - This parameter is required.
      options - This parameter is required.