com.amazonaws.services.keyspaces.model

Class AutoScalingSettings

java.lang.Object

com.amazonaws.services.keyspaces.model.AutoScalingSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The optional auto scaling settings for a table with provisioned throughput capacity.

To turn on auto scaling for a table in throughputMode:PROVISIONED, you must specify the following parameters.

Configure the minimum and maximum capacity units. The auto scaling policy ensures that capacity never goes below the minimum or above the maximum range.

• minimumUnits: The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

• maximumUnits: The maximum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

• scalingPolicy: Amazon Keyspaces supports the target tracking scaling policy. The auto scaling target is the provisioned capacity of the table.

  • targetTrackingScalingPolicyConfiguration: To define the target tracking policy, you must define the target value.

    • targetValue: The target utilization rate of the table. Amazon Keyspaces auto scaling ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90. (Required)

    • disableScaleIn: A boolean that specifies if scale-in is disabled or enabled for the table. This parameter is disabled by default. To turn on scale-in, set the boolean value to FALSE. This means that capacity for a table can be automatically scaled down on your behalf. (Optional)

    • scaleInCooldown: A cooldown period in seconds between scaling activities that lets the table stabilize before another scale in activity starts. If no value is provided, the default is 0. (Optional)

    • scaleOutCooldown: A cooldown period in seconds between scaling activities that lets the table stabilize before another scale out activity starts. If no value is provided, the default is 0. (Optional)

For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AutoScalingSettings()

Method Summary

Modifier and Type	Method and Description
AutoScalingSettings	clone()
boolean	equals(Object obj)
Boolean	getAutoScalingDisabled() This optional parameter enables auto scaling for the table if set to false.
Long	getMaximumUnits() Manage costs by specifying the maximum amount of throughput to provision.
Long	getMinimumUnits() The minimum level of throughput the table should always be ready to support.
AutoScalingPolicy	getScalingPolicy() Amazon Keyspaces supports the target tracking auto scaling policy.
int	hashCode()
Boolean	isAutoScalingDisabled() This optional parameter enables auto scaling for the table if set to false.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAutoScalingDisabled(Boolean autoScalingDisabled) This optional parameter enables auto scaling for the table if set to false.
void	setMaximumUnits(Long maximumUnits) Manage costs by specifying the maximum amount of throughput to provision.
void	setMinimumUnits(Long minimumUnits) The minimum level of throughput the table should always be ready to support.
void	setScalingPolicy(AutoScalingPolicy scalingPolicy) Amazon Keyspaces supports the target tracking auto scaling policy.
String	toString() Returns a string representation of this object.
AutoScalingSettings	withAutoScalingDisabled(Boolean autoScalingDisabled) This optional parameter enables auto scaling for the table if set to false.
AutoScalingSettings	withMaximumUnits(Long maximumUnits) Manage costs by specifying the maximum amount of throughput to provision.
AutoScalingSettings	withMinimumUnits(Long minimumUnits) The minimum level of throughput the table should always be ready to support.
AutoScalingSettings	withScalingPolicy(AutoScalingPolicy scalingPolicy) Amazon Keyspaces supports the target tracking auto scaling policy.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AutoScalingSettings

public AutoScalingSettings()

Method Detail

setAutoScalingDisabled

public void setAutoScalingDisabled(Boolean autoScalingDisabled)

This optional parameter enables auto scaling for the table if set to false.

Parameters:

autoScalingDisabled - This optional parameter enables auto scaling for the table if set to false.

getAutoScalingDisabled

public Boolean getAutoScalingDisabled()

This optional parameter enables auto scaling for the table if set to false.

Returns:

This optional parameter enables auto scaling for the table if set to false.

withAutoScalingDisabled

public AutoScalingSettings withAutoScalingDisabled(Boolean autoScalingDisabled)

This optional parameter enables auto scaling for the table if set to false.

Parameters:

autoScalingDisabled - This optional parameter enables auto scaling for the table if set to false.

Returns:

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

isAutoScalingDisabled

public Boolean isAutoScalingDisabled()

This optional parameter enables auto scaling for the table if set to false.

Returns:

This optional parameter enables auto scaling for the table if set to false.

setMinimumUnits

public void setMinimumUnits(Long minimumUnits)

The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

Parameters:

minimumUnits - The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

getMinimumUnits

public Long getMinimumUnits()

The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

Returns:

The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

withMinimumUnits

public AutoScalingSettings withMinimumUnits(Long minimumUnits)

The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

Parameters:

minimumUnits - The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

Returns:

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

setMaximumUnits

public void setMaximumUnits(Long maximumUnits)

Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

Parameters:

maximumUnits - Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

getMaximumUnits

public Long getMaximumUnits()

Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

Returns:

Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

withMaximumUnits

public AutoScalingSettings withMaximumUnits(Long maximumUnits)

Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

Parameters:

maximumUnits - Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

Returns:

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

setScalingPolicy

public void setScalingPolicy(AutoScalingPolicy scalingPolicy)

Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

Parameters:

scalingPolicy - Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

getScalingPolicy

public AutoScalingPolicy getScalingPolicy()

Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

Returns:

Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

withScalingPolicy

public AutoScalingSettings withScalingPolicy(AutoScalingPolicy scalingPolicy)

Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

Parameters:

scalingPolicy - Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

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 AutoScalingSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.