software.amazon.awscdk.services.rds

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.29.0 (build 41df200)",
           date="2021-06-02T09:55:32.023Z")
 @Stability(value=Experimental)
public interface IEngine
extends software.amazon.jsii.JsiiSerializable

(experimental) 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 and Description
static interface	IEngine.Jsii$Default Internal default implementation for IEngine.
static class	IEngine.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEngineType

@Stability(value=Experimental)
 @NotNull
String getEngineType()

(experimental) The type of the engine, for example "mysql".

getDefaultUsername

@Stability(value=Experimental)
 @Nullable
default String getDefaultUsername()

(experimental) 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(value=Experimental)
 @Nullable
default String getEngineFamily()

(experimental) 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(value=Experimental)
 @Nullable
default EngineVersion getEngineVersion()

(experimental) 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(value=Experimental)
 @Nullable
default String getParameterGroupFamily()

(experimental) 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)