aws-cdk-lib/aws-dynamodb/lib/billing.d.ts

Version 2 of the AWS Cloud Development Kit library

import { Capacity } from './capacity';
import { BillingMode } from './shared';
/**
 * Properties used to configure provisioned throughput for a DynamoDB table.
 */
export interface ThroughputProps {
    /**
     * The read capacity.
     */
    readonly readCapacity: Capacity;
    /**
     * The write capacity.
     */
    readonly writeCapacity: Capacity;
}
/**
 * Properties used to configure maximum throughput for an on-demand table.
 */
export interface MaxThroughputProps {
    /**
     * 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.
     */
    readonly maxReadRequestUnits?: number;
    /**
     * 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.
     */
    readonly maxWriteRequestUnits?: number;
}
/**
 * Represents how capacity is managed and how you are charged for read and write throughput
 * for a DynamoDB table.
 */
export declare abstract class Billing {
    readonly mode: BillingMode;
    /**
     * Flexible billing option capable of serving requests without capacity planning.
     *
     * Note: Billing mode will be PAY_PER_REQUEST.
     */
    static onDemand(props?: MaxThroughputProps): Billing;
    /**
     * Specify the number of reads and writes per second that you need for your application.
     *
     * @param props specify read and write capacity configurations.
     */
    static provisioned(props: ThroughputProps): Billing;
    private constructor();
    /**
     * @internal
     */
    abstract _renderReadCapacity(): any;
    /**
     * @internal
     */
    abstract _renderWriteCapacity(): any;
}