Class CfnDBCluster.ScalingConfigurationProperty

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless v1 DB cluster.

Inheritance

object

CfnDBCluster.ScalingConfigurationProperty

Implements

CfnDBCluster.IScalingConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDBCluster.ScalingConfigurationProperty : CfnDBCluster.IScalingConfigurationProperty

Syntax (vb)

Public Class CfnDBCluster.ScalingConfigurationProperty Implements CfnDBCluster.IScalingConfigurationProperty

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html

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

Constructors

ScalingConfigurationProperty()

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless v1 DB cluster.

Properties

AutoPause	Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in `serverless` DB engine mode.
MaxCapacity	The maximum capacity for an Aurora DB cluster in `serverless` DB engine mode.
MinCapacity	The minimum capacity for an Aurora DB cluster in `serverless` DB engine mode.
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 `serverless` mode is paused.
TimeoutAction	The action to take when the timeout is reached, either `ForceApplyCapacityChange` or `RollbackCapacityChange` .

Constructors

ScalingConfigurationProperty()

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless v1 DB cluster.

public ScalingConfigurationProperty()

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html

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"
             };

Properties

AutoPause

Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.

public object? AutoPause { get; set; }

Property Value

object

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-autopause

MaxCapacity

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

public double? MaxCapacity { get; set; }

Property Value

double?

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-maxcapacity

MinCapacity

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

public double? MinCapacity { get; set; }

Property Value

double?

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-mincapacity

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.

public double? SecondsBeforeTimeout { get; set; }

Property Value

double?

Remarks

The default is 300.

Specify a value between 60 and 600 seconds.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-secondsbeforetimeout

SecondsUntilAutoPause

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

public double? SecondsUntilAutoPause { get; set; }

Property Value

double?

Remarks

Specify a value between 300 and 86,400 seconds.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-secondsuntilautopause

TimeoutAction

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .

public string? TimeoutAction { get; set; }

Property Value

string

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-timeoutaction

Implements

CfnDBCluster.IScalingConfigurationProperty