@gradientedge/cdk-utils 4.4.1 → 4.4.2

package/src/lib/types/aws/index.ts

@@ -24,7 +24,8 @@ import * as wafv2 from 'aws-cdk-lib/aws-wafv2'
 import * as types from '../index'
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.app-config-manager
+ * @subcategory Properties
  */
 export interface AppConfigProps {
   id: string
@@ -36,7 +37,8 @@ export interface AppConfigProps {
 }
 
 /**
- * @category Constructs
+ * @category cdk-utils.common-stack
+ * @subcategory Properties
  */
 export interface CommonStackProps extends cdk.StackProps {
   name: string
@@ -49,7 +51,8 @@ export interface CommonStackProps extends cdk.StackProps {
 }
 
 /**
- * @category Constructs
+ * @category cdk-utils.site-with-ecs-backend
+ * @subcategory Properties
  */
 export interface SiteWithEcsBackendProps extends CommonStackProps {
   siteCacheInvalidationDockerFilePath?: string
@@ -73,7 +76,8 @@ export interface SiteWithEcsBackendProps extends CommonStackProps {
 }
 
 /**
- * @category Constructs
+ * @category cdk-utils.static-site
+ * @subcategory Properties
  */
 export interface StaticSiteProps extends CommonStackProps {
   siteCreateAltARecord: boolean
@@ -95,7 +99,8 @@ export interface StaticSiteProps extends CommonStackProps {
 }
 
 /**
- * @category Compute
+ * @category cdk-utils.site-with-ecs-backend
+ * @subcategory Properties
  */
 export interface HealthCheck extends elb.HealthCheck {
   intervalInSecs: number
@@ -103,7 +108,8 @@ export interface HealthCheck extends elb.HealthCheck {
 }
 
 /**
- * @category Constructs
+ * @category cdk-utils.lambda-manager
+ * @subcategory Types
  */
 export interface LambdaEnvironment {
   NODE_ENV: string
@@ -112,19 +118,22 @@ export interface LambdaEnvironment {
 }
 
 /**
- * @category Constructs
+ * @category cdk-utils.api-to-eventbridge-target
+ * @subcategory Types
  */
 export interface ApiDestinedLambdaEnvironment extends LambdaEnvironment {
   SOURCE_ID: string
 }
 
 /**
- * @category Constructs
+ * @category cdk-utils.graphql-api-lambda
+ * @subcategory Types
  */
 export interface GraphQlApiLambdaEnvironment extends LambdaEnvironment {}
 
 /**
- * @category Constructs
+ * @category cdk-utils.graphql-api-lambda
+ * @subcategory Properties
  */
 export interface GraphQlApiLambdaProps extends CommonStackProps {
   apiRootPaths?: string[]
@@ -142,7 +151,8 @@ export interface GraphQlApiLambdaProps extends CommonStackProps {
 }
 
 /**
- * @category Constructs
+ * @category cdk-utils.api-to-eventbridge-target
+ * @subcategory Types
  */
 export interface ApiDestinationEventType {
   eventBus: events.IEventBus
@@ -153,8 +163,8 @@ export interface ApiDestinationEventType {
 }
 
 /**
- }
- * @category Constructs
+ * @category cdk-utils.api-to-eventbridge-target
+ * @subcategory Types
  */
 export interface ApiDestinedRestApiType {
   api: apig.RestApi
@@ -177,8 +187,8 @@ export interface ApiDestinedRestApiType {
 }
 
 /**
- }
- * @category Constructs
+ * @category cdk-utils.api-to-eventbridge-target
+ * @subcategory Types
  */
 export interface ApiDestinedLambdaType {
   destinationFailure: destinations.EventBridgeDestination
@@ -190,6 +200,10 @@ export interface ApiDestinedLambdaType {
   role: iam.Role
 }
 
+/**
+ * @category cdk-utils.api-to-eventbridge-target
+ * @subcategory Properties
+ */
 export interface ApiToEventBridgeTargetRestApiProps {
   certificate: AcmProps
   integrationResponse?: apig.IntegrationResponse
@@ -204,7 +218,8 @@ export interface ApiToEventBridgeTargetRestApiProps {
 }
 
 /**
- * @category Constructs
+ * @category cdk-utils.api-to-eventbridge-target
+ * @subcategory Properties
  */
 interface ApiToEventBridgeTargetLambdaProps {
   useNative?: boolean
@@ -214,7 +229,8 @@ interface ApiToEventBridgeTargetLambdaProps {
 }
 
 /**
- * @category Constructs
+ * @category cdk-utils.api-to-eventbridge-target
+ * @subcategory Properties
  */
 interface ApiToEventBridgeTargetEventProps {
   eventBusName?: string
@@ -225,7 +241,8 @@ interface ApiToEventBridgeTargetEventProps {
 }
 
 /**
- * @category Constructs
+ * @category cdk-utils.api-to-eventbridge-target
+ * @subcategory Properties
  */
 export interface ApiToEventBridgeTargetProps extends CommonStackProps {
   apiRootPaths?: string[]
@@ -240,7 +257,8 @@ export interface ApiToEventBridgeTargetProps extends CommonStackProps {
 }
 
 /**
- * @category Security, Identity & Compliance
+ * @category cdk-utils.acm-manager
+ * @subcategory Properties
  */
 export interface AcmProps extends acm.CertificateProps {
   certificateSsmName?: string
@@ -252,7 +270,8 @@ export interface AcmProps extends acm.CertificateProps {
 }
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.ssm-manager
+ * @subcategory Properties
  */
 export interface SSMParameterReaderProps {
   parameterName: string
@@ -260,12 +279,14 @@ export interface SSMParameterReaderProps {
 }
 
 /**
- * @category Networking & Content Delivery
+ * @category cdk-utils.cloudfront-manager
+ * @subcategory Properties
  */
 export interface CloudFrontProps extends cloudfront.CloudFrontWebDistributionProps {}
 
 /**
- * @category Networking & Content Delivery
+ * @category cdk-utils.cloudfront-manager
+ * @subcategory Properties
  */
 export interface CloudfrontFunctionProps extends cloudfront.FunctionProps {
   functionFilePath: string
@@ -273,17 +294,20 @@ export interface CloudfrontFunctionProps extends cloudfront.FunctionProps {
 }
 
 /**
- * @category Networking & Content Delivery
+ * @category cdk-utils.cloudfront-manager
+ * @subcategory Properties
  */
 export interface DistributionProps extends cloudfront.DistributionProps {}
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.cloudtrail-manager
+ * @subcategory Properties
  */
 export interface CloudTrailProps extends cloudtrail.CfnTrailProps {}
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Properties
  */
 export interface DashboardProps extends watch.DashboardProps {
   positionX: number
@@ -291,7 +315,8 @@ export interface DashboardProps extends watch.DashboardProps {
 }
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Properties
  */
 export interface AlarmProps extends watch.AlarmProps {
   expression?: string
@@ -300,7 +325,8 @@ export interface AlarmProps extends watch.AlarmProps {
 }
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Properties
  */
 export interface MetricProps extends watch.MetricProps {
   stageSuffix: boolean
@@ -310,7 +336,8 @@ export interface MetricProps extends watch.MetricProps {
 }
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Properties
  */
 export interface TextWidgetProps extends watch.TextWidgetProps {
   positionX: number
@@ -318,7 +345,8 @@ export interface TextWidgetProps extends watch.TextWidgetProps {
 }
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Properties
  */
 export interface NumericWidgetProps extends watch.SingleValueWidgetProps {
   positionX: number
@@ -327,7 +355,8 @@ export interface NumericWidgetProps extends watch.SingleValueWidgetProps {
 }
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Properties
  */
 export interface GraphWidgetProps extends watch.GraphWidgetProps {
   positionX: number
@@ -336,7 +365,8 @@ export interface GraphWidgetProps extends watch.GraphWidgetProps {
 }
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Properties
  */
 export interface AlarmStatusWidgetProps extends watch.AlarmStatusWidgetProps {
   positionX: number
@@ -345,7 +375,8 @@ export interface AlarmStatusWidgetProps extends watch.AlarmStatusWidgetProps {
 }
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Properties
  */
 export interface LogQueryWidgetProps extends watch.LogQueryWidgetProps {
   positionX: number
@@ -353,17 +384,20 @@ export interface LogQueryWidgetProps extends watch.LogQueryWidgetProps {
 }
 
 /**
- * @category Containers
+ * @category cdk-utils.ecs-manager
+ * @subcategory Properties
  */
 export interface EcsClusterProps extends ecs.ClusterProps {}
 
 /**
- * @category Containers
+ * @category cdk-utils.ecs-manager
+ * @subcategory Properties
  */
 export interface EcsTaskProps extends ecs.TaskDefinitionProps {}
 
 /**
- * @category Containers
+ * @category cdk-utils.eks-manager
+ * @subcategory Properties
  */
 export interface EksClusterProps extends eks.ClusterProps {
   appContainerPort: number
@@ -371,41 +405,48 @@ export interface EksClusterProps extends eks.ClusterProps {
 }
 
 /**
- * @category Application Integration
+ * @category cdk-utils.event-manager
+ * @subcategory Properties
  */
 export interface RuleProps extends events.CfnRuleProps {}
 
 /**
- * @category Application Integration
+ * @category cdk-utils.event-manager
+ * @subcategory Properties
  */
 export interface EventRuleProps extends events.RuleProps {}
 
 /**
- * @category Application Integration
+ * @category cdk-utils.event-manager
+ * @subcategory Properties
  */
 export interface EventBusProps extends events.EventBusProps {}
 
 /**
- * @category Compute
+ * @category cdk-utils.lambda-manager
+ * @subcategory Properties
  */
 export interface LambdaProps extends lambda.FunctionProps {
   timeoutInSecs?: number
 }
 
 /**
- * @category Compute
+ * @category cdk-utils.lambda-manager
+ * @subcategory Properties
  */
 export interface LambdaEdgeProps extends cloudfront.experimental.EdgeFunctionProps {
   timeoutInSecs?: number
 }
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Properties
  */
 export interface LogProps extends logs.LogGroupProps {}
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Properties
  */
 export interface MetricFilterProps extends logs.MetricFilterProps {
   periodInSecs: number
@@ -413,24 +454,31 @@ export interface MetricFilterProps extends logs.MetricFilterProps {
 }
 
 /**
- * @category Networking & Content Delivery
+ * @category cdk-utils.route53-manager
+ * @subcategory Properties
  */
 export interface Route53Props extends route53.HostedZoneProps {
   useExistingHostedZone?: boolean
 }
 
+/**
+ * @category cdk-utils.s3-manager
+ * @subcategory Properties
+ */
 export interface LifecycleRule extends s3.LifecycleRule {
   expirationInDays?: number
   noncurrentVersionExpirationInDays?: number
 }
 
 /**
- * @category Storage
+ * @category cdk-utils.dynamodb-manager
+ * @subcategory Properties
  */
 export interface TableProps extends dynamodb.TableProps {}
 
 /**
- * @category Storage
+ * @category cdk-utils.s3-manager
+ * @subcategory Properties
  */
 export interface S3BucketProps extends s3.BucketProps {
   enableEventBridge?: boolean
@@ -441,16 +489,19 @@ export interface S3BucketProps extends s3.BucketProps {
 }
 
 /**
- * @category Application Integration
+ * @category cdk-utils.sns-manager
+ * @subcategory Properties
  */
 export interface SubscriptionProps extends sns.TopicProps {}
 
 /**
- * @category Security, Identity & Compliance
+ * @category cdk-utils.waf-manager
+ * @subcategory Properties
  */
 export interface WafIPSetProps extends wafv2.CfnIPSetProps {}
 
 /**
- * @category Security, Identity & Compliance
+ * @category cdk-utils.waf-manager
+ * @subcategory Properties
  */
 export interface WafWebACLProps extends wafv2.CfnWebACLProps {}

package/src/lib/utils/aws/index.ts

@@ -3,7 +3,7 @@ import * as _ from 'lodash'
 import { CommonConstruct } from '../../common'
 
 /**
- * @category Utils
+ * @category cdk-utils.utils
  * @summary Helper method to add CloudFormation outputs from the construct
  * @param {string} id scoped id of the resource
  * @param {CommonConstruct} scope scope in which this resource is defined

package/src/lib/utils/index.ts

@@ -1,7 +1,7 @@
 export * from './aws'
 
 /**
- * @category Utils
+ * @category cdk-utils.utils
  */
 const defaultResponseObject = {
   statusCode: 200,
@@ -13,8 +13,7 @@ const defaultResponseObject = {
 }
 
 /**
- * @category Utils
- * LogLevel enumeration
+ * @category cdk-utils.utils
  */
 export enum LogLevel {
   DEBUG = 'DEBUG',
@@ -26,28 +25,28 @@ export enum LogLevel {
 }
 
 /**
- * @category Utils
+ * @category cdk-utils.utils
  * @param stage
  */
 export const isDevStage = (stage: string) => stage === 'dev'
 /**
- * @category Utils
+ * @category cdk-utils.utils
  * @param stage
  */
 export const isTestStage = (stage: string) => stage === 'tst'
 /**
- * @category Utils
+ * @category cdk-utils.utils
  * @param stage
  */
 export const isUatStage = (stage: string) => stage === 'uat'
 /**
- * @category Utils
+ * @category cdk-utils.utils
  * @param stage
  */
 export const isPrdStage = (stage: string) => stage === 'prd'
 
 /**
- * @category Utils
+ * @category cdk-utils.utils
  * @param error
  */
 export function redirectError(error: any) {
@@ -59,7 +58,7 @@ export function redirectError(error: any) {
 }
 
 /**
- * @category Utils
+ * @category cdk-utils.utils
  * @param message
  */
 export function redirectSuccess(message: any) {

package/theme/styles.css

@@ -0,0 +1,113 @@
+body {
+    font-family: Gotham, system-ui;
+!important;
+    color: #fff !important;
+}
+
+h1, h2, h3, h4, h5, h6 p, strong, span {
+    color: #fff !important;
+}
+
+.table {
+    background-color: rgb(35, 48, 68);
+}
+
+th, td, code {
+    color: #fff !important;
+}
+
+.param-type, .tag:not(body) {
+    background-color: rgb(71, 130, 218);
+    border-radius: 4px;
+}
+
+a {
+    color: #00e7eb !important;
+}
+
+.button {
+    background-color: #4782da;
+    color: #fff !important;
+}
+
+.mermaid {
+    background-color: #fff;
+}
+
+.mermaid span {
+    color: #000 !important;
+}
+
+.top-nav {
+    background-color: rgb(35, 48, 68);
+}
+
+#main, .core, .content {
+    background-color: rgb(27, 38, 53) !important;
+}
+
+.sidebar {
+    width: 450px !important;
+    border-right: none !important;
+}
+
+.side-nav {
+    width: 350px !important;
+    border-left: none !important;
+}
+
+.category h2 {
+    background: rgb(71, 130, 218);
+    border-radius: 25px;
+    color: #fff !important;
+    padding-left: 10px;
+    font-weight: bold;
+}
+
+.category h2:before {
+    content: '⇝';
+    padding-right: 10px;
+}
+
+.category h3 {
+    font-weight: bold;
+    color: #2b74b1;
+}
+
+.sidebar a:hover, .sidebar a.active, .side-nav a:hover, .side-nav a.is-active {
+    color: #ffdc7d !important;
+    font-weight: bold;
+}
+
+.logo h1 {
+    color: #fff;
+    font-weight: bold;
+}
+
+.link {
+    color: #fff !important;
+    font-weight: bold;
+}
+
+.dropdown-content {
+    background-color: rgb(27, 38, 53) !important;
+}
+
+#search {
+    background: none;
+    color: rgb(238, 238, 238);
+    border-color: #999999;
+    border-radius: 4px;
+}
+
+#search::placeholder {
+    color: rgb(238, 238, 238);
+}
+
+.logo .image img {
+    width: 4% !important;
+}
+
+.logo a {
+    display: inline-block;
+}