Package software.amazon.awscdk.services.rds

Interface IClusterEngine

All Superinterfaces:

IEngine, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IClusterEngine.Jsii$Default

All Known Implementing Classes:

IClusterEngine.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.175Z")
@Stability(Stable)
public interface IClusterEngine
extends software.amazon.jsii.JsiiSerializable, IEngine

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
ClusterEngineConfig	bindToCluster(Construct scope, ClusterEngineBindOptions options)	Method called when the engine is used to create a new cluster.
default Boolean	getCombineImportAndExportRoles()	Whether the IAM Roles used for data importing and exporting need to be combined for this Engine, or can they be kept separate.
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.
List<String>	getSupportedLogTypes()	The log types that are available with this engine type.

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.

getSupportedLogTypes

@Stability(Stable)
@NotNull
List<String> getSupportedLogTypes()

The log types that are available with this engine type.

getCombineImportAndExportRoles

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

Whether the IAM Roles used for data importing and exporting need to be combined for this Engine, or can they be kept separate.

Default: false

bindToCluster

@Stability(Stable)
@NotNull
ClusterEngineConfig bindToCluster(@NotNull
 Construct scope,
 @NotNull
 ClusterEngineBindOptions options)

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

Parameters:

scope - This parameter is required.

options - This parameter is required.