Package software.amazon.awscdk.services.rds

Interface ServerlessScalingOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ServerlessScalingOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-24T21:00:35.349Z") @Stability(Stable) public interface ServerlessScalingOptions extends software.amazon.jsii.JsiiSerializable
Options for configuring scaling on an Aurora Serverless cluster.

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

  • Method Details

    • getAutoPause

      @Stability(Stable) @Nullable default Duration getAutoPause()
      The time before an Aurora Serverless database cluster is paused.

      A database cluster can be paused only when it is idle (it has no connections). Auto pause time must be between 5 minutes and 1 day.

      If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

      Set to 0 to disable

      Default: - automatic pause enabled after 5 minutes

    • getMaxCapacity

      @Stability(Stable) @Nullable default AuroraCapacityUnit getMaxCapacity()
      The maximum capacity for an Aurora Serverless database cluster.

      Default: - determined by Aurora based on database engine

    • getMinCapacity

      @Stability(Stable) @Nullable default AuroraCapacityUnit getMinCapacity()
      The minimum capacity for an Aurora Serverless database cluster.

      Default: - determined by Aurora based on database engine

    • getTimeout

      @Stability(Stable) @Nullable default Duration getTimeout()
      The amount of time that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action.

      Default: - 5 minutes

    • getTimeoutAction

      @Stability(Stable) @Nullable default TimeoutAction getTimeoutAction()
      The action to take when the timeout is reached.

      Selecting ForceApplyCapacityChange will force the capacity to the specified value as soon as possible, even without a scaling point. Selecting RollbackCapacityChange will ignore the capacity change if a scaling point is not found. This is the default behavior.

      Default: - TimeoutAction.ROLLBACK_CAPACITY_CHANGE

    • builder

      @Stability(Stable) static ServerlessScalingOptions.Builder builder()
      Returns:
      a ServerlessScalingOptions.Builder of ServerlessScalingOptions