Class ServerlessScalingOptions
Options for configuring scaling on an Aurora Serverless v1 Cluster.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ServerlessScalingOptions : Object, IServerlessScalingOptions
Syntax (vb)
Public Class ServerlessScalingOptions
Inherits Object
Implements IServerlessScalingOptions
Remarks
ExampleMetadata: infused
Examples
Vpc vpc;
var cluster = new ServerlessCluster(this, "AnotherCluster", new ServerlessClusterProps {
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 = new ServerlessScalingOptions {
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
}
});
Synopsis
Constructors
ServerlessScalingOptions() |
Properties
AutoPause | The time before an Aurora Serverless database cluster is paused. |
MaxCapacity | The maximum capacity for an Aurora Serverless database cluster. |
MinCapacity | The minimum capacity for an Aurora Serverless database cluster. |
Timeout | The amount of time that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. |
TimeoutAction | The action to take when the timeout is reached. |
Constructors
ServerlessScalingOptions()
public ServerlessScalingOptions()
Properties
AutoPause
The time before an Aurora Serverless database cluster is paused.
public Duration AutoPause { get; set; }
Property Value
Remarks
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
MaxCapacity
The maximum capacity for an Aurora Serverless database cluster.
public Nullable<AuroraCapacityUnit> MaxCapacity { get; set; }
Property Value
System.Nullable<AuroraCapacityUnit>
Remarks
Default: - determined by Aurora based on database engine
MinCapacity
The minimum capacity for an Aurora Serverless database cluster.
public Nullable<AuroraCapacityUnit> MinCapacity { get; set; }
Property Value
System.Nullable<AuroraCapacityUnit>
Remarks
Default: - determined by Aurora based on database engine
Timeout
The amount of time that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action.
public Duration Timeout { get; set; }
Property Value
Remarks
Default: - 5 minutes
TimeoutAction
The action to take when the timeout is reached.
public Nullable<TimeoutAction> TimeoutAction { get; set; }
Property Value
System.Nullable<TimeoutAction>
Remarks
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