Package software.amazon.awscdk.services.rds

Class ServerlessScalingOptions.Builder

java.lang.Object

software.amazon.awscdk.services.rds.ServerlessScalingOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ServerlessScalingOptions>

Enclosing interface:

ServerlessScalingOptions

@Stability(Stable)
public static final class ServerlessScalingOptions.Builder
extends Object
implements software.amazon.jsii.Builder<ServerlessScalingOptions>

A builder for ServerlessScalingOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ServerlessScalingOptions.Builder	autoPause(Duration autoPause)	Sets the value of ServerlessScalingOptions.getAutoPause()
ServerlessScalingOptions	build()	Builds the configured instance.
ServerlessScalingOptions.Builder	maxCapacity(AuroraCapacityUnit maxCapacity)	Sets the value of ServerlessScalingOptions.getMaxCapacity()
ServerlessScalingOptions.Builder	minCapacity(AuroraCapacityUnit minCapacity)	Sets the value of ServerlessScalingOptions.getMinCapacity()
ServerlessScalingOptions.Builder	timeout(Duration timeout)	Sets the value of ServerlessScalingOptions.getTimeout()
ServerlessScalingOptions.Builder	timeoutAction(TimeoutAction timeoutAction)	Sets the value of ServerlessScalingOptions.getTimeoutAction()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

autoPause

@Stability(Stable)
public ServerlessScalingOptions.Builder autoPause(Duration autoPause)

Sets the value of ServerlessScalingOptions.getAutoPause()

Parameters:

autoPause - 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

Returns:

this

maxCapacity

@Stability(Stable)
public ServerlessScalingOptions.Builder maxCapacity(AuroraCapacityUnit maxCapacity)

Sets the value of ServerlessScalingOptions.getMaxCapacity()

Parameters:

maxCapacity - The maximum capacity for an Aurora Serverless database cluster.

Returns:

this

minCapacity

@Stability(Stable)
public ServerlessScalingOptions.Builder minCapacity(AuroraCapacityUnit minCapacity)

Sets the value of ServerlessScalingOptions.getMinCapacity()

Parameters:

minCapacity - The minimum capacity for an Aurora Serverless database cluster.

Returns:

this

timeout

@Stability(Stable)
public ServerlessScalingOptions.Builder timeout(Duration timeout)

Sets the value of ServerlessScalingOptions.getTimeout()

Parameters:

timeout - The amount of time that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action.

Returns:

this

timeoutAction

@Stability(Stable)
public ServerlessScalingOptions.Builder timeoutAction(TimeoutAction timeoutAction)

Sets the value of ServerlessScalingOptions.getTimeoutAction()

Parameters:

timeoutAction - 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.

Returns:

this

build

@Stability(Stable)
public ServerlessScalingOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ServerlessScalingOptions>

Returns:

a new instance of ServerlessScalingOptions

Throws:

NullPointerException - if any required attribute was not provided