Skip to content

Commit

Permalink
Add docstring to KinesisStreamInput params
Browse files Browse the repository at this point in the history
  • Loading branch information
Lee Hannigan committed Oct 19, 2024
1 parent 8addf83 commit 0ea5bd9
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions packages/aws-cdk-lib/aws-dynamodb/lib/table-v2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,6 @@ export interface TableOptionsV2 {
/**
* Kinesis Data Stream to capture item level changes.
* can supply either a Stream or a KinesisStreamInput
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-kinesisstreamspecification.html
* @default - no Kinesis Data Stream
*/
readonly kinesisStream?: IStream | KinesisStreamInput;
Expand Down Expand Up @@ -358,7 +357,10 @@ export interface TableAttributesV2 {
*/
readonly grantIndexPermissions?: boolean;
}

/**
* @param - steam kinesis data stream
* @param - approximateCreationDateTimePrecision Optional timestamp precision for stream records
*/
export interface KinesisStreamInput {
/**
* A Kinesis Stream
Expand Down

0 comments on commit 0ea5bd9

Please sign in to comment.