Package software.amazon.awscdk.services.dynamodb

Interface MaxThroughputProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

MaxThroughputProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:38.762Z")
@Stability(Stable)
public interface MaxThroughputProps
extends software.amazon.jsii.JsiiSerializable

Properties used to configure maximum throughput for an on-demand table.

Example:

 TableV2 table = TableV2.Builder.create(this, "Table")
         .partitionKey(Attribute.builder().name("pk").type(AttributeType.STRING).build())
         .billing(Billing.onDemand(MaxThroughputProps.builder()
                 .maxReadRequestUnits(100)
                 .maxWriteRequestUnits(115)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MaxThroughputProps.Builder	builder()
default Number	getMaxReadRequestUnits()	The max read request units.
default Number	getMaxWriteRequestUnits()	The max write request units.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaxReadRequestUnits

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

The max read request units.

Default: - if table mode is on-demand and this property is undefined, no maximum throughput limit will be put in place for read requests. This property is only applicable for tables using on-demand mode.

getMaxWriteRequestUnits

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

The max write request units.

Default: - if table mode is on-demand and this property is undefined, no maximum throughput limit will be put in place for write requests. This property is only applicable for tables using on-demand mode.

builder

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

Returns:

a MaxThroughputProps.Builder of MaxThroughputProps