@sylvesterllc/aws-constructs 1.1.11 → 1.1.13

package/src/interfaces/MicroserviceProps.ts

@@ -1,11 +1,11 @@
-import { ApiAppConfig } from "../config/customConfigs/ApiAppConfig";
-import { GlobalAppConfig } from "../config/customConfigs/GlobalAppConfig";
-import { ResourceAppConfig } from "../config/customConfigs/ResourceAppConfig";
-import { TsgDnsAppConfig } from "../config/types/TsgDnsConfig";
-
-export interface MicroserviceProps {
-    API: ApiAppConfig;
-    GLOBALS: GlobalAppConfig;
-    RESOURCES: ResourceAppConfig;
-    DNS?: TsgDnsAppConfig;
+import { ApiAppConfig } from "../config/customConfigs/ApiAppConfig";
+import { GlobalAppConfig } from "../config/customConfigs/GlobalAppConfig";
+import { ResourceAppConfig } from "../config/customConfigs/ResourceAppConfig";
+import { TsgDnsAppConfig } from "../config/types/TsgDnsConfig";
+
+export interface MicroserviceProps {
+    API: ApiAppConfig;
+    GLOBALS: GlobalAppConfig;
+    RESOURCES: ResourceAppConfig;
+    DNS?: TsgDnsAppConfig;
 }

package/src/interfaces/timer-job/index.ts

@@ -0,0 +1 @@
+export * from "./timer-job-props";

package/src/interfaces/timer-job/timer-job-props.ts

@@ -0,0 +1,17 @@
+import { CronOptions } from "aws-cdk-lib/aws-events/lib/schedule";
+import { IRole } from "aws-cdk-lib/aws-iam/lib";
+import { LayerVersion } from "aws-cdk-lib/aws-lambda";
+
+export interface TimerJobProps {
+
+    functionName: string;
+    appPrefix: string;
+    codePath: string;
+    timeoutInMinutes: number;
+    memory: number;
+    envs: Record<string, string>;
+    role?: IRole;    
+    cronOptions: CronOptions;
+    dynamoTableNames?: string[];
+    lambdaLayerArn?: string[];
+}

package/src/resources/base/baseResource.ts

@@ -1,15 +1,15 @@
-import { Tags } from "aws-cdk-lib";
-import { Construct } from "constructs";
-import { AppConfig } from "../../config/AppConfig";
-
-export abstract class BaseResource<T> {
-
-    protected createdResources: T[];
-
-    constructor(protected scope: Construct, protected config: AppConfig) { }
-
-    protected abstract createResource(scope: Construct): T[] | null;
-    
-    protected abstract createOutput<T>(scope: Construct, createdAssets: T[]): void;
-    
+import { Tags } from "aws-cdk-lib";
+import { Construct } from "constructs";
+import { AppConfig } from "../../config/AppConfig";
+
+export abstract class BaseResource<T> {
+
+    protected createdResources: T[];
+
+    constructor(protected scope: Construct, protected config: AppConfig) { }
+
+    protected abstract createResource(scope: Construct): T[] | null;
+    
+    protected abstract createOutput<T>(scope: Construct, createdAssets: T[]): void;
+    
 }

package/src/resources/base/tsgBaseResource.ts

@@ -1,22 +1,22 @@
-import { CfnOutput } from "aws-cdk-lib";
-import { Construct } from "constructs";
-
-export abstract class TsgBaseResource<T, R> {
-
-    protected createdResource: T | null;
-
-    constructor(protected scope: Construct, protected config: R) {
-
-        this.createdResource = this.createResource(scope);
-
-        if (this.createdResource) {
-            this.createOutput(scope);
-        }
-    }
-
-
-    protected abstract createResource(scope: Construct): T | null;
-
-    protected abstract createOutput<T>(scope: Construct): void;
-
+import { CfnOutput } from "aws-cdk-lib";
+import { Construct } from "constructs";
+
+export abstract class TsgBaseResource<T, R> {
+
+    protected createdResource: T | null;
+
+    constructor(protected scope: Construct, protected config: R) {
+
+        this.createdResource = this.createResource(scope);
+
+        if (this.createdResource) {
+            this.createOutput(scope);
+        }
+    }
+
+
+    protected abstract createResource(scope: Construct): T | null;
+
+    protected abstract createOutput<T>(scope: Construct): void;
+
 }

package/src/resources/certificate/createCertificate.ts

@@ -1,58 +1,58 @@
-import { RemovalPolicy } from "aws-cdk-lib";
-import { Certificate, CertificateValidation, DnsValidatedCertificate, ICertificate } from "aws-cdk-lib/aws-certificatemanager";
-import { HostedZone, IHostedZone } from "aws-cdk-lib/aws-route53";
-import { Construct } from "constructs";
-import { MicroserviceProps } from "../../interfaces/MicroserviceProps";
-import { environmentSuffixForDomain } from "../../helpers/util-helper";
-import { Environment } from "../../config/Environments";
-import { env } from "process";
-
-
-export class CreateCertificate {
-
-  public certificate: ICertificate;
-
-  constructor(scope: Construct, props: MicroserviceProps, hostedZone: IHostedZone, env: string) {
-
-    // this.certificate = this.generateCertificate(scope, props, hostedZone);
-
-    this.certificate = this.generateApiCertificate(scope, props, env);
-
-    this.certificate.applyRemovalPolicy(RemovalPolicy.DESTROY);
-
-  }
-
-  generateCertificate(scope: Construct, props: MicroserviceProps, hostedZone: IHostedZone, env: string) {
-
-    const devHostedZone = HostedZone.fromHostedZoneId(scope, `api.c1.dev.convergeone.io-hosted-zone`,
-      'Z0508834Q8E4TWFVG990');
-
-    const cert = new Certificate(scope, `api-c1-dev-api-certificate`, {
-      domainName: `c1.api.dev.convergeone.io`,
-      validation: CertificateValidation.fromDnsMultiZone({
-        [`dev.convergeone.io`]: devHostedZone
-      })
-    });
-    return cert;
-  }
-
-  generateApiCertificate(scope: Construct, props: MicroserviceProps, env: string) {
-
-    const hostedZone = HostedZone.fromHostedZoneId(scope, `${props.API.DomainPrefix}-${env}-${props.DNS?.ZoneName}-hosted-zone`,
-      props.DNS?.ZoneId!);
-
-    const domainName = `${props.API.DomainPrefix}.${env}.${props.DNS?.ZoneName}`;
-
-    const cert = new Certificate(scope, `${props.API.DomainPrefix}-${env}-${props.DNS?.ZoneName}-certificate`, {
-      certificateName: `${domainName}-certificate`,
-      domainName: domainName,
-      // validation: CertificateValidation.fromDnsMultiZone({
-      //   [`${props.API.DomainPrefix}.${env}.${props.DNS?.ZoneName}`]: hostedZone
-
-      // })
-      validation: CertificateValidation.fromDns(hostedZone)
-    });
-
-    return cert;
-  }
+import { RemovalPolicy } from "aws-cdk-lib";
+import { Certificate, CertificateValidation, DnsValidatedCertificate, ICertificate } from "aws-cdk-lib/aws-certificatemanager";
+import { HostedZone, IHostedZone } from "aws-cdk-lib/aws-route53";
+import { Construct } from "constructs";
+import { MicroserviceProps } from "../../interfaces/MicroserviceProps";
+import { environmentSuffixForDomain } from "../../helpers/util-helper";
+import { Environment } from "../../config/Environments";
+import { env } from "process";
+
+
+export class CreateCertificate {
+
+  public certificate: ICertificate;
+
+  constructor(scope: Construct, props: MicroserviceProps, hostedZone: IHostedZone, env: string) {
+
+    // this.certificate = this.generateCertificate(scope, props, hostedZone);
+
+    this.certificate = this.generateApiCertificate(scope, props, env);
+
+    this.certificate.applyRemovalPolicy(RemovalPolicy.DESTROY);
+
+  }
+
+  generateCertificate(scope: Construct, props: MicroserviceProps, hostedZone: IHostedZone, env: string) {
+
+    const devHostedZone = HostedZone.fromHostedZoneId(scope, `api.c1.dev.convergeone.io-hosted-zone`,
+      'Z0508834Q8E4TWFVG990');
+
+    const cert = new Certificate(scope, `api-c1-dev-api-certificate`, {
+      domainName: `c1.api.dev.convergeone.io`,
+      validation: CertificateValidation.fromDnsMultiZone({
+        [`dev.convergeone.io`]: devHostedZone
+      })
+    });
+    return cert;
+  }
+
+  generateApiCertificate(scope: Construct, props: MicroserviceProps, env: string) {
+
+    const hostedZone = HostedZone.fromHostedZoneId(scope, `${props.API.DomainPrefix}-${env}-${props.DNS?.ZoneName}-hosted-zone`,
+      props.DNS?.ZoneId!);
+
+    const domainName = `${props.API.DomainPrefix}.${env}.${props.DNS?.ZoneName}`;
+
+    const cert = new Certificate(scope, `${props.API.DomainPrefix}-${env}-${props.DNS?.ZoneName}-certificate`, {
+      certificateName: `${domainName}-certificate`,
+      domainName: domainName,
+      // validation: CertificateValidation.fromDnsMultiZone({
+      //   [`${props.API.DomainPrefix}.${env}.${props.DNS?.ZoneName}`]: hostedZone
+
+      // })
+      validation: CertificateValidation.fromDns(hostedZone)
+    });
+
+    return cert;
+  }
 }

package/src/resources/cognito/createCognito.ts

@@ -1,47 +1,47 @@
-import { IUserPool, UserPool, UserPoolClient, UserPoolClientProps, UserPoolIdentityProviderAmazon, UserPoolIdentityProviderAmazonProps, UserPoolIdentityProviderSaml, UserPoolIdentityProviderSamlMetadataType } from "aws-cdk-lib/aws-cognito";
-import { Construct } from "constructs";
-import { AppConfig } from "../../config/AppConfig";
-import { createUserPoolProps } from "./createCognitoProps";
-import { Duration } from "aws-cdk-lib";
-import { ClientAppType } from "../../config/Environments";
-
-export const createCognito = (scope: Construct, appConfig: AppConfig) => {
-
-
-    const userPool = createUserPool(scope, appConfig);
-    const clientPool = createUserPoolClient(scope, userPool, "mobile", appConfig);    
-    
-    return {
-        userPool,
-        clientPool
-    };
-};
-
-const createUserPool = (scope: Construct, appConfig: AppConfig, userPoolName?: string) => {
-
-    return new UserPool(scope, `${appConfig.AppName}-user-pool`,
-        createUserPoolProps(`${appConfig.AppName}-user-pool`));
-
-};
-
-const createUserPoolClient = (scope: Construct, userPool: IUserPool, appType: ClientAppType,
-    appConfig: AppConfig) => {
-
-    const client = new UserPoolClient(scope, `${appConfig.AppName}-user-pool-client`,
-        createUserPoolClientProps(userPool, appConfig, appType));
-
-    return client;
-};
-
-const createUserPoolClientProps = (userpool: IUserPool, config: AppConfig, appType: ClientAppType): UserPoolClientProps => {
-    const props: UserPoolClientProps = {
-        userPool: userpool,
-        accessTokenValidity: Duration.hours(3),
-        refreshTokenValidity: Duration.days(3),
-        userPoolClientName: `${config.AppName}-${appType}`,
-        authFlows: {
-            userPassword: true,
-        }
-    };
-    return props;
-};
+import { IUserPool, UserPool, UserPoolClient, UserPoolClientProps, UserPoolIdentityProviderAmazon, UserPoolIdentityProviderAmazonProps, UserPoolIdentityProviderSaml, UserPoolIdentityProviderSamlMetadataType } from "aws-cdk-lib/aws-cognito";
+import { Construct } from "constructs";
+import { AppConfig } from "../../config/AppConfig";
+import { createUserPoolProps } from "./createCognitoProps";
+import { Duration } from "aws-cdk-lib";
+import { ClientAppType } from "../../config/Environments";
+
+export const createCognito = (scope: Construct, appConfig: AppConfig) => {
+
+
+    const userPool = createUserPool(scope, appConfig);
+    const clientPool = createUserPoolClient(scope, userPool, "mobile", appConfig);    
+    
+    return {
+        userPool,
+        clientPool
+    };
+};
+
+const createUserPool = (scope: Construct, appConfig: AppConfig, userPoolName?: string) => {
+
+    return new UserPool(scope, `${appConfig.AppName}-user-pool`,
+        createUserPoolProps(`${appConfig.AppName}-user-pool`));
+
+};
+
+const createUserPoolClient = (scope: Construct, userPool: IUserPool, appType: ClientAppType,
+    appConfig: AppConfig) => {
+
+    const client = new UserPoolClient(scope, `${appConfig.AppName}-user-pool-client`,
+        createUserPoolClientProps(userPool, appConfig, appType));
+
+    return client;
+};
+
+const createUserPoolClientProps = (userpool: IUserPool, config: AppConfig, appType: ClientAppType): UserPoolClientProps => {
+    const props: UserPoolClientProps = {
+        userPool: userpool,
+        accessTokenValidity: Duration.hours(3),
+        refreshTokenValidity: Duration.days(3),
+        userPoolClientName: `${config.AppName}-${appType}`,
+        authFlows: {
+            userPassword: true,
+        }
+    };
+    return props;
+};

package/src/resources/cognito/createCognitoProps.ts

@@ -1,46 +1,46 @@
-import { Duration, RemovalPolicy } from "aws-cdk-lib";
-import { AccountRecovery, DateTimeAttribute, NumberAttribute, StringAttribute, UserPoolProps, 
-    VerificationEmailStyle } from "aws-cdk-lib/aws-cognito";
-
-export const createUserPoolProps = (securityUserPool: string) => {
-   
-    const cognitoProps: UserPoolProps = {
-        userPoolName: securityUserPool.toLowerCase(),
-        selfSignUpEnabled: true,
-        userVerification: {
-            emailSubject: 'Verify your email for Bishop CDK Constructs!',
-            emailBody: 'Thanks for creating an account with Bishop CDK Constructs! Your verification code is {####}',
-            emailStyle: VerificationEmailStyle.CODE,
-            smsMessage: 'Thanks for signing up {username} with Bishop CDK Constructs! Your verification code is {####}',
-        },
-        userInvitation: {
-            emailSubject: 'Invite to join Bishop CDK Constructs!',
-            emailBody: 'Hello {username}, you have been invited to join Bishop CDK Constructs! Your temporary password is {####}',
-            smsMessage: 'Your temporary password for {username} with Bishop CDK Constructs is {####}'
-        },
-        signInAliases: {
-            username: true,
-            email: true,
-            phone: true
-        },
-        customAttributes: {
-            'firstName': new StringAttribute({ minLen: 3, maxLen: 30, mutable: true }),
-            'lastName': new StringAttribute({ minLen: 3, maxLen: 30, mutable: true }),
-            'phoneNumber': new StringAttribute({ minLen: 3, maxLen: 30, mutable: true }),
-            'acccountType': new NumberAttribute({ mutable: true }),
-            'joinedOn': new DateTimeAttribute(),
-        },
-        passwordPolicy: {
-            minLength: 8,
-            requireLowercase: true,
-            requireUppercase: true,
-            requireDigits: true,
-            requireSymbols: true,
-            tempPasswordValidity: Duration.days(1),
-        },
-        accountRecovery: AccountRecovery.PHONE_AND_EMAIL,
-        removalPolicy: RemovalPolicy.DESTROY,
-    }
-    return cognitoProps;
-};
-
+import { Duration, RemovalPolicy } from "aws-cdk-lib";
+import { AccountRecovery, DateTimeAttribute, NumberAttribute, StringAttribute, UserPoolProps, 
+    VerificationEmailStyle } from "aws-cdk-lib/aws-cognito";
+
+export const createUserPoolProps = (securityUserPool: string) => {
+   
+    const cognitoProps: UserPoolProps = {
+        userPoolName: securityUserPool.toLowerCase(),
+        selfSignUpEnabled: true,
+        userVerification: {
+            emailSubject: 'Verify your email for Bishop CDK Constructs!',
+            emailBody: 'Thanks for creating an account with Bishop CDK Constructs! Your verification code is {####}',
+            emailStyle: VerificationEmailStyle.CODE,
+            smsMessage: 'Thanks for signing up {username} with Bishop CDK Constructs! Your verification code is {####}',
+        },
+        userInvitation: {
+            emailSubject: 'Invite to join Bishop CDK Constructs!',
+            emailBody: 'Hello {username}, you have been invited to join Bishop CDK Constructs! Your temporary password is {####}',
+            smsMessage: 'Your temporary password for {username} with Bishop CDK Constructs is {####}'
+        },
+        signInAliases: {
+            username: true,
+            email: true,
+            phone: true
+        },
+        customAttributes: {
+            'firstName': new StringAttribute({ minLen: 3, maxLen: 30, mutable: true }),
+            'lastName': new StringAttribute({ minLen: 3, maxLen: 30, mutable: true }),
+            'phoneNumber': new StringAttribute({ minLen: 3, maxLen: 30, mutable: true }),
+            'acccountType': new NumberAttribute({ mutable: true }),
+            'joinedOn': new DateTimeAttribute(),
+        },
+        passwordPolicy: {
+            minLength: 8,
+            requireLowercase: true,
+            requireUppercase: true,
+            requireDigits: true,
+            requireSymbols: true,
+            tempPasswordValidity: Duration.days(1),
+        },
+        accountRecovery: AccountRecovery.PHONE_AND_EMAIL,
+        removalPolicy: RemovalPolicy.DESTROY,
+    }
+    return cognitoProps;
+};
+

package/src/resources/customResource/createSeedDatabaseCustomResource.ts

@@ -1,37 +1,37 @@
-import { ITableV2 } from "aws-cdk-lib/aws-dynamodb";
-import { LayerVersion, Runtime } from "aws-cdk-lib/aws-lambda";
-import { NodejsFunction } from "aws-cdk-lib/aws-lambda-nodejs";
-import { Construct } from "constructs";
-import { AppConfig } from "../../config/AppConfig";
-import { LambdaHelper } from "../lambda/lambdaHelper";
-import { Provider, ProviderProps } from "aws-cdk-lib/custom-resources";
-import { RetentionDays } from "aws-cdk-lib/aws-logs";
-import { CustomResource, CustomResourceProps } from "aws-cdk-lib";
-
-
-export const createSeedDatabaseCustomResource = (scope: Construct, config: AppConfig, 
-    database: ITableV2, layers?: LayerVersion[]) => {
-
-        const seedLambda = config.RESOURCES.DYNAMO?.SEED_LAMBDA;
-
-        const databaseSeedLambda = LambdaHelper.createLambdaFunctions(scope, 
-            config, 
-            seedLambda!, 
-            undefined, 
-            layers!) as NodejsFunction;
-
-    database.grantReadWriteData(databaseSeedLambda);
-
-    const providerProps: ProviderProps = {
-        onEventHandler: databaseSeedLambda,
-      logRetention: RetentionDays.ONE_WEEK,
-    };
-
-    const provider = new Provider(scope, `${config.AppPrefix}-database-seed-provider`, providerProps);
-
-    const crProps: CustomResourceProps = {
-        serviceToken: provider.serviceToken,
-    };
-
-    new CustomResource(scope, `${config.AppPrefix}-database-seed`, crProps);
+import { ITableV2 } from "aws-cdk-lib/aws-dynamodb";
+import { LayerVersion, Runtime } from "aws-cdk-lib/aws-lambda";
+import { NodejsFunction } from "aws-cdk-lib/aws-lambda-nodejs";
+import { Construct } from "constructs";
+import { AppConfig } from "../../config/AppConfig";
+import { LambdaHelper } from "../lambda/lambdaHelper";
+import { Provider, ProviderProps } from "aws-cdk-lib/custom-resources";
+import { RetentionDays } from "aws-cdk-lib/aws-logs";
+import { CustomResource, CustomResourceProps } from "aws-cdk-lib";
+
+
+export const createSeedDatabaseCustomResource = (scope: Construct, config: AppConfig, 
+    database: ITableV2, layers?: LayerVersion[]) => {
+
+        const seedLambda = config.RESOURCES.DYNAMO?.SEED_LAMBDA;
+
+        const databaseSeedLambda = LambdaHelper.createLambdaFunctions(scope, 
+            config, 
+            seedLambda!, 
+            undefined, 
+            layers!) as NodejsFunction;
+
+    database.grantReadWriteData(databaseSeedLambda);
+
+    const providerProps: ProviderProps = {
+        onEventHandler: databaseSeedLambda,
+      logRetention: RetentionDays.ONE_WEEK,
+    };
+
+    const provider = new Provider(scope, `${config.AppPrefix}-database-seed-provider`, providerProps);
+
+    const crProps: CustomResourceProps = {
+        serviceToken: provider.serviceToken,
+    };
+
+    new CustomResource(scope, `${config.AppPrefix}-database-seed`, crProps);
 };