Interface TableOptions
Synopsis
Properties
| billingMode | Specify how you are charged for read and write throughput and how you manage capacity. Provisioned |
| partitionKey | Partition key attribute definition. |
| pointInTimeRecovery | Whether point-in-time recovery is enabled. - point-in-time recovery is disabled |
| readCapacity | The read capacity for the table. Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput. |
| removalPolicy | The removal policy to apply to the DynamoDB Table. |
| serverSideEncryption | Whether server-side encryption with an AWS managed customer master key is enabled. - server-side encryption is enabled with an AWS owned customer master key |
| sortKey | Table sort key attribute definition. |
| stream | When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. |
| timeToLiveAttribute | The name of TTL attribute. - TTL is disabled |
| writeCapacity | The write capacity for the table. Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput. |
Properties
billingMode
Specify how you are charged for read and write throughput and how you manage capacity. Provisioned
Declaration
readonly billingMode?: BillingMode;Property Value
partitionKey
Partition key attribute definition.
Declaration
readonly partitionKey: Attribute;Property Value
pointInTimeRecovery
Whether point-in-time recovery is enabled. - point-in-time recovery is disabled
Declaration
readonly pointInTimeRecovery?: boolean;Property Value
boolean
readCapacity
The read capacity for the table. Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput.
Can only be provided if billingMode is Provisioned.
5
Declaration
readonly readCapacity?: number;Property Value
number
removalPolicy
The removal policy to apply to the DynamoDB Table.
RemovalPolicy.RETAIN
Declaration
readonly removalPolicy?: RemovalPolicy;Property Value
serverSideEncryption
Whether server-side encryption with an AWS managed customer master key is enabled. - server-side encryption is enabled with an AWS owned customer master key
Declaration
readonly serverSideEncryption?: boolean;Property Value
boolean
sortKey
Table sort key attribute definition.
no sort key
Declaration
readonly sortKey?: Attribute;Property Value
stream
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.
- streams are disabled
Declaration
readonly stream?: StreamViewType;Property Value
timeToLiveAttribute
The name of TTL attribute. - TTL is disabled
Declaration
readonly timeToLiveAttribute?: string;Property Value
string
writeCapacity
The write capacity for the table. Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput.
Can only be provided if billingMode is Provisioned.
5
Declaration
readonly writeCapacity?: number;Property Value
number