com.amazonaws.services.rds.model

Class ScalingConfiguration

java.lang.Object

com.amazonaws.services.rds.model.ScalingConfiguration

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ScalingConfiguration
extends Object
implements Serializable, Cloneable

Contains the scaling configuration of an Aurora Serverless DB cluster.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScalingConfiguration()

Method Summary

Modifier and Type	Method and Description
ScalingConfiguration	clone()
boolean	equals(Object obj)
Boolean	getAutoPause() A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.
Integer	getMaxCapacity() The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
Integer	getMinCapacity() The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
Integer	getSecondsUntilAutoPause() The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
String	getTimeoutAction() The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
int	hashCode()
Boolean	isAutoPause() A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.
void	setAutoPause(Boolean autoPause) A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.
void	setMaxCapacity(Integer maxCapacity) The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
void	setMinCapacity(Integer minCapacity) The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
void	setSecondsUntilAutoPause(Integer secondsUntilAutoPause) The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
void	setTimeoutAction(String timeoutAction) The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
String	toString() Returns a string representation of this object.
ScalingConfiguration	withAutoPause(Boolean autoPause) A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.
ScalingConfiguration	withMaxCapacity(Integer maxCapacity) The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
ScalingConfiguration	withMinCapacity(Integer minCapacity) The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
ScalingConfiguration	withSecondsUntilAutoPause(Integer secondsUntilAutoPause) The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
ScalingConfiguration	withTimeoutAction(String timeoutAction) The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScalingConfiguration

public ScalingConfiguration()

Method Detail

setMinCapacity

public void setMinCapacity(Integer minCapacity)

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The minimum capacity must be less than or equal to the maximum capacity.

Parameters:

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The minimum capacity must be less than or equal to the maximum capacity.

getMinCapacity

public Integer getMinCapacity()

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The minimum capacity must be less than or equal to the maximum capacity.

Returns:

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The minimum capacity must be less than or equal to the maximum capacity.

withMinCapacity

public ScalingConfiguration withMinCapacity(Integer minCapacity)

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The minimum capacity must be less than or equal to the maximum capacity.

Parameters:

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The minimum capacity must be less than or equal to the maximum capacity.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxCapacity

public void setMaxCapacity(Integer maxCapacity)

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The maximum capacity must be greater than or equal to the minimum capacity.

Parameters:

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The maximum capacity must be greater than or equal to the minimum capacity.

getMaxCapacity

public Integer getMaxCapacity()

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The maximum capacity must be greater than or equal to the minimum capacity.

Returns:

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The maximum capacity must be greater than or equal to the minimum capacity.

withMaxCapacity

public ScalingConfiguration withMaxCapacity(Integer maxCapacity)

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The maximum capacity must be greater than or equal to the minimum capacity.

Parameters:

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The maximum capacity must be greater than or equal to the minimum capacity.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAutoPause

public void setAutoPause(Boolean autoPause)

A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. 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.

Parameters:

autoPause - A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. 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.

getAutoPause

public Boolean getAutoPause()

A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. 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.

Returns:

A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. 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.

withAutoPause

public ScalingConfiguration withAutoPause(Boolean autoPause)

A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. 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.

Parameters:

autoPause - A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isAutoPause

public Boolean isAutoPause()

A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. 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.

Returns:

A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. 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.

setSecondsUntilAutoPause

public void setSecondsUntilAutoPause(Integer secondsUntilAutoPause)

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

Parameters:

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

getSecondsUntilAutoPause

public Integer getSecondsUntilAutoPause()

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

Returns:

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

withSecondsUntilAutoPause

public ScalingConfiguration withSecondsUntilAutoPause(Integer secondsUntilAutoPause)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setTimeoutAction

public void setTimeoutAction(String timeoutAction)

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

ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

RollbackCapacityChange ignores the capacity change if a scaling point is not found in the timeout period.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

Parameters:

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

ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

RollbackCapacityChange ignores the capacity change if a scaling point is not found in the timeout period.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

getTimeoutAction

public String getTimeoutAction()

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

ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

RollbackCapacityChange ignores the capacity change if a scaling point is not found in the timeout period.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

Returns:

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

ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

RollbackCapacityChange ignores the capacity change if a scaling point is not found in the timeout period.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

withTimeoutAction

public ScalingConfiguration withTimeoutAction(String timeoutAction)

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

ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

RollbackCapacityChange ignores the capacity change if a scaling point is not found in the timeout period.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

Parameters:

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

ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

RollbackCapacityChange ignores the capacity change if a scaling point is not found in the timeout period.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ScalingConfiguration clone()

Overrides:

clone in class Object