software.amazon.awscdk.services.rds

Interface IInstanceEngine.Jsii$Default

All Superinterfaces:

IEngine, IEngine.Jsii$Default, IInstanceEngine, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IInstanceEngine.Jsii$Proxy

Enclosing interface:

IInstanceEngine

@Internal
public static interface IInstanceEngine.Jsii$Default
extends IInstanceEngine, IEngine.Jsii$Default

Internal default implementation for IInstanceEngine.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.IInstanceEngine

IInstanceEngine.Jsii$Default, IInstanceEngine.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default InstanceEngineConfig	bindToInstance(software.constructs.Construct scope, InstanceEngineBindOptions options) (experimental) Method called when the engine is used to create a new instance.
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".
default 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 SecretRotationApplication	getMultiUserRotationApplication() (experimental) The application used by this engine to perform rotation for a multi-user scenario.
default String	getParameterGroupFamily() (experimental) The family to use for ParameterGroups using this engine.
default SecretRotationApplication	getSingleUserRotationApplication() (experimental) The application used by this engine to perform rotation for a single-user scenario.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEngineType

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

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

Specified by:

getEngineType in interface IEngine

Specified by:

getEngineType in interface IEngine.Jsii$Default

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.

Specified by:

getDefaultUsername in interface IEngine

Specified by:

getDefaultUsername in interface IEngine.Jsii$Default

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

Specified by:

getEngineFamily in interface IEngine

Specified by:

getEngineFamily in interface IEngine.Jsii$Default

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

Specified by:

getEngineVersion in interface IEngine

Specified by:

getEngineVersion in interface IEngine.Jsii$Default

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)

Specified by:

getParameterGroupFamily in interface IEngine

Specified by:

getParameterGroupFamily in interface IEngine.Jsii$Default

getMultiUserRotationApplication

@Stability(value=Experimental)
 @NotNull
default SecretRotationApplication getMultiUserRotationApplication()

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

Specified by:

getMultiUserRotationApplication in interface IInstanceEngine

getSingleUserRotationApplication

@Stability(value=Experimental)
 @NotNull
default SecretRotationApplication getSingleUserRotationApplication()

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

Specified by:

getSingleUserRotationApplication in interface IInstanceEngine

bindToInstance

@Stability(value=Experimental)
 @NotNull
default InstanceEngineConfig bindToInstance(@NotNull
                                                                                     software.constructs.Construct scope,
                                                                                     @NotNull
                                                                                     InstanceEngineBindOptions options)

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

Specified by:

bindToInstance in interface IInstanceEngine

Parameters:

scope - This parameter is required.

options - This parameter is required.