dynamotableviewer

README

cdk-dynamo-table-viewer

An AWS CDK construct which exposes a public HTTP endpoint which displays an HTML page with the contents of a DynamoDB table in your stack.

SECURITY NOTE: this construct was built for demonstration purposes and using it in production is probably a really bad idea. It exposes the entire contents of a DynamoDB table in your account to the general public.

The library is published under the following names:

Language	Repository
JavaScript/TypeScript	cdk-dynamo-table-viewer
Python	cdk-dynamo-table-viewer
.NET	Eladb.DynamoTableViewer
Java	com.github.eladb/cdk-dynamo-table-viewer
Go	github.com/cdklabs/cdk-dynamo-table-viewer-go/dynamotableviewer

Usage (TypeScript/JavaScript)

Install via npm:

$ npm i cdk-dynamo-table-viewer

Add to your CDK stack:

var cookiesTable table


viewer := dynamotableviewer.NewTableViewer(this, jsii.String("CookiesViewer"), &TableViewerProps{
	Table: cookiesTable,
	Title: jsii.String("Cookie Sales"),
	 // optional
	SortBy: jsii.String("-sales"),
})

Notes:

• The endpoint will be available (as an deploy-time value) under viewer.endpoint. It will also be exported as a stack output.
• Paging is not supported. This means that only the first 1MB of items will be displayed (again, this is a demo...)
• Supports CDK version 2.60.0 and above

License

Apache 2.0

Documentation

Overview

An AWS CDK construct which exposes an endpoint with the contents of a DynamoDB table

Index

• func NewTableViewer_Override(t TableViewer, parent constructs.Construct, id *string, ...)
• func TableViewer_IsConstruct(x interface{}) *bool
• type TableViewer
  • func NewTableViewer(parent constructs.Construct, id *string, props *TableViewerProps) TableViewer
• type TableViewerProps

Functions

func NewTableViewer_Override

func NewTableViewer_Override(t TableViewer, parent constructs.Construct, id *string, props *TableViewerProps)

Experimental.

func TableViewer_IsConstruct

func TableViewer_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

Types

type TableViewer

type TableViewer interface {
	constructs.Construct
	// Experimental.
	Endpoint() *string
	// The tree node.
	// Experimental.
	Node() constructs.Node
	// Returns a string representation of this construct.
	// Experimental.
	ToString() *string
}

Installs an endpoint in your stack that allows users to view the contents of a DynamoDB table through their browser. Experimental.

func NewTableViewer

func NewTableViewer(parent constructs.Construct, id *string, props *TableViewerProps) TableViewer

Experimental.

type TableViewerProps

type TableViewerProps struct {
	// The DynamoDB table to view.
	//
	// Note that all contents of this table will be
	// visible to the public.
	// Experimental.
	Table awsdynamodb.ITable `field:"required" json:"table" yaml:"table"`
	// 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.
	// Default: - EDGE.
	//
	// Experimental.
	EndpointType awsapigateway.EndpointType `field:"optional" json:"endpointType" yaml:"endpointType"`
	// Name of the column to sort by, prefix with "-" for descending order.
	// Default: - No sort.
	//
	// Experimental.
	SortBy *string `field:"optional" json:"sortBy" yaml:"sortBy"`
	// The web page title.
	// Default: - No title.
	//
	// Experimental.
	Title *string `field:"optional" json:"title" yaml:"title"`
}

Experimental.