@sylvesterllc/aws-constructs 1.1.11 → 1.1.13

package/src/resources/gateway/CreateApiAndAttachLambdas.ts

@@ -1,162 +1,162 @@
-import { Construct } from "constructs";
-import { BaseResource } from "../base/baseResource";
-import { ITable } from "aws-cdk-lib/aws-dynamodb";
-import { AppConfig } from "../../config/AppConfig";
-import { ApiLambdaResult } from "../../interfaces/ApiLambdaResult";
-import { TsgAuthorizerType } from "../../config/types/TsgAuthorizerType";
-import { IRestApi, RequestAuthorizer, TokenAuthorizer } from "aws-cdk-lib/aws-apigateway";
-import { TsgJwtTokenAuthorizer } from "../lambda-authorizer/TsgJwtTokenAuthorizer";
-import { CfnOutput, RemovalPolicy } from "aws-cdk-lib";
-import { TsgRequestAuthorizer } from "../lambda-authorizer/TsgRequestAuthorizer";
-import { CreateLambda } from "../lambda/createLambda";
-import { LayerVersion } from "aws-cdk-lib/aws-lambda";
-import { NodejsFunction } from "aws-cdk-lib/aws-lambda-nodejs";
-import { TsgLambdaProp } from "../../config/types";
-import { Routes } from "../helpers/createRoutes";
-
-export class CreateApiAndAttachLambdas extends BaseResource<ApiLambdaResult> {
-
-    protected requireAuthorizer: boolean;
-    protected authorizerType?: TsgAuthorizerType;
-
-    private lambdas: NodejsFunction[] = [];
-    private lambdaRecords: Record<string, NodejsFunction> = {};
-
-    public get Lambdas() {
-        return this.lambdas;
-    }
-
-    public get LambdaRecords() {
-        return this.lambdaRecords;
-    }
-
-    constructor(scope: Construct,
-        config: AppConfig,
-        private gatewayApi: IRestApi,
-        private layers?: LayerVersion[],
-        private tables?: ITable[]) {
-        super(scope, config);
-
-        this.requireAuthorizer = (this.config.RESOURCES.AUTHORIZER &&
-            this.config.RESOURCES.AUTHORIZER.type) ? true : false;
-
-        if (this.requireAuthorizer) {
-            this.authorizerType = this.config.RESOURCES.AUTHORIZER?.type;
-        } else if (this.config.RESOURCES.AUTHORIZER && !this.config.RESOURCES.AUTHORIZER.type) {
-            throw new Error(`You must provide an authorizer type if a Authorizer is required`);
-        }
-
-        this.createdResources = this.createResource(scope)!;
-    }
-
-    protected createResource(scope: Construct): ApiLambdaResult[] | null {
-
-        let authorizer: TokenAuthorizer | RequestAuthorizer | undefined | null = undefined;
-
-        // Create Authorizer
-        if (this.requireAuthorizer) {
-            authorizer = this.createAuthorizer();
-
-            if (!authorizer) {
-                // console.log('Authorizer Not Created');
-            }
-            else {
-                // console.log('Authorizer Created', authorizer);
-            }
-        }
-
-        // Create Lambdas
-        const lambdas = new CreateLambda(scope, this.config, this.layers);
-        this.lambdas = lambdas.Lambdas;
-        this.lambdaRecords = this.lambdaRecords;
-
-        // Give Access to Lambdds to All DynamoDb Tables
-        if (this.tables) {
-            this.assignAccessToTables(this.tables, lambdas.Lambdas);
-        }
-
-        // Create Routes on API Gateway for Lambdas from config
-        this.AddRoutes(this.config, this.gatewayApi, lambdas.Lambdas, authorizer);
-
-        const result: ApiLambdaResult = {
-            api: this.gatewayApi,
-            authorizer: authorizer
-        };
-        return [result];
-    }
-
-    protected createOutput<T>(scope: Construct, createdAssets: T[]): void {
-
-        this.createdResources!.forEach((x, idx) => {
-            new CfnOutput(scope, `Authorizerr-${idx}`, {
-                value: x.authorizer?.authorizerArn!
-            });
-        });
-    }
-
-    private createAuthorizer() {
-
-        let authorizer: TokenAuthorizer | RequestAuthorizer | undefined = undefined;
-
-        if (this.requireAuthorizer && this.authorizerType === TsgAuthorizerType.TOKEN_AUTHORIZER) {
-
-            authorizer = new TsgJwtTokenAuthorizer(this.scope,
-                this.config).JwtAuthorizer;
-
-            (authorizer as TokenAuthorizer)?._attachToApi(this.gatewayApi);
-            (authorizer as TokenAuthorizer)?.applyRemovalPolicy(RemovalPolicy.DESTROY);
-
-            return authorizer;
-
-        } else if (this.requireAuthorizer && this.authorizerType === TsgAuthorizerType.REQUEST_AUTHORIZER) {
-
-            authorizer = new TsgRequestAuthorizer(this.scope,
-                this.config, this.layers, this.tables).TsgRequestAuthorizer as RequestAuthorizer;
-
-            (authorizer as RequestAuthorizer)._attachToApi(this.gatewayApi);
-            (authorizer as RequestAuthorizer).applyRemovalPolicy(RemovalPolicy.DESTROY);
-
-            return authorizer;
-        }
-
-
-        return authorizer;
-    }
-
-    private assignAccessToTables(tables: ITable[], lambdas: NodejsFunction[]) {
-
-        if (tables) {
-            lambdas.forEach((lambda: NodejsFunction) => {
-
-                tables.forEach((table: ITable) => {
-
-                    table.grantReadWriteData(lambda);
-
-                });
-            });
-        }
-    }
-
-    private AddRoutes(config: AppConfig,
-        gateway: IRestApi,
-        lambdas: NodejsFunction[],
-        authorizer?: TokenAuthorizer | RequestAuthorizer) {
-
-
-        config.RESOURCES.LAMBDA?.forEach((prop: TsgLambdaProp) => {
-
-            const lambdaId = CreateLambda.getIdForLambda(prop, this.config);
-
-            if (!lambdaId) {
-                throw new Error(`Can't find lambda`);
-            }
-            const lambdaNode = lambdas.find(x => x.node.id === lambdaId);
-
-            if (!lambdaNode) {
-                throw new Error("Can't find the Lambda Integration");
-            }
-
-            Routes.createResource(prop, gateway, lambdaNode, authorizer);
-        });
-    }
+import { Construct } from "constructs";
+import { BaseResource } from "../base/baseResource";
+import { ITable } from "aws-cdk-lib/aws-dynamodb";
+import { AppConfig } from "../../config/AppConfig";
+import { ApiLambdaResult } from "../../interfaces/ApiLambdaResult";
+import { TsgAuthorizerType } from "../../config/types/TsgAuthorizerType";
+import { IRestApi, RequestAuthorizer, TokenAuthorizer } from "aws-cdk-lib/aws-apigateway";
+import { TsgJwtTokenAuthorizer } from "../lambda-authorizer/TsgJwtTokenAuthorizer";
+import { CfnOutput, RemovalPolicy } from "aws-cdk-lib";
+import { TsgRequestAuthorizer } from "../lambda-authorizer/TsgRequestAuthorizer";
+import { CreateLambda } from "../lambda/createLambda";
+import { LayerVersion } from "aws-cdk-lib/aws-lambda";
+import { NodejsFunction } from "aws-cdk-lib/aws-lambda-nodejs";
+import { TsgLambdaProp } from "../../config/types";
+import { Routes } from "../helpers/createRoutes";
+
+export class CreateApiAndAttachLambdas extends BaseResource<ApiLambdaResult> {
+
+    protected requireAuthorizer: boolean;
+    protected authorizerType?: TsgAuthorizerType;
+
+    private lambdas: NodejsFunction[] = [];
+    private lambdaRecords: Record<string, NodejsFunction> = {};
+
+    public get Lambdas() {
+        return this.lambdas;
+    }
+
+    public get LambdaRecords() {
+        return this.lambdaRecords;
+    }
+
+    constructor(scope: Construct,
+        config: AppConfig,
+        private gatewayApi: IRestApi,
+        private layers?: LayerVersion[],
+        private tables?: ITable[]) {
+        super(scope, config);
+
+        this.requireAuthorizer = (this.config.RESOURCES.AUTHORIZER &&
+            this.config.RESOURCES.AUTHORIZER.type) ? true : false;
+
+        if (this.requireAuthorizer) {
+            this.authorizerType = this.config.RESOURCES.AUTHORIZER?.type;
+        } else if (this.config.RESOURCES.AUTHORIZER && !this.config.RESOURCES.AUTHORIZER.type) {
+            throw new Error(`You must provide an authorizer type if a Authorizer is required`);
+        }
+
+        this.createdResources = this.createResource(scope)!;
+    }
+
+    protected createResource(scope: Construct): ApiLambdaResult[] | null {
+
+        let authorizer: TokenAuthorizer | RequestAuthorizer | undefined | null = undefined;
+
+        // Create Authorizer
+        if (this.requireAuthorizer) {
+            authorizer = this.createAuthorizer();
+
+            if (!authorizer) {
+                // console.log('Authorizer Not Created');
+            }
+            else {
+                // console.log('Authorizer Created', authorizer);
+            }
+        }
+
+        // Create Lambdas
+        const lambdas = new CreateLambda(scope, this.config, this.layers);
+        this.lambdas = lambdas.Lambdas;
+        this.lambdaRecords = this.lambdaRecords;
+
+        // Give Access to Lambdds to All DynamoDb Tables
+        if (this.tables) {
+            this.assignAccessToTables(this.tables, lambdas.Lambdas);
+        }
+
+        // Create Routes on API Gateway for Lambdas from config
+        this.AddRoutes(this.config, this.gatewayApi, lambdas.Lambdas, authorizer);
+
+        const result: ApiLambdaResult = {
+            api: this.gatewayApi,
+            authorizer: authorizer
+        };
+        return [result];
+    }
+
+    protected createOutput<T>(scope: Construct, createdAssets: T[]): void {
+
+        this.createdResources!.forEach((x, idx) => {
+            new CfnOutput(scope, `Authorizerr-${idx}`, {
+                value: x.authorizer?.authorizerArn!
+            });
+        });
+    }
+
+    private createAuthorizer() {
+
+        let authorizer: TokenAuthorizer | RequestAuthorizer | undefined = undefined;
+
+        if (this.requireAuthorizer && this.authorizerType === TsgAuthorizerType.TOKEN_AUTHORIZER) {
+
+            authorizer = new TsgJwtTokenAuthorizer(this.scope,
+                this.config).JwtAuthorizer;
+
+            (authorizer as TokenAuthorizer)?._attachToApi(this.gatewayApi);
+            (authorizer as TokenAuthorizer)?.applyRemovalPolicy(RemovalPolicy.DESTROY);
+
+            return authorizer;
+
+        } else if (this.requireAuthorizer && this.authorizerType === TsgAuthorizerType.REQUEST_AUTHORIZER) {
+
+            authorizer = new TsgRequestAuthorizer(this.scope,
+                this.config, this.layers, this.tables).TsgRequestAuthorizer as RequestAuthorizer;
+
+            (authorizer as RequestAuthorizer)._attachToApi(this.gatewayApi);
+            (authorizer as RequestAuthorizer).applyRemovalPolicy(RemovalPolicy.DESTROY);
+
+            return authorizer;
+        }
+
+
+        return authorizer;
+    }
+
+    private assignAccessToTables(tables: ITable[], lambdas: NodejsFunction[]) {
+
+        if (tables) {
+            lambdas.forEach((lambda: NodejsFunction) => {
+
+                tables.forEach((table: ITable) => {
+
+                    table.grantReadWriteData(lambda);
+
+                });
+            });
+        }
+    }
+
+    private AddRoutes(config: AppConfig,
+        gateway: IRestApi,
+        lambdas: NodejsFunction[],
+        authorizer?: TokenAuthorizer | RequestAuthorizer) {
+
+
+        config.RESOURCES.LAMBDA?.forEach((prop: TsgLambdaProp) => {
+
+            const lambdaId = CreateLambda.getIdForLambda(prop, this.config);
+
+            if (!lambdaId) {
+                throw new Error(`Can't find lambda`);
+            }
+            const lambdaNode = lambdas.find(x => x.node.id === lambdaId);
+
+            if (!lambdaNode) {
+                throw new Error("Can't find the Lambda Integration");
+            }
+
+            Routes.createResource(prop, gateway, lambdaNode, authorizer);
+        });
+    }
 }

package/src/resources/gateway/createApi.ts

@@ -1,174 +1,174 @@
-import { CfnOutput, RemovalPolicy, Tag } from "aws-cdk-lib";
-import { BasePathMapping, Cors, CorsOptions, DomainName, EndpointType, IDomainName, IRestApi, MethodOptions, RestApi, RestApiProps, SecurityPolicy } from "aws-cdk-lib/aws-apigateway";
-import { ARecord, CnameRecord, HostedZone, IHostedZone, RecordTarget } from "aws-cdk-lib/aws-route53";
-import { ApiGateway, ApiGatewayDomain } from "aws-cdk-lib/aws-route53-targets";
-import { Construct } from "constructs";
-import { AppConfig } from "../../config/AppConfig";
-import { MicroserviceProps } from "../../interfaces/MicroserviceProps";
-
-import { BaseResource } from "../base/baseResource";
-import { CreateCertificate } from "../certificate/createCertificate";
-import { TsgApiKey } from "./createApiKey";
-
-
-export class Api extends BaseResource<IRestApi> {
-
-    private corsOptions: CorsOptions;
-
-
-    get APIs() {
-        return this.createdResources;
-    }
-
-    constructor(scope: Construct, config: AppConfig, private env: string) {
-        super(scope, config);
-
-        this.corsOptions = this.createDefaultCorsOptions();
-
-        this.createdResources = this.createResource(scope);
-    }
-
-    private createApi(scope: Construct, env: string) {
-        if (this.config.DNS) {
-
-            // console.log('### DNS is true ###');
-
-            const zone = this.getZone(this.scope, this.config);
-
-            const api = new RestApi(this.scope, `${this.config.AppPrefix}-rest-api`, this.createApiProps(env, zone));
-
-            this.createARecord(scope, zone, api);
-
-            // this.createCnameRecord(scope, zone, api, this.config);
-
-            this.createApiKey(this.config, api);
-
-            return api;
-
-        } else {
-
-            const api = new RestApi(this.scope, `${this.config.AppPrefix}-rest-api-without-DNS`, this.createApiProps(env));
-
-            this.createApiKey(this.config, api);
-
-            return api;
-        }
-    }
-
-    private createApiProps(env: string, zone?: IHostedZone): RestApiProps {
-
-        if (this.config.DNS) {
-
-            const cert = this.createCertificate(this.scope, zone!, this.config, env);
-
-            const props: RestApiProps = {
-                restApiName: `${this.config.AppPrefix}-${this.config.API.Name}`,
-                description: this.config.API.Description,
-                domainName: {
-                    domainName: `${this.config.API.DomainPrefix}.${env}.${this.config.DNS.ZoneName}`,
-                    certificate: cert.certificate,
-                    endpointType: EndpointType.REGIONAL,
-                    securityPolicy: SecurityPolicy.TLS_1_2
-                },
-                defaultCorsPreflightOptions: this.corsOptions
-            };
-
-            return props;
-        } else {
-            const props: RestApiProps = {
-                restApiName: `${this.config.AppPrefix}-${this.config.API.Name}`,
-                description: this.config.API.Description,
-                defaultCorsPreflightOptions: this.corsOptions
-            };
-
-            return props;
-        }
-    }
-
-    private createDefaultCorsOptions() {
-
-        const corsOptions: CorsOptions = {
-            allowHeaders: [
-                '*',
-            ],
-            allowMethods: Cors.ALL_METHODS,
-            allowCredentials: true,
-            allowOrigins: Cors.ALL_ORIGINS,
-        };
-
-        return corsOptions;
-    }
-
-    private requiresApiKey(config: AppConfig) {
-        // Determine if any of the lambdas require an API Key
-        return config.RESOURCES.LAMBDA.some((lambda) => lambda.apiGateway?.requireApiKey === true);
-    }
-
-    private createApiKey(config: AppConfig, api: RestApi) {
-
-        if (this.requiresApiKey(this.config)) {
-            const apiKey = new TsgApiKey(this.scope, this.config, api)
-            return apiKey;
-        }
-        return null;
-    }
-
-    private getZone(scope: Construct, config: MicroserviceProps) {
-        return HostedZone.fromHostedZoneAttributes(scope, `${config.DNS?.ZoneName}-zone`, {
-            zoneName: config.DNS?.ZoneName!,
-            hostedZoneId: config.DNS?.ZoneId!
-        });
-    }
-
-    private createCertificate(scope: Construct, zone: IHostedZone, config: MicroserviceProps,
-        env: string) {
-        const cert = new CreateCertificate(scope, config, zone, env);
-
-        cert.certificate.applyRemovalPolicy(RemovalPolicy.DESTROY);
-        return cert;
-    }
-
-    private createARecord(scope: Construct, zone: IHostedZone, api: RestApi) {
-        const aRecord = new ARecord(scope, `api-dns-a-record-${this.config.API.DomainPrefix}`, {
-            zone,
-            target: RecordTarget.fromAlias(new ApiGateway(api)),
-            recordName: `${this.config.API.DomainPrefix}.${this.env}.${this.config.DNS?.ZoneName}`
-        });
-
-        aRecord.applyRemovalPolicy(RemovalPolicy.DESTROY);
-        return aRecord;
-    }
-
-    private createCnameRecord(scope: Construct, zone: IHostedZone, api: RestApi, config: AppConfig) {
-        const record = new CnameRecord(scope, "api-cname-record", {
-            zone,
-            domainName: api.domainName?.domainNameAliasDomainName!,
-            recordName: `${config?.DNS?.SubDomainNameForApi}.${config?.DNS?.SubDomainName}`
-        });
-        return record;
-    }
-
-    protected createResource(scope: Construct) {
-
-        const api = this.createApi(scope, this.env);
-        // TODO:  ONLY IF CUSTOM MAPPING IS REQUIRED
-        // const domain = this.createCustomDomain(scope, this.config);
-
-        // const mapping = this.attachDomainToApi(scope, api, domain, this.config);
-
-
-
-        return [api];
-    }
-
-    protected createOutput<T>(scope: Construct, createdAssets: T[]): void {
-        createdAssets.forEach((api, idx) => {
-
-            new CfnOutput(scope, `api${idx}`, {
-                // @ts-ignore
-                value: api.url
-            });
-        });
-    }
-
+import { CfnOutput, RemovalPolicy, Tag } from "aws-cdk-lib";
+import { BasePathMapping, Cors, CorsOptions, DomainName, EndpointType, IDomainName, IRestApi, MethodOptions, RestApi, RestApiProps, SecurityPolicy } from "aws-cdk-lib/aws-apigateway";
+import { ARecord, CnameRecord, HostedZone, IHostedZone, RecordTarget } from "aws-cdk-lib/aws-route53";
+import { ApiGateway, ApiGatewayDomain } from "aws-cdk-lib/aws-route53-targets";
+import { Construct } from "constructs";
+import { AppConfig } from "../../config/AppConfig";
+import { MicroserviceProps } from "../../interfaces/MicroserviceProps";
+
+import { BaseResource } from "../base/baseResource";
+import { CreateCertificate } from "../certificate/createCertificate";
+import { TsgApiKey } from "./createApiKey";
+
+
+export class Api extends BaseResource<IRestApi> {
+
+    private corsOptions: CorsOptions;
+
+
+    get APIs() {
+        return this.createdResources;
+    }
+
+    constructor(scope: Construct, config: AppConfig, private env: string) {
+        super(scope, config);
+
+        this.corsOptions = this.createDefaultCorsOptions();
+
+        this.createdResources = this.createResource(scope);
+    }
+
+    private createApi(scope: Construct, env: string) {
+        if (this.config.DNS) {
+
+            // console.log('### DNS is true ###');
+
+            const zone = this.getZone(this.scope, this.config);
+
+            const api = new RestApi(this.scope, `${this.config.AppPrefix}-rest-api`, this.createApiProps(env, zone));
+
+            this.createARecord(scope, zone, api);
+
+            // this.createCnameRecord(scope, zone, api, this.config);
+
+            this.createApiKey(this.config, api);
+
+            return api;
+
+        } else {
+
+            const api = new RestApi(this.scope, `${this.config.AppPrefix}-rest-api-without-DNS`, this.createApiProps(env));
+
+            this.createApiKey(this.config, api);
+
+            return api;
+        }
+    }
+
+    private createApiProps(env: string, zone?: IHostedZone): RestApiProps {
+
+        if (this.config.DNS) {
+
+            const cert = this.createCertificate(this.scope, zone!, this.config, env);
+
+            const props: RestApiProps = {
+                restApiName: `${this.config.AppPrefix}-${this.config.API.Name}`,
+                description: this.config.API.Description,
+                domainName: {
+                    domainName: `${this.config.API.DomainPrefix}.${env}.${this.config.DNS.ZoneName}`,
+                    certificate: cert.certificate,
+                    endpointType: EndpointType.REGIONAL,
+                    securityPolicy: SecurityPolicy.TLS_1_2
+                },
+                defaultCorsPreflightOptions: this.corsOptions
+            };
+
+            return props;
+        } else {
+            const props: RestApiProps = {
+                restApiName: `${this.config.AppPrefix}-${this.config.API.Name}`,
+                description: this.config.API.Description,
+                defaultCorsPreflightOptions: this.corsOptions
+            };
+
+            return props;
+        }
+    }
+
+    private createDefaultCorsOptions() {
+
+        const corsOptions: CorsOptions = {
+            allowHeaders: [
+                '*',
+            ],
+            allowMethods: Cors.ALL_METHODS,
+            allowCredentials: true,
+            allowOrigins: Cors.ALL_ORIGINS,
+        };
+
+        return corsOptions;
+    }
+
+    private requiresApiKey(config: AppConfig) {
+        // Determine if any of the lambdas require an API Key
+        return config.RESOURCES.LAMBDA.some((lambda) => lambda.apiGateway?.requireApiKey === true);
+    }
+
+    private createApiKey(config: AppConfig, api: RestApi) {
+
+        if (this.requiresApiKey(this.config)) {
+            const apiKey = new TsgApiKey(this.scope, this.config, api)
+            return apiKey;
+        }
+        return null;
+    }
+
+    private getZone(scope: Construct, config: MicroserviceProps) {
+        return HostedZone.fromHostedZoneAttributes(scope, `${config.DNS?.ZoneName}-zone`, {
+            zoneName: config.DNS?.ZoneName!,
+            hostedZoneId: config.DNS?.ZoneId!
+        });
+    }
+
+    private createCertificate(scope: Construct, zone: IHostedZone, config: MicroserviceProps,
+        env: string) {
+        const cert = new CreateCertificate(scope, config, zone, env);
+
+        cert.certificate.applyRemovalPolicy(RemovalPolicy.DESTROY);
+        return cert;
+    }
+
+    private createARecord(scope: Construct, zone: IHostedZone, api: RestApi) {
+        const aRecord = new ARecord(scope, `api-dns-a-record-${this.config.API.DomainPrefix}`, {
+            zone,
+            target: RecordTarget.fromAlias(new ApiGateway(api)),
+            recordName: `${this.config.API.DomainPrefix}.${this.env}.${this.config.DNS?.ZoneName}`
+        });
+
+        aRecord.applyRemovalPolicy(RemovalPolicy.DESTROY);
+        return aRecord;
+    }
+
+    private createCnameRecord(scope: Construct, zone: IHostedZone, api: RestApi, config: AppConfig) {
+        const record = new CnameRecord(scope, "api-cname-record", {
+            zone,
+            domainName: api.domainName?.domainNameAliasDomainName!,
+            recordName: `${config?.DNS?.SubDomainNameForApi}.${config?.DNS?.SubDomainName}`
+        });
+        return record;
+    }
+
+    protected createResource(scope: Construct) {
+
+        const api = this.createApi(scope, this.env);
+        // TODO:  ONLY IF CUSTOM MAPPING IS REQUIRED
+        // const domain = this.createCustomDomain(scope, this.config);
+
+        // const mapping = this.attachDomainToApi(scope, api, domain, this.config);
+
+
+
+        return [api];
+    }
+
+    protected createOutput<T>(scope: Construct, createdAssets: T[]): void {
+        createdAssets.forEach((api, idx) => {
+
+            new CfnOutput(scope, `api${idx}`, {
+                // @ts-ignore
+                value: api.url
+            });
+        });
+    }
+
 }