Package software.amazon.awscdk.services.rds

Class DatabaseClusterEngine

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.rds.DatabaseClusterEngine
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-27T13:12:06.308Z") @Stability(Stable) public class DatabaseClusterEngine extends software.amazon.jsii.JsiiObject
A database cluster engine.

Provides mapping to the serverless application used for secret rotation.

Example: 

 Vpc vpc;
 ServerlessCluster cluster = ServerlessCluster.Builder.create(this, "AnotherCluster")
         .engine(DatabaseClusterEngine.AURORA_POSTGRESQL)
         .copyTagsToSnapshot(true) // whether to save the cluster tags when creating the snapshot. Default is 'true'
         .parameterGroup(ParameterGroup.fromParameterGroupName(this, "ParameterGroup", "default.aurora-postgresql11"))
         .vpc(vpc)
         .scaling(ServerlessScalingOptions.builder()
                 .autoPause(Duration.minutes(10)) // default is to pause after 5 minutes of idle time
                 .minCapacity(AuroraCapacityUnit.ACU_8) // default is 2 Aurora capacity units (ACUs)
                 .maxCapacity(AuroraCapacityUnit.ACU_32) // default is 16 Aurora capacity units (ACUs)
                 .timeout(Duration.seconds(100)) // default is 5 minutes
                 .timeoutAction(TimeoutAction.FORCE_APPLY_CAPACITY_CHANGE)
                 .build())
         .build();

  • Field Details

    • AURORA

      @Stability(Deprecated) @Deprecated public static final IClusterEngine AURORA
      Deprecated.
      use AURORA_MYSQL instead
      (deprecated) The unversioned 'aurora' cluster engine.

      Note: we do not recommend using unversioned engines for non-serverless Clusters, as that can pose an availability risk. We recommend using versioned engines created using the aurora() method

    • AURORA_MYSQL

      @Stability(Stable) public static final IClusterEngine AURORA_MYSQL
      The unversioned 'aurora-msql' cluster engine.

      Note: we do not recommend using unversioned engines for non-serverless Clusters, as that can pose an availability risk. We recommend using versioned engines created using the auroraMysql() method

    • AURORA_POSTGRESQL

      @Stability(Stable) public static final IClusterEngine AURORA_POSTGRESQL
      The unversioned 'aurora-postgresql' cluster engine.

      Note: we do not recommend using unversioned engines for non-serverless Clusters, as that can pose an availability risk. We recommend using versioned engines created using the auroraPostgres() method

  • Constructor Details

    • DatabaseClusterEngine

      protected DatabaseClusterEngine(software.amazon.jsii.JsiiObjectRef objRef)

    • DatabaseClusterEngine

      protected DatabaseClusterEngine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • DatabaseClusterEngine

      @Stability(Stable) public DatabaseClusterEngine()

  • Method Details

    • aurora

      @Stability(Deprecated) @Deprecated @NotNull public static IClusterEngine aurora(@NotNull AuroraClusterEngineProps props)
      Deprecated.
      use auroraMysql() instead
      (deprecated) Creates a new plain Aurora database cluster engine.

      Parameters:
      props - This parameter is required.

    • auroraMysql

      @Stability(Stable) @NotNull public static IClusterEngine auroraMysql(@NotNull AuroraMysqlClusterEngineProps props)
      Creates a new Aurora MySQL database cluster engine.

      Parameters:
      props - This parameter is required.

    • auroraPostgres

      @Stability(Stable) @NotNull public static IClusterEngine auroraPostgres(@NotNull AuroraPostgresClusterEngineProps props)
      Creates a new Aurora PostgreSQL database cluster engine.

      Parameters:
      props - This parameter is required.