@pwrdrvr/microapps-cdk
Version:
MicroApps framework, by PwrDrvr LLC, delivered as an AWS CDK construct that provides the DynamoDB, Router service, Deploy service, API Gateway, and CloudFront distribution.
54 lines (53 loc) • 1.61 kB
TypeScript
import { RemovalPolicy } from 'aws-cdk-lib';
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import { Construct } from 'constructs';
/**
* Properties to initialize an instance of `MicroAppsTable`.
*/
export interface MicroAppsTableProps {
/**
* RemovalPolicy override for child resources
*
* Note: if set to DESTROY the S3 buckes will have `autoDeleteObjects` set to `true`
*
* @default - per resource default
*/
readonly removalPolicy?: RemovalPolicy;
/**
* Optional asset name root
*
* @example microapps
* @default - resource names auto assigned
*/
readonly assetNameRoot?: string;
/**
* Optional asset name suffix
*
* @example -dev-pr-12
* @default none
*/
readonly assetNameSuffix?: string;
}
/**
* Represents a MicroAppsTable
*/
export interface IMicroAppsTable {
/**
* DynamoDB table used by Router, Deployer, and Release console app
*/
readonly table: dynamodb.Table;
}
/**
* Create a new MicroApps Table for apps / versions / rules
*
* @warning This construct is not intended for production use.
* In a production stack the DynamoDB Table, API Gateway, S3 Buckets,
* etc. should be created in a "durable" stack where the IDs will not
* change and where changes to the MicroApps construct will not
* cause failures to deploy or data to be deleted.
*/
export declare class MicroAppsTable extends Construct implements IMicroAppsTable {
private _table;
get table(): dynamodb.Table;
constructor(scope: Construct, id: string, props?: MicroAppsTableProps);
}