Package software.amazon.awscdk.services.rds

Interface IInstanceEngine

All Superinterfaces:

IEngine, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IInstanceEngine.Jsii$Default

All Known Implementing Classes:

IInstanceEngine.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:25:04.208Z")
@Stability(Stable)
public interface IInstanceEngine
extends software.amazon.jsii.JsiiSerializable, IEngine

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IInstanceEngine.Jsii$Default	Internal default implementation for IInstanceEngine.
static final class	IInstanceEngine.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
InstanceEngineConfig	bindToInstance(software.constructs.Construct scope, InstanceEngineBindOptions options)	Method called when the engine is used to create a new instance.
SecretRotationApplication	getMultiUserRotationApplication()	The application used by this engine to perform rotation for a multi-user scenario.
SecretRotationApplication	getSingleUserRotationApplication()	The application used by this engine to perform rotation for a single-user scenario.
default Boolean	getSupportsReadReplicaBackups()	Whether this engine supports automatic backups of a read replica instance.

Methods inherited from interface software.amazon.awscdk.services.rds.IEngine

getDefaultUsername, getEngineFamily, getEngineType, getEngineVersion, getParameterGroupFamily

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMultiUserRotationApplication

@Stability(Stable)
@NotNull
SecretRotationApplication getMultiUserRotationApplication()

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

getSingleUserRotationApplication

@Stability(Stable)
@NotNull
SecretRotationApplication getSingleUserRotationApplication()

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

getSupportsReadReplicaBackups

@Stability(Stable)
@Nullable
default Boolean getSupportsReadReplicaBackups()

Whether this engine supports automatic backups of a read replica instance.

Default: false

bindToInstance

@Stability(Stable)
@NotNull
InstanceEngineConfig bindToInstance(@NotNull
 software.constructs.Construct scope,
 @NotNull
 InstanceEngineBindOptions options)

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

Parameters:

scope - This parameter is required.

options - This parameter is required.