Package software.amazon.awscdk.services.dynamodb

Interface AutoscaledCapacityOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AutoscaledCapacityOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)",
           date="2023-10-26T00:56:06.511Z")
@Stability(Stable)
public interface AutoscaledCapacityOptions
extends software.amazon.jsii.JsiiSerializable

Options used to configure autoscaled capacity.

Example:

 TableV2 table = TableV2.Builder.create(this, "Table")
         .partitionKey(Attribute.builder().name("pk").type(AttributeType.STRING).build())
         .billing(Billing.provisioned(ThroughputProps.builder()
                 .readCapacity(Capacity.fixed(10))
                 .writeCapacity(Capacity.autoscaled(AutoscaledCapacityOptions.builder().maxCapacity(10).build()))
                 .build()))
         .globalSecondaryIndexes(List.of(GlobalSecondaryIndexPropsV2.builder()
                 .indexName("gsi1")
                 .partitionKey(Attribute.builder().name("pk").type(AttributeType.STRING).build())
                 .readCapacity(Capacity.fixed(15))
                 .build(), GlobalSecondaryIndexPropsV2.builder()
                 .indexName("gsi2")
                 .partitionKey(Attribute.builder().name("pk").type(AttributeType.STRING).build())
                 .writeCapacity(Capacity.autoscaled(AutoscaledCapacityOptions.builder().minCapacity(5).maxCapacity(20).build()))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AutoscaledCapacityOptions.Builder	A builder for AutoscaledCapacityOptions
static final class	AutoscaledCapacityOptions.Jsii$Proxy	An implementation for AutoscaledCapacityOptions

Method Summary

Modifier and Type	Method	Description
static AutoscaledCapacityOptions.Builder	builder()
Number	getMaxCapacity()	The maximum allowable capacity.
default Number	getMinCapacity()	The minimum allowable capacity.
default Number	getTargetUtilizationPercent()	The ratio of consumed capacity units to provisioned capacity units.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaxCapacity

@Stability(Stable)
@NotNull
Number getMaxCapacity()

The maximum allowable capacity.

getMinCapacity

@Stability(Stable)
@Nullable
default Number getMinCapacity()

The minimum allowable capacity.

Default: 1

getTargetUtilizationPercent

@Stability(Stable)
@Nullable
default Number getTargetUtilizationPercent()

The ratio of consumed capacity units to provisioned capacity units.

Note: Target utilization percent cannot be less than 20 and cannot be greater than 90.

Default: 70

builder

@Stability(Stable)
static AutoscaledCapacityOptions.Builder builder()

Returns:

a AutoscaledCapacityOptions.Builder of AutoscaledCapacityOptions