Recently, I have started using the AWS CDK and encountered a challenge. I want to allow end users to define custom input variables when using my AWS CDK without having to edit the entire code. While I have been able to work with standard types such as strings, numbers, and booleans, I am unsure of how to handle custom types. For instance, when attempting to create an AWS DynamoDB, I first defined an interface to ensure that users can input the required data accurately.
Below is the interface I created:
export interface IDynamoDB extends StackProps {
tableClass: unknow,
billingMode: unknown
sortKeyName: string,
sortKeyType: unknown,
partitionKeyName: string,
partitionKeyType: unknown
inTimeRecovery: boolean
}
Here is the corresponding class:
export class Ddb extends Stack {
constructor(scope: Construct, name: string, props: IDynamoDB) {
super(scope, name, props);
const table = new ddb.Table(this, name, {
tableName: name,
tableClass: ddb.TableClass.STANDARD,
billingMode: ddb.BillingMode.PROVISIONED,
sortKey: {
name: props.sortKeyName,
type: ddb.AttributeType.NUMBER
},
partitionKey: {
name: props.partitionKeyName,
type: ddb.AttributeType.STRING
},
})
}
}
Imports
import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import * as ddb from 'aws-cdk-lib/aws-dynamodb';
My issue lies with the interface where I used unknown as a type, and I am unsure how to simplify it further. Ideally, I would like to be able to just use a string as shown below:
ddb.TableClass.STANDARD = standartTableClass
I hope this explanation clarifies my problem.