# API Reference ## Constructs ### TableViewer Installs an endpoint in your stack that allows users to view the contents of a DynamoDB table through their browser. #### Initializers ```typescript import { TableViewer } from 'cdk-dynamo-table-viewer' new TableViewer(parent: Construct, id: string, props: TableViewerProps) ``` ##### `parent`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Required - *Type:* [`cdk-dynamo-table-viewer.TableViewerProps`](#cdk-dynamo-table-viewer.TableViewerProps) --- #### Properties ##### `endpoint`Required ```typescript public readonly endpoint: string; ``` - *Type:* `string` --- ## Structs ### TableViewerProps #### Initializer ```typescript import { TableViewerProps } from 'cdk-dynamo-table-viewer' const tableViewerProps: TableViewerProps = { ... } ``` ##### `table`Required ```typescript public readonly table: Table; ``` - *Type:* [`aws-cdk-lib.aws_dynamodb.Table`](#aws-cdk-lib.aws_dynamodb.Table) The DynamoDB table to view. Note that all contents of this table will be visible to the public. --- ##### `endpointType`Optional ```typescript public readonly endpointType: EndpointType; ``` - *Type:* [`aws-cdk-lib.aws_apigateway.EndpointType`](#aws-cdk-lib.aws_apigateway.EndpointType) - *Default:* EDGE The endpoint type of the [LambdaRestApi](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.LambdaRestApi.html) that will be created. --- ##### `sortBy`Optional ```typescript public readonly sortBy: string; ``` - *Type:* `string` - *Default:* No sort Name of the column to sort by, prefix with "-" for descending order. --- ##### `title`Optional ```typescript public readonly title: string; ``` - *Type:* `string` - *Default:* No title The web page title. ---