Interface CfnDBCluster.IScalingConfigurationProperty
The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless v1 DB cluster.
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnDBCluster.IScalingConfigurationPropertySyntax (vb)
Public Interface CfnDBCluster.IScalingConfigurationPropertyRemarks
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ServerlessV2ScalingConfiguration property.
Valid for: Aurora Serverless v1 DB clusters only
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;
var scalingConfigurationProperty = new ScalingConfigurationProperty {
AutoPause = false,
MaxCapacity = 123,
MinCapacity = 123,
SecondsBeforeTimeout = 123,
SecondsUntilAutoPause = 123,
TimeoutAction = "timeoutAction"
};Synopsis
Properties
| AutoPause | Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in |
| MaxCapacity | The maximum capacity for an Aurora DB cluster in |
| MinCapacity | The minimum capacity for an Aurora DB cluster in |
| SecondsBeforeTimeout | The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. |
| SecondsUntilAutoPause | The time, in seconds, before an Aurora DB cluster in |
| TimeoutAction | The action to take when the timeout is reached, either |
Properties
AutoPause
Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.
object? AutoPause { get; }Property Value
Remarks
A DB cluster can be paused only when it's idle (it has no connections).
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.
Type union: either bool or IResolvable
MaxCapacity
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
double? MaxCapacity { get; }Property Value
Remarks
For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .
For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .
The maximum capacity must be greater than or equal to the minimum capacity.
MinCapacity
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
double? MinCapacity { get; }Property Value
Remarks
For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .
For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .
The minimum capacity must be less than or equal to the maximum capacity.
SecondsBeforeTimeout
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action.
double? SecondsBeforeTimeout { get; }Property Value
Remarks
The default is 300.
Specify a value between 60 and 600 seconds.
SecondsUntilAutoPause
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
double? SecondsUntilAutoPause { get; }Property Value
Remarks
Specify a value between 300 and 86,400 seconds.
TimeoutAction
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .
string? TimeoutAction { get; }Property Value
Remarks
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange , the default, ignores the capacity change if a scaling point isn't found in the timeout period.
If you specify <code>ForceApplyCapacityChange</code> , connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide .