@gradientedge/cdk-utils 10.8.0 → 11.1.0

package/src/lib/aws/construct/static-site/main.ts

@@ -1,212 +0,0 @@
-import { ICertificate } from 'aws-cdk-lib/aws-certificatemanager'
-import {
-  FunctionAssociation,
-  FunctionEventType,
-  IDistribution,
-  IFunction,
-  OriginAccessIdentity,
-} from 'aws-cdk-lib/aws-cloudfront'
-import { ARecord, IHostedZone } from 'aws-cdk-lib/aws-route53'
-import { IBucket } from 'aws-cdk-lib/aws-s3'
-import { Construct } from 'constructs'
-import { CommonConstruct } from '../../common/index.js'
-import { StaticSiteProps } from './types.js'
-
-/**
- * @classdesc Provides a construct to create and deploy a s3 hosted static site
- * @example
- * import { StaticSite, StaticSiteProps } '@gradientedge/cdk-utils'
- * import { Construct } from 'constructs'
- *
- * class CustomConstruct extends StaticSite {
- *   constructor(parent: Construct, id: string, props: StaticSiteProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     this.id = id
- *     this.initResources()
- *   }
- * }
- */
-export class StaticSite extends CommonConstruct {
-  /* static site properties */
-  props: StaticSiteProps
-  id: string
-
-  /* static site resources */
-  siteHostedZone: IHostedZone
-  siteCertificate: ICertificate
-  siteARecord: ARecord
-  siteBucket: IBucket
-  siteDistribution: IDistribution
-  siteLogBucket: IBucket
-  siteOriginAccessIdentity: OriginAccessIdentity
-  siteCloudfrontFunction: IFunction
-  siteFunctionAssociations: FunctionAssociation[]
-
-  constructor(parent: Construct, id: string, props: StaticSiteProps) {
-    super(parent, id, props)
-
-    this.props = props
-    this.id = id
-  }
-
-  /**
-   * @summary Initialise and provision resources
-   */
-  public initResources() {
-    this.resolveHostedZone()
-    this.resolveCertificate()
-    this.createSiteLogBucket()
-    this.createSiteBucket()
-    this.createSiteCloudfrontFunction()
-    this.resolveSiteFunctionAssociations()
-    this.createSiteOriginAccessIdentity()
-    this.createSiteDistribution()
-    this.createSiteRouteAssets()
-    this.deploySite()
-    this.invalidateDistributionCache()
-  }
-
-  /**
-   * @summary Method to resolve a hosted zone based on domain attributes
-   */
-  protected resolveHostedZone() {
-    this.siteHostedZone = this.route53Manager.withHostedZoneFromFullyQualifiedDomainName(
-      `${this.id}-hosted-zone`,
-      this,
-      this.props.useExistingHostedZone
-    )
-  }
-
-  /**
-   * @summary Method to resolve a certificate based on attributes
-   */
-  protected resolveCertificate() {
-    if (
-      this.props.siteCertificate.useExistingCertificate &&
-      this.props.siteCertificate.certificateSsmName &&
-      this.props.siteCertificate.certificateRegion
-    ) {
-      this.props.siteCertificate.certificateArn = this.ssmManager.readStringParameterFromRegion(
-        `${this.id}-certificate-param`,
-        this,
-        this.props.siteCertificate.certificateSsmName,
-        this.props.siteCertificate.certificateRegion
-      )
-    }
-    this.siteCertificate = this.acmManager.resolveCertificate(
-      `${this.id}-certificate`,
-      this,
-      this.props.siteCertificate
-    )
-  }
-
-  /**
-   * @summary Method to create a site log bucket
-   */
-  protected createSiteLogBucket() {
-    this.siteLogBucket = this.s3Manager.createS3Bucket(`${this.id}-site-logs`, this, this.props.siteLogBucket)
-  }
-
-  /**
-   * @summary Method to create a site bucket
-   */
-  protected createSiteBucket() {
-    this.siteBucket = this.s3Manager.createS3Bucket(`${this.id}-site`, this, this.props.siteBucket)
-  }
-
-  /**
-   * @summary Method to create a site cloudfront function
-   */
-  protected createSiteCloudfrontFunction() {
-    if (this.props.siteCloudfrontFunctionProps) {
-      this.siteCloudfrontFunction = this.cloudFrontManager.createCloudfrontFunction(
-        `${this.id}-function`,
-        this,
-        this.props.siteCloudfrontFunctionProps
-      )
-    }
-  }
-
-  /**
-   * @summary Method to create a site cloudfront function associations
-   */
-  protected resolveSiteFunctionAssociations() {
-    if (this.props.siteCloudfrontFunctionProps) {
-      this.siteFunctionAssociations = [
-        {
-          eventType: FunctionEventType.VIEWER_REQUEST,
-          function: this.siteCloudfrontFunction,
-        },
-      ]
-    }
-  }
-
-  /**
-   * @summary Method to create a site origin access identity
-   */
-  protected createSiteOriginAccessIdentity() {}
-
-  /**
-   * @summary Method to create a site cloudfront distribution
-   */
-  protected createSiteDistribution() {
-    if (!this.props.siteDistribution) throw 'SiteDistribution props undefined'
-
-    this.siteDistribution = this.cloudFrontManager.createDistributionWithS3Origin(
-      `${this.id}-distribution`,
-      this,
-      this.props.siteDistribution,
-      this.siteBucket,
-      this.siteLogBucket,
-      this.siteOriginAccessIdentity,
-      this.siteCertificate,
-      this.props.siteAliases,
-      this.siteFunctionAssociations
-    )
-  }
-
-  /**
-   * @summary Method to create route53 records for static site
-   */
-  protected createSiteRouteAssets() {
-    this.siteARecord = this.route53Manager.createCloudFrontTargetARecord(
-      `${this.id}-domain-a-record`,
-      this,
-      this.siteDistribution,
-      this.siteHostedZone,
-      this.props.siteRecordName,
-      this.props.skipStageForARecords
-    )
-  }
-
-  /**
-   * @summary Method to deploy the static assets into s3 bucket for static site
-   */
-  protected deploySite() {
-    const prune = this.props.pruneOnDeployment ?? true
-    this.s3Manager.doBucketDeployment(
-      `${this.id}-deployment`,
-      this,
-      this.siteBucket,
-      this.siteDistribution,
-      [this.props.siteSource],
-      '',
-      prune
-    )
-  }
-
-  /**
-   * Method to invalidation the cloudfront distribution cache after a deployment
-   */
-  protected invalidateDistributionCache() {
-    if (this.props.siteCacheInvalidationDockerFilePath) {
-      this.cloudFrontManager.invalidateCache(
-        `${this.id}-cache-invalidation`,
-        this,
-        this.props.siteCacheInvalidationDockerFilePath,
-        this.siteDistribution.distributionId
-      )
-    }
-  }
-}

package/src/lib/aws/construct/static-site/types.ts

@@ -1,31 +0,0 @@
-import { CommonStackProps } from '../../common/index.js'
-import { AcmProps, CloudfrontFunctionProps, DistributionProps, S3BucketProps } from '../../services/index.js'
-import { ISource } from 'aws-cdk-lib/aws-s3-deployment'
-
-/**
- */
-export interface StaticSiteProps extends CommonStackProps {
-  logLevel: string
-  nodeEnv: string
-  siteAliases?: string[]
-  siteBucket: S3BucketProps
-  siteCacheInvalidationDockerFilePath?: string
-  siteCertificate: AcmProps
-  siteCloudfrontFunctionProps?: CloudfrontFunctionProps
-  siteCreateAltARecord: boolean
-  siteDistribution?: DistributionProps
-  siteFunctionFilePath?: string
-  siteHostedZoneDomainName?: string
-  siteLogBucket: S3BucketProps
-  siteRecordName?: string
-  siteSource: ISource
-  siteSubDomain?: string
-  timezone: string
-  /**
-   * Whether to prune the contents of the bucket when deploying assets.
-   *
-   * @default true
-   */
-  pruneOnDeployment?: boolean
-  useExistingHostedZone: boolean
-}

package/src/lib/aws/index.ts

@@ -1,5 +0,0 @@
-export * from './common/index.js'
-export * from './construct/index.js'
-export * from './services/index.js'
-export * from './types/index.js'
-export * from './utils/index.js'

package/src/lib/aws/services/api-gateway/index.ts

@@ -1,2 +0,0 @@
-export * from './main.js'
-export * from './types.js'

package/src/lib/aws/services/api-gateway/main.ts

@@ -1,225 +0,0 @@
-import { RemovalPolicy, Size, Tags } from 'aws-cdk-lib'
-import {
-  Cors,
-  Deployment,
-  DomainName,
-  EndpointType,
-  IAuthorizer,
-  IResource,
-  IRestApi,
-  Integration,
-  LambdaRestApi,
-  LogGroupLogDestination,
-  MethodResponse,
-  SecurityPolicy,
-} from 'aws-cdk-lib/aws-apigateway'
-import { ICertificate } from 'aws-cdk-lib/aws-certificatemanager'
-import { IFunction } from 'aws-cdk-lib/aws-lambda'
-import _ from 'lodash'
-import { CommonConstruct } from '../../common/index.js'
-import { createCfnOutput } from '../../utils/index.js'
-import { LambdaRestApiProps } from './types.js'
-
-/**
- * @classdesc Provides operations on AWS API Gateway.
- * - A new instance of this class is injected into {@link CommonConstruct} constructor.
- * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
- * @example
- * import { CommonConstruct } from '@gradientedge/cdk-utils'
- *
- * class CustomConstruct extends CommonConstruct {
- *   constructor(parent: Construct, id: string, props: common.CommonStackProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     const lambdaFunction = this.lambdaManager.createLambdaFunction('MyFunction', this, role, layers, code)
- *     this.apiManager.createLambdaRestApi('MyCertificate', this, props, lambdaFunction)
- *   }
- * }
- * @see [CDK API Gateway Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway-readme.html}
- */
-export class ApiManager {
-  /**
-   * @summary Method to create a Rest API with Lambda backend/target
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props lambda rest restApi props
-   * @param lambdaFunction
-   */
-  public createLambdaRestApi(id: string, scope: CommonConstruct, props: LambdaRestApiProps, lambdaFunction: IFunction) {
-    if (!props) throw `Api props undefined for ${id}`
-    if (!props.restApiName) throw `Api restApiName undefined for ${id}`
-
-    const restApiName = scope.resourceNameFormatter.format(
-      props.restApiName,
-      scope.props.resourceNameOptions?.apigateway
-    )
-    const restApiAccessLogName = scope.resourceNameFormatter.format(
-      `${props.restApiName}-access`,
-      scope.props.resourceNameOptions?.apigateway
-    )
-
-    const accessLogGroup = scope.logManager.createLogGroup(`${id}-rest-api-access-log`, scope, {
-      logGroupName: restApiAccessLogName,
-      removalPolicy: RemovalPolicy.DESTROY,
-    })
-
-    const api = new LambdaRestApi(scope, `${id}`, {
-      ...props,
-      cloudWatchRole: props.cloudWatchRole || false,
-      deploy: props.deploy || true,
-      deployOptions: {
-        ...props.deployOptions,
-        accessLogDestination: new LogGroupLogDestination(accessLogGroup),
-        description: `${id} - ${scope.props.stage} stage`,
-        stageName: scope.props.stage,
-      },
-      endpointConfiguration: {
-        ...props.endpointConfiguration,
-        types: props.endpointConfiguration?.types || [EndpointType.REGIONAL],
-      },
-      failOnWarnings: props.failOnWarnings || false,
-      handler: lambdaFunction,
-      minCompressionSize: props.minCompressionSizeInBytes ? Size.bytes(props.minCompressionSizeInBytes) : undefined,
-      proxy: props.proxy ?? true,
-      restApiName,
-    })
-
-    if (props.tags && !_.isEmpty(props.tags)) {
-      _.forEach(props.tags, tag => {
-        Tags.of(api).add(tag.key, tag.value)
-      })
-    }
-
-    createCfnOutput(`${id}-restApiId`, scope, api.restApiId)
-    createCfnOutput(`${id}-restApiName`, scope, api.restApiName)
-
-    return api
-  }
-
-  /**
-   * @summary Method to create custom restApi domain
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param domainName the domain name to use
-   * @param certificate the certificate used for custom restApi domain
-   */
-  public createApiDomain(id: string, scope: CommonConstruct, domainName: string, certificate: ICertificate) {
-    const apiDomain = new DomainName(scope, `${id}`, {
-      certificate,
-      domainName,
-      endpointType: scope.isProductionStage() ? EndpointType.EDGE : EndpointType.REGIONAL,
-      securityPolicy: SecurityPolicy.TLS_1_2,
-    })
-
-    createCfnOutput(`${id}-customDomainName`, scope, apiDomain.domainName)
-
-    return apiDomain
-  }
-
-  /**
-   * @summary Method to create an API gateway resource
-   * @param id
-   * @param scope
-   * @param parent
-   * @param path
-   * @param integration
-   * @param addProxy
-   * @param authorizer
-   * @param allowedOrigins
-   * @param allowedMethods
-   * @param allowedHeaders
-   * @param methodRequestParameters
-   * @param proxyIntegration
-   * @param enableDefaultCors
-   * @param mockIntegration
-   * @param mockMethodResponses
-   */
-  public createApiResource(
-    id: string,
-    scope: CommonConstruct,
-    parent: IResource,
-    path: string,
-    integration: Integration,
-    addProxy: boolean,
-    authorizer?: IAuthorizer,
-    allowedOrigins?: string[],
-    allowedMethods?: string[],
-    allowedHeaders?: string[],
-    methodRequestParameters?: { [param: string]: boolean },
-    proxyIntegration?: Integration,
-    enableDefaultCors?: boolean,
-    mockIntegration?: Integration,
-    mockMethodResponses?: MethodResponse[]
-  ) {
-    const methods = allowedMethods ?? Cors.ALL_METHODS
-
-    let defaultCorsPreflightOptions
-    if (enableDefaultCors === false) {
-      defaultCorsPreflightOptions = undefined
-    } else {
-      defaultCorsPreflightOptions = {
-        allowCredentials: true,
-        allowHeaders: allowedHeaders ?? Cors.DEFAULT_HEADERS,
-        allowMethods: [...methods, 'OPTIONS'],
-        allowOrigins: allowedOrigins ?? Cors.ALL_ORIGINS,
-      }
-    }
-
-    const resource = parent.addResource(path, {
-      defaultCorsPreflightOptions: defaultCorsPreflightOptions,
-    })
-
-    _.forEach(methods, method => {
-      if (enableDefaultCors === false && mockIntegration && method === 'OPTIONS') {
-        resource.addMethod(method, mockIntegration, {
-          authorizer,
-          requestParameters: methodRequestParameters,
-          methodResponses: mockMethodResponses,
-        })
-      } else {
-        resource.addMethod(method, integration, {
-          authorizer,
-          requestParameters: methodRequestParameters,
-        })
-      }
-    })
-    createCfnOutput(`${id}-${path}ResourceId`, scope, resource.resourceId)
-
-    if (addProxy) {
-      const resourceProxy = resource.addResource(`{${path}+}`, {
-        defaultCorsPreflightOptions: defaultCorsPreflightOptions,
-      })
-
-      _.forEach(methods, method => {
-        if (enableDefaultCors === false && mockIntegration && method === 'OPTIONS') {
-          resourceProxy.addMethod(method, mockIntegration, {
-            authorizer,
-            requestParameters: methodRequestParameters,
-            methodResponses: mockMethodResponses,
-          })
-        } else {
-          resourceProxy.addMethod(method, proxyIntegration ?? integration, {
-            authorizer,
-            requestParameters: methodRequestParameters,
-          })
-        }
-      })
-      createCfnOutput(`${id}-${path}ProxyResourceId`, scope, resourceProxy.resourceId)
-    }
-
-    return resource
-  }
-
-  /**
-   * @summary Method to create an api deployment
-   * @param id
-   * @param scope
-   * @param api
-   */
-  public createApiDeployment(id: string, scope: CommonConstruct, api: IRestApi) {
-    new Deployment(scope, `${id}`, {
-      api,
-      retainDeployments: false,
-    })
-  }
-}

package/src/lib/aws/services/api-gateway/types.ts

@@ -1,12 +0,0 @@
-import { LambdaRestApiProps as LambdaRestApigProps, RestApiProps } from 'aws-cdk-lib/aws-apigateway'
-import { ResourceNameFormatterProps } from '../../common/index.js'
-import { TagProps } from '../../types/index.js'
-
-/**
- */
-export interface LambdaRestApiProps extends LambdaRestApigProps {
-  tags?: TagProps[]
-  minCompressionSizeInBytes?: number
-}
-
-export interface RestApigProps extends RestApiProps {}

package/src/lib/aws/services/appconfig/constants.ts

@@ -1,52 +0,0 @@
-/**
- * @returns { Map<string, string> } AppConfig extension ARN by region for x84
- */
-export const ArnsByRegionForX86_64: { [region: string]: string } = {
-  'af-south-1': 'arn:aws:lambda:af-south-1:574348263942:layer:AWS-AppConfig-Extension:116',
-  'ap-east-1': 'arn:aws:lambda:ap-east-1:630222743974:layer:AWS-AppConfig-Extension:106',
-  'ap-northeast-1': 'arn:aws:lambda:ap-northeast-1:980059726660:layer:AWS-AppConfig-Extension:119',
-  'ap-northeast-2': 'arn:aws:lambda:ap-northeast-2:826293736237:layer:AWS-AppConfig-Extension:129',
-  'ap-northeast-3': 'arn:aws:lambda:ap-northeast-3:706869817123:layer:AWS-AppConfig-Extension:123',
-  'ap-south-1': 'arn:aws:lambda:ap-south-1:554480029851:layer:AWS-AppConfig-Extension:139',
-  'ap-south-2': 'arn:aws:lambda:ap-south-2:489524808438:layer:AWS-AppConfig-Extension:68',
-  'ap-southeast-1': 'arn:aws:lambda:ap-southeast-1:421114256042:layer:AWS-AppConfig-Extension:127',
-  'ap-southeast-2': 'arn:aws:lambda:ap-southeast-2:080788657173:layer:AWS-AppConfig-Extension:158',
-  'ap-southeast-3': 'arn:aws:lambda:ap-southeast-3:418787028745:layer:AWS-AppConfig-Extension:114',
-  'ap-southeast-4': 'arn:aws:lambda:ap-southeast-4:307021474294:layer:AWS-AppConfig-Extension:42',
-  'ca-central-1': 'arn:aws:lambda:ca-central-1:039592058896:layer:AWS-AppConfig-Extension:116',
-  'cn-north-1': 'arn:aws-cn:lambda:cn-north-1:615057806174:layer:AWS-AppConfig-Extension:99',
-  'cn-northwest-1': 'arn:aws-cn:lambda:cn-northwest-1:615084187847:layer:AWS-AppConfig-Extension:97',
-  'eu-central-1': 'arn:aws:lambda:eu-central-1:066940009817:layer:AWS-AppConfig-Extension:152',
-  'eu-central-2': 'arn:aws:lambda:eu-central-2:758369105281:layer:AWS-AppConfig-Extension:70',
-  'eu-north-1': 'arn:aws:lambda:eu-north-1:646970417810:layer:AWS-AppConfig-Extension:218',
-  'eu-south-1': 'arn:aws:lambda:eu-south-1:203683718741:layer:AWS-AppConfig-Extension:104',
-  'eu-south-2': 'arn:aws:lambda:eu-south-2:586093569114:layer:AWS-AppConfig-Extension:67',
-  'eu-west-1': 'arn:aws:lambda:eu-west-1:434848589818:layer:AWS-AppConfig-Extension:153',
-  'eu-west-2': 'arn:aws:lambda:eu-west-2:282860088358:layer:AWS-AppConfig-Extension:114',
-  'eu-west-3': 'arn:aws:lambda:eu-west-3:493207061005:layer:AWS-AppConfig-Extension:126',
-  'me-central-1': 'arn:aws:lambda:me-central-1:662846165436:layer:AWS-AppConfig-Extension:84',
-  'me-south-1': 'arn:aws:lambda:me-south-1:559955524753:layer:AWS-AppConfig-Extension:118',
-  'sa-east-1': 'arn:aws:lambda:sa-east-1:000010852771:layer:AWS-AppConfig-Extension:172',
-  'us-east-1': 'arn:aws:lambda:us-east-1:027255383542:layer:AWS-AppConfig-Extension:167',
-  'us-east-2': 'arn:aws:lambda:us-east-2:728743619870:layer:AWS-AppConfig-Extension:126',
-  'us-gov-east-1': 'arn:aws-us-gov:lambda:us-gov-east-1:946561847325:layer:AWS-AppConfig-Extension:73',
-  'us-gov-west-1': 'arn:aws-us-gov:lambda:us-gov-west-1:946746059096:layer:AWS-AppConfig-Extension:73',
-  'us-west-1': 'arn:aws:lambda:us-west-1:958113053741:layer:AWS-AppConfig-Extension:213',
-  'us-west-2': 'arn:aws:lambda:us-west-2:359756378197:layer:AWS-AppConfig-Extension:223',
-}
-
-/**
- * @returns { Map<string, string> } AppConfig extension ARN by region for arm64
- */
-export const ArnsByRegionForArm64: { [region: string]: string } = {
-  'ap-northeast-1': 'arn:aws:lambda:ap-northeast-1:980059726660:layer:AWS-AppConfig-Extension-Arm64:72',
-  'ap-south-1': 'arn:aws:lambda:ap-south-1:554480029851:layer:AWS-AppConfig-Extension-Arm64:81',
-  'ap-southeast-1': 'arn:aws:lambda:ap-southeast-1:421114256042:layer:AWS-AppConfig-Extension-Arm64:79',
-  'ap-southeast-2': 'arn:aws:lambda:ap-southeast-2:080788657173:layer:AWS-AppConfig-Extension-Arm64:101',
-  'eu-central-1': 'arn:aws:lambda:eu-central-1:066940009817:layer:AWS-AppConfig-Extension-Arm64:95',
-  'eu-west-1': 'arn:aws:lambda:eu-west-1:434848589818:layer:AWS-AppConfig-Extension-Arm64:91',
-  'eu-west-2': 'arn:aws:lambda:eu-west-2:282860088358:layer:AWS-AppConfig-Extension-Arm64:66',
-  'us-east-1': 'arn:aws:lambda:us-east-1:027255383542:layer:AWS-AppConfig-Extension-Arm64:100',
-  'us-east-2': 'arn:aws:lambda:us-east-2:728743619870:layer:AWS-AppConfig-Extension-Arm64:78',
-  'us-west-2': 'arn:aws:lambda:us-west-2:359756378197:layer:AWS-AppConfig-Extension-Arm64:125',
-}

package/src/lib/aws/services/appconfig/index.ts

@@ -1,3 +0,0 @@
-export * from './constants.js'
-export * from './main.js'
-export * from './types.js'